Identity and Access Management Access Analyzer helps identify potential resource-access risks by enabling you to\n identify any policies that grant access to an external principal. It does this by using\n logic-based reasoning to analyze resource-based policies in your Amazon Web Services environment. An\n external principal can be another Amazon Web Services account, a root user, an IAM user or role, a\n federated user, an Amazon Web Services service, or an anonymous user. You can also use IAM Access Analyzer to\n preview and validate public and cross-account access to your resources before deploying\n permissions changes. This guide describes the Identity and Access Management Access Analyzer operations that you can\n call programmatically. For general information about IAM Access Analyzer, see Identity and Access Management Access Analyzer in the IAM User Guide.
\nTo start using IAM Access Analyzer, you first need to create an analyzer.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#title": "Access Analyzer" + }, "version": "2019-11-01", "operations": [ { @@ -67,28 +88,7 @@ { "target": "com.amazonaws.accessanalyzer#Analyzer" } - ], - "traits": { - "aws.api#service": { - "sdkId": "AccessAnalyzer", - "arnNamespace": "access-analyzer", - "cloudFormationName": "AccessAnalyzer", - "cloudTrailEventSource": "access-analyzer.amazonaws.com", - "endpointPrefix": "access-analyzer" - }, - "aws.auth#sigv4": { - "name": "access-analyzer" - }, - "aws.protocols#restJson1": {}, - "smithy.api#cors": {}, - "smithy.api#documentation": "Identity and Access Management Access Analyzer helps identify potential resource-access risks by enabling you to\n identify any policies that grant access to an external principal. It does this by using\n logic-based reasoning to analyze resource-based policies in your Amazon Web Services environment. An\n external principal can be another Amazon Web Services account, a root user, an IAM user or role, a\n federated user, an Amazon Web Services service, or an anonymous user. You can also use IAM Access Analyzer to\n preview and validate public and cross-account access to your resources before deploying\n permissions changes. This guide describes the Identity and Access Management Access Analyzer operations that you can\n call programmatically. For general information about IAM Access Analyzer, see Identity and Access Management Access Analyzer in the IAM User Guide.
\nTo start using IAM Access Analyzer, you first need to create an analyzer.
", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" - }, - "smithy.api#title": "Access Analyzer" - } + ] }, "com.amazonaws.accessanalyzer#AccessDeniedException": { "type": "structure", @@ -3863,7 +3863,7 @@ "kmsKeyId": { "target": "com.amazonaws.accessanalyzer#SecretsManagerSecretKmsId", "traits": { - "smithy.api#documentation": "The proposed ARN, key ID, or alias of the KMS customer master key (CMK).
" + "smithy.api#documentation": "The proposed ARN, key ID, or alias of the KMS key.
" } }, "secretPolicy": { @@ -3874,7 +3874,7 @@ } }, "traits": { - "smithy.api#documentation": "The configuration for a Secrets Manager secret. For more information, see CreateSecret.
\nYou can propose a configuration for a new secret or an existing secret that you own by\n specifying the secret policy and optional KMS encryption key. If the configuration is for\n an existing secret and you do not specify the secret policy, the access preview uses the\n existing policy for the secret. If the access preview is for a new resource and you do not\n specify the policy, the access preview assumes a secret without a policy. To propose\n deletion of an existing policy, you can specify an empty string. If the proposed\n configuration is for a new secret and you do not specify the KMS key ID, the access\n preview uses the default CMK of the Amazon Web Services account. If you specify an empty string for the\n KMS key ID, the access preview uses the default CMK of the Amazon Web Services account. For more\n information about secret policy limits, see Quotas for\n Secrets Manager..
" + "smithy.api#documentation": "The configuration for a Secrets Manager secret. For more information, see CreateSecret.
\nYou can propose a configuration for a new secret or an existing secret that you own by\n specifying the secret policy and optional KMS encryption key. If the configuration is for\n an existing secret and you do not specify the secret policy, the access preview uses the\n existing policy for the secret. If the access preview is for a new resource and you do not\n specify the policy, the access preview assumes a secret without a policy. To propose\n deletion of an existing policy, you can specify an empty string. If the proposed\n configuration is for a new secret and you do not specify the KMS key ID, the access\n preview uses the Amazon Web Services managed key aws/secretsmanager. If you specify an empty\n string for the KMS key ID, the access preview uses the Amazon Web Services managed key of the Amazon Web Services\n account. For more information about secret policy limits, see Quotas for\n Secrets Manager..
The type of policy to validate. Identity policies grant permissions to IAM principals.\n Identity policies include managed and inline policies for IAM roles, users, and groups.\n They also include service-control policies (SCPs) that are attached to an Amazon Web Services\n organization, organizational unit (OU), or an account.
\nResource policies grant permissions on Amazon Web Services resources. Resource policies include trust\n policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic\n input such as identity policy or resource policy or a specific input such as managed policy\n or Amazon S3 bucket policy.
", "smithy.api#required": {} } + }, + "validatePolicyResourceType": { + "target": "com.amazonaws.accessanalyzer#ValidatePolicyResourceType", + "traits": { + "smithy.api#documentation": "The type of resource to attach to your resource policy. Specify a value for the policy\n validation resource type only if the policy type is RESOURCE_POLICY. For\n example, to validate a resource policy to attach to an Amazon S3 bucket, you can choose\n AWS::S3::Bucket for the policy validation resource type.
For resource types not supported as valid values, IAM Access Analyzer runs policy checks that\n apply to all resource policies. For example, to validate a resource policy to attach to a\n KMS key, do not specify a value for the policy validation resource type and IAM Access Analyzer\n will run policy checks that apply to all resource policies.
" + } } } }, + "com.amazonaws.accessanalyzer#ValidatePolicyResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWS::S3::Bucket", + "name": "S3_BUCKET" + }, + { + "value": "AWS::S3::AccessPoint", + "name": "S3_ACCESS_POINT" + }, + { + "value": "AWS::S3::MultiRegionAccessPoint", + "name": "S3_MULTI_REGION_ACCESS_POINT" + }, + { + "value": "AWS::S3ObjectLambda::AccessPoint", + "name": "S3_OBJECT_LAMBDA_ACCESS_POINT" + } + ] + } + }, "com.amazonaws.accessanalyzer#ValidatePolicyResponse": { "type": "structure", "members": { diff --git a/aws/sdk/aws-models/appconfigdata.json b/aws/sdk/aws-models/appconfigdata.json new file mode 100644 index 0000000000000000000000000000000000000000..a50427f56862996bb01df718d5949ef525ed61c2 --- /dev/null +++ b/aws/sdk/aws-models/appconfigdata.json @@ -0,0 +1,439 @@ +{ + "smithy": "1.0", + "shapes": { + "com.amazonaws.appconfigdata#AppConfigData": { + "type": "service", + "traits": { + "aws.api#dataPlane": {}, + "aws.api#service": { + "sdkId": "AppConfigData", + "arnNamespace": "appconfigdata", + "cloudFormationName": "AppConfigData", + "cloudTrailEventSource": "appconfigdata.amazonaws.com", + "endpointPrefix": "appconfigdata" + }, + "aws.auth#sigv4": { + "name": "appconfig" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Use the AppConfigData API, a capability of AWS AppConfig, to retrieve deployed configuration.
", + "smithy.api#title": "AWS AppConfig Data" + }, + "version": "2021-11-11", + "operations": [ + { + "target": "com.amazonaws.appconfigdata#GetLatestConfiguration" + } + ], + "resources": [ + { + "target": "com.amazonaws.appconfigdata#ConfigurationSession" + } + ] + }, + "com.amazonaws.appconfigdata#BadRequestDetails": { + "type": "union", + "members": { + "InvalidParameters": { + "target": "com.amazonaws.appconfigdata#InvalidParameterMap", + "traits": { + "smithy.api#documentation": "Present if the Reason for the bad request was 'InvalidParameters'
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details describing why the request was invalid
" + } + }, + "com.amazonaws.appconfigdata#BadRequestException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.appconfigdata#String" + }, + "Reason": { + "target": "com.amazonaws.appconfigdata#BadRequestReason", + "traits": { + "smithy.api#documentation": "Code indicating the reason the request was invalid.
" + } + }, + "Details": { + "target": "com.amazonaws.appconfigdata#BadRequestDetails", + "traits": { + "smithy.api#documentation": "Details describing why the request was invalid
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by the service.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.appconfigdata#BadRequestReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "InvalidParameters", + "name": "INVALID_PARAMETERS", + "documentation": "Indicates there was a problem with one or more of the parameters.\nSee InvalidParameters in the BadRequestDetails for more information." + } + ] + } + }, + "com.amazonaws.appconfigdata#Blob": { + "type": "blob" + }, + "com.amazonaws.appconfigdata#ConfigurationSession": { + "type": "resource", + "identifiers": { + "SessionId": { + "target": "com.amazonaws.appconfigdata#Id" + } + }, + "create": { + "target": "com.amazonaws.appconfigdata#StartConfigurationSession" + } + }, + "com.amazonaws.appconfigdata#GetLatestConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.appconfigdata#GetLatestConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.appconfigdata#GetLatestConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appconfigdata#BadRequestException" + }, + { + "target": "com.amazonaws.appconfigdata#InternalServerException" + }, + { + "target": "com.amazonaws.appconfigdata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appconfigdata#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the latest deployed configuration. This API may return empty Configuration data if the client already has the latest version. See StartConfigurationSession to obtain an InitialConfigurationToken to call this API.
\nEach call to GetLatestConfiguration returns a new ConfigurationToken (NextPollConfigurationToken\n in the response). This new token MUST be provided to the next call to GetLatestConfiguration when\n polling for configuration updates.
\nTo avoid excess charges, we recommend that you include the\n ClientConfigurationVersion value with every call to\n GetConfiguration. This value must be saved on your client. Subsequent\n calls to GetConfiguration must pass this value by using the\n ClientConfigurationVersion parameter.
Token describing the current state of the configuration session. To obtain a token, first call the StartConfigurationSession API. Note that every call to GetLatestConfiguration will return a new ConfigurationToken (NextPollConfigurationToken in the response) and MUST be provided to subsequent GetLatestConfiguration API calls.
", + "smithy.api#httpQuery": "configuration_token", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request parameters for the GetLatestConfiguration API
" + } + }, + "com.amazonaws.appconfigdata#GetLatestConfigurationResponse": { + "type": "structure", + "members": { + "NextPollConfigurationToken": { + "target": "com.amazonaws.appconfigdata#Token", + "traits": { + "smithy.api#documentation": "The latest token describing the current state of the configuration session. This MUST be provided to the next call to GetLatestConfiguration.
", + "smithy.api#httpHeader": "Next-Poll-Configuration-Token" + } + }, + "NextPollIntervalInSeconds": { + "target": "com.amazonaws.appconfigdata#Integer", + "traits": { + "smithy.api#documentation": "The amount of time the client should wait before polling for configuration updates again. See RequiredMinimumPollIntervalInSeconds to set the desired poll interval.
", + "smithy.api#httpHeader": "Next-Poll-Interval-In-Seconds" + } + }, + "ContentType": { + "target": "com.amazonaws.appconfigdata#String", + "traits": { + "smithy.api#documentation": "A standard MIME type describing the format of the configuration content.
", + "smithy.api#httpHeader": "Content-Type" + } + }, + "Configuration": { + "target": "com.amazonaws.appconfigdata#Blob", + "traits": { + "smithy.api#documentation": "The data of the configuration. Note that this may be empty if the client already has the latest version of configuration.
", + "smithy.api#httpPayload": {}, + "smithy.api#sensitive": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Response parameters for the GetLatestConfiguration API
" + } + }, + "com.amazonaws.appconfigdata#Id": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z0-9]{7}$" + } + }, + "com.amazonaws.appconfigdata#Identifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.appconfigdata#Integer": { + "type": "integer" + }, + "com.amazonaws.appconfigdata#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.appconfigdata#String" + } + }, + "traits": { + "smithy.api#documentation": "There was an internal failure in the service.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.appconfigdata#InvalidParameterDetail": { + "type": "structure", + "members": { + "Problem": { + "target": "com.amazonaws.appconfigdata#InvalidParameterProblem", + "traits": { + "smithy.api#documentation": "Detail describing why an individual parameter did not satisfy the constraints specified by the service
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an invalid parameter.
" + } + }, + "com.amazonaws.appconfigdata#InvalidParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.appconfigdata#String" + }, + "value": { + "target": "com.amazonaws.appconfigdata#InvalidParameterDetail" + } + }, + "com.amazonaws.appconfigdata#InvalidParameterProblem": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Corrupted", + "name": "CORRUPTED", + "documentation": "The parameter was corrupted and could not be understood by the service." + }, + { + "value": "Expired", + "name": "EXPIRED", + "documentation": "The parameter was expired and can no longer be used." + }, + { + "value": "PollIntervalNotSatisfied", + "name": "POLL_INTERVAL_NOT_SATISFIED", + "documentation": "The client called the service before the time specified in the poll interval." + } + ] + } + }, + "com.amazonaws.appconfigdata#OptionalPollSeconds": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 15, + "max": 86400 + } + } + }, + "com.amazonaws.appconfigdata#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.appconfigdata#String" + }, + "ResourceType": { + "target": "com.amazonaws.appconfigdata#ResourceType", + "traits": { + "smithy.api#documentation": "The type of resource that was not found.
" + } + }, + "ReferencedBy": { + "target": "com.amazonaws.appconfigdata#StringMap", + "traits": { + "smithy.api#documentation": "A map indicating which parameters in the request reference the resource that was not found.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The requested resource could not be found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.appconfigdata#ResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Application", + "name": "APPLICATION", + "documentation": "Resource type value for the Application resource." + }, + { + "value": "ConfigurationProfile", + "name": "CONFIGURATION_PROFILE", + "documentation": "Resource type value for the ConfigurationProfile resource." + }, + { + "value": "Deployment", + "name": "DEPLOYMENT", + "documentation": "Resource type value for the Deployment resource." + }, + { + "value": "Environment", + "name": "ENVIRONMENT", + "documentation": "Resource type value for the Environment resource." + }, + { + "value": "Configuration", + "name": "CONFIGURATION", + "documentation": "Resource type value for the Configuration resource." + } + ] + } + }, + "com.amazonaws.appconfigdata#StartConfigurationSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.appconfigdata#StartConfigurationSessionRequest" + }, + "output": { + "target": "com.amazonaws.appconfigdata#StartConfigurationSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appconfigdata#BadRequestException" + }, + { + "target": "com.amazonaws.appconfigdata#InternalServerException" + }, + { + "target": "com.amazonaws.appconfigdata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appconfigdata#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Starts a configuration session used to retrieve a deployed configuration. See the GetLatestConfiguration API for more details.
", + "smithy.api#http": { + "method": "POST", + "uri": "/configurationsessions", + "code": 201 + } + } + }, + "com.amazonaws.appconfigdata#StartConfigurationSessionRequest": { + "type": "structure", + "members": { + "ApplicationIdentifier": { + "target": "com.amazonaws.appconfigdata#Identifier", + "traits": { + "smithy.api#documentation": "The application ID or the application name.
", + "smithy.api#required": {} + } + }, + "EnvironmentIdentifier": { + "target": "com.amazonaws.appconfigdata#Identifier", + "traits": { + "smithy.api#documentation": "The environment ID or the environment name.
", + "smithy.api#required": {} + } + }, + "ConfigurationProfileIdentifier": { + "target": "com.amazonaws.appconfigdata#Identifier", + "traits": { + "smithy.api#documentation": "The configuration profile ID or the configuration profile name.
", + "smithy.api#required": {} + } + }, + "RequiredMinimumPollIntervalInSeconds": { + "target": "com.amazonaws.appconfigdata#OptionalPollSeconds", + "traits": { + "smithy.api#documentation": "The interval at which your client will poll for configuration. If provided, the service\n will throw a BadRequestException if the client polls before the specified poll interval. By default,\n client poll intervals are not enforced.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Request parameters for the StartConfigurationSession API.
" + } + }, + "com.amazonaws.appconfigdata#StartConfigurationSessionResponse": { + "type": "structure", + "members": { + "InitialConfigurationToken": { + "target": "com.amazonaws.appconfigdata#Token", + "traits": { + "smithy.api#documentation": "Token encapsulating state about the configuration session. Provide this token to the GetLatestConfiguration API to retrieve configuration data.
\nThis token should only be used once in your first call to GetLatestConfiguration. You MUST use the\n new token in the GetConfiguration response (NextPollConfigurationToken) in each subsequent call to\n GetLatestConfiguration.
\nResponse parameters for the StartConfigurationSession API.
" + } + }, + "com.amazonaws.appconfigdata#String": { + "type": "string" + }, + "com.amazonaws.appconfigdata#StringMap": { + "type": "map", + "key": { + "target": "com.amazonaws.appconfigdata#String" + }, + "value": { + "target": "com.amazonaws.appconfigdata#String" + } + }, + "com.amazonaws.appconfigdata#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.appconfigdata#String" + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.appconfigdata#Token": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\S{1,8192}$" + } + } + } +} diff --git a/aws/sdk/aws-models/application-insights.json b/aws/sdk/aws-models/application-insights.json index 27440d7f417edc2b60f48e46c43b7c4ead7ed95e..1bd7ba60c11deb8b13a389f01e9b905038bfa5ee 100644 --- a/aws/sdk/aws-models/application-insights.json +++ b/aws/sdk/aws-models/application-insights.json @@ -1208,6 +1208,21 @@ }, "com.amazonaws.applicationinsights#EC2WindowsBarleyService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Application Insights", + "arnNamespace": "applicationinsights", + "cloudFormationName": "ApplicationInsights", + "cloudTrailEventSource": "applicationinsights.amazonaws.com", + "endpointPrefix": "applicationinsights" + }, + "aws.auth#sigv4": { + "name": "applicationinsights" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Amazon CloudWatch Application Insights is a service that\n helps you detect common problems with your applications. It\n enables you to pinpoint the source of issues in your applications (built with technologies\n such as Microsoft IIS, .NET, and Microsoft SQL Server), by providing key insights into\n detected problems.
\nAfter you onboard your application, CloudWatch Application Insights identifies, \n recommends, and sets up metrics and logs. It continuously analyzes and\n correlates your metrics and logs for unusual behavior to surface actionable problems with\n your application. For example, if your application is slow and unresponsive and leading to\n HTTP 500 errors in your Application Load Balancer (ALB), Application Insights informs you\n that a memory pressure problem with your SQL Server database is occurring. It bases this\n analysis on impactful metrics and log errors.
", + "smithy.api#title": "Amazon CloudWatch Application Insights" + }, "version": "2018-11-25", "operations": [ { @@ -1291,22 +1306,7 @@ { "target": "com.amazonaws.applicationinsights#UpdateLogPattern" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Application Insights", - "arnNamespace": "applicationinsights", - "cloudFormationName": "ApplicationInsights", - "cloudTrailEventSource": "applicationinsights.amazonaws.com", - "endpointPrefix": "applicationinsights" - }, - "aws.auth#sigv4": { - "name": "applicationinsights" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon CloudWatch Application Insights is a service that\n helps you detect common problems with your applications. It\n enables you to pinpoint the source of issues in your applications (built with technologies\n such as Microsoft IIS, .NET, and Microsoft SQL Server), by providing key insights into\n detected problems.
\nAfter you onboard your application, CloudWatch Application Insights identifies, \n recommends, and sets up metrics and logs. It continuously analyzes and\n correlates your metrics and logs for unusual behavior to surface actionable problems with\n your application. For example, if your application is slow and unresponsive and leading to\n HTTP 500 errors in your Application Load Balancer (ALB), Application Insights informs you\n that a memory pressure problem with your SQL Server database is occurring. It bases this\n analysis on impactful metrics and log errors.
", - "smithy.api#title": "Amazon CloudWatch Application Insights" - } + ] }, "com.amazonaws.applicationinsights#EbsCause": { "type": "string" @@ -2823,10 +2823,6 @@ "value": "ORACLE", "name": "ORACLE" }, - { - "value": "SAP_HANA", - "name": "SAP_HANA" - }, { "value": "SAP_HANA_MULTI_NODE", "name": "SAP_HANA_MULTI_NODE" diff --git a/aws/sdk/aws-models/appstream.json b/aws/sdk/aws-models/appstream.json index c715115bdf708326c9c2709a510987507d5e75e0..8e1bc32d52ba5347d6736663ef3a0853727c3eb3 100644 --- a/aws/sdk/aws-models/appstream.json +++ b/aws/sdk/aws-models/appstream.json @@ -127,6 +127,65 @@ ] } }, + "com.amazonaws.appstream#AppBlock": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The name of the app block.
", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the app block.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The description of the app block.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The display name of the app block.
" + } + }, + "SourceS3Location": { + "target": "com.amazonaws.appstream#S3Location", + "traits": { + "smithy.api#documentation": "The source S3 location of the app block.
" + } + }, + "SetupScriptDetails": { + "target": "com.amazonaws.appstream#ScriptDetails", + "traits": { + "smithy.api#documentation": "The setup script details of the app block.
", + "smithy.api#required": {} + } + }, + "CreatedTime": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "The created time of the app block.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an app block.
\nApp blocks are an Amazon AppStream 2.0 resource that stores the details about the\n virtual hard disk in an S3 bucket. It also stores the setup script with details about\n how to mount the virtual hard disk. The virtual hard disk includes the application\n binaries and other files necessary to launch your applications. Multiple applications\n can be assigned to a single app block.
\nThis is only supported for Elastic fleets.
" + } + }, + "com.amazonaws.appstream#AppBlocks": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#AppBlock" + } + }, "com.amazonaws.appstream#Application": { "type": "structure", "members": { @@ -171,12 +230,121 @@ "traits": { "smithy.api#documentation": "Additional attributes that describe the application.
" } + }, + "WorkingDirectory": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The working directory for the application.
" + } + }, + "Description": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The description of the application.
" + } + }, + "Arn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the application.
" + } + }, + "AppBlockArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The app block ARN of the application.
" + } + }, + "IconS3Location": { + "target": "com.amazonaws.appstream#S3Location", + "traits": { + "smithy.api#documentation": "The S3 location of the application icon.
" + } + }, + "Platforms": { + "target": "com.amazonaws.appstream#Platforms", + "traits": { + "smithy.api#documentation": "The platforms on which the application can run.
" + } + }, + "InstanceFamilies": { + "target": "com.amazonaws.appstream#StringList", + "traits": { + "smithy.api#documentation": "The instance families for the application.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the application was created within the app block.
" + } } }, "traits": { "smithy.api#documentation": "Describes an application in the application catalog.
" } }, + "com.amazonaws.appstream#ApplicationAttribute": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LAUNCH_PARAMETERS", + "name": "LAUNCH_PARAMETERS" + }, + { + "value": "WORKING_DIRECTORY", + "name": "WORKING_DIRECTORY" + } + ] + } + }, + "com.amazonaws.appstream#ApplicationAttributes": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#ApplicationAttribute" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.appstream#ApplicationFleetAssociation": { + "type": "structure", + "members": { + "FleetName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The name of the fleet associated with the application.
", + "smithy.api#required": {} + } + }, + "ApplicationArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the application associated with the fleet.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the application fleet association.
" + } + }, + "com.amazonaws.appstream#ApplicationFleetAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#ApplicationFleetAssociation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, "com.amazonaws.appstream#ApplicationSettings": { "type": "structure", "members": { @@ -251,6 +419,65 @@ "target": "com.amazonaws.appstream#Arn" } }, + "com.amazonaws.appstream#AssociateApplicationFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#AssociateApplicationFleetRequest" + }, + "output": { + "target": "com.amazonaws.appstream#AssociateApplicationFleetResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#LimitExceededException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Associates the specified application with the specified fleet. This is only supported for Elastic fleets.
" + } + }, + "com.amazonaws.appstream#AssociateApplicationFleetRequest": { + "type": "structure", + "members": { + "FleetName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the fleet.
", + "smithy.api#required": {} + } + }, + "ApplicationArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the application.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appstream#AssociateApplicationFleetResult": { + "type": "structure", + "members": { + "ApplicationFleetAssociation": { + "target": "com.amazonaws.appstream#ApplicationFleetAssociation", + "traits": { + "smithy.api#documentation": "If fleet name is specified, this returns the list of applications that are associated\n to it. If application ARN is specified, this returns the list of fleets to which it is\n associated.
" + } + } + } + }, "com.amazonaws.appstream#AssociateFleet": { "type": "operation", "input": { @@ -574,6 +801,201 @@ } } }, + "com.amazonaws.appstream#CreateAppBlock": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#CreateAppBlockRequest" + }, + "output": { + "target": "com.amazonaws.appstream#CreateAppBlockResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#LimitExceededException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an app block.
\nApp blocks are an Amazon AppStream 2.0 resource that stores the details about the\n virtual hard disk in an S3 bucket. It also stores the setup script with details about\n how to mount the virtual hard disk. The virtual hard disk includes the application\n binaries and other files necessary to launch your applications. Multiple applications\n can be assigned to a single app block.
\nThis is only supported for Elastic fleets.
" + } + }, + "com.amazonaws.appstream#CreateAppBlockRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the app block.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.appstream#Description", + "traits": { + "smithy.api#documentation": "The description of the app block.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.appstream#DisplayName", + "traits": { + "smithy.api#documentation": "The display name of the app block. This is not displayed to the user.
" + } + }, + "SourceS3Location": { + "target": "com.amazonaws.appstream#S3Location", + "traits": { + "smithy.api#documentation": "The source S3 location of the app block.
", + "smithy.api#required": {} + } + }, + "SetupScriptDetails": { + "target": "com.amazonaws.appstream#ScriptDetails", + "traits": { + "smithy.api#documentation": "The setup script details of the app block.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.appstream#Tags", + "traits": { + "smithy.api#documentation": "The tags assigned to the app block.
" + } + } + } + }, + "com.amazonaws.appstream#CreateAppBlockResult": { + "type": "structure", + "members": { + "AppBlock": { + "target": "com.amazonaws.appstream#AppBlock", + "traits": { + "smithy.api#documentation": "The app block.
" + } + } + } + }, + "com.amazonaws.appstream#CreateApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#CreateApplicationRequest" + }, + "output": { + "target": "com.amazonaws.appstream#CreateApplicationResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#LimitExceededException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an application.
\nApplications are an Amazon AppStream 2.0 resource that stores the details about how to\n launch applications on Elastic fleet streaming instances. An application consists of the\n launch details, icon, and display name. Applications are associated with an app block\n that contains the application binaries and other files. The applications assigned to an\n Elastic fleet are the applications users can launch.
\nThis is only supported for Elastic fleets.
" + } + }, + "com.amazonaws.appstream#CreateApplicationRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the application. This name is visible to users when display name is not specified.
", + "smithy.api#required": {} + } + }, + "DisplayName": { + "target": "com.amazonaws.appstream#DisplayName", + "traits": { + "smithy.api#documentation": "The display name of the application. This name is visible to users in the application catalog.
" + } + }, + "Description": { + "target": "com.amazonaws.appstream#Description", + "traits": { + "smithy.api#documentation": "The description of the application.
" + } + }, + "IconS3Location": { + "target": "com.amazonaws.appstream#S3Location", + "traits": { + "smithy.api#documentation": "The location in S3 of the application icon.
", + "smithy.api#required": {} + } + }, + "LaunchPath": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The launch path of the application.
", + "smithy.api#required": {} + } + }, + "WorkingDirectory": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The working directory of the application.
" + } + }, + "LaunchParameters": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The launch parameters of the application.
" + } + }, + "Platforms": { + "target": "com.amazonaws.appstream#Platforms", + "traits": { + "smithy.api#documentation": "The platforms the application supports. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
", + "smithy.api#required": {} + } + }, + "InstanceFamilies": { + "target": "com.amazonaws.appstream#StringList", + "traits": { + "smithy.api#documentation": "The instance families the application supports. Valid values are GENERAL_PURPOSE and GRAPHICS_G4.
", + "smithy.api#required": {} + } + }, + "AppBlockArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The app block ARN to which the application should be associated
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.appstream#Tags", + "traits": { + "smithy.api#documentation": "The tags assigned to the application.
" + } + } + } + }, + "com.amazonaws.appstream#CreateApplicationResult": { + "type": "structure", + "members": { + "Application": { + "target": "com.amazonaws.appstream#Application" + } + } + }, "com.amazonaws.appstream#CreateDirectoryConfig": { "type": "operation", "input": { @@ -686,7 +1108,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a fleet. A fleet consists of streaming instances that run a specified image.
" + "smithy.api#documentation": "Creates a fleet. A fleet consists of streaming instances that run a specified image when using Always-On or On-Demand.
" } }, "com.amazonaws.appstream#CreateFleetRequest": { @@ -714,7 +1136,7 @@ "InstanceType": { "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "The instance type to use when launching fleet instances. The following instance types are available:
\nstream.standard.small
\nstream.standard.medium
\nstream.standard.large
\nstream.compute.large
\nstream.compute.xlarge
\nstream.compute.2xlarge
\nstream.compute.4xlarge
\nstream.compute.8xlarge
\nstream.memory.large
\nstream.memory.xlarge
\nstream.memory.2xlarge
\nstream.memory.4xlarge
\nstream.memory.8xlarge
\nstream.memory.z1d.large
\nstream.memory.z1d.xlarge
\nstream.memory.z1d.2xlarge
\nstream.memory.z1d.3xlarge
\nstream.memory.z1d.6xlarge
\nstream.memory.z1d.12xlarge
\nstream.graphics-design.large
\nstream.graphics-design.xlarge
\nstream.graphics-design.2xlarge
\nstream.graphics-design.4xlarge
\nstream.graphics-desktop.2xlarge
\nstream.graphics.g4dn.xlarge
\nstream.graphics.g4dn.2xlarge
\nstream.graphics.g4dn.4xlarge
\nstream.graphics.g4dn.8xlarge
\nstream.graphics.g4dn.12xlarge
\nstream.graphics.g4dn.16xlarge
\nstream.graphics-pro.4xlarge
\nstream.graphics-pro.8xlarge
\nstream.graphics-pro.16xlarge
\nThe instance type to use when launching fleet instances. The following instance types are available:
\nstream.standard.small
\nstream.standard.medium
\nstream.standard.large
\nstream.compute.large
\nstream.compute.xlarge
\nstream.compute.2xlarge
\nstream.compute.4xlarge
\nstream.compute.8xlarge
\nstream.memory.large
\nstream.memory.xlarge
\nstream.memory.2xlarge
\nstream.memory.4xlarge
\nstream.memory.8xlarge
\nstream.memory.z1d.large
\nstream.memory.z1d.xlarge
\nstream.memory.z1d.2xlarge
\nstream.memory.z1d.3xlarge
\nstream.memory.z1d.6xlarge
\nstream.memory.z1d.12xlarge
\nstream.graphics-design.large
\nstream.graphics-design.xlarge
\nstream.graphics-design.2xlarge
\nstream.graphics-design.4xlarge
\nstream.graphics-desktop.2xlarge
\nstream.graphics.g4dn.xlarge
\nstream.graphics.g4dn.2xlarge
\nstream.graphics.g4dn.4xlarge
\nstream.graphics.g4dn.8xlarge
\nstream.graphics.g4dn.12xlarge
\nstream.graphics.g4dn.16xlarge
\nstream.graphics-pro.4xlarge
\nstream.graphics-pro.8xlarge
\nstream.graphics-pro.16xlarge
\nThe following instance types are available for Elastic fleets:
\nstream.standard.small
\nstream.standard.medium
\nThe desired capacity for the fleet.
", - "smithy.api#required": {} + "smithy.api#documentation": "The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.
" } }, "VpcConfig": { "target": "com.amazonaws.appstream#VpcConfig", "traits": { - "smithy.api#documentation": "The VPC configuration for the fleet.
" + "smithy.api#documentation": "The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.
" } }, "MaxUserDurationInSeconds": { @@ -770,7 +1191,7 @@ "DomainJoinInfo": { "target": "com.amazonaws.appstream#DomainJoinInfo", "traits": { - "smithy.api#documentation": "The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
" + "smithy.api#documentation": "The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. This is not allowed for Elastic fleets.
" } }, "Tags": { @@ -782,19 +1203,37 @@ "IdleDisconnectTimeoutInSeconds": { "target": "com.amazonaws.appstream#Integer", "traits": { - "smithy.api#documentation": "The amount of time that users can be idle (inactive) before they are disconnected\n from their streaming session and the DisconnectTimeoutInSeconds time\n interval begins. Users are notified before they are disconnected due to inactivity. If\n they try to reconnect to the streaming session before the time interval specified in\n DisconnectTimeoutInSeconds elapses, they are connected to their\n previous session. Users are considered idle when they stop providing keyboard or mouse\n input during their streaming session. File uploads and downloads, audio in, audio out,\n and pixels changing do not qualify as user activity. If users continue to be idle after\n the time interval in IdleDisconnectTimeoutInSeconds elapses, they are\n disconnected.
To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.
\nIf you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
\nThe amount of time that users can be idle (inactive) before they are disconnected\n from their streaming session and the DisconnectTimeoutInSeconds time\n interval begins. Users are notified before they are disconnected due to inactivity. If\n they try to reconnect to the streaming session before the time interval specified in\n DisconnectTimeoutInSeconds elapses, they are connected to their\n previous session. Users are considered idle when they stop providing keyboard or mouse\n input during their streaming session. File uploads and downloads, audio in, audio out,\n and pixels changing do not qualify as user activity. If users continue to be idle after\n the time interval in IdleDisconnectTimeoutInSeconds elapses, they are\n disconnected.
To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.
\nIf you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
\nThe Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
" + } + }, + "StreamView": { + "target": "com.amazonaws.appstream#StreamView", + "traits": { + "smithy.api#documentation": "The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.
The default value is APP.
The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic\n fleets.
" } }, - "IamRoleArn": { - "target": "com.amazonaws.appstream#Arn", + "MaxConcurrentSessions": { + "target": "com.amazonaws.appstream#Integer", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
" + "smithy.api#documentation": "The maximum concurrent sessions of the Elastic fleet. This is required for Elastic\n fleets, and not allowed for other fleet types.
" } }, - "StreamView": { - "target": "com.amazonaws.appstream#StreamView", + "UsbDeviceFilterStrings": { + "target": "com.amazonaws.appstream#UsbDeviceFilterStrings", "traits": { - "smithy.api#documentation": "The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.
The default value is APP.
The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.
" } } } @@ -1419,6 +1858,87 @@ "type": "structure", "members": {} }, + "com.amazonaws.appstream#DeleteAppBlock": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DeleteAppBlockRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DeleteAppBlockResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#ResourceInUseException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an app block.
" + } + }, + "com.amazonaws.appstream#DeleteAppBlockRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the app block.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appstream#DeleteAppBlockResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.appstream#DeleteApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DeleteApplicationRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DeleteApplicationResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceInUseException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an application.
" + } + }, + "com.amazonaws.appstream#DeleteApplicationRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the application.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appstream#DeleteApplicationResult": { + "type": "structure", + "members": {} + }, "com.amazonaws.appstream#DeleteDirectoryConfig": { "type": "operation", "input": { @@ -1739,6 +2259,192 @@ "type": "structure", "members": {} }, + "com.amazonaws.appstream#DescribeAppBlocks": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DescribeAppBlocksRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DescribeAppBlocksResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list that describes one or more app blocks.
" + } + }, + "com.amazonaws.appstream#DescribeAppBlocksRequest": { + "type": "structure", + "members": { + "Arns": { + "target": "com.amazonaws.appstream#ArnList", + "traits": { + "smithy.api#documentation": "The ARNs of the app blocks.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this\n operation.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum size of each page of results.
" + } + } + } + }, + "com.amazonaws.appstream#DescribeAppBlocksResult": { + "type": "structure", + "members": { + "AppBlocks": { + "target": "com.amazonaws.appstream#AppBlocks", + "traits": { + "smithy.api#documentation": "The app blocks in the list.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this\n operation.
" + } + } + } + }, + "com.amazonaws.appstream#DescribeApplicationFleetAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DescribeApplicationFleetAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DescribeApplicationFleetAssociationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified.
" + } + }, + "com.amazonaws.appstream#DescribeApplicationFleetAssociationsRequest": { + "type": "structure", + "members": { + "FleetName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the fleet.
" + } + }, + "ApplicationArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the application.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum size of each page of results.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this\n operation.
" + } + } + } + }, + "com.amazonaws.appstream#DescribeApplicationFleetAssociationsResult": { + "type": "structure", + "members": { + "ApplicationFleetAssociations": { + "target": "com.amazonaws.appstream#ApplicationFleetAssociationList", + "traits": { + "smithy.api#documentation": "The application fleet associations in the list.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this\n operation.
" + } + } + } + }, + "com.amazonaws.appstream#DescribeApplications": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DescribeApplicationsRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DescribeApplicationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list that describes one or more applications.
" + } + }, + "com.amazonaws.appstream#DescribeApplicationsRequest": { + "type": "structure", + "members": { + "Arns": { + "target": "com.amazonaws.appstream#ArnList", + "traits": { + "smithy.api#documentation": "The ARNs for the applications.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this\n operation.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum size of each page of results.
" + } + } + } + }, + "com.amazonaws.appstream#DescribeApplicationsResult": { + "type": "structure", + "members": { + "Applications": { + "target": "com.amazonaws.appstream#Applications", + "traits": { + "smithy.api#documentation": "The applications in the list.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this\n operation.
" + } + } + } + }, "com.amazonaws.appstream#DescribeDirectoryConfigs": { "type": "operation", "input": { @@ -2513,43 +3219,89 @@ "target": "com.amazonaws.appstream#DirectoryName" } }, - "com.amazonaws.appstream#DisableUser": { + "com.amazonaws.appstream#DisableUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DisableUserRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DisableUserResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Disables the specified user in the user pool. Users can't sign in to AppStream 2.0 until they are re-enabled. This action does not delete the user.
" + } + }, + "com.amazonaws.appstream#DisableUserRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.appstream#Username", + "traits": { + "smithy.api#documentation": "The email address of the user.
\n \nUsers' email addresses are case-sensitive.
\nThe authentication type for the user. You must specify USERPOOL.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appstream#DisableUserResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.appstream#DisassociateApplicationFleet": { "type": "operation", "input": { - "target": "com.amazonaws.appstream#DisableUserRequest" + "target": "com.amazonaws.appstream#DisassociateApplicationFleetRequest" }, "output": { - "target": "com.amazonaws.appstream#DisableUserResult" + "target": "com.amazonaws.appstream#DisassociateApplicationFleetResult" }, "errors": [ { - "target": "com.amazonaws.appstream#ResourceNotFoundException" + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" } ], "traits": { - "smithy.api#documentation": "Disables the specified user in the user pool. Users can't sign in to AppStream 2.0 until they are re-enabled. This action does not delete the user.
" + "smithy.api#documentation": "Disassociates the specified application from the fleet.
" } }, - "com.amazonaws.appstream#DisableUserRequest": { + "com.amazonaws.appstream#DisassociateApplicationFleetRequest": { "type": "structure", "members": { - "UserName": { - "target": "com.amazonaws.appstream#Username", + "FleetName": { + "target": "com.amazonaws.appstream#Name", "traits": { - "smithy.api#documentation": "The email address of the user.
\n \nUsers' email addresses are case-sensitive.
\nThe name of the fleet.
", "smithy.api#required": {} } }, - "AuthenticationType": { - "target": "com.amazonaws.appstream#AuthenticationType", + "ApplicationArn": { + "target": "com.amazonaws.appstream#Arn", "traits": { - "smithy.api#documentation": "The authentication type for the user. You must specify USERPOOL.
", + "smithy.api#documentation": "The ARN of the application.
", "smithy.api#required": {} } } } }, - "com.amazonaws.appstream#DisableUserResult": { + "com.amazonaws.appstream#DisassociateApplicationFleetResult": { "type": "structure", "members": {} }, @@ -2889,6 +3641,24 @@ "traits": { "smithy.api#documentation": "The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.
The default value is APP.
The platform of the fleet.
" + } + }, + "MaxConcurrentSessions": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of concurrent sessions for the fleet.
" + } + }, + "UsbDeviceFilterStrings": { + "target": "com.amazonaws.appstream#UsbDeviceFilterStrings", + "traits": { + "smithy.api#documentation": "The USB device filter strings associated with the fleet.
" + } } }, "traits": { @@ -2915,6 +3685,10 @@ { "value": "IAM_ROLE_ARN", "name": "IAM_ROLE_ARN" + }, + { + "value": "USB_DEVICE_FILTER_STRINGS", + "name": "USB_DEVICE_FILTER_STRINGS" } ] } @@ -3124,6 +3898,10 @@ { "value": "ON_DEMAND", "name": "ON_DEMAND" + }, + { + "value": "ELASTIC", + "name": "ELASTIC" } ] } @@ -3887,8 +4665,26 @@ }, "com.amazonaws.appstream#PhotonAdminProxyService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "AppStream", + "arnNamespace": "appstream", + "cloudFormationName": "AppStream", + "cloudTrailEventSource": "appstream.amazonaws.com", + "endpointPrefix": "appstream2" + }, + "aws.auth#sigv4": { + "name": "appstream" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "This is the Amazon AppStream 2.0 API Reference. This documentation provides descriptions and syntax for each of the actions and data types in AppStream 2.0. AppStream 2.0 is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications. AppStream 2.0 manages the AWS resources that are required to host and run your applications, scales automatically, and provides access to your users on demand.
\n \nYou can call the AppStream 2.0 API operations by using an interface VPC endpoint (interface endpoint). For more information, see Access AppStream 2.0 API Operations and CLI Commands Through an Interface VPC Endpoint in the Amazon AppStream 2.0 Administration Guide.
\nTo learn more about AppStream 2.0, see the following resources:
\n \nThis is the Amazon AppStream 2.0 API Reference. This documentation provides descriptions and syntax for each of the actions and data types in AppStream 2.0. AppStream 2.0 is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications. AppStream 2.0 manages the AWS resources that are required to host and run your applications, scales automatically, and provides access to your users on demand.
\n \nYou can call the AppStream 2.0 API operations by using an interface VPC endpoint (interface endpoint). For more information, see Access AppStream 2.0 API Operations and CLI Commands Through an Interface VPC Endpoint in the Amazon AppStream 2.0 Administration Guide.
\nTo learn more about AppStream 2.0, see the following resources:
\n \nThe S3 key of the S3 object.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the S3 location.
" + } + }, + "com.amazonaws.appstream#ScriptDetails": { + "type": "structure", + "members": { + "ScriptS3Location": { + "target": "com.amazonaws.appstream#S3Location", + "traits": { + "smithy.api#documentation": "The S3 object location for the script.
", + "smithy.api#required": {} + } + }, + "ExecutablePath": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The run path for the script.
", + "smithy.api#required": {} + } + }, + "ExecutableParameters": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The runtime parameters passed to the run path for the script.
" + } + }, + "TimeoutInSeconds": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The run timeout, in seconds, for the script.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the details of the script.
" + } + }, "com.amazonaws.appstream#SecurityGroupIdList": { "type": "list", "member": { @@ -5018,6 +5914,97 @@ "type": "structure", "members": {} }, + "com.amazonaws.appstream#UpdateApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#UpdateApplicationRequest" + }, + "output": { + "target": "com.amazonaws.appstream#UpdateApplicationResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the specified application.
" + } + }, + "com.amazonaws.appstream#UpdateApplicationRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the application. This name is visible to users when display name is not specified.
", + "smithy.api#required": {} + } + }, + "DisplayName": { + "target": "com.amazonaws.appstream#DisplayName", + "traits": { + "smithy.api#documentation": "The display name of the application. This name is visible to users in the application catalog.
" + } + }, + "Description": { + "target": "com.amazonaws.appstream#Description", + "traits": { + "smithy.api#documentation": "The description of the application.
" + } + }, + "IconS3Location": { + "target": "com.amazonaws.appstream#S3Location", + "traits": { + "smithy.api#documentation": "The icon S3 location of the application.
" + } + }, + "LaunchPath": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The launch path of the application.
" + } + }, + "WorkingDirectory": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The working directory of the application.
" + } + }, + "LaunchParameters": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The launch parameters of the application.
" + } + }, + "AppBlockArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the app block.
" + } + }, + "AttributesToDelete": { + "target": "com.amazonaws.appstream#ApplicationAttributes", + "traits": { + "smithy.api#documentation": "The attributes to delete for an application.
" + } + } + } + }, + "com.amazonaws.appstream#UpdateApplicationResult": { + "type": "structure", + "members": { + "Application": { + "target": "com.amazonaws.appstream#Application" + } + } + }, "com.amazonaws.appstream#UpdateDirectoryConfig": { "type": "operation", "input": { @@ -5126,7 +6113,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the specified fleet.
\nIf the fleet is in the STOPPED state, you can update any attribute except the fleet name. \n If the fleet is in the RUNNING state, you can update the DisplayName, ComputeCapacity, ImageARN, ImageName, IdleDisconnectTimeoutInSeconds, and DisconnectTimeoutInSeconds attributes. \n If the fleet is in the STARTING or STOPPING state, you can't update it.
Updates the specified fleet.
\nIf the fleet is in the STOPPED state, you can update any attribute except\n the fleet name.
If the fleet is in the RUNNING state, you can update the following based\n on the fleet type:
Always-On and On-Demand fleet types
\nYou can update the DisplayName, ComputeCapacity,\n ImageARN, ImageName,\n IdleDisconnectTimeoutInSeconds, and\n DisconnectTimeoutInSeconds attributes.
Elastic fleet type
\nYou can update the DisplayName,\n IdleDisconnectTimeoutInSeconds,\n DisconnectTimeoutInSeconds, MaxConcurrentSessions,\n and UsbDeviceFilterStrings attributes.
If the fleet is in the STARTING or STOPPED state, you can't update it.
The instance type to use when launching fleet instances. The following instance types are available:
\nstream.standard.small
\nstream.standard.medium
\nstream.standard.large
\nstream.compute.large
\nstream.compute.xlarge
\nstream.compute.2xlarge
\nstream.compute.4xlarge
\nstream.compute.8xlarge
\nstream.memory.large
\nstream.memory.xlarge
\nstream.memory.2xlarge
\nstream.memory.4xlarge
\nstream.memory.8xlarge
\nstream.memory.z1d.large
\nstream.memory.z1d.xlarge
\nstream.memory.z1d.2xlarge
\nstream.memory.z1d.3xlarge
\nstream.memory.z1d.6xlarge
\nstream.memory.z1d.12xlarge
\nstream.graphics-design.large
\nstream.graphics-design.xlarge
\nstream.graphics-design.2xlarge
\nstream.graphics-design.4xlarge
\nstream.graphics-desktop.2xlarge
\nstream.graphics.g4dn.xlarge
\nstream.graphics.g4dn.2xlarge
\nstream.graphics.g4dn.4xlarge
\nstream.graphics.g4dn.8xlarge
\nstream.graphics.g4dn.12xlarge
\nstream.graphics.g4dn.16xlarge
\nstream.graphics-pro.4xlarge
\nstream.graphics-pro.8xlarge
\nstream.graphics-pro.16xlarge
\nThe instance type to use when launching fleet instances. The following instance types are available:
\nstream.standard.small
\nstream.standard.medium
\nstream.standard.large
\nstream.compute.large
\nstream.compute.xlarge
\nstream.compute.2xlarge
\nstream.compute.4xlarge
\nstream.compute.8xlarge
\nstream.memory.large
\nstream.memory.xlarge
\nstream.memory.2xlarge
\nstream.memory.4xlarge
\nstream.memory.8xlarge
\nstream.memory.z1d.large
\nstream.memory.z1d.xlarge
\nstream.memory.z1d.2xlarge
\nstream.memory.z1d.3xlarge
\nstream.memory.z1d.6xlarge
\nstream.memory.z1d.12xlarge
\nstream.graphics-design.large
\nstream.graphics-design.xlarge
\nstream.graphics-design.2xlarge
\nstream.graphics-design.4xlarge
\nstream.graphics-desktop.2xlarge
\nstream.graphics.g4dn.xlarge
\nstream.graphics.g4dn.2xlarge
\nstream.graphics.g4dn.4xlarge
\nstream.graphics.g4dn.8xlarge
\nstream.graphics.g4dn.12xlarge
\nstream.graphics.g4dn.16xlarge
\nstream.graphics-pro.4xlarge
\nstream.graphics-pro.8xlarge
\nstream.graphics-pro.16xlarge
\nThe following instance types are available for Elastic fleets:
\nstream.standard.small
\nstream.standard.medium
\nThe desired capacity for the fleet.
" + "smithy.api#documentation": "The desired capacity for the fleet. This is not allowed for Elastic fleets.
" } }, "VpcConfig": { "target": "com.amazonaws.appstream#VpcConfig", "traits": { - "smithy.api#documentation": "The VPC configuration for the fleet.
" + "smithy.api#documentation": "The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.
" } }, "MaxUserDurationInSeconds": { @@ -5234,6 +6221,24 @@ "traits": { "smithy.api#documentation": "The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.
The default value is APP.
The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
" + } + }, + "MaxConcurrentSessions": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of concurrent sessions for a fleet.
" + } + }, + "UsbDeviceFilterStrings": { + "target": "com.amazonaws.appstream#UsbDeviceFilterStrings", + "traits": { + "smithy.api#documentation": "The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.
" + } } } }, @@ -5500,6 +6505,22 @@ "target": "com.amazonaws.appstream#UsageReportSubscription" } }, + "com.amazonaws.appstream#UsbDeviceFilterString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#pattern": "^((\\w*)\\s*(\\w*)\\s*\\,\\s*(\\w*)\\s*\\,\\s*\\*?(\\w*)\\s*\\,\\s*\\*?(\\w*)\\s*\\,\\s*\\*?\\d*\\s*\\,\\s*\\*?\\d*\\s*\\,\\s*[0-1]\\s*\\,\\s*[0-1]\\s*)$" + } + }, + "com.amazonaws.appstream#UsbDeviceFilterStrings": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#UsbDeviceFilterString" + } + }, "com.amazonaws.appstream#User": { "type": "structure", "members": { diff --git a/aws/sdk/aws-models/autoscaling.json b/aws/sdk/aws-models/autoscaling.json index cda3cef35c23300a154cf9ed97dcb51ad9807051..83ddeaad248fe3831bdd47fe34e656adc1a3ec6e 100644 --- a/aws/sdk/aws-models/autoscaling.json +++ b/aws/sdk/aws-models/autoscaling.json @@ -441,7 +441,7 @@ } ], "traits": { - "smithy.api#documentation": "Attaches one or more target groups to the specified Auto Scaling group.
\nThis operation is used with the following load balancer types:
\nApplication Load Balancer - Operates at the application layer (layer 7) and\n supports HTTP and HTTPS.
\nNetwork Load Balancer - Operates at the transport layer (layer 4) and\n supports TCP, TLS, and UDP.
\nGateway Load Balancer - Operates at the network layer (layer 3).
\nTo describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from\n the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.
\nFor more information, see Elastic Load Balancing and\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Attaches one or more target groups to the specified Auto Scaling group.
\nThis operation is used with the following load balancer types:
\nApplication Load Balancer - Operates at the application layer (layer 7) and\n supports HTTP and HTTPS.
\nNetwork Load Balancer - Operates at the transport layer (layer 4) and\n supports TCP, TLS, and UDP.
\nGateway Load Balancer - Operates at the network layer (layer 3).
\nTo describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from\n the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.
\nThis operation is additive and does not detach existing target groups or Classic Load\n Balancers from the Auto Scaling group.
\nFor more information, see Elastic Load Balancing and\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroupsResultType": { @@ -484,7 +484,7 @@ } ], "traits": { - "smithy.api#documentation": "To attach an Application Load Balancer, Network Load Balancer, or Gateway Load\n Balancer, use the AttachLoadBalancerTargetGroups API operation\n instead.
\nAttaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling\n registers the running instances with these Classic Load Balancers.
\nTo describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach the load balancer from the Auto Scaling\n group, call the DetachLoadBalancers API.
\nFor more information, see Elastic Load Balancing and\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "To attach an Application Load Balancer, Network Load Balancer, or Gateway Load\n Balancer, use the AttachLoadBalancerTargetGroups API operation\n instead.
\nAttaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling\n registers the running instances with these Classic Load Balancers.
\nTo describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach the load balancer from the Auto Scaling\n group, call the DetachLoadBalancers API.
\nThis operation is additive and does not detach existing Classic Load Balancers or\n target groups from the Auto Scaling group.
\nFor more information, see Elastic Load Balancing and\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#AttachLoadBalancersResultType": { @@ -607,7 +607,7 @@ "HealthCheckGracePeriod": { "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", "traits": { - "smithy.api#documentation": "The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service.
" + "smithy.api#documentation": "The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n health check.
" } }, "Instances": { @@ -1426,7 +1426,7 @@ "Timestamps": { "target": "com.amazonaws.autoscaling#PredictiveScalingForecastTimestamps", "traits": { - "smithy.api#documentation": "The time stamps for the data points, in UTC format.
", + "smithy.api#documentation": "The timestamps for the data points, in UTC format.
", "smithy.api#required": {} } }, @@ -1484,7 +1484,7 @@ } ], "traits": { - "smithy.api#documentation": "Completes the lifecycle action for the specified token or instance with the specified\n result.
\nThis step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:
\n(Optional) Create a Lambda function and a rule that allows CloudWatch Events to\n invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates\n instances.
\n(Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to\n publish lifecycle notifications to the target.
\nCreate the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.
\nIf you need more time, record the lifecycle action heartbeat to keep the\n instance in a pending state.
\n\n If you finish before the timeout period ends, complete the\n lifecycle action.\n
\nFor more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Completes the lifecycle action for the specified token or instance with the specified\n result.
\nThis step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:
\n(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to\n invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates\n instances.
\n(Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.
\nCreate the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.
\nIf you need more time, record the lifecycle action heartbeat to keep the\n instance in a pending state.
\n\n If you finish before the timeout period ends, send a\n callback by using the CompleteLifecycleAction API\n call.\n
\nFor more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#CompleteLifecycleActionAnswer": { @@ -1611,7 +1611,7 @@ "MixedInstancesPolicy": { "target": "com.amazonaws.autoscaling#MixedInstancesPolicy", "traits": { - "smithy.api#documentation": "An embedded object that specifies a mixed instances policy.
\n \n \n \nFor more information, see Auto Scaling groups with multiple\n instance types and purchase options in the Amazon EC2 Auto Scaling User\n Guide.
" + "smithy.api#documentation": "An embedded object that specifies a mixed instances policy.
\n \n \n \nFor more information, see Auto Scaling groups with multiple\n instance types and purchase options in the Amazon EC2 Auto Scaling User\n Guide.
" } }, "InstanceId": { @@ -1673,7 +1673,7 @@ "HealthCheckGracePeriod": { "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", "traits": { - "smithy.api#documentation": "The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service. During this time, any health check\n failures for the instance are ignored. The default value is 0. For more\n information, see Health\n check grace period in the Amazon EC2 Auto Scaling User Guide.
Conditional: Required if you are adding an ELB health check.
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n health check. The default value is 0. For more information, see Health\n check grace period in the Amazon EC2 Auto Scaling User Guide.
Conditional: Required if you are adding an ELB health check.
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in. For more information about preventing instances from terminating on\n scale in, see Instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in. For more information about preventing instances from terminating on\n scale in, see Using\n instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "CapacityRebalance": { "target": "com.amazonaws.autoscaling#CapacityRebalanceEnabled", "traits": { - "smithy.api#documentation": "Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is\n disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot\n Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of\n interruption. After launching a new instance, it then terminates an old instance. For\n more information, see Amazon EC2 Auto Scaling Capacity\n Rebalancing in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is\n disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot\n Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of\n interruption. After launching a new instance, it then terminates an old instance. For\n more information, see Amazon EC2 Auto Scaling\n Capacity Rebalancing in the Amazon EC2 Auto Scaling User Guide.
" } }, "LifecycleHookSpecificationList": { @@ -1925,7 +1925,7 @@ "MetricName": { "target": "com.amazonaws.autoscaling#MetricName", "traits": { - "smithy.api#documentation": "The name of the metric.
", + "smithy.api#documentation": "The name of the metric. To get the exact metric name, namespace, and dimensions,\n inspect the Metric object\n that is returned by a call to ListMetrics.
", "smithy.api#required": {} } }, @@ -1952,12 +1952,12 @@ "Unit": { "target": "com.amazonaws.autoscaling#MetricUnit", "traits": { - "smithy.api#documentation": "The unit of the metric.
" + "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.
" } } }, "traits": { - "smithy.api#documentation": "Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use\n with Amazon EC2 Auto Scaling.
\nTo create your customized metric specification:
\nAdd values for each required parameter from CloudWatch. You can use an existing\n metric, or a new metric that you create. To use your own metric, you must first\n publish the metric to CloudWatch. For more information, see Publish\n Custom Metrics in the Amazon CloudWatch User\n Guide.
\nChoose a metric that changes proportionally with capacity. The value of the\n metric should increase or decrease in inverse proportion to the number of\n capacity units. That is, the value of the metric should decrease when capacity\n increases.
\nFor more information about CloudWatch, see Amazon CloudWatch\n Concepts.
" + "smithy.api#documentation": "Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use\n with Amazon EC2 Auto Scaling.
\nTo create your customized metric specification:
\nAdd values for each required parameter from CloudWatch. You can use an existing\n metric, or a new metric that you create. To use your own metric, you must first\n publish the metric to CloudWatch. For more information, see Publish\n custom metrics in the Amazon CloudWatch User\n Guide.
\nChoose a metric that changes proportionally with capacity. The value of the\n metric should increase or decrease in inverse proportion to the number of\n capacity units. That is, the value of the metric should decrease when capacity\n increases.
\nFor more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts.
\nEach individual service provides information about the metrics, namespace, and\n dimensions they use. For more information, see Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.
\nThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS)\n topic.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic.
", "smithy.api#required": {} } } @@ -4704,13 +4704,13 @@ "WeightedCapacity": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { - "smithy.api#documentation": "The number of capacity units provided by the instance type specified in\n InstanceType in terms of virtual CPUs, memory, storage, throughput, or\n other relative performance characteristic. When a Spot or On-Demand Instance is\n launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches\n instances until the desired capacity is totally fulfilled, even if this results in an\n overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling\n can only launch an instance with a WeightedCapacity of five units, the\n instance is launched, and the desired capacity is exceeded by three units. For more\n information, see Instance weighting for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. Value must be in the\n range of 1–999.
The number of capacity units provided by the instance type specified in\n InstanceType in terms of virtual CPUs, memory, storage, throughput, or\n other relative performance characteristic. When a Spot or On-Demand Instance is\n launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches\n instances until the desired capacity is totally fulfilled, even if this results in an\n overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling\n can only launch an instance with a WeightedCapacity of five units, the\n instance is launched, and the desired capacity is exceeded by three units. For more\n information, see Instance weighting for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. Value must be in the\n range of 1–999.
Provides the launch template to be used when launching the instance type specified in\n InstanceType. For example, some instance types might require a launch\n template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's\n defined for your mixed instances policy. For more information, see Specifying a\n different launch template for an instance type in the\n Amazon EC2 Auto Scaling User Guide.
Provides the launch template to be used when launching the instance type specified in\n InstanceType. For example, some instance types might require a launch\n template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's\n defined for your mixed instances policy. For more information, see Specifying a\n different launch template for an instance type in the\n Amazon EC2 Auto Scaling User Guide.
Describes an override for a launch template. For more information, see Configuring overrides in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Describes an override for a launch template. For more information, see Configuring overrides in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#LaunchTemplateSpecification": { @@ -4821,7 +4821,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action\n whenever it launches instances or terminates\n instances.
" + "smithy.api#documentation": "Describes a lifecycle hook, which enables an Auto Scaling group to be aware of events in the\n Auto Scaling instance lifecycle, and then perform a custom action when the corresponding\n lifecycle event occurs.
" } }, "com.amazonaws.autoscaling#LifecycleHookNames": { @@ -4885,7 +4885,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes information used to specify a lifecycle hook for an Auto Scaling\n group.
\nA lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance\n launches (before it is put into service) or as the instance terminates (before it is\n fully terminated).
\nThis step is a part of the procedure for creating a lifecycle hook for an Auto Scaling\n group:
\n(Optional) Create a Lambda function and a rule that allows CloudWatch Events to\n invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates\n instances.
\n(Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to\n publish lifecycle notifications to the target.
\n\n Create the lifecycle hook. Specify whether the hook is\n used when the instances launch or terminate.\n
\nIf you need more time, record the lifecycle action heartbeat to keep the\n instance in a pending state.
\nIf you finish before the timeout period ends, complete the lifecycle\n action.
\nFor more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Describes information used to specify a lifecycle hook for an Auto Scaling\n group.
\n \n \n \nFor more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#LifecycleHookSpecifications": { @@ -5082,7 +5082,7 @@ "Timestamps": { "target": "com.amazonaws.autoscaling#PredictiveScalingForecastTimestamps", "traits": { - "smithy.api#documentation": "The time stamps for the data points, in UTC format.
", + "smithy.api#documentation": "The timestamps for the data points, in UTC format.
", "smithy.api#required": {} } }, @@ -5225,6 +5225,34 @@ "smithy.api#documentation": "Specifies the minimum and maximum for the MemoryMiB object when you\n specify InstanceRequirements for an Auto Scaling group.
The namespace of the metric. For more information, see the table in Amazon Web Services\n services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.
", + "smithy.api#required": {} + } + }, + "MetricName": { + "target": "com.amazonaws.autoscaling#MetricName", + "traits": { + "smithy.api#documentation": "The name of the metric.
", + "smithy.api#required": {} + } + }, + "Dimensions": { + "target": "com.amazonaws.autoscaling#MetricDimensions", + "traits": { + "smithy.api#documentation": "The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services\n documentation available from the table in Amazon Web Services\n services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.
\nConditional: If you published your metric with dimensions, you must specify the same\n dimensions in your scaling policy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a specific metric.
" + } + }, "com.amazonaws.autoscaling#MetricCollectionType": { "type": "structure", "members": { @@ -5245,6 +5273,51 @@ "target": "com.amazonaws.autoscaling#MetricCollectionType" } }, + "com.amazonaws.autoscaling#MetricDataQueries": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#MetricDataQuery" + } + }, + "com.amazonaws.autoscaling#MetricDataQuery": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "A short name that identifies the object's results in the response. This name must be\n unique among all MetricDataQuery objects specified for a single scaling\n policy. If you are performing math expressions on this set of data, this name represents\n that data and can serve as a variable in the mathematical expression. The valid\n characters are letters, numbers, and underscores. The first character must be a\n lowercase letter.
The math expression to perform on the returned data, if this object is performing a\n math expression. This expression can use the Id of the other metrics to\n refer to those metrics, and can also use the Id of other expressions to use\n the result of those expressions.
Conditional: Within each MetricDataQuery object, you must specify either\n Expression or MetricStat, but not both.
Information about the metric data to return.
\nConditional: Within each MetricDataQuery object, you must specify either\n Expression or MetricStat, but not both.
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.
" + } + }, + "ReturnData": { + "target": "com.amazonaws.autoscaling#ReturnData", + "traits": { + "smithy.api#documentation": "Indicates whether to return the timestamps and raw data values of this metric.
\nIf you use any math expressions, specify true for this value for only the\n final math expression that the metric specification is based on. You must specify\n false for ReturnData for all the other metrics and\n expressions used in the metric specification.
If you are only retrieving metrics and not performing any math expressions, do not\n specify anything for ReturnData. This sets it to its default\n (true).
The metric data to return. Also defines whether this call is returning data for one\n metric only, or whether it is performing a math expression on the values of returned\n metric statistics to create a new time series. A time series is a series of data points,\n each of which is associated with a timestamp.
\n \n \nFor more information and examples, see Advanced predictive scaling policy configurations using custom metrics in\n the Amazon EC2 Auto Scaling User Guide.
" + } + }, "com.amazonaws.autoscaling#MetricDimension": { "type": "structure", "members": { @@ -5311,6 +5384,34 @@ "smithy.api#box": {} } }, + "com.amazonaws.autoscaling#MetricStat": { + "type": "structure", + "members": { + "Metric": { + "target": "com.amazonaws.autoscaling#Metric", + "traits": { + "smithy.api#documentation": "The CloudWatch metric to return, including the metric name, namespace, and dimensions. To\n get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.
", + "smithy.api#required": {} + } + }, + "Stat": { + "target": "com.amazonaws.autoscaling#XmlStringMetricStat", + "traits": { + "smithy.api#documentation": "The statistic to return. It can include any CloudWatch statistic or extended statistic. For\n a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.
\nThe most commonly used metrics for predictive scaling are Average and\n Sum.
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.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure defines the CloudWatch metric to return, along with the statistic, period,\n and unit.
\n \nFor more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts in the Amazon CloudWatch User Guide.
" + } + }, "com.amazonaws.autoscaling#MetricStatistic": { "type": "string", "traits": { @@ -5409,7 +5510,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes a mixed instances policy. A mixed instances policy contains the instance\n types that Amazon EC2 Auto Scaling can launch and other information that Amazon EC2 Auto Scaling can use to launch\n instances and help optimize your costs. For more information, see Auto Scaling\n groups with multiple instance types and purchase options in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Describes a mixed instances policy. A mixed instances policy contains the instance\n types that Amazon EC2 Auto Scaling can launch and other information that Amazon EC2 Auto Scaling can use to launch\n instances and help optimize your costs. For more information, see Auto Scaling\n groups with multiple instance types and purchase options in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#MonitoringEnabled": { @@ -5466,7 +5567,7 @@ "TopicARN": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS)\n topic.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic.
" } }, "NotificationType": { @@ -5734,6 +5835,51 @@ "smithy.api#documentation": "Represents a predictive scaling policy configuration to use with Amazon EC2 Auto Scaling.
" } }, + "com.amazonaws.autoscaling#PredictiveScalingCustomizedCapacityMetric": { + "type": "structure", + "members": { + "MetricDataQueries": { + "target": "com.amazonaws.autoscaling#MetricDataQueries", + "traits": { + "smithy.api#documentation": "One or more metric data queries to provide the data points for a capacity metric. Use\n multiple metric data queries only if you are performing a math expression on returned\n data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a customized capacity metric for a predictive scaling policy.
" + } + }, + "com.amazonaws.autoscaling#PredictiveScalingCustomizedLoadMetric": { + "type": "structure", + "members": { + "MetricDataQueries": { + "target": "com.amazonaws.autoscaling#MetricDataQueries", + "traits": { + "smithy.api#documentation": "One or more metric data queries to provide the data points for a load metric. Use\n multiple metric data queries only if you are performing a math expression on returned\n data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a custom load metric for a predictive scaling policy.
" + } + }, + "com.amazonaws.autoscaling#PredictiveScalingCustomizedScalingMetric": { + "type": "structure", + "members": { + "MetricDataQueries": { + "target": "com.amazonaws.autoscaling#MetricDataQueries", + "traits": { + "smithy.api#documentation": "One or more metric data queries to provide the data points for a scaling metric. Use\n multiple metric data queries only if you are performing a math expression on returned\n data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a custom scaling metric for a predictive scaling policy.
" + } + }, "com.amazonaws.autoscaling#PredictiveScalingForecastTimestamps": { "type": "list", "member": { @@ -5777,31 +5923,49 @@ "TargetValue": { "target": "com.amazonaws.autoscaling#MetricScale", "traits": { - "smithy.api#documentation": "Specifies the target utilization.
", + "smithy.api#documentation": "Specifies the target utilization.
\nSome metrics are based on a count instead of a percentage, such as the request\n count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy\n specifies one of these metrics, specify the target utilization as the optimal\n average request or message count per instance during any one-minute interval.\n
\nThe metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling\n metric and load metric to use.
" + "smithy.api#documentation": "The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the\n appropriate scaling metric and load metric to use.
" } }, "PredefinedScalingMetricSpecification": { "target": "com.amazonaws.autoscaling#PredictiveScalingPredefinedScalingMetric", "traits": { - "smithy.api#documentation": "The scaling metric specification.
" + "smithy.api#documentation": "The predefined scaling metric specification.
" } }, "PredefinedLoadMetricSpecification": { "target": "com.amazonaws.autoscaling#PredictiveScalingPredefinedLoadMetric", "traits": { - "smithy.api#documentation": "The load metric specification.
" + "smithy.api#documentation": "The predefined load metric specification.
" + } + }, + "CustomizedScalingMetricSpecification": { + "target": "com.amazonaws.autoscaling#PredictiveScalingCustomizedScalingMetric", + "traits": { + "smithy.api#documentation": "The customized scaling metric specification.
" + } + }, + "CustomizedLoadMetricSpecification": { + "target": "com.amazonaws.autoscaling#PredictiveScalingCustomizedLoadMetric", + "traits": { + "smithy.api#documentation": "The customized load metric specification.
" + } + }, + "CustomizedCapacityMetricSpecification": { + "target": "com.amazonaws.autoscaling#PredictiveScalingCustomizedCapacityMetric", + "traits": { + "smithy.api#documentation": "The customized capacity metric specification.
" } } }, "traits": { - "smithy.api#documentation": "This structure specifies the metrics and target utilization settings for a predictive\n scaling policy.
\nYou must specify either a metric pair, or a load metric and a scaling metric\n individually. Specifying a metric pair instead of individual metrics provides a simpler\n way to configure metrics for a scaling policy. You choose the metric pair, and the\n policy automatically knows the correct sum and average statistics to use for the load\n metric and the scaling metric.
\nExample
\nYou create a predictive scaling policy and specify\n ALBRequestCount as the value for the metric pair and\n 1000.0 as the target value. For this type of metric, you must\n provide the metric dimension for the corresponding target group, so you also\n provide a resource label for the Application Load Balancer target group that is\n attached to your Auto Scaling group.
The number of requests the target group receives per minute provides the load\n metric, and the request count averaged between the members of the target group\n provides the scaling metric. In CloudWatch, this refers to the\n RequestCount and RequestCountPerTarget metrics,\n respectively.
For optimal use of predictive scaling, you adhere to the best practice of\n using a dynamic scaling policy to automatically scale between the minimum\n capacity and maximum capacity in response to real-time changes in resource\n utilization.
\nAmazon EC2 Auto Scaling consumes data points for the load metric over the last 14 days and\n creates an hourly load forecast for predictive scaling. (A minimum of 24 hours\n of data is required.)
\nAfter creating the load forecast, Amazon EC2 Auto Scaling determines when to reduce or\n increase the capacity of your Auto Scaling group in each hour of the forecast period so\n that the average number of requests received by each instance is as close to\n 1000 requests per minute as possible at all times.
\nThis structure specifies the metrics and target utilization settings for a predictive\n scaling policy.
\nYou must specify either a metric pair, or a load metric and a scaling metric\n individually. Specifying a metric pair instead of individual metrics provides a simpler\n way to configure metrics for a scaling policy. You choose the metric pair, and the\n policy automatically knows the correct sum and average statistics to use for the load\n metric and the scaling metric.
\nExample
\nYou create a predictive scaling policy and specify\n ALBRequestCount as the value for the metric pair and\n 1000.0 as the target value. For this type of metric, you must\n provide the metric dimension for the corresponding target group, so you also\n provide a resource label for the Application Load Balancer target group that is\n attached to your Auto Scaling group.
The number of requests the target group receives per minute provides the load\n metric, and the request count averaged between the members of the target group\n provides the scaling metric. In CloudWatch, this refers to the\n RequestCount and RequestCountPerTarget metrics,\n respectively.
For optimal use of predictive scaling, you adhere to the best practice of\n using a dynamic scaling policy to automatically scale between the minimum\n capacity and maximum capacity in response to real-time changes in resource\n utilization.
\nAmazon EC2 Auto Scaling consumes data points for the load metric over the last 14 days and\n creates an hourly load forecast for predictive scaling. (A minimum of 24 hours\n of data is required.)
\nAfter creating the load forecast, Amazon EC2 Auto Scaling determines when to reduce or\n increase the capacity of your Auto Scaling group in each hour of the forecast period so\n that the average number of requests received by each instance is as close to\n 1000 requests per minute as possible at all times.
\nFor information about using custom metrics with predictive scaling, see Advanced predictive scaling policy configurations using custom metrics in\n the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#PredictiveScalingMetricSpecifications": { @@ -5838,7 +6002,7 @@ "ResourceLabel": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", "traits": { - "smithy.api#documentation": "A label that uniquely identifies a specific Application Load Balancer target group from which to determine\n the request count served by your Auto Scaling group. You can't specify a resource label\n unless the target group is attached to the Auto Scaling group.
\nYou create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:
\n\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
\napp/
targetgroup/
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.
" + "smithy.api#documentation": "A label that uniquely identifies a specific Application Load Balancer target group from which to determine\n the request count served by your Auto Scaling group. You can't specify a resource label unless\n the target group is attached to the Auto Scaling group.
\nYou create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:
\n\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
\napp/
targetgroup/
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.
" } } }, @@ -5880,7 +6044,7 @@ "ResourceLabel": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", "traits": { - "smithy.api#documentation": "A label that uniquely identifies a specific Application Load Balancer target group from which to determine\n the average request count served by your Auto Scaling group. You can't specify a resource\n label unless the target group is attached to the Auto Scaling group.
\nYou create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:
\n\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
\napp/
targetgroup/
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.
" + "smithy.api#documentation": "A label that uniquely identifies a specific Application Load Balancer target group from which to determine\n the average request count served by your Auto Scaling group. You can't specify a resource label\n unless the target group is attached to the Auto Scaling group.
\nYou create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:
\n\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
\napp/
targetgroup/
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.
" } } }, @@ -5967,7 +6131,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates or updates a lifecycle hook for the specified Auto Scaling group.
\nA lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance\n launches (before it is put into service) or as the instance terminates (before it is\n fully terminated).
\nThis step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:
\n(Optional) Create a Lambda function and a rule that allows CloudWatch Events to\n invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates\n instances.
\n(Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to\n publish lifecycle notifications to the target.
\n\n Create the lifecycle hook. Specify whether the hook is\n used when the instances launch or terminate.\n
\nIf you need more time, record the lifecycle action heartbeat to keep the\n instance in a pending state using the RecordLifecycleActionHeartbeat API call.
\nIf you finish before the timeout period ends, complete the lifecycle action\n using the CompleteLifecycleAction API call.
\nFor more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.
\nIf you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling\n group, the call fails.
\nYou can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle\n hook, you can delete it by calling the DeleteLifecycleHook API.
" + "smithy.api#documentation": "Creates or updates a lifecycle hook for the specified Auto Scaling group.
\nA lifecycle hook enables an Auto Scaling group to be aware of events in the Auto Scaling instance\n lifecycle, and then perform a custom action when the corresponding lifecycle event\n occurs.
\nThis step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:
\n(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to\n invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates\n instances.
\n(Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.
\n\n Create the lifecycle hook. Specify whether the hook is\n used when the instances launch or terminate.\n
\nIf you need more time, record the lifecycle action heartbeat to keep the\n instance in a pending state using the RecordLifecycleActionHeartbeat API call.
\nIf you finish before the timeout period ends, send a callback by using the\n CompleteLifecycleAction API call.
\nFor more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.
\nIf you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling\n group, the call fails.
\nYou can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle\n hook, you can delete it by calling the DeleteLifecycleHook API.
" } }, "com.amazonaws.autoscaling#PutLifecycleHookAnswer": { @@ -6006,7 +6170,7 @@ "NotificationTargetARN": { "target": "com.amazonaws.autoscaling#NotificationTargetResourceName", "traits": { - "smithy.api#documentation": "The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance\n is in the transition state for the lifecycle hook. This target can be either an SQS\n queue or an SNS topic.
\nIf you specify an empty string, this overrides the current ARN.
\nThis operation uses the JSON format when sending notifications to an Amazon SQS queue,\n and an email key-value pair format when sending notifications to an Amazon SNS\n topic.
\nWhen you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test\n messages contain the following additional key-value pair: \"Event\":\n \"autoscaling:TEST_NOTIFICATION\".
The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance\n is in the transition state for the lifecycle hook. This target can be either an SQS\n queue or an SNS topic.
\nIf you specify an empty string, this overrides the current ARN.
\nThis operation uses the JSON format when sending notifications to an Amazon SQS queue, and\n an email key-value pair format when sending notifications to an Amazon SNS topic.
\nWhen you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test\n messages contain the following additional key-value pair: \"Event\":\n \"autoscaling:TEST_NOTIFICATION\".
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS)\n topic.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic.
", "smithy.api#required": {} } }, @@ -6172,7 +6336,7 @@ "TargetTrackingConfiguration": { "target": "com.amazonaws.autoscaling#TargetTrackingConfiguration", "traits": { - "smithy.api#documentation": "A target tracking scaling policy. Provides support for predefined or customized\n metrics.
\nThe following predefined metrics are available:
\n\n ASGAverageCPUUtilization\n
\n ASGAverageNetworkIn\n
\n ASGAverageNetworkOut\n
\n ALBRequestCountPerTarget\n
If you specify ALBRequestCountPerTarget for the metric, you must specify\n the ResourceLabel parameter with the\n PredefinedMetricSpecification.
For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API\n Reference.
\nRequired if the policy type is TargetTrackingScaling.
A target tracking scaling policy. Provides support for predefined or custom\n metrics.
\nThe following predefined metrics are available:
\n\n ASGAverageCPUUtilization\n
\n ASGAverageNetworkIn\n
\n ASGAverageNetworkOut\n
\n ALBRequestCountPerTarget\n
If you specify ALBRequestCountPerTarget for the metric, you must specify\n the ResourceLabel parameter with the\n PredefinedMetricSpecification.
For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API\n Reference.
\nRequired if the policy type is TargetTrackingScaling.
A predictive scaling policy. Provides support for only predefined metrics.
\nPredictive scaling works with CPU utilization, network in/out, and the Application\n Load Balancer request count.
\nFor more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API\n Reference.
\nRequired if the policy type is PredictiveScaling.
A predictive scaling policy. Provides support for predefined and custom\n metrics.
\nPredefined metrics include CPU utilization, network in/out, and the Application Load\n Balancer request count.
\nFor more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API\n Reference.
\nRequired if the policy type is PredictiveScaling.
Records a heartbeat for the lifecycle action associated with the specified token or\n instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.
\n\nThis step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:
\n(Optional) Create a Lambda function and a rule that allows CloudWatch Events to\n invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates\n instances.
\n(Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to\n publish lifecycle notifications to the target.
\nCreate the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.
\n\n If you need more time, record the lifecycle action\n heartbeat to keep the instance in a pending state.\n
\nIf you finish before the timeout period ends, complete the lifecycle\n action.
\nFor more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Records a heartbeat for the lifecycle action associated with the specified token or\n instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.
\nThis step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:
\n(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to\n invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates\n instances.
\n(Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.
\nCreate the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.
\n\n If you need more time, record the lifecycle action\n heartbeat to keep the instance in a pending state.\n
\nIf you finish before the timeout period ends, send a callback by using the\n CompleteLifecycleAction API call.
\nFor more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#RecordLifecycleActionHeartbeatAnswer": { @@ -6507,6 +6671,12 @@ "smithy.api#documentation": "Resumes the specified suspended auto scaling processes, or all suspended process, for\n the specified Auto Scaling group.
\nFor more information, see Suspending and\n resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.
" } }, + "com.amazonaws.autoscaling#ReturnData": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.autoscaling#ScalingActivityInProgressFault": { "type": "structure", "members": { @@ -7003,7 +7173,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the instance protection settings of the specified instances. This operation\n cannot be called on instances in a warm pool.
\nFor more information about preventing instances that are part of an Auto Scaling group from\n terminating on scale in, see Instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.
\nIf you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call\n fails.
" + "smithy.api#documentation": "Updates the instance protection settings of the specified instances. This operation\n cannot be called on instances in a warm pool.
\nFor more information about preventing instances that are part of an Auto Scaling group from\n terminating on scale in, see Using\n instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.
\nIf you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call\n fails.
" } }, "com.amazonaws.autoscaling#SetInstanceProtectionAnswer": { @@ -7487,7 +7657,7 @@ "MixedInstancesPolicy": { "target": "com.amazonaws.autoscaling#MixedInstancesPolicy", "traits": { - "smithy.api#documentation": "An embedded object that specifies a mixed instances policy. For more information, see\n Auto Scaling groups with multiple\n instance types and purchase options in the Amazon EC2 Auto Scaling User\n Guide.
" + "smithy.api#documentation": "An embedded object that specifies a mixed instances policy. For more information, see\n Auto Scaling groups with multiple\n instance types and purchase options in the Amazon EC2 Auto Scaling User\n Guide.
" } }, "MinSize": { @@ -7529,7 +7699,7 @@ "HealthCheckGracePeriod": { "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", "traits": { - "smithy.api#documentation": "The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service. The default value is 0. For\n more information, see Health\n check grace period in the Amazon EC2 Auto Scaling User Guide.
Conditional: Required if you are adding an ELB health check.
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n health check. The default value is 0. For more information, see Health\n check grace period in the Amazon EC2 Auto Scaling User Guide.
Conditional: Required if you are adding an ELB health check.
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in. For more information about preventing instances from terminating on\n scale in, see Instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in. For more information about preventing instances from terminating on\n scale in, see Using\n instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "ServiceLinkedRoleARN": { @@ -7571,7 +7741,7 @@ "CapacityRebalance": { "target": "com.amazonaws.autoscaling#CapacityRebalanceEnabled", "traits": { - "smithy.api#documentation": "Enables or disables Capacity Rebalancing. For more information, see Amazon EC2 Auto Scaling Capacity Rebalancing in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Enables or disables Capacity Rebalancing. For more information, see Amazon EC2 Auto Scaling\n Capacity Rebalancing in the Amazon EC2 Auto Scaling User Guide.
" } }, "Context": { @@ -7774,6 +7944,26 @@ "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, + "com.amazonaws.autoscaling#XmlStringMetricLabel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2047 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.autoscaling#XmlStringMetricStat": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, "com.amazonaws.autoscaling#XmlStringUserData": { "type": "string", "traits": { diff --git a/aws/sdk/aws-models/backup-gateway.json b/aws/sdk/aws-models/backup-gateway.json new file mode 100644 index 0000000000000000000000000000000000000000..dc93ffd859072f4123eadf5bec776074a335e3a8 --- /dev/null +++ b/aws/sdk/aws-models/backup-gateway.json @@ -0,0 +1,1543 @@ +{ + "smithy": "1.0", + "shapes": { + "com.amazonaws.backupgateway#AccessDeniedException": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.backupgateway#string", + "traits": { + "smithy.api#documentation": "A description of why you have insufficient permissions.
", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.backupgateway#string" + } + }, + "traits": { + "smithy.api#documentation": "The operation cannot proceed because you have insufficient permissions.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.backupgateway#ActivationKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^[0-9a-zA-Z\\-]+$" + } + }, + "com.amazonaws.backupgateway#AssociateGatewayToServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupgateway#AssociateGatewayToServerInput" + }, + "output": { + "target": "com.amazonaws.backupgateway#AssociateGatewayToServerOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupgateway#ConflictException" + }, + { + "target": "com.amazonaws.backupgateway#InternalServerException" + }, + { + "target": "com.amazonaws.backupgateway#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Associates a backup gateway with your server. After you complete the association process,\n you can back up and restore your VMs through the gateway.
" + } + }, + "com.amazonaws.backupgateway#AssociateGatewayToServerInput": { + "type": "structure", + "members": { + "GatewayArn": { + "target": "com.amazonaws.backupgateway#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation\n to return a list of gateways for your account and Amazon Web Services Region.
The Amazon Resource Name (ARN) of the server that hosts your virtual machines.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupgateway#AssociateGatewayToServerOutput": { + "type": "structure", + "members": { + "GatewayArn": { + "target": "com.amazonaws.backupgateway#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a gateway.
" + } + } + } + }, + "com.amazonaws.backupgateway#BackupOnPremises_v20210101": { + "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Backup Gateway", + "arnNamespace": "backup-gateway", + "cloudFormationName": "BackupGateway", + "cloudTrailEventSource": "backup-gateway.amazonaws.com", + "endpointPrefix": "backup-gateway" + }, + "aws.auth#sigv4": { + "name": "backup-gateway" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "Backup gateway connects Backup to your hypervisor, so you can\n create, store, and restore backups of your virtual machines (VMs) anywhere, whether\n on-premises or in the VMware Cloud (VMC) on Amazon Web Services.
\nAdd on-premises resources by connecting to a hypervisor through a gateway. Backup will automatically discover the resources in your hypervisor.
\nUse Backup to assign virtual or on-premises resources to a backup plan, or run\n on-demand backups. Once you have backed up your resources, you can view them and restore them\n like any resource supported by Backup.
\nTo download the Amazon Web Services software to get started, navigate to the Backup console, choose Gateways, then choose Create gateway.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + }, + "smithy.api#title": "AWS Backup Gateway" + }, + "version": "2021-01-01", + "operations": [ + { + "target": "com.amazonaws.backupgateway#ListTagsForResource" + }, + { + "target": "com.amazonaws.backupgateway#ListVirtualMachines" + }, + { + "target": "com.amazonaws.backupgateway#TagResource" + }, + { + "target": "com.amazonaws.backupgateway#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.backupgateway#GatewayResource" + }, + { + "target": "com.amazonaws.backupgateway#HypervisorResource" + } + ] + }, + "com.amazonaws.backupgateway#ConflictException": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.backupgateway#string", + "traits": { + "smithy.api#documentation": "A description of why the operation is not supported.
", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.backupgateway#string" + } + }, + "traits": { + "smithy.api#documentation": "The operation cannot proceed because it is not supported.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.backupgateway#CreateGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupgateway#CreateGatewayInput" + }, + "output": { + "target": "com.amazonaws.backupgateway#CreateGatewayOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupgateway#InternalServerException" + }, + { + "target": "com.amazonaws.backupgateway#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a backup gateway. After you create a gateway, you can associate it with a server\n using the AssociateGatewayToServer operation.
The activation key of the created gateway.
", + "smithy.api#required": {} + } + }, + "GatewayDisplayName": { + "target": "com.amazonaws.backupgateway#Name", + "traits": { + "smithy.api#documentation": "The display name of the created gateway.
", + "smithy.api#required": {} + } + }, + "GatewayType": { + "target": "com.amazonaws.backupgateway#GatewayType", + "traits": { + "smithy.api#documentation": "The type of created gateway.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.backupgateway#Tags", + "traits": { + "smithy.api#documentation": "A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair.
" + } + } + } + }, + "com.amazonaws.backupgateway#CreateGatewayOutput": { + "type": "structure", + "members": { + "GatewayArn": { + "target": "com.amazonaws.backupgateway#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway you create.
" + } + } + } + }, + "com.amazonaws.backupgateway#DayOfMonth": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 31 + } + } + }, + "com.amazonaws.backupgateway#DayOfWeek": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 6 + } + } + }, + "com.amazonaws.backupgateway#DeleteGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupgateway#DeleteGatewayInput" + }, + "output": { + "target": "com.amazonaws.backupgateway#DeleteGatewayOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupgateway#InternalServerException" + }, + { + "target": "com.amazonaws.backupgateway#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backupgateway#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a backup gateway.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.backupgateway#DeleteGatewayInput": { + "type": "structure", + "members": { + "GatewayArn": { + "target": "com.amazonaws.backupgateway#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway to delete.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupgateway#DeleteGatewayOutput": { + "type": "structure", + "members": { + "GatewayArn": { + "target": "com.amazonaws.backupgateway#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway you deleted.
" + } + } + } + }, + "com.amazonaws.backupgateway#DeleteHypervisor": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupgateway#DeleteHypervisorInput" + }, + "output": { + "target": "com.amazonaws.backupgateway#DeleteHypervisorOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupgateway#AccessDeniedException" + }, + { + "target": "com.amazonaws.backupgateway#InternalServerException" + }, + { + "target": "com.amazonaws.backupgateway#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backupgateway#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a hypervisor.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.backupgateway#DeleteHypervisorInput": { + "type": "structure", + "members": { + "HypervisorArn": { + "target": "com.amazonaws.backupgateway#ServerArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the hypervisor to delete.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupgateway#DeleteHypervisorOutput": { + "type": "structure", + "members": { + "HypervisorArn": { + "target": "com.amazonaws.backupgateway#ServerArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the hypervisor you deleted.
" + } + } + } + }, + "com.amazonaws.backupgateway#DisassociateGatewayFromServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupgateway#DisassociateGatewayFromServerInput" + }, + "output": { + "target": "com.amazonaws.backupgateway#DisassociateGatewayFromServerOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupgateway#ConflictException" + }, + { + "target": "com.amazonaws.backupgateway#InternalServerException" + }, + { + "target": "com.amazonaws.backupgateway#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backupgateway#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates a backup gateway from the specified server. After the disassociation process\n finishes, the gateway can no longer access the virtual machines on the server.
" + } + }, + "com.amazonaws.backupgateway#DisassociateGatewayFromServerInput": { + "type": "structure", + "members": { + "GatewayArn": { + "target": "com.amazonaws.backupgateway#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway to disassociate.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupgateway#DisassociateGatewayFromServerOutput": { + "type": "structure", + "members": { + "GatewayArn": { + "target": "com.amazonaws.backupgateway#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway you disassociated.
" + } + } + } + }, + "com.amazonaws.backupgateway#Gateway": { + "type": "structure", + "members": { + "GatewayArn": { + "target": "com.amazonaws.backupgateway#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation\n to return a list of gateways for your account and Amazon Web Services Region.
The display name of the gateway.
" + } + }, + "GatewayType": { + "target": "com.amazonaws.backupgateway#GatewayType", + "traits": { + "smithy.api#documentation": "The type of the gateway.
" + } + }, + "HypervisorId": { + "target": "com.amazonaws.backupgateway#HypervisorId", + "traits": { + "smithy.api#documentation": "The hypervisor ID of the gateway.
" + } + }, + "LastSeenTime": { + "target": "com.amazonaws.backupgateway#Time", + "traits": { + "smithy.api#documentation": "The last time Backup gateway communicated with the gateway, in Unix format and\n UTC time.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A gateway is an Backup Gateway appliance that runs on the customer's network\n to provide seamless connectivity to backup storage in the Amazon Web Services Cloud.
" + } + }, + "com.amazonaws.backupgateway#GatewayArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 50, + "max": 500 + }, + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\\/[a-zA-Z-0-9]+$" + } + }, + "com.amazonaws.backupgateway#GatewayResource": { + "type": "resource", + "identifiers": { + "GatewayArn": { + "target": "com.amazonaws.backupgateway#GatewayArn" + } + }, + "create": { + "target": "com.amazonaws.backupgateway#CreateGateway" + }, + "update": { + "target": "com.amazonaws.backupgateway#UpdateGatewayInformation" + }, + "delete": { + "target": "com.amazonaws.backupgateway#DeleteGateway" + }, + "list": { + "target": "com.amazonaws.backupgateway#ListGateways" + }, + "operations": [ + { + "target": "com.amazonaws.backupgateway#AssociateGatewayToServer" + }, + { + "target": "com.amazonaws.backupgateway#DisassociateGatewayFromServer" + }, + { + "target": "com.amazonaws.backupgateway#PutMaintenanceStartTime" + }, + { + "target": "com.amazonaws.backupgateway#TestHypervisorConfiguration" + } + ], + "traits": { + "aws.cloudformation#cfnResource": { + "name": "Gateway" + } + } + }, + "com.amazonaws.backupgateway#GatewayType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "BACKUP_VM", + "name": "BACKUP_VM" + } + ] + } + }, + "com.amazonaws.backupgateway#Gateways": { + "type": "list", + "member": { + "target": "com.amazonaws.backupgateway#Gateway" + } + }, + "com.amazonaws.backupgateway#Host": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 128 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.backupgateway#HourOfDay": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 23 + } + } + }, + "com.amazonaws.backupgateway#Hypervisor": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.backupgateway#Host", + "traits": { + "smithy.api#documentation": "The server host of the hypervisor. This can be either an IP address or a fully-qualified\n domain name (FQDN).
" + } + }, + "HypervisorArn": { + "target": "com.amazonaws.backupgateway#ServerArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the hypervisor.
" + } + }, + "KmsKeyArn": { + "target": "com.amazonaws.backupgateway#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Key Management Service used to encrypt the\n hypervisor.
" + } + }, + "Name": { + "target": "com.amazonaws.backupgateway#Name", + "traits": { + "smithy.api#documentation": "The name of the hypervisor.
" + } + }, + "State": { + "target": "com.amazonaws.backupgateway#HypervisorState", + "traits": { + "smithy.api#documentation": "The state of the hypervisor.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the hypervisor's permissions to which the gateway will connect.
\nA hypervisor is hardware, software, or firmware that creates and manages virtual machines,\n and allocates resources to them.
" + } + }, + "com.amazonaws.backupgateway#HypervisorId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.backupgateway#HypervisorResource": { + "type": "resource", + "identifiers": { + "HypervisorArn": { + "target": "com.amazonaws.backupgateway#ServerArn" + } + }, + "create": { + "target": "com.amazonaws.backupgateway#ImportHypervisorConfiguration" + }, + "update": { + "target": "com.amazonaws.backupgateway#UpdateHypervisor" + }, + "delete": { + "target": "com.amazonaws.backupgateway#DeleteHypervisor" + }, + "list": { + "target": "com.amazonaws.backupgateway#ListHypervisors" + }, + "traits": { + "aws.cloudformation#cfnResource": { + "name": "Hypervisor" + } + } + }, + "com.amazonaws.backupgateway#HypervisorState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "ONLINE", + "name": "ONLINE" + }, + { + "value": "OFFLINE", + "name": "OFFLINE" + }, + { + "value": "ERROR", + "name": "ERROR" + } + ] + } + }, + "com.amazonaws.backupgateway#Hypervisors": { + "type": "list", + "member": { + "target": "com.amazonaws.backupgateway#Hypervisor" + } + }, + "com.amazonaws.backupgateway#ImportHypervisorConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupgateway#ImportHypervisorConfigurationInput" + }, + "output": { + "target": "com.amazonaws.backupgateway#ImportHypervisorConfigurationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupgateway#AccessDeniedException" + }, + { + "target": "com.amazonaws.backupgateway#InternalServerException" + }, + { + "target": "com.amazonaws.backupgateway#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Connect to a hypervisor by importing its configuration.
" + } + }, + "com.amazonaws.backupgateway#ImportHypervisorConfigurationInput": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.backupgateway#Name", + "traits": { + "smithy.api#documentation": "The name of the hypervisor.
", + "smithy.api#required": {} + } + }, + "Host": { + "target": "com.amazonaws.backupgateway#Host", + "traits": { + "smithy.api#documentation": "The server host of the hypervisor. This can be either an IP address or a fully-qualified\n domain name (FQDN).
", + "smithy.api#required": {} + } + }, + "Username": { + "target": "com.amazonaws.backupgateway#Username", + "traits": { + "smithy.api#documentation": "The username for the hypervisor.
" + } + }, + "Password": { + "target": "com.amazonaws.backupgateway#Password", + "traits": { + "smithy.api#documentation": "The password for the hypervisor.
" + } + }, + "KmsKeyArn": { + "target": "com.amazonaws.backupgateway#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Key Management Service for the hypervisor.
" + } + }, + "Tags": { + "target": "com.amazonaws.backupgateway#Tags", + "traits": { + "smithy.api#documentation": "The tags of the hypervisor configuration to import.
" + } + } + } + }, + "com.amazonaws.backupgateway#ImportHypervisorConfigurationOutput": { + "type": "structure", + "members": { + "HypervisorArn": { + "target": "com.amazonaws.backupgateway#ServerArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the hypervisor you disassociated.
" + } + } + } + }, + "com.amazonaws.backupgateway#InternalServerException": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.backupgateway#string", + "traits": { + "smithy.api#documentation": "A description of which internal error occured.
" + } + }, + "Message": { + "target": "com.amazonaws.backupgateway#string" + } + }, + "traits": { + "smithy.api#documentation": "The operation did not succeed because an internal error occurred. Try again later.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.backupgateway#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 50, + "max": 500 + }, + "smithy.api#pattern": "^(^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\\S+)$)|(^alias/(\\S+)$)$" + } + }, + "com.amazonaws.backupgateway#ListGateways": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupgateway#ListGatewaysInput" + }, + "output": { + "target": "com.amazonaws.backupgateway#ListGatewaysOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupgateway#InternalServerException" + }, + { + "target": "com.amazonaws.backupgateway#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).
", + "smithy.api#paginated": { + "items": "Gateways" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.backupgateway#ListGatewaysInput": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.backupgateway#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of gateways to list.
" + } + }, + "NextToken": { + "target": "com.amazonaws.backupgateway#NextToken", + "traits": { + "smithy.api#documentation": "The next item following a partial list of returned resources. For example, if a request is\n made to return MaxResults number of resources, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.
A list of your gateways.
" + } + }, + "NextToken": { + "target": "com.amazonaws.backupgateway#NextToken", + "traits": { + "smithy.api#documentation": "The next item following a partial list of returned resources. For example, if a request is\n made to return maxResults number of resources, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.
Lists your hypervisors.
", + "smithy.api#paginated": { + "items": "Hypervisors" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.backupgateway#ListHypervisorsInput": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.backupgateway#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of hypervisors to list.
" + } + }, + "NextToken": { + "target": "com.amazonaws.backupgateway#NextToken", + "traits": { + "smithy.api#documentation": "The next item following a partial list of returned resources. For example, if a request is\n made to return maxResults number of resources, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.
A list of your Hypervisor objects, ordered by their Amazon Resource Names\n (ARNs).
The next item following a partial list of returned resources. For example, if a request is\n made to return maxResults number of resources, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.
Lists the tags applied to the resource identified by its Amazon Resource Name\n (ARN).
" + } + }, + "com.amazonaws.backupgateway#ListTagsForResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.backupgateway#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource's tags to list.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupgateway#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.backupgateway#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource's tags that you listed.
" + } + }, + "Tags": { + "target": "com.amazonaws.backupgateway#Tags", + "traits": { + "smithy.api#documentation": "A list of the resource's tags.
" + } + } + } + }, + "com.amazonaws.backupgateway#ListVirtualMachines": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupgateway#ListVirtualMachinesInput" + }, + "output": { + "target": "com.amazonaws.backupgateway#ListVirtualMachinesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupgateway#InternalServerException" + }, + { + "target": "com.amazonaws.backupgateway#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists your virtual machines.
", + "smithy.api#paginated": { + "items": "VirtualMachines" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.backupgateway#ListVirtualMachinesInput": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.backupgateway#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of virtual machines to list.
" + } + }, + "NextToken": { + "target": "com.amazonaws.backupgateway#NextToken", + "traits": { + "smithy.api#documentation": "The next item following a partial list of returned resources. For example, if a request is\n made to return maxResults number of resources, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.
A list of your VirtualMachine objects, ordered by their Amazon Resource Names\n (ARNs).
The next item following a partial list of returned resources. For example, if a request is\n made to return maxResults number of resources, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.
Set the maintenance start time for a gateway.
" + } + }, + "com.amazonaws.backupgateway#PutMaintenanceStartTimeInput": { + "type": "structure", + "members": { + "GatewayArn": { + "target": "com.amazonaws.backupgateway#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the gateway, used to specify its maintenance start\n time.
", + "smithy.api#required": {} + } + }, + "HourOfDay": { + "target": "com.amazonaws.backupgateway#HourOfDay", + "traits": { + "smithy.api#documentation": "The hour of the day to start maintenance on a gateway.
", + "smithy.api#required": {} + } + }, + "MinuteOfHour": { + "target": "com.amazonaws.backupgateway#MinuteOfHour", + "traits": { + "smithy.api#documentation": "The minute of the hour to start maintenance on a gateway.
", + "smithy.api#required": {} + } + }, + "DayOfWeek": { + "target": "com.amazonaws.backupgateway#DayOfWeek", + "traits": { + "smithy.api#documentation": "The day of the week to start maintenance on a gateway.
" + } + }, + "DayOfMonth": { + "target": "com.amazonaws.backupgateway#DayOfMonth", + "traits": { + "smithy.api#documentation": "The day of the month start maintenance on a gateway.
\nValid values range from Sunday to Saturday.
The Amazon Resource Name (ARN) of a gateway for which you set the maintenance start\n time.
" + } + } + } + }, + "com.amazonaws.backupgateway#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 50, + "max": 500 + }, + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\\/[a-zA-Z-0-9]+$" + } + }, + "com.amazonaws.backupgateway#ResourceNotFoundException": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.backupgateway#string", + "traits": { + "smithy.api#documentation": "A description of which resource wasn't found.
" + } + }, + "Message": { + "target": "com.amazonaws.backupgateway#string" + } + }, + "traits": { + "smithy.api#documentation": "A resource that is required for the action wasn't found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.backupgateway#ServerArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 50, + "max": 500 + }, + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\\/[a-zA-Z-0-9]+$" + } + }, + "com.amazonaws.backupgateway#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.backupgateway#TagKey", + "traits": { + "smithy.api#documentation": "The key part of a tag's key-value pair. The key can't start with aws:.
The key part of a value's key-value pair.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A key-value pair you can use to manage, filter, and search for your resources. Allowed\n characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ :\n /.
" + } + }, + "com.amazonaws.backupgateway#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.backupgateway#TagKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.backupgateway#TagKey" + } + }, + "com.amazonaws.backupgateway#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupgateway#TagResourceInput" + }, + "output": { + "target": "com.amazonaws.backupgateway#TagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupgateway#InternalServerException" + }, + { + "target": "com.amazonaws.backupgateway#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backupgateway#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Tag the resource.
" + } + }, + "com.amazonaws.backupgateway#TagResourceInput": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.backupgateway#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to tag.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.backupgateway#Tags", + "traits": { + "smithy.api#documentation": "A list of tags to assign to the resource.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupgateway#TagResourceOutput": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.backupgateway#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource you tagged.
" + } + } + } + }, + "com.amazonaws.backupgateway#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[^\\x00]*$" + } + }, + "com.amazonaws.backupgateway#Tags": { + "type": "list", + "member": { + "target": "com.amazonaws.backupgateway#Tag" + } + }, + "com.amazonaws.backupgateway#TestHypervisorConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupgateway#TestHypervisorConfigurationInput" + }, + "output": { + "target": "com.amazonaws.backupgateway#TestHypervisorConfigurationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupgateway#ConflictException" + }, + { + "target": "com.amazonaws.backupgateway#InternalServerException" + }, + { + "target": "com.amazonaws.backupgateway#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backupgateway#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Tests your hypervisor configuration to validate that backup gateway can connect with the\n hypervisor and its resources.
" + } + }, + "com.amazonaws.backupgateway#TestHypervisorConfigurationInput": { + "type": "structure", + "members": { + "GatewayArn": { + "target": "com.amazonaws.backupgateway#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway to the hypervisor to test.
", + "smithy.api#required": {} + } + }, + "Host": { + "target": "com.amazonaws.backupgateway#Host", + "traits": { + "smithy.api#documentation": "The server host of the hypervisor. This can be either an IP address or a fully-qualified\n domain name (FQDN).
", + "smithy.api#required": {} + } + }, + "Username": { + "target": "com.amazonaws.backupgateway#Username", + "traits": { + "smithy.api#documentation": "The username for the hypervisor.
" + } + }, + "Password": { + "target": "com.amazonaws.backupgateway#Password", + "traits": { + "smithy.api#documentation": "The password for the hypervisor.
" + } + } + } + }, + "com.amazonaws.backupgateway#TestHypervisorConfigurationOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.backupgateway#Time": { + "type": "timestamp" + }, + "com.amazonaws.backupgateway#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupgateway#UntagResourceInput" + }, + "output": { + "target": "com.amazonaws.backupgateway#UntagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupgateway#InternalServerException" + }, + { + "target": "com.amazonaws.backupgateway#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backupgateway#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes tags from the resource.
" + } + }, + "com.amazonaws.backupgateway#UntagResourceInput": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.backupgateway#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource from which to remove tags.
", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.backupgateway#TagKeys", + "traits": { + "smithy.api#documentation": "The list of tag keys specifying which tags to remove.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupgateway#UntagResourceOutput": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.backupgateway#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource from which you removed tags.
" + } + } + } + }, + "com.amazonaws.backupgateway#UpdateGatewayInformation": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupgateway#UpdateGatewayInformationInput" + }, + "output": { + "target": "com.amazonaws.backupgateway#UpdateGatewayInformationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupgateway#ConflictException" + }, + { + "target": "com.amazonaws.backupgateway#InternalServerException" + }, + { + "target": "com.amazonaws.backupgateway#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backupgateway#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name\n (ARN) of the gateway in your request.
" + } + }, + "com.amazonaws.backupgateway#UpdateGatewayInformationInput": { + "type": "structure", + "members": { + "GatewayArn": { + "target": "com.amazonaws.backupgateway#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway to update.
", + "smithy.api#required": {} + } + }, + "GatewayDisplayName": { + "target": "com.amazonaws.backupgateway#Name", + "traits": { + "smithy.api#documentation": "The updated display name of the gateway.
" + } + } + } + }, + "com.amazonaws.backupgateway#UpdateGatewayInformationOutput": { + "type": "structure", + "members": { + "GatewayArn": { + "target": "com.amazonaws.backupgateway#GatewayArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway you updated.
" + } + } + } + }, + "com.amazonaws.backupgateway#UpdateHypervisor": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupgateway#UpdateHypervisorInput" + }, + "output": { + "target": "com.amazonaws.backupgateway#UpdateHypervisorOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupgateway#AccessDeniedException" + }, + { + "target": "com.amazonaws.backupgateway#InternalServerException" + }, + { + "target": "com.amazonaws.backupgateway#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backupgateway#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a hypervisor metadata, including its host, username, and password. Specify which\n hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your\n request.
" + } + }, + "com.amazonaws.backupgateway#UpdateHypervisorInput": { + "type": "structure", + "members": { + "HypervisorArn": { + "target": "com.amazonaws.backupgateway#ServerArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the hypervisor to update.
", + "smithy.api#required": {} + } + }, + "Host": { + "target": "com.amazonaws.backupgateway#Host", + "traits": { + "smithy.api#documentation": "The updated host of the hypervisor. This can be either an IP address or a fully-qualified\n domain name (FQDN).
" + } + }, + "Username": { + "target": "com.amazonaws.backupgateway#Username", + "traits": { + "smithy.api#documentation": "The updated username for the hypervisor.
" + } + }, + "Password": { + "target": "com.amazonaws.backupgateway#Password", + "traits": { + "smithy.api#documentation": "The updated password for the hypervisor.
" + } + } + } + }, + "com.amazonaws.backupgateway#UpdateHypervisorOutput": { + "type": "structure", + "members": { + "HypervisorArn": { + "target": "com.amazonaws.backupgateway#ServerArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the hypervisor you updated.
" + } + } + } + }, + "com.amazonaws.backupgateway#Username": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[ -\\.0-\\[\\]-~]*[!-\\.0-\\[\\]-~][ -\\.0-\\[\\]-~]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.backupgateway#ValidationException": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.backupgateway#string", + "traits": { + "smithy.api#documentation": "A description of what caused the validation error.
" + } + }, + "Message": { + "target": "com.amazonaws.backupgateway#string" + } + }, + "traits": { + "smithy.api#documentation": "The operation did not succeed because a validation error occurred.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.backupgateway#VirtualMachine": { + "type": "structure", + "members": { + "HostName": { + "target": "com.amazonaws.backupgateway#Name", + "traits": { + "smithy.api#documentation": "The host name of the virtual machine.
" + } + }, + "HypervisorId": { + "target": "com.amazonaws.backupgateway#string", + "traits": { + "smithy.api#documentation": "The ID of the virtual machine's hypervisor.
" + } + }, + "Name": { + "target": "com.amazonaws.backupgateway#Name", + "traits": { + "smithy.api#documentation": "The name of the virtual machine.
" + } + }, + "Path": { + "target": "com.amazonaws.backupgateway#Path", + "traits": { + "smithy.api#documentation": "The path of the virtual machine.
" + } + }, + "ResourceArn": { + "target": "com.amazonaws.backupgateway#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the virtual machine.
" + } + }, + "LastBackupDate": { + "target": "com.amazonaws.backupgateway#Time", + "traits": { + "smithy.api#documentation": "The most recent date a virtual machine was backed up, in Unix format and UTC time.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A virtual machine that is on a hypervisor.
" + } + }, + "com.amazonaws.backupgateway#VirtualMachines": { + "type": "list", + "member": { + "target": "com.amazonaws.backupgateway#VirtualMachine" + } + }, + "com.amazonaws.backupgateway#string": { + "type": "string" + } + } +} diff --git a/aws/sdk/aws-models/backup.json b/aws/sdk/aws-models/backup.json index cb2df7ee1bc4dc06fb31dd7a2deb0e3b37e33763..567c15b1e31c5ccee3f777455ee7765e54f82df7 100644 --- a/aws/sdk/aws-models/backup.json +++ b/aws/sdk/aws-models/backup.json @@ -303,7 +303,7 @@ "BackupPlanName": { "target": "com.amazonaws.backup#BackupPlanName", "traits": { - "smithy.api#documentation": "The display name of a backup plan.
", + "smithy.api#documentation": "The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.'\n characters.
", "smithy.api#required": {} } }, @@ -331,7 +331,7 @@ "BackupPlanName": { "target": "com.amazonaws.backup#BackupPlanName", "traits": { - "smithy.api#documentation": "The optional display name of a backup plan.
", + "smithy.api#documentation": "The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.'\n characters.
", "smithy.api#required": {} } }, @@ -436,7 +436,7 @@ "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice.
" + "smithy.api#documentation": "A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice. This parameter is optional.
\nIf used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
" } }, "LastExecutionDate": { @@ -462,7 +462,7 @@ "RuleName": { "target": "com.amazonaws.backup#BackupRuleName", "traits": { - "smithy.api#documentation": "An optional display name for a backup rule.
", + "smithy.api#documentation": "A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.'\n characters.
", "smithy.api#required": {} } }, @@ -476,7 +476,7 @@ "ScheduleExpression": { "target": "com.amazonaws.backup#CronExpression", "traits": { - "smithy.api#documentation": "A cron expression in UTC specifying when Backup initiates a backup job. For\n more information about cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User\n Guide.. Prior to specifying a value for this parameter, we recommend testing\n your cron expression using one of the many available cron generator and testing\n tools.
" + "smithy.api#documentation": "A cron expression in UTC specifying when Backup initiates a backup job. For\n more information about Amazon Web Services cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User\n Guide.. Two examples of Amazon Web Services cron expressions are 15 * ?\n * * * (take a backup every hour at 15 minutes past the hour) and 0 12 * * ?\n * (take a backup every day at 12 noon UTC). For a table of examples, click the\n preceding link and scroll down the page.
An optional display name for a backup rule.
", + "smithy.api#documentation": "A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.'\n characters.
", "smithy.api#required": {} } }, @@ -614,7 +614,7 @@ "SelectionName": { "target": "com.amazonaws.backup#BackupSelectionName", "traits": { - "smithy.api#documentation": "The display name of a resource selection document.
", + "smithy.api#documentation": "The display name of a resource selection document. Must contain 1 to 50 alphanumeric or\n '-_.' characters.
", "smithy.api#required": {} } }, @@ -628,20 +628,26 @@ "Resources": { "target": "com.amazonaws.backup#ResourceArns", "traits": { - "smithy.api#documentation": "An array of strings that contain Amazon Resource Names (ARNs)\n \n of resources to assign to a backup plan.
" + "smithy.api#documentation": "A list of Amazon Resource Names (ARNs) to assign to a backup plan. The maximum number of\n ARNs is 500 without wildcards, or 30 ARNs with wildcards.
\nIf you need to assign many resources to a backup plan, consider a different resource\n selection strategy, such as assigning all resources of a resource type or refining your\n resource selection using tags.
" } }, "ListOfTags": { "target": "com.amazonaws.backup#ListOfTags", "traits": { - "smithy.api#documentation": "An array of conditions used to specify a set of resources to assign to a backup plan;\n for example, \"StringEquals\": {\"ec2:ResourceTag/Department\": \"accounting\".\n Assigns the backup plan to every resource with at least one matching tag.
A list of conditions that you define to assign resources to your backup plans using\n tags. For example, \"StringEquals\": {\"Department\": \"accounting\". Condition\n operators are case sensitive.
\n ListOfTags differs from Conditions as follows:
When you specify more than one condition, you assign all resources that match AT\n LEAST ONE condition (using OR logic).
\n\n ListOfTags only supports StringEquals.\n Conditions supports StringEquals,\n StringLike, StringNotEquals, and\n StringNotLike.
A list of Amazon Resource Names (ARNs) to exclude from a backup plan. The maximum number\n of ARNs is 500 without wildcards, or 30 ARNs with wildcards.
\nIf you need to exclude many resources from a backup plan, consider a different resource\n selection strategy, such as assigning only one or a few resource types or refining your\n resource selection using tags.
" + } }, "Conditions": { - "target": "com.amazonaws.backup#Conditions" + "target": "com.amazonaws.backup#Conditions", + "traits": { + "smithy.api#documentation": "A list of conditions that you define to assign resources to your backup plans using\n tags. For example, \"StringEquals\": {\"Department\": \"accounting\". Condition\n operators are case sensitive.
\n Conditions differs from ListOfTags as follows:
When you specify more than one condition, you only assign the resources that match\n ALL conditions (using AND logic).
\n\n Conditions supports StringEquals,\n StringLike, StringNotEquals, and\n StringNotLike. ListOfTags only supports\n StringEquals.
A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice.
" + "smithy.api#documentation": "A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice. This parameter is optional.
\nIf used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
" } }, "IamRoleArn": { @@ -813,7 +819,7 @@ "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice.
" + "smithy.api#documentation": "A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice. This parameter is optional.
\nIf used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
" } }, "NumberOfRecoveryPoints": { @@ -904,27 +910,27 @@ "ConditionType": { "target": "com.amazonaws.backup#ConditionType", "traits": { - "smithy.api#documentation": "An operation, such as StringEquals, that is applied to a key-value pair\n used to filter resources in a selection.
An operation applied to a key-value pair used to assign resources to your backup plan.\n Condition only supports StringEquals. For more flexible assignment options,\n incluidng StringLike and the ability to exclude resources from your backup\n plan, use Conditions (with an \"s\" on the end) for your \n BackupSelection\n .
The key in a key-value pair. For example, in \"ec2:ResourceTag/Department\":\n \"accounting\", \"ec2:ResourceTag/Department\" is the key.
The key in a key-value pair. For example, in the tag Department:\n Accounting, Department is the key.
The value in a key-value pair. For example, in \"ec2:ResourceTag/Department\":\n \"accounting\", \"accounting\" is the value.
The value in a key-value pair. For example, in the tag Department:\n Accounting, Accounting is the value.
Contains an array of triplets made up of a condition type (such as\n StringEquals), a key, and a value. Conditions are used to filter resources\n in a selection that is assigned to a backup plan.
Contains an array of triplets made up of a condition type (such as\n StringEquals), a key, and a value. Used to filter resources using their\n tags and assign them to a backup plan. Case sensitive.
The key in a key-value pair. For example, in the tag Department:\n Accounting, Department is the key.
The value in a key-value pair. For example, in the tag Department:\n Accounting, Accounting is the value.
Includes information about tags you define to assign tagged resources to a backup\n plan.
" } }, "com.amazonaws.backup#ConditionParameters": { @@ -965,17 +980,32 @@ "type": "structure", "members": { "StringEquals": { - "target": "com.amazonaws.backup#ConditionParameters" + "target": "com.amazonaws.backup#ConditionParameters", + "traits": { + "smithy.api#documentation": "Filters the values of your tagged resources for only those resources that you tagged\n with the same value. Also called \"exact matching.\"
" + } }, "StringNotEquals": { - "target": "com.amazonaws.backup#ConditionParameters" + "target": "com.amazonaws.backup#ConditionParameters", + "traits": { + "smithy.api#documentation": "Filters the values of your tagged resources for only those resources that you tagged\n that do not have the same value. Also called \"negated matching.\"
" + } }, "StringLike": { - "target": "com.amazonaws.backup#ConditionParameters" + "target": "com.amazonaws.backup#ConditionParameters", + "traits": { + "smithy.api#documentation": "Filters the values of your tagged resources for matching tag values with the use of a\n wildcard character (*) anywhere in the string. For example, \"prod*\" or \"*rod*\" matches the\n tag value \"production\".
" + } }, "StringNotLike": { - "target": "com.amazonaws.backup#ConditionParameters" + "target": "com.amazonaws.backup#ConditionParameters", + "traits": { + "smithy.api#documentation": "Filters the values of your tagged resources for non-matching tag values with the use of\n a wildcard character (*) anywhere in the string.
" + } } + }, + "traits": { + "smithy.api#documentation": "Contains information about which resources to include or exclude from a backup plan\n using their tags. Conditions are case sensitive.
" } }, "com.amazonaws.backup#ConflictException": { @@ -1057,12 +1087,12 @@ "Tags": { "target": "com.amazonaws.backup#stringMap", "traits": { - "smithy.api#documentation": "Describes whether the control scope includes resources with one or more tags. Each tag\n is a key-value pair.
" + "smithy.api#documentation": "The tag key-value pair applied to those Amazon Web Services resources that you want to\n trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag\n value is optional, but it cannot be an empty string. The structure to assign a tag is:\n [{\"Key\":\"string\",\"Value\":\"string\"}].
A framework consists of one or more controls. Each control has its own control scope.\n The control scope defines what the control will evaluate. Three examples of control scopes\n are: a specific backup plan, all backup plans with a specific tag, or all backup\n plans.
\nTo set a control scope that includes all of a particular resource, leave the\n ControlScope empty or do not pass it when calling\n CreateFramework.
A framework consists of one or more controls. Each control has its own control scope.\n The control scope can include one or more resource types, a combination of a tag key and\n value, or a combination of one resource type and one resource ID. If no scope is specified,\n evaluations for the rule are triggered when any resource in your recording group changes in\n configuration.
\nTo set a control scope that includes all of a particular resource, leave the\n ControlScope empty or do not pass it when calling\n CreateFramework.
Identifies the request and allows failed requests to be retried without the risk of\n running the operation twice. If the request includes a CreatorRequestId that\n matches an existing backup plan, that plan is returned. This parameter is optional.
Identifies the request and allows failed requests to be retried without the risk of\n running the operation twice. If the request includes a CreatorRequestId that\n matches an existing backup plan, that plan is returned. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
" } } } @@ -1333,7 +1363,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a JSON document that specifies a set of resources to assign to a backup plan.\n Resources can be included by specifying patterns for a ListOfTags and selected\n Resources.
For example, consider the following patterns:
\n\n Resources: \"arn:aws:ec2:region:account-id:volume/volume-id\"\n
\n ConditionKey:\"department\"\n
\n ConditionValue:\"finance\"\n
\n ConditionType:\"StringEquals\"\n
\n ConditionKey:\"importance\"\n
\n ConditionValue:\"critical\"\n
\n ConditionType:\"StringEquals\"\n
Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS)\n volumes that are tagged as \"department=finance\",\n \"importance=critical\", in addition to an EBS volume with the specified\n volume ID.
Resources and conditions are additive in that all resources that match the pattern are\n selected. This shouldn't be confused with a logical AND, where all conditions must match.\n The matching patterns are logically put together using the OR operator.\n In other words, all patterns that match are selected for backup.
", + "smithy.api#documentation": "Creates a JSON document that specifies a set of resources to assign to a backup plan.\n For examples, see Assigning resources\n programmatically.
", "smithy.api#http": { "method": "PUT", "uri": "/backup/plans/{BackupPlanId}/selections", @@ -1363,7 +1393,7 @@ "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice.
" + "smithy.api#documentation": "A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice. This parameter is optional.
\nIf used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
" } } } @@ -1452,7 +1482,7 @@ "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice.
" + "smithy.api#documentation": "A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice. This parameter is optional.
\nIf used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
" } } } @@ -1678,6 +1708,21 @@ }, "com.amazonaws.backup#CryoControllerUserManager": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Backup", + "arnNamespace": "backup", + "cloudFormationName": "Backup", + "cloudTrailEventSource": "backup.amazonaws.com", + "endpointPrefix": "backup" + }, + "aws.auth#sigv4": { + "name": "backup" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Backup is a unified backup service designed to protect Amazon Web Services\n services and their associated data. Backup simplifies the creation, migration,\n restoration, and deletion of backups, while also providing reporting and\n auditing.
", + "smithy.api#title": "AWS Backup" + }, "version": "2018-11-15", "operations": [ { @@ -1878,22 +1923,7 @@ { "target": "com.amazonaws.backup#UpdateReportPlan" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Backup", - "arnNamespace": "backup", - "cloudFormationName": "Backup", - "cloudTrailEventSource": "backup.amazonaws.com", - "endpointPrefix": "backup" - }, - "aws.auth#sigv4": { - "name": "backup" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Backup is a unified backup service designed to protect Amazon Web Services\n services and their associated data. Backup simplifies the creation, migration,\n restoration, and deletion of backups, while also providing reporting and\n auditing.
", - "smithy.api#title": "AWS Backup" - } + ] }, "com.amazonaws.backup#DeleteBackupPlan": { "type": "operation", @@ -3121,6 +3151,12 @@ "traits": { "smithy.api#documentation": "Returns a list of all services along with the opt-in preferences in the Region.
" } + }, + "ResourceTypeManagementPreference": { + "target": "com.amazonaws.backup#ResourceTypeManagementPreference", + "traits": { + "smithy.api#documentation": "Returns whether a DynamoDB recovery point was taken using \n \n Backup's advanced DynamoDB backup features.\n
" + } } } }, @@ -5771,7 +5807,7 @@ } ], "traits": { - "smithy.api#documentation": "Applies Backup Vault Lock to a backup vault, preventing attempts to delete\n any recovery point stored in or created in a backup vault. Vault Lock also prevents\n attempts to update the lifecycle policy that controls the retention period of any recovery\n point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and\n maximum retention period for future backup and copy jobs that target a backup vault.
", + "smithy.api#documentation": "Applies Backup Vault Lock to a backup vault, preventing attempts to delete\n any recovery point stored in or created in a backup vault. Vault Lock also prevents\n attempts to update the lifecycle policy that controls the retention period of any recovery\n point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and\n maximum retention period for future backup and copy jobs that target a backup vault.
\nBackup Vault Lock has yet to receive a third-party assessment for SEC\n 17a-4(f) and CFTC.
\nAn array of events that indicate the status of jobs to back up resources to the backup\n vault.
\nThe following events are supported:
\n\n BACKUP_JOB_STARTED, BACKUP_JOB_COMPLETED,
\n COPY_JOB_STARTED, COPY_JOB_SUCCESSFUL,\n COPY_JOB_FAILED,
\n RESTORE_JOB_STARTED, RESTORE_JOB_COMPLETED, and\n RECOVERY_POINT_MODIFIED.
To find failed backup jobs, use BACKUP_JOB_COMPLETED and filter using\n event metadata.
Other events in the following list are deprecated.
\nAn array of events that indicate the status of jobs to back up resources to the backup\n vault.
\nFor common use cases and code samples, see Using Amazon SNS to\n track Backup events.
\nThe following events are supported:
\n\n BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED\n
\n COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL |\n COPY_JOB_FAILED\n
\n RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED |\n RECOVERY_POINT_MODIFIED\n
Ignore the list below because it includes deprecated events. Refer to the list\n above.
\nKey-value pairs that are used to help organize your resources. You can assign your own\n metadata to the resources you create.
", + "smithy.api#documentation": "Key-value pairs that are used to help organize your resources. You can assign your own\n metadata to the resources you create. For clarity, this is the structure to assign tags:\n [{\"Key\":\"string\",\"Value\":\"string\"}].
Updates the list of services along with the opt-in preferences for the Region.
" } + }, + "ResourceTypeManagementPreference": { + "target": "com.amazonaws.backup#ResourceTypeManagementPreference", + "traits": { + "smithy.api#documentation": "Enables or disables \n \n Backup's advanced DynamoDB backup features for the\n Region.
" + } } } }, diff --git a/aws/sdk/aws-models/batch.json b/aws/sdk/aws-models/batch.json index 2b150ee8af9c603f7b642ed57909abab49cfec3e..b384ae99cb0a0de40ce3b7c4533ec24bdb3dfcb9 100644 --- a/aws/sdk/aws-models/batch.json +++ b/aws/sdk/aws-models/batch.json @@ -482,7 +482,7 @@ "computeEnvironmentName": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and\n underscores are allowed.
", + "smithy.api#documentation": "The name of the compute environment. It can be up to 128 letters long. It can contain uppercase and\n lowercase letters, numbers, hyphens (-), and underscores (_).
", "smithy.api#required": {} } }, @@ -695,7 +695,7 @@ "ec2Configuration": { "target": "com.amazonaws.batch#Ec2ConfigurationList", "traits": { - "smithy.api#documentation": "Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment.\n If Ec2Configuration isn't specified, the default is ECS_AL2.
One or two values can be provided.
\n \nThis parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.
\nProvides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment.\n If Ec2Configuration isn't specified, the default is ECS_AL2.
One or two values can be provided.
\nThis parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.
\nThis parameter is deprecated, use\n resourceRequirements to override the vcpus parameter that's set in the\n job definition. It's not supported for jobs\n that run on Fargate resources. For jobs run on EC2 resources, it overrides the vcpus parameter set in\n the job definition, but doesn't override any vCPU requirement specified in the\n resourceRequirements structure in the job definition. To override vCPU requirements that are specified\n in the resourceRequirements structure in the job definition, resourceRequirements must be\n specified in the SubmitJob request, with type set to VCPU and\n value set to the new value. For\n more information, see Can't override job definition\n resource requirements in the Batch User Guide.
This parameter is deprecated, use resourceRequirements to override the vcpus parameter\n that's set in the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2\n resources, it overrides the vcpus parameter set in the job definition, but doesn't override any vCPU\n requirement specified in the resourceRequirements structure in the job definition. To override vCPU\n requirements that are specified in the resourceRequirements structure in the job definition,\n resourceRequirements must be specified in the SubmitJob request, with type\n set to VCPU and value set to the new value. For more information, see Can't override\n job definition resource requirements in the Batch User Guide.
This parameter is deprecated, use\n resourceRequirements to override the memory requirements specified in the job definition. It's not\n supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it overrides the\n memory parameter set in the job definition, but doesn't override any memory requirement specified in\n the resourceRequirements structure in the job definition. To override memory requirements that are\n specified in the resourceRequirements structure in the job definition, resourceRequirements\n must be specified in the SubmitJob request, with type set to MEMORY and\n value set to the new value. For more information, see Can't override job definition\n resource requirements in the Batch User Guide.
This parameter is deprecated, use resourceRequirements to override the memory requirements\n specified in the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2\n resources, it overrides the memory parameter set in the job definition, but doesn't override any memory\n requirement specified in the resourceRequirements structure in the job definition. To override memory\n requirements that are specified in the resourceRequirements structure in the job definition,\n resourceRequirements must be specified in the SubmitJob request, with type\n set to MEMORY and value set to the new value. For more information, see Can't override\n job definition resource requirements in the Batch User Guide.
This parameter is deprecated, use resourceRequirements to specify the vCPU requirements for the job\n definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it specifies\n the number of vCPUs reserved for the job.
Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the\n Create a container section of the Docker Remote API and the --cpu-shares option to\n docker run. The number of vCPUs must be specified but can be specified\n in several places. You must specify it at least once for each node.
This parameter is deprecated, use resourceRequirements to specify the vCPU requirements for the job\n definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it specifies\n the number of vCPUs reserved for the job.
Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the\n Create a container section of the Docker Remote API and the --cpu-shares option to\n docker run. The number of vCPUs must be specified but can be specified\n in several places. You must specify it at least once for each node.
This parameter is deprecated, use\n resourceRequirements to specify the memory requirements for the job definition. It's not supported for\n jobs that run on Fargate resources. For jobs run on EC2 resources, it specifies the memory hard\n limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must\n specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several\n places. It must be specified for each node at least once.
This parameter is deprecated, use resourceRequirements to specify the memory requirements for the\n job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it\n specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number,\n it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can\n be specified in several places. It must be specified for each node at least once.
Creates an Batch compute environment. You can create MANAGED or UNMANAGED compute\n environments. MANAGED compute environments can use Amazon EC2 or Fargate resources.\n UNMANAGED compute environments can only use EC2 resources.
In a managed compute environment, Batch manages the capacity and instance types of the compute resources\n within the environment. This is based on the compute resource specification that you define or the launch template that you\n specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot\n Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can\n optionally set a maximum price so that Spot Instances only launch\n when\n the Spot Instance price is less than a specified percentage of the On-Demand price.
\nMulti-node parallel jobs aren't supported on Spot Instances.
\nIn an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility\n with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that\n each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the\n Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch\n your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the\n Amazon Elastic Container Service Developer Guide.
\nBatch doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it\n doesn't update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're responsible\n for managing the guest operating system (including its updates and security patches) and any additional application\n software or utilities that you install on the compute resources. To use a new AMI for your Batch jobs, complete\n these steps:
\nCreate a new compute environment with the new AMI.
\nAdd the compute environment to an existing job queue.
\nRemove the earlier compute environment from your job queue.
\nDelete the earlier compute environment.
\nCreates an Batch compute environment. You can create MANAGED or UNMANAGED compute\n environments. MANAGED compute environments can use Amazon EC2 or Fargate resources.\n UNMANAGED compute environments can only use EC2 resources.
In a managed compute environment, Batch manages the capacity and instance types of the compute resources\n within the environment. This is based on the compute resource specification that you define or the launch template that you\n specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot\n Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can\n optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a\n specified percentage of the On-Demand price.
\nMulti-node parallel jobs aren't supported on Spot Instances.
\nIn an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility\n with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that\n each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the\n Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch\n your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the\n Amazon Elastic Container Service Developer Guide.
\nBatch doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it\n doesn't update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're responsible\n for managing the guest operating system (including its updates and security patches) and any additional application\n software or utilities that you install on the compute resources. To use a new AMI for your Batch jobs, complete\n these steps:
\nCreate a new compute environment with the new AMI.
\nAdd the compute environment to an existing job queue.
\nRemove the earlier compute environment from your job queue.
\nDelete the earlier compute environment.
\nThe name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and\n underscores are allowed.
", + "smithy.api#documentation": "The name for your compute environment. It can be up to 128 letters long. It can contain uppercase and\n lowercase letters, numbers, hyphens (-), and underscores (_).
", "smithy.api#required": {} } }, @@ -1160,7 +1160,7 @@ "unmanagedvCpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "The maximum number of vCPUs for an\n unmanaged compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new\n share identifiers. If this parameter is not provided for a fair share job queue, no vCPU capacity will be\n reserved.
\n \nThis parameter is only supported when the type parameter is set to UNMANAGED/
The maximum number of vCPUs for an unmanaged compute environment. This parameter is only used for fair share\n scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair share job\n queue, no vCPU capacity is reserved.
\nThis parameter is only supported when the type parameter is set to UNMANAGED/
The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and\n underscores are allowed.
" + "smithy.api#documentation": "The name of the compute environment. It can be up to 128 letters long. It can contain uppercase and\n lowercase letters, numbers, hyphens (-), and underscores (_).
" } }, "computeEnvironmentArn": { @@ -1234,7 +1234,7 @@ "jobQueueName": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The name of the job queue. Up to 128 letters (uppercase and lowercase), numbers, and underscores are\n allowed.
", + "smithy.api#documentation": "The name of the job queue. It can be up to 128 letters long. It can contain uppercase and lowercase letters,\n numbers, hyphens (-), and underscores (_).
", "smithy.api#required": {} } }, @@ -1247,7 +1247,7 @@ "schedulingPolicyArn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "Amazon Resource Name (ARN) of the fair share scheduling\n policy. If this parameter is specified, the job queue will use a fair share scheduling policy. If this parameter is\n not specified, the job queue will use a first in, first out (FIFO) scheduling policy. Once a job queue is created,\n the fair share scheduling policy can be replaced but not removed. The format is\n aws:Partition:batch:Region:Account:scheduling-policy/Name\n .\n For example,\n aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.
The Amazon Resource Name (ARN) of the fair share scheduling policy. If this parameter is specified, the job queue uses a fair\n share scheduling policy. If this parameter isn't specified, the job queue uses a first in, first out (FIFO)\n scheduling policy. After a job queue is created, you can replace but can't remove the fair share scheduling policy.\n The format is\n aws:Partition:batch:Region:Account:scheduling-policy/Name\n .\n An example is\n aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.
Creates an Batch scheduling\n policy.
", + "smithy.api#documentation": "Creates an Batch scheduling policy.
", "smithy.api#http": { "method": "POST", "uri": "/v1/createschedulingpolicy", @@ -1325,14 +1325,14 @@ "name": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The name of the scheduling\n policy. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
", + "smithy.api#documentation": "The name of the scheduling policy. It can be up to 128 letters long. It can contain uppercase and lowercase\n letters, numbers, hyphens (-), and underscores (_).
", "smithy.api#required": {} } }, "fairsharePolicy": { "target": "com.amazonaws.batch#FairsharePolicy", "traits": { - "smithy.api#documentation": "The fair share policy of the scheduling\n policy.
" + "smithy.api#documentation": "The fair share policy of the scheduling policy.
" } }, "tags": { @@ -1349,14 +1349,14 @@ "name": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The name of the scheduling\n policy.
", + "smithy.api#documentation": "The name of the scheduling policy.
", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the scheduling policy.\n The format is\n aws:Partition:batch:Region:Account:scheduling-policy/Name\n .\n For example,\n aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.
The Amazon Resource Name (ARN) of the scheduling policy. The format is\n aws:Partition:batch:Region:Account:scheduling-policy/Name\n .\n For example,\n aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.
Deletes the specified scheduling\n policy.
\nYou can't delete a scheduling policy that is used in any job queues.
", + "smithy.api#documentation": "Deletes the specified scheduling policy.
\nYou can't delete a scheduling policy that's used in any job queues.
", "smithy.api#http": { "method": "POST", "uri": "/v1/deleteschedulingpolicy", @@ -1481,7 +1481,7 @@ "arn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the scheduling policy to\n delete.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the scheduling policy to delete.
", "smithy.api#required": {} } } @@ -1641,7 +1641,7 @@ "jobDefinitions": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "A list of up to 100 job definitions. Each\n entry in the list can either be an ARN of the form\n arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} or a short version\n using the form ${JobDefinitionName}:${Revision}.
A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format\n arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} or a short version\n using the form ${JobDefinitionName}:${Revision}.
Describes one or more of your scheduling\n policies.
", + "smithy.api#documentation": "Describes one or more of your scheduling policies.
", "smithy.api#http": { "method": "POST", "uri": "/v1/describeschedulingpolicies", @@ -1845,7 +1845,7 @@ "arns": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "A list of up to 100 scheduling policy\n Amazon Resource Name (ARN) entries.
", + "smithy.api#documentation": "A list of up to 100 scheduling policy Amazon Resource Name (ARN) entries.
", "smithy.api#required": {} } } @@ -1857,7 +1857,7 @@ "schedulingPolicies": { "target": "com.amazonaws.batch#SchedulingPolicyDetailList", "traits": { - "smithy.api#documentation": "The list of scheduling\n policies.
" + "smithy.api#documentation": "The list of scheduling policies.
" } } } @@ -2048,19 +2048,19 @@ "onStatusReason": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "Contains a glob pattern to match against the StatusReason returned for a job. The pattern can be up\n to 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including\n spaces or tabs).\n It can optionally end with an\n asterisk (*) so that only the start of the string needs to be an exact match.
The string can be between 1 and 512 characters in length.
" + "smithy.api#documentation": "Contains a glob pattern to match against the StatusReason returned for a job. The pattern can be up\n to 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including\n spaces or tabs).\n It can optionally end with an\n asterisk (*) so that only the start of the string needs to be an exact match.
The string can be between 1 and 512 characters in length.
" } }, "onReason": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "Contains a glob pattern to match against the Reason returned for a job. The pattern can be up to\n 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces\n and tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact\n match.
The string can be between 1 and 512 characters in length.
" + "smithy.api#documentation": "Contains a glob pattern to match against the Reason returned for a job. The pattern can be up to\n 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces\n and tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact\n match.
The string can be between 1 and 512 characters in length.
" } }, "onExitCode": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "Contains a glob pattern to match against the decimal representation of the ExitCode returned for a\n job. The pattern can be up to 512 characters in length. It can contain only numbers, and can optionally end with an\n asterisk (*) so that only the start of the string needs to be an exact match.
The string can be between 1 and 512 characters in length.
" + "smithy.api#documentation": "Contains a glob pattern to match against the decimal representation of the ExitCode returned for a\n job. The pattern can be up to 512 characters in length. It can contain only numbers, and can optionally end with an\n asterisk (*) so that only the start of the string needs to be an exact match.
The string can be between 1 and 512 characters in length.
" } }, "action": { @@ -2087,24 +2087,24 @@ "shareDecaySeconds": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "The time period to use to calculate a\n fair share percentage for each fair share identifier in use, in seconds. A value of zero (0) indicates that only\n current usage should be measured; if there are four evenly weighted fair share identifiers then each can only use up\n to 25% of the available CPU resources, even if some of the fair share identifiers have no currently running jobs. The\n decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value\n is 604800 (1 week).
" + "smithy.api#documentation": "The time period to use to calculate a fair share percentage for each fair share identifier in use, in seconds. A\n value of zero (0) indicates that only current usage should be measured. The decay allows for more recently run jobs\n to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).
" } }, "computeReservation": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "A value used to reserve some of the\n available maximum vCPU for fair share identifiers that have not yet been used.
\nThe reserved ratio is\n (computeReservation/100)^ActiveFairShares\n where\n \n ActiveFairShares\n is the number of active fair share identifiers.
For example, a computeReservation value of 50 indicates that Batch should reserve 50% of the\n maximum available vCPU if there is only one fair share identifier, 25% if there are two fair share identifiers, and\n 12.5% if there are three fair share identifiers. A computeReservation value of 25 indicates that Batch\n should reserve 25% of the maximum available vCPU if there is only one fair share identifier, 6.25% if there are two\n fair share identifiers, and 1.56% if there are three fair share identifiers.
The minimum value is 0 and the maximum value is 99.
" + "smithy.api#documentation": "A value used to reserve some of the available maximum vCPU for fair share identifiers that have not yet been\n used.
\nThe reserved ratio is\n (computeReservation/100)^ActiveFairShares\n where\n \n ActiveFairShares\n is the number of active fair share identifiers.
For example, a computeReservation value of 50 indicates that Batch should reserve 50% of the\n maximum available vCPU if there is only one fair share identifier, 25% if there are two fair share identifiers, and\n 12.5% if there are three fair share identifiers. A computeReservation value of 25 indicates that Batch\n should reserve 25% of the maximum available vCPU if there is only one fair share identifier, 6.25% if there are two\n fair share identifiers, and 1.56% if there are three fair share identifiers.
The minimum value is 0 and the maximum value is 99.
" } }, "shareDistribution": { "target": "com.amazonaws.batch#ShareAttributesList", "traits": { - "smithy.api#documentation": "Array of SharedIdentifier\n objects that contain the weights for the fair\n share identifiers for the fair share policy.\n Fair share identifiers that\n are not included have a default weight of 1.0.
An array of SharedIdentifier objects that contain the weights for the fair share identifiers for\n the fair share policy. Fair share identifiers that aren't included have a default weight of 1.0.
The fair share policy for a scheduling\n policy.
" + "smithy.api#documentation": "The fair share policy for a scheduling policy.
" } }, "com.amazonaws.batch#FargatePlatformConfiguration": { @@ -2238,14 +2238,14 @@ "type": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The type of job definition, either\n container or multinode. If the job is run on Fargate resources, then\n multinode isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition\n in the Batch User Guide.
The type of job definition, either container or multinode. If the job is run on\n Fargate resources, then multinode isn't supported. For more information about multi-node parallel\n jobs, see Creating a multi-node parallel job\n definition in the Batch User Guide.
The scheduling priority of the job\n definition. This will only affect jobs in job queues with a fair share policy. Jobs with a higher scheduling priority\n will be scheduled before jobs with a lower scheduling priority.
" + "smithy.api#documentation": "The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy.\n Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
" } }, "parameters": { @@ -2394,7 +2394,7 @@ "schedulingPriority": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "The scheduling policy of the job definition. This will only affect jobs in job queues with a fair share policy.\n Jobs with a higher scheduling priority will be scheduled before jobs with a lower scheduling priority.
" + "smithy.api#documentation": "The scheduling policy of the job definition. This only affects jobs in job queues with a fair share policy. Jobs\n with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
" } }, "attempts": { @@ -2539,7 +2539,7 @@ "schedulingPolicyArn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "Amazon Resource Name (ARN) of the scheduling policy. The format is\n aws:Partition:batch:Region:Account:scheduling-policy/Name\n .\n For example,\n aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.
The Amazon Resource Name (ARN) of the scheduling policy. The format is\n aws:Partition:batch:Region:Account:scheduling-policy/Name\n .\n For example,\n aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.
The Unix timestamp for when the job was created. For non-array jobs and parent array jobs, this is when the job\n entered the SUBMITTED state (at the time SubmitJob was called). For array child jobs,\n this is when the child job was spawned by its parent and entered the PENDING state.
The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs,\n this is when the job entered the SUBMITTED state (at the time SubmitJob was called).\n For array child jobs, this is when the child job was spawned by its parent and entered the PENDING\n state.
The filter to apply to the query. Only one filter can be used at a time. When the filter is used,\n jobStatus is ignored. The filter doesn't apply to child jobs in an array or multi-node parallel (MNP)\n jobs. The results are sorted by the createdAt field, with the most recent jobs being first.
The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (*),\n the filter will match any job name that begins with the string before the '*'. This corresponds to the\n jobName value. For example, test1 matches both Test1 and\n test1, and test1* matches both test1 and Test10. When the\n JOB_NAME filter is used, the results are grouped by the job name and version.
The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This corresponds to the\n jobDefinition value. The value is case sensitive. When the value for the filter is the job\n definition name, the results include all the jobs that used any revision of that job definition name. If the value\n ends with an asterisk (*), the filter will match any job definition name that begins with the string before the\n '*'. For example, jd1 matches only jd1, and jd1* matches both\n jd1 and jd1A. The version of the job definition that's used doesn't affect the sort\n order. When the JOB_DEFINITION filter is used and the ARN is used (which is in the form\n arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}), the\n results include jobs that used the specified revision of the job definition. Asterisk (*) is not supported when\n the ARN is used.
The value for the filter is the time that's before the job was created. This corresponds to the\n createdAt value. The value is a string representation of the number of seconds since 00:00:00 UTC\n (midnight) on January 1, 1970.
The value for the filter is the time that's after the job was created. This corresponds to the\n createdAt value. The value is a string representation of the number of seconds since 00:00:00 UTC\n (midnight) on January 1, 1970.
The filter to apply to the query. Only one filter can be used at a time. When the filter is used,\n jobStatus is ignored. The filter doesn't apply to child jobs in an array or multi-node parallel (MNP)\n jobs. The results are sorted by the createdAt field, with the most recent jobs being first.
The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (*),\n the filter will match any job name that begins with the string before the '*'. This corresponds to the\n jobName value. For example, test1 matches both Test1 and\n test1, and test1* matches both test1 and Test10. When the\n JOB_NAME filter is used, the results are grouped by the job name and version.
The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This corresponds to the\n jobDefinition value. The value is case sensitive. When the value for the filter is the job\n definition name, the results include all the jobs that used any revision of that job definition name. If the value\n ends with an asterisk (*), the filter will match any job definition name that begins with the string before the\n '*'. For example, jd1 matches only jd1, and jd1* matches both\n jd1 and jd1A. The version of the job definition that's used doesn't affect the sort\n order. When the JOB_DEFINITION filter is used and the ARN is used (which is in the form\n arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}), the\n results include jobs that used the specified revision of the job definition. Asterisk (*) is not supported when\n the ARN is used.
The value for the filter is the time that's before the job was created. This corresponds to the\n createdAt value. The value is a string representation of the number of milliseconds since 00:00:00\n UTC (midnight) on January 1, 1970.
The value for the filter is the time that's after the job was created. This corresponds to the\n createdAt value. The value is a string representation of the number of milliseconds since 00:00:00\n UTC (midnight) on January 1, 1970.
Returns a list of Batch scheduling\n policies.
", + "smithy.api#documentation": "Returns a list of Batch scheduling policies.
", "smithy.api#http": { "method": "POST", "uri": "/v1/listschedulingpolicies", @@ -2972,13 +2972,13 @@ "maxResults": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "The maximum number of results returned by ListSchedulingPolicies in paginated output. When this\n parameter is used, ListSchedulingPolicies only returns maxResults results in a single page\n and a nextToken response element. The remaining results of the initial request can be seen by sending\n another ListSchedulingPolicies request with the returned nextToken value. This value can be\n between 1 and 100. If this parameter isn't used, then\n ListSchedulingPolicies returns up to 100 results and a nextToken value\n if applicable.
The maximum number of results that's returned by ListSchedulingPolicies in paginated output. When\n this parameter is used, ListSchedulingPolicies only returns maxResults results in a single\n page and a nextToken response element. You can see the remaining results of the initial request by\n sending another ListSchedulingPolicies request with the returned nextToken value. This\n value can be between 1 and 100. If this parameter isn't used,\n ListSchedulingPolicies returns up to 100 results and a nextToken value\n if applicable.
The nextToken value returned from a previous paginated ListSchedulingPolicies request\n where maxResults was used and the results exceeded the value of that parameter. Pagination continues\n from the end of the previous results that returned the nextToken value. This value is null\n when there are no more results to return.
This token should be treated as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe nextToken value that's returned from a previous paginated ListSchedulingPolicies\n request where maxResults was used and the results exceeded the value of that parameter. Pagination\n continues from the end of the previous results that returned the nextToken value. This value is\n null when there are no more results to\n return.
This token should be treated as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nA list of scheduling policies that match\n the request.
" + "smithy.api#documentation": "A list of scheduling policies that match the request.
" } }, "nextToken": { @@ -3411,7 +3411,7 @@ "jobDefinitionName": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and\n underscores are allowed.
", + "smithy.api#documentation": "The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and\n lowercase letters, numbers, hyphens (-), and underscores (_).
", "smithy.api#required": {} } }, @@ -3431,7 +3431,7 @@ "schedulingPriority": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "The scheduling priority for jobs that are\n submitted with this job definition. This will only affect jobs in job queues with a fair share policy. Jobs with a\n higher scheduling priority will be scheduled before jobs with a lower scheduling priority.
\n \nThe minimum supported value is 0 and the maximum supported value is 9999.
" + "smithy.api#documentation": "The scheduling priority for jobs that are submitted with this job definition. This will only affect jobs in job\n queues with a fair share policy. Jobs with a higher scheduling priority will be scheduled before jobs with a lower\n scheduling priority.
\nThe minimum supported value is 0 and the maximum supported value is 9999.
" } }, "containerProperties": { @@ -3513,7 +3513,7 @@ "value": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The quantity of the specified resource to reserve for the container. The values vary based on the\n type specified.
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a\n job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.
\nGPUs are not available for jobs that are running on Fargate resources.
\nThe memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are\n running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated.\n This parameter maps to Memory in the Create a container section of the\n Docker Remote API and the --memory option to docker run.\n You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for\n multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to\n Memory in the Create a container section of the Docker Remote API and the\n --memory option to docker run.
If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for\n a particular instance type, see Memory\n Management in the Batch User Guide.
\nFor jobs that are running on Fargate resources, then value is the hard limit (in MiB), and\n must match one of the supported values and the VCPU values must be one of the values supported for\n that memory value.
\n VCPU = 0.25
\n VCPU = 0.25 or 0.5
\n VCPU = 0.25, 0.5, or 1
\n VCPU = 0.5, or 1
\n VCPU = 0.5, 1, or 2
\n VCPU = 1 or 2
\n VCPU = 1, 2, or 4
\n VCPU = 2 or 4
\n VCPU = 4
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the\n Create a container section of the Docker Remote API and the --cpu-shares option to\n docker run. Each vCPU is equivalent to 1,024 CPU shares. For EC2\n resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be\n specified for each node at least once.
For jobs that are running on Fargate resources, then value must match one of the supported\n values and the MEMORY values must be one of the values supported for that\n VCPU\n value. The supported values are 0.25, 0.5, 1, 2, and 4
\n MEMORY = 512, 1024, or 2048
\n MEMORY = 1024, 2048, 3072, or 4096
\n MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192
\n MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
\n MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456,\n 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
The quantity of the specified resource to reserve for the container. The values vary based on the\n type specified.
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a\n job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.
\nGPUs are not available for jobs that are running on Fargate resources.
\nThe memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are\n running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated.\n This parameter maps to Memory in the Create a container section of the\n Docker Remote API and the --memory option to docker run.\n You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for\n multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to\n Memory in the Create a container section of the Docker Remote API and the\n --memory option to docker run.
If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for\n a particular instance type, see Memory\n Management in the Batch User Guide.
\nFor jobs that are running on Fargate resources, then value is the hard limit (in MiB), and\n must match one of the supported values and the VCPU values must be one of the values supported for\n that memory value.
\n VCPU = 0.25
\n VCPU = 0.25 or 0.5
\n VCPU = 0.25, 0.5, or 1
\n VCPU = 0.5, or 1
\n VCPU = 0.5, 1, or 2
\n VCPU = 1 or 2
\n VCPU = 1, 2, or 4
\n VCPU = 2 or 4
\n VCPU = 4
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the\n Create a container section of the Docker Remote API and the --cpu-shares option to\n docker run. Each vCPU is equivalent to 1,024 CPU shares. For EC2\n resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be\n specified for each node at least once.
For jobs that are running on Fargate resources, then value must match one of the supported\n values and the MEMORY values must be one of the values supported for that VCPU value.\n The supported values are 0.25, 0.5, 1, 2, and 4
\n MEMORY = 512, 1024, or 2048
\n MEMORY = 1024, 2048, 3072, or 4096
\n MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192
\n MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
\n MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456,\n 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
The name of the scheduling\n policy.
", + "smithy.api#documentation": "The name of the scheduling policy.
", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "Amazon Resource Name (ARN) of the scheduling policy. An example would be\n arn:aws:batch:us-east-1:123456789012:scheduling-policy/HighPriority\n \n
The Amazon Resource Name (ARN) of the scheduling policy. An example is\n arn:aws:batch:us-east-1:123456789012:scheduling-policy/HighPriority\n .
The fair share policy for the scheduling\n policy.
" + "smithy.api#documentation": "The fair share policy for the scheduling policy.
" } }, "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { - "smithy.api#documentation": "The tags that you apply to the scheduling policy to help you categorize and organize your resources. Each tag\n consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General\n Reference.
" + "smithy.api#documentation": "The tags that you apply to the scheduling policy to categorize and organize your resources. Each tag consists of\n a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General\n Reference.
" } } }, "traits": { - "smithy.api#documentation": "An object representing a scheduling\n policy.
" + "smithy.api#documentation": "An object that represents a scheduling policy.
" } }, "com.amazonaws.batch#SchedulingPolicyDetailList": { @@ -3641,7 +3641,7 @@ } }, "traits": { - "smithy.api#documentation": "An object containing the details of a scheduling policy returned in a ListSchedulingPolicy\n action.
An object that contains the details of a scheduling policy that's returned in a\n ListSchedulingPolicy action.
A fair share identifier or fair share identifier prefix. If the string ends with '*' then this entry specifies\n the weight factor to use for fair share identifiers that begin with that prefix. The list of fair share identifiers\n in a fair share policy cannot overlap. For example you cannot have one that specifies a shareIdentifier\n of UserA* and another that specifies a shareIdentifier of UserA-1.
There can be no more than 500 fair share identifiers active in a job queue.
\nThe string is limited to 255 alphanumeric characters, optionally followed by '*'.
", + "smithy.api#documentation": "A fair share identifier or fair share identifier prefix. If the string ends with an asterisk (*), this entry\n specifies the weight factor to use for fair share identifiers that start with that prefix. The list of fair share\n identifiers in a fair share policy cannot overlap. For example, you can't have one that specifies a\n shareIdentifier of UserA* and another that specifies a shareIdentifier of\n UserA-1.
There can be no more than 500 fair share identifiers active in a job queue.
\nThe string is limited to 255 alphanumeric characters, optionally followed by an asterisk (*).
", "smithy.api#required": {} } }, "weightFactor": { "target": "com.amazonaws.batch#Float", "traits": { - "smithy.api#documentation": "The weight factor for the fair share\n identifier. The default value is 1.0. A lower value has a higher priority for compute resources. For example, jobs\n using a share identifier with a weight factor of 0.125 (1/8) will get 8 times the compute resources of jobs using a\n share identifier with a weight factor of 1.
\nThe smallest supported value is 0.0001 and the largest supported value is 999.9999.
" + "smithy.api#documentation": "The weight factor for the fair share identifier. The default value is 1.0. A lower value has a higher priority\n for compute resources. For example, jobs that use a share identifier with a weight factor of 0.125 (1/8) get 8 times\n the compute resources of jobs that use a share identifier with a weight factor of 1.
\nThe smallest supported value is 0.0001, and the largest supported value is 999.9999.
" } } }, "traits": { - "smithy.api#documentation": "Specifies the weights for the fair share identifiers for the fair share policy. Fair share identifiers that are\n not included have a default weight of 1.0.
Specifies the weights for the fair share identifiers for the fair share policy. Fair share identifiers that\n aren't included have a default weight of 1.0.
Submits an Batch job from a job definition. Parameters that are specified during SubmitJob\n override parameters defined in the job definition. vCPU and memory requirements that are specified in the\n resourceRequirements objects in the job definition are the exception. They can't be overridden this way\n using the memory and vcpus parameters. Rather, you must specify updates to job definition\n parameters in a ResourceRequirements object that's included in the containerOverrides\n parameter.
Job queues with a scheduling policy are limited to 500 active fair share identifiers at a time.
\nJobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14\n days, Fargate resources might become unavailable and job might be terminated.
\nSubmits an Batch job from a job definition. Parameters that are specified during SubmitJob\n override parameters defined in the job definition. vCPU and memory requirements that are specified in the\n resourceRequirements objects in the job definition are the exception. They can't be overridden this way\n using the memory and vcpus parameters. Rather, you must specify updates to job definition\n parameters in a ResourceRequirements object that's included in the containerOverrides\n parameter.
Job queues with a scheduling policy are limited to 500 active fair share identifiers at a time.
\nJobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14\n days, Fargate resources might become unavailable and job might be terminated.
\nThe name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase),\n numbers, hyphens, and underscores are allowed.
", + "smithy.api#documentation": "The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain\n uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
", "smithy.api#required": {} } }, @@ -3772,13 +3772,13 @@ "shareIdentifier": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The share identifier for the\n job.
" + "smithy.api#documentation": "The share identifier for the job.
" } }, "schedulingPriorityOverride": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "The scheduling priority for the job. This\n will only affect jobs in job queues with a fair share policy. Jobs with a higher scheduling priority will be\n scheduled before jobs with a lower scheduling priority. This will override any scheduling priority in the job\n definition.
\n \nThe minimum supported value is 0 and the maximum supported value is 9999.
" + "smithy.api#documentation": "The scheduling priority for the job. This will only affect jobs in job queues with a fair share policy. Jobs\n with a higher scheduling priority will be scheduled before jobs with a lower scheduling priority. This will override\n any scheduling priority in the job definition.
\nThe minimum supported value is 0 and the maximum supported value is 9999.
" } }, "arrayProperties": { @@ -4189,7 +4189,7 @@ "unmanagedvCpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "The maximum number of vCPUs expected to\n be used for an unmanaged compute environment. This parameter should not be specified for a managed compute\n environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share\n identifiers. If this parameter is not provided for a fair share job queue, no vCPU capacity will be\n reserved.
" + "smithy.api#documentation": "The maximum number of vCPUs expected to be used for an unmanaged compute environment. This parameter should not\n be specified for a managed compute environment. This parameter is only used for fair share scheduling to reserve vCPU\n capacity for new share identifiers. If this parameter is not provided for a fair share job queue, no vCPU capacity\n will be reserved.
" } }, "computeResources": { @@ -4215,7 +4215,7 @@ "computeEnvironmentName": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and\n underscores are allowed.
" + "smithy.api#documentation": "The name of the compute environment. It can be up to 128 letters long. It can contain uppercase and\n lowercase letters, numbers, hyphens (-), and underscores (_).
" } }, "computeEnvironmentArn": { @@ -4324,7 +4324,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a scheduling\n policy.
", + "smithy.api#documentation": "Updates a scheduling policy.
", "smithy.api#http": { "method": "POST", "uri": "/v1/updateschedulingpolicy", @@ -4345,7 +4345,7 @@ "fairsharePolicy": { "target": "com.amazonaws.batch#FairsharePolicy", "traits": { - "smithy.api#documentation": "The fair share\n policy.
" + "smithy.api#documentation": "The fair share policy.
" } } } @@ -4366,7 +4366,7 @@ "name": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are\n allowed. This name is referenced in the sourceVolume\n parameter of container definition mountPoints.
The name of the volume. It can be up to 255 letters long. It can contain uppercase and lowercase letters,\n numbers, hyphens (-), and underscores (_). This name is referenced in the sourceVolume\n parameter of container definition mountPoints.
Configures the paths to the Python scripts used for entry and training.
" + } }, - { - "target": "com.amazonaws.braket#QuantumTaskResource" + "containerImage": { + "target": "com.amazonaws.braket#ContainerImage", + "traits": { + "smithy.api#documentation": "The container image used to create an Amazon Braket job.
" + } } - ], + }, + "traits": { + "smithy.api#documentation": "Defines the Amazon Braket job to be created. Specifies the container image the job uses and the paths to\n the Python scripts used for entry and training.
" + } + }, + "com.amazonaws.braket#Braket": { + "type": "service", "traits": { "aws.api#service": { "sdkId": "Braket", @@ -71,6 +68,99 @@ }, "smithy.api#documentation": "The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.
", "smithy.api#title": "Braket" + }, + "version": "2019-09-01", + "operations": [ + { + "target": "com.amazonaws.braket#ListTagsForResource" + }, + { + "target": "com.amazonaws.braket#TagResource" + }, + { + "target": "com.amazonaws.braket#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.braket#DeviceResource" + }, + { + "target": "com.amazonaws.braket#JobResource" + }, + { + "target": "com.amazonaws.braket#QuantumTaskResource" + } + ] + }, + "com.amazonaws.braket#CancelJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.braket#CancelJobRequest" + }, + "output": { + "target": "com.amazonaws.braket#CancelJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.braket#AccessDeniedException" + }, + { + "target": "com.amazonaws.braket#ConflictException" + }, + { + "target": "com.amazonaws.braket#InternalServiceException" + }, + { + "target": "com.amazonaws.braket#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.braket#ThrottlingException" + }, + { + "target": "com.amazonaws.braket#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Cancels an Amazon Braket job.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/job/{jobArn}/cancel", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.braket#CancelJobRequest": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.braket#JobArn", + "traits": { + "smithy.api#documentation": "The ARN of the Amazon Braket job to cancel.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.braket#CancelJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.braket#JobArn", + "traits": { + "smithy.api#documentation": "The ARN of the Amazon Braket job.
", + "smithy.api#required": {} + } + }, + "cancellationStatus": { + "target": "com.amazonaws.braket#CancellationStatus", + "traits": { + "smithy.api#documentation": "The status of the job cancellation request.
", + "smithy.api#required": {} + } + } } }, "com.amazonaws.braket#CancelQuantumTask": { @@ -166,6 +256,21 @@ ] } }, + "com.amazonaws.braket#CompressionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "GZIP", + "name": "GZIP" + } + ] + } + }, "com.amazonaws.braket#ConflictException": { "type": "structure", "members": { @@ -179,6 +284,167 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.braket#ContainerImage": { + "type": "structure", + "members": { + "uri": { + "target": "com.amazonaws.braket#Uri", + "traits": { + "smithy.api#documentation": "The URI locating the container image.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The container image used to create an Amazon Braket job.
" + } + }, + "com.amazonaws.braket#CreateJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.braket#CreateJobRequest" + }, + "output": { + "target": "com.amazonaws.braket#CreateJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.braket#AccessDeniedException" + }, + { + "target": "com.amazonaws.braket#ConflictException" + }, + { + "target": "com.amazonaws.braket#DeviceRetiredException" + }, + { + "target": "com.amazonaws.braket#InternalServiceException" + }, + { + "target": "com.amazonaws.braket#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.braket#ThrottlingException" + }, + { + "target": "com.amazonaws.braket#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Amazon Braket job.
", + "smithy.api#http": { + "method": "POST", + "uri": "/job", + "code": 201 + } + } + }, + "com.amazonaws.braket#CreateJobRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.braket#String64", + "traits": { + "smithy.api#documentation": "A unique token that guarantees that the call to this API is idempotent.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "algorithmSpecification": { + "target": "com.amazonaws.braket#AlgorithmSpecification", + "traits": { + "smithy.api#documentation": "Definition of the Amazon Braket job to be created. Specifies the container image the job uses and information\n about the Python scripts used for entry and training.
", + "smithy.api#required": {} + } + }, + "inputDataConfig": { + "target": "com.amazonaws.braket#InputConfigList", + "traits": { + "smithy.api#documentation": "A list of parameters that specify the name and type of input data and where it is\n located.
", + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "outputDataConfig": { + "target": "com.amazonaws.braket#JobOutputDataConfig", + "traits": { + "smithy.api#documentation": "The path to the S3 location where you want to store job artifacts and the\n encryption key used to store them.
", + "smithy.api#required": {} + } + }, + "checkpointConfig": { + "target": "com.amazonaws.braket#JobCheckpointConfig", + "traits": { + "smithy.api#documentation": "Information about the output locations for job checkpoint data.
" + } + }, + "jobName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon Braket job.
", + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,50}$", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.braket#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform\n tasks on behalf of a user. It can access user resources, run an Amazon Braket job container\n on behalf of user, and output resources to the users' s3 buckets.
", + "smithy.api#required": {} + } + }, + "stoppingCondition": { + "target": "com.amazonaws.braket#JobStoppingCondition", + "traits": { + "smithy.api#documentation": "The user-defined criteria that specifies when a job stops running.
" + } + }, + "instanceConfig": { + "target": "com.amazonaws.braket#InstanceConfig", + "traits": { + "smithy.api#documentation": "Configuration of the resource instances to use while running the hybrid job on Amazon\n Braket.
", + "smithy.api#required": {} + } + }, + "hyperParameters": { + "target": "com.amazonaws.braket#HyperParameters", + "traits": { + "smithy.api#documentation": "Algorithm-specific parameters used by an Amazon Braket job that influence the quality of\n the training job. The values are set with a string of JSON key:value pairs, where the key is the\n name of the hyperparameter and the value is the value of th hyperparameter.
" + } + }, + "deviceConfig": { + "target": "com.amazonaws.braket#DeviceConfig", + "traits": { + "smithy.api#documentation": "The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.braket#TagsMap", + "traits": { + "smithy.api#documentation": "A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
" + } + } + } + }, + "com.amazonaws.braket#CreateJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.braket#JobArn", + "traits": { + "smithy.api#documentation": "The ARN of the Amazon Braket job created.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.braket#CreateQuantumTask": { "type": "operation", "input": { @@ -194,6 +460,9 @@ { "target": "com.amazonaws.braket#DeviceOfflineException" }, + { + "target": "com.amazonaws.braket#DeviceRetiredException" + }, { "target": "com.amazonaws.braket#InternalServiceException" }, @@ -288,6 +557,12 @@ "traits": { "smithy.api#documentation": "Tags to be added to the quantum task you're creating.
" } + }, + "jobToken": { + "target": "com.amazonaws.braket#JobToken", + "traits": { + "smithy.api#documentation": "The token for an Amazon Braket job that associates it with the quantum task.
" + } } } }, @@ -303,6 +578,21 @@ } } }, + "com.amazonaws.braket#DataSource": { + "type": "structure", + "members": { + "s3DataSource": { + "target": "com.amazonaws.braket#S3DataSource", + "traits": { + "smithy.api#documentation": "Information about the data stored in Amazon S3 used by the Amazon Braket job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the source of the data used by the Amazon Braket job.
" + } + }, "com.amazonaws.braket#DeviceArn": { "type": "string", "traits": { @@ -316,10 +606,25 @@ } } }, - "com.amazonaws.braket#DeviceOfflineException": { + "com.amazonaws.braket#DeviceConfig": { "type": "structure", "members": { - "message": { + "device": { + "target": "com.amazonaws.braket#String256", + "traits": { + "smithy.api#documentation": "The primary quantum processing unit (QPU) or simulator used to create and run an Amazon Braket job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configures the quantum processing units (QPUs) or simulator used to create and run an Amazon Braket job.
" + } + }, + "com.amazonaws.braket#DeviceOfflineException": { + "type": "structure", + "members": { + "message": { "target": "smithy.api#String" } }, @@ -459,12 +764,6 @@ { "target": "com.amazonaws.braket#AccessDeniedException" }, - { - "target": "com.amazonaws.braket#DeviceOfflineException" - }, - { - "target": "com.amazonaws.braket#DeviceRetiredException" - }, { "target": "com.amazonaws.braket#InternalServiceException" }, @@ -548,6 +847,189 @@ } } }, + "com.amazonaws.braket#GetJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.braket#GetJobRequest" + }, + "output": { + "target": "com.amazonaws.braket#GetJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.braket#AccessDeniedException" + }, + { + "target": "com.amazonaws.braket#InternalServiceException" + }, + { + "target": "com.amazonaws.braket#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.braket#ThrottlingException" + }, + { + "target": "com.amazonaws.braket#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the specified Amazon Braket job.
", + "smithy.api#http": { + "method": "GET", + "uri": "/job/{jobArn}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.braket#GetJobRequest": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.braket#JobArn", + "traits": { + "smithy.api#documentation": "The ARN of the job to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.braket#GetJobResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.braket#JobPrimaryStatus", + "traits": { + "smithy.api#documentation": "The status of the Amazon Braket job.
", + "smithy.api#required": {} + } + }, + "jobArn": { + "target": "com.amazonaws.braket#JobArn", + "traits": { + "smithy.api#documentation": "The ARN of the Amazon Braket job.
", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.braket#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform\n tasks on behalf of a user. It can access user resources, run an Amazon Braket job container\n on behalf of user, and output resources to the s3 buckets of a user.
", + "smithy.api#required": {} + } + }, + "failureReason": { + "target": "com.amazonaws.braket#String1024", + "traits": { + "smithy.api#documentation": "A description of the reason why an Amazon Braket job failed, if it failed.
" + } + }, + "jobName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon Braket job.
", + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,50}$", + "smithy.api#required": {} + } + }, + "hyperParameters": { + "target": "com.amazonaws.braket#HyperParameters", + "traits": { + "smithy.api#documentation": "Algorithm-specific parameters used by an Amazon Braket job that influence the quality of\n the traiing job. The values are set with a string of JSON key:value pairs, where the key is the\n name of the hyperparameter and the value is the value of th hyperparameter.
" + } + }, + "inputDataConfig": { + "target": "com.amazonaws.braket#InputConfigList", + "traits": { + "smithy.api#documentation": "A list of parameters that specify the name and type of input data and where it is\n located.
" + } + }, + "outputDataConfig": { + "target": "com.amazonaws.braket#JobOutputDataConfig", + "traits": { + "smithy.api#documentation": "The path to the S3 location where job artifacts are stored and the encryption\n key used to store them there.
", + "smithy.api#required": {} + } + }, + "stoppingCondition": { + "target": "com.amazonaws.braket#JobStoppingCondition", + "traits": { + "smithy.api#documentation": "The user-defined criteria that specifies when to stop a job running.
" + } + }, + "checkpointConfig": { + "target": "com.amazonaws.braket#JobCheckpointConfig", + "traits": { + "smithy.api#documentation": "Information about the output locations for job checkpoint data.
" + } + }, + "algorithmSpecification": { + "target": "com.amazonaws.braket#AlgorithmSpecification", + "traits": { + "smithy.api#documentation": "Definition of the Amazon Braket job created. Specifies the container image the job uses, information about\n the Python scripts used for entry and training, and the user-defined metrics used to\n evaluation the job.
", + "smithy.api#required": {} + } + }, + "instanceConfig": { + "target": "com.amazonaws.braket#InstanceConfig", + "traits": { + "smithy.api#documentation": "The resource instances to use while running the hybrid job on Amazon\n Braket.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the Amazon Braket job was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "startedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the Amazon Braket job was started.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "endedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the Amazon Braket job ended.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "billableDuration": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The billable time the Amazon Braket job used to complete.
" + } + }, + "deviceConfig": { + "target": "com.amazonaws.braket#DeviceConfig", + "traits": { + "smithy.api#documentation": "The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.
" + } + }, + "events": { + "target": "com.amazonaws.braket#JobEvents", + "traits": { + "smithy.api#documentation": "Details about the type and time events occurred related to the Amazon Braket job.
" + } + }, + "tags": { + "target": "com.amazonaws.braket#TagsMap", + "traits": { + "smithy.api#documentation": "A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
" + } + } + } + }, "com.amazonaws.braket#GetQuantumTask": { "type": "operation", "input": { @@ -629,86 +1111,618 @@ "deviceParameters": { "target": "com.amazonaws.braket#JsonValue", "traits": { - "smithy.api#documentation": "The parameters for the device on which the task ran.
", + "smithy.api#documentation": "The parameters for the device on which the task ran.
", + "smithy.api#required": {} + } + }, + "shots": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of shots used in the task.
", + "smithy.api#required": {} + } + }, + "outputS3Bucket": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The S3 bucket where task results are stored.
", + "smithy.api#required": {} + } + }, + "outputS3Directory": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The folder in the S3 bucket where task results are stored.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the task was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "endedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the task ended.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "tags": { + "target": "com.amazonaws.braket#TagsMap", + "traits": { + "smithy.api#documentation": "The tags that belong to this task.
" + } + }, + "jobArn": { + "target": "com.amazonaws.braket#JobArn", + "traits": { + "smithy.api#documentation": "The ARN of the Amazon Braket job associated with the quantum task.
" + } + } + } + }, + "com.amazonaws.braket#HyperParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.braket#String256" + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2500 + } + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.braket#InputConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.braket#InputFileConfig" + } + }, + "com.amazonaws.braket#InputFileConfig": { + "type": "structure", + "members": { + "channelName": { + "target": "com.amazonaws.braket#String64", + "traits": { + "smithy.api#documentation": "A named input source that an Amazon Braket job can consume.
", + "smithy.api#pattern": "^[A-Za-z0-9\\.\\-_]+$", + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.braket#String256", + "traits": { + "smithy.api#documentation": "The MIME type of the data.
" + } + }, + "dataSource": { + "target": "com.amazonaws.braket#DataSource", + "traits": { + "smithy.api#documentation": "The location of the channel data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A list of parameters that specify the input channels, type of input data, and where it\n is located.
" + } + }, + "com.amazonaws.braket#InstanceConfig": { + "type": "structure", + "members": { + "instanceType": { + "target": "com.amazonaws.braket#InstanceType", + "traits": { + "smithy.api#documentation": "Configures the type resource instances to use while running an Amazon Braket hybrid job.
", + "smithy.api#required": {} + } + }, + "volumeSizeInGb": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The size of the storage volume, in GB, that user wants to provision.
", + "smithy.api#range": { + "min": 1 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configures the resource instances to use while running the Amazon Braket hybrid job on Amazon\n Braket.
" + } + }, + "com.amazonaws.braket#InstanceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ml.m4.xlarge", + "name": "ML_M4_XLARGE" + }, + { + "value": "ml.m4.2xlarge", + "name": "ML_M4_2XLARGE" + }, + { + "value": "ml.m4.4xlarge", + "name": "ML_M4_4XLARGE" + }, + { + "value": "ml.m4.10xlarge", + "name": "ML_M4_10XLARGE" + }, + { + "value": "ml.m4.16xlarge", + "name": "ML_M4_16XLARGE" + }, + { + "value": "ml.g4dn.xlarge", + "name": "ML_G4DN_XLARGE" + }, + { + "value": "ml.g4dn.2xlarge", + "name": "ML_G4DN_2XLARGE" + }, + { + "value": "ml.g4dn.4xlarge", + "name": "ML_G4DN_4XLARGE" + }, + { + "value": "ml.g4dn.8xlarge", + "name": "ML_G4DN_8XLARGE" + }, + { + "value": "ml.g4dn.12xlarge", + "name": "ML_G4DN_12XLARGE" + }, + { + "value": "ml.g4dn.16xlarge", + "name": "ML_G4DN_16XLARGE" + }, + { + "value": "ml.m5.large", + "name": "ML_M5_LARGE" + }, + { + "value": "ml.m5.xlarge", + "name": "ML_M5_XLARGE" + }, + { + "value": "ml.m5.2xlarge", + "name": "ML_M5_2XLARGE" + }, + { + "value": "ml.m5.4xlarge", + "name": "ML_M5_4XLARGE" + }, + { + "value": "ml.m5.12xlarge", + "name": "ML_M5_12XLARGE" + }, + { + "value": "ml.m5.24xlarge", + "name": "ML_M5_24XLARGE" + }, + { + "value": "ml.c4.xlarge", + "name": "ML_C4_XLARGE" + }, + { + "value": "ml.c4.2xlarge", + "name": "ML_C4_2XLARGE" + }, + { + "value": "ml.c4.4xlarge", + "name": "ML_C4_4XLARGE" + }, + { + "value": "ml.c4.8xlarge", + "name": "ML_C4_8XLARGE" + }, + { + "value": "ml.p2.xlarge", + "name": "ML_P2_XLARGE" + }, + { + "value": "ml.p2.8xlarge", + "name": "ML_P2_8XLARGE" + }, + { + "value": "ml.p2.16xlarge", + "name": "ML_P2_16XLARGE" + }, + { + "value": "ml.p3.2xlarge", + "name": "ML_P3_2XLARGE" + }, + { + "value": "ml.p3.8xlarge", + "name": "ML_P3_8XLARGE" + }, + { + "value": "ml.p3.16xlarge", + "name": "ML_P3_16XLARGE" + }, + { + "value": "ml.p3dn.24xlarge", + "name": "ML_P3DN_24XLARGE" + }, + { + "value": "ml.p4d.24xlarge", + "name": "ML_P4D_24XLARGE" + }, + { + "value": "ml.c5.xlarge", + "name": "ML_C5_XLARGE" + }, + { + "value": "ml.c5.2xlarge", + "name": "ML_C5_2XLARGE" + }, + { + "value": "ml.c5.4xlarge", + "name": "ML_C5_4XLARGE" + }, + { + "value": "ml.c5.9xlarge", + "name": "ML_C5_9XLARGE" + }, + { + "value": "ml.c5.18xlarge", + "name": "ML_C5_18XLARGE" + }, + { + "value": "ml.c5n.xlarge", + "name": "ML_C5N_XLARGE" + }, + { + "value": "ml.c5n.2xlarge", + "name": "ML_C5N_2XLARGE" + }, + { + "value": "ml.c5n.4xlarge", + "name": "ML_C5N_4XLARGE" + }, + { + "value": "ml.c5n.9xlarge", + "name": "ML_C5N_9XLARGE" + }, + { + "value": "ml.c5n.18xlarge", + "name": "ML_C5N_18XLARGE" + } + ] + } + }, + "com.amazonaws.braket#InternalServiceException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The request processing has failed because of an unknown error, exception, or failure.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.braket#JobArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "service": "com.amazonaws.braket#Braket", + "resource": "com.amazonaws.braket#JobResource" + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:braket:[a-z0-9\\-]*:[0-9]{12}:job/.*$" + } + }, + "com.amazonaws.braket#JobCheckpointConfig": { + "type": "structure", + "members": { + "localPath": { + "target": "com.amazonaws.braket#String4096", + "traits": { + "smithy.api#documentation": "(Optional) The local directory where checkpoints are written. The default directory is /opt/braket/checkpoints/.
Identifies the S3 path where you want Amazon Braket to store checkpoints. For example, s3://bucket-name/key-name-prefix.
Contains information about the output locations for job checkpoint data.
" + } + }, + "com.amazonaws.braket#JobEventDetails": { + "type": "structure", + "members": { + "eventType": { + "target": "com.amazonaws.braket#JobEventType", + "traits": { + "smithy.api#documentation": "The type of event that occurred related to the Amazon Braket job.
" + } + }, + "timeOfEvent": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "TThe type of event that occurred related to the Amazon Braket job.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A message describing the event that occurred related to the Amazon Braket job.
", + "smithy.api#length": { + "min": 0, + "max": 2500 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the type and time events occurred related to the Amazon Braket job.
" + } + }, + "com.amazonaws.braket#JobEventType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "WAITING_FOR_PRIORITY", + "name": "WAITING_FOR_PRIORITY" + }, + { + "value": "QUEUED_FOR_EXECUTION", + "name": "QUEUED_FOR_EXECUTION" + }, + { + "value": "STARTING_INSTANCE", + "name": "STARTING_INSTANCE" + }, + { + "value": "DOWNLOADING_DATA", + "name": "DOWNLOADING_DATA" + }, + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "DEPRIORITIZED_DUE_TO_INACTIVITY", + "name": "DEPRIORITIZED_DUE_TO_INACTIVITY" + }, + { + "value": "UPLOADING_RESULTS", + "name": "UPLOADING_RESULTS" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "MAX_RUNTIME_EXCEEDED", + "name": "MAX_RUNTIME_EXCEEDED" + }, + { + "value": "CANCELLED", + "name": "CANCELLED" + } + ] + } + }, + "com.amazonaws.braket#JobEvents": { + "type": "list", + "member": { + "target": "com.amazonaws.braket#JobEventDetails" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.braket#JobOutputDataConfig": { + "type": "structure", + "members": { + "kmsKeyId": { + "target": "com.amazonaws.braket#String2048", + "traits": { + "smithy.api#documentation": "The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the\n job training artifacts at rest using Amazon S3 server-side encryption.
" + } + }, + "s3Path": { + "target": "com.amazonaws.braket#S3Path", + "traits": { + "smithy.api#documentation": "Identifies the S3 path where you want Amazon Braket to store the job training artifacts. For\n example, s3://bucket-name/key-name-prefix.
Specifies the path to the S3 location where you want to store job artifacts and the\n encryption key used to store them.
" + } + }, + "com.amazonaws.braket#JobPrimaryStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "QUEUED", + "name": "QUEUED" + }, + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "CANCELLING", + "name": "CANCELLING" + }, + { + "value": "CANCELLED", + "name": "CANCELLED" + } + ] + } + }, + "com.amazonaws.braket#JobResource": { + "type": "resource", + "identifiers": { + "jobArn": { + "target": "com.amazonaws.braket#JobArn" + } + }, + "create": { + "target": "com.amazonaws.braket#CreateJob" + }, + "read": { + "target": "com.amazonaws.braket#GetJob" + }, + "update": { + "target": "com.amazonaws.braket#CancelJob" + }, + "collectionOperations": [ + { + "target": "com.amazonaws.braket#SearchJobs" + } + ], + "traits": { + "aws.api#arn": { + "template": "{jobArn}", + "absolute": true, + "noAccount": false, + "noRegion": false + } + } + }, + "com.amazonaws.braket#JobStoppingCondition": { + "type": "structure", + "members": { + "maxRuntimeInSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum length of time, in seconds, that an Amazon Braket job can run.
", + "smithy.api#range": { + "min": 1, + "max": 432000 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies limits for how long an Amazon Braket job can run.
" + } + }, + "com.amazonaws.braket#JobSummary": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.braket#JobPrimaryStatus", + "traits": { + "smithy.api#documentation": "The status of the Amazon Braket job.
", "smithy.api#required": {} } }, - "shots": { - "target": "smithy.api#Long", + "jobArn": { + "target": "com.amazonaws.braket#JobArn", "traits": { - "smithy.api#documentation": "The number of shots used in the task.
", + "smithy.api#documentation": "The ARN of the Amazon Braket job.
", "smithy.api#required": {} } }, - "outputS3Bucket": { + "jobName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The S3 bucket where task results are stored.
", + "smithy.api#documentation": "The name of the Amazon Braket job.
", "smithy.api#required": {} } }, - "outputS3Directory": { - "target": "smithy.api#String", + "device": { + "target": "com.amazonaws.braket#String256", "traits": { - "smithy.api#documentation": "The folder in the S3 bucket where task results are stored.
", + "smithy.api#documentation": "Provides summary information about the primary device used by an Amazon Braket job.
", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time at which the task was created.
", + "smithy.api#documentation": "The date and time that the Amazon Braket job was created.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, + "startedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the Amazon Braket job was started.
", + "smithy.api#timestampFormat": "date-time" + } + }, "endedAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time at which the task ended.
", + "smithy.api#documentation": "The date and time that the Amazon Braket job ended.
", "smithy.api#timestampFormat": "date-time" } }, "tags": { "target": "com.amazonaws.braket#TagsMap", "traits": { - "smithy.api#documentation": "The tags that belong to this task.
" + "smithy.api#documentation": "A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
" } } - } - }, - "com.amazonaws.braket#InternalServiceException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String" - } }, "traits": { - "smithy.api#documentation": "The request processing has failed because of an unknown error, exception, or failure.
", - "smithy.api#error": "server", - "smithy.api#httpError": 500 + "smithy.api#documentation": "Provides summary information about an Amazon Braket job.
" } }, - "com.amazonaws.braket#JobArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws[a-z\\-]*:braket:[a-z0-9\\-]*:[0-9]{12}:job/.*$" + "com.amazonaws.braket#JobSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.braket#JobSummary" } }, - "com.amazonaws.braket#JobResource": { - "type": "resource", - "identifiers": { - "jobArn": { - "target": "com.amazonaws.braket#JobArn" - } - }, + "com.amazonaws.braket#JobToken": { + "type": "string", "traits": { - "aws.api#arn": { - "template": "{jobArn}", - "absolute": true, - "noAccount": false, - "noRegion": false + "smithy.api#length": { + "min": 1, + "max": 128 } } }, @@ -937,6 +1951,64 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.braket#RoleArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, + "com.amazonaws.braket#S3DataSource": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.braket#S3Path", + "traits": { + "smithy.api#documentation": "Depending on the value specified for the S3DataType, identifies either a\n key name prefix or a manifest that locates the S3 data source.
Information about the data stored in Amazon S3 used by the Amazon Braket job.
" + } + }, + "com.amazonaws.braket#S3Path": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#pattern": "^(https|s3)://([^/]+)/?(.*)$" + } + }, + "com.amazonaws.braket#ScriptModeConfig": { + "type": "structure", + "members": { + "entryPoint": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The path to the Python script that serves as the entry point for an Amazon Braket\n job.
", + "smithy.api#required": {} + } + }, + "s3Uri": { + "target": "com.amazonaws.braket#S3Path", + "traits": { + "smithy.api#documentation": "The URI that specifies the S3 path to the Python script module that contains the\n training script used by an Amazon Braket job.
", + "smithy.api#required": {} + } + }, + "compressionType": { + "target": "com.amazonaws.braket#CompressionType", + "traits": { + "smithy.api#documentation": "The type of compression used by the Python scripts for an Amazon Braket job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the Python scripts used for entry and by an Amazon Braket job.
" + } + }, "com.amazonaws.braket#SearchDevices": { "type": "operation", "input": { @@ -1061,6 +2133,167 @@ } } }, + "com.amazonaws.braket#SearchJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.braket#SearchJobsRequest" + }, + "output": { + "target": "com.amazonaws.braket#SearchJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.braket#AccessDeniedException" + }, + { + "target": "com.amazonaws.braket#InternalServiceException" + }, + { + "target": "com.amazonaws.braket#ThrottlingException" + }, + { + "target": "com.amazonaws.braket#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Searches for Amazon Braket jobs that match the specified filter values.
", + "smithy.api#http": { + "method": "POST", + "uri": "/jobs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "jobs", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.braket#SearchJobsFilter": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.braket#String64", + "traits": { + "smithy.api#documentation": "The name to use for the jobs filter.
", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.braket#String256List", + "traits": { + "smithy.api#documentation": "The values to use for the jobs filter.
", + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#required": {} + } + }, + "operator": { + "target": "com.amazonaws.braket#SearchJobsFilterOperator", + "traits": { + "smithy.api#documentation": "An operator to use for the jobs filter.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A filter used to search for Amazon Braket jobs.
" + } + }, + "com.amazonaws.braket#SearchJobsFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.braket#SearchJobsFilter" + } + }, + "com.amazonaws.braket#SearchJobsFilterOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LT", + "name": "LT" + }, + { + "value": "LTE", + "name": "LTE" + }, + { + "value": "EQUAL", + "name": "EQUAL" + }, + { + "value": "GT", + "name": "GT" + }, + { + "value": "GTE", + "name": "GTE" + }, + { + "value": "BETWEEN", + "name": "BETWEEN" + }, + { + "value": "CONTAINS", + "name": "CONTAINS" + } + ] + } + }, + "com.amazonaws.braket#SearchJobsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A token used for pagination of results returned in the response. Use the token returned\n from the previous request to continue results where the previous request ended.
" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "filters": { + "target": "com.amazonaws.braket#SearchJobsFilterList", + "traits": { + "smithy.api#documentation": "The filter values to use when searching for a job.
", + "smithy.api#length": { + "min": 0, + "max": 10 + }, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.braket#SearchJobsResponse": { + "type": "structure", + "members": { + "jobs": { + "target": "com.amazonaws.braket#JobSummaryList", + "traits": { + "smithy.api#documentation": "An array of JobSummary objects for devices that match the specified filter\n values.
A token used for pagination of results, or null if there are no additional results. Use\n the token value in a subsequent request to continue results where the previous request\n ended.
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
" + } + }, + "AttendeeId": { + "target": "com.amazonaws.chimesdkmeetings#GuidString", + "traits": { + "smithy.api#documentation": "The Amazon Chime SDK attendee ID.
" + } + }, + "JoinToken": { + "target": "com.amazonaws.chimesdkmeetings#JoinTokenString", + "traits": { + "smithy.api#documentation": "The join token used by the Amazon Chime SDK attendee.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An Amazon Chime SDK meeting attendee. Includes a unique \n AttendeeId and JoinToken. The \n JoinToken\n allows a client to authenticate and join as the specified attendee. The \n JoinToken\n expires when the meeting ends, or when \n DeleteAttendee\n is called. After that, the attendee is unable to join the meeting.\n
We recommend securely transferring each JoinToken from your server application\n to the client so that no other client has access to the token except for the one\n authorized to represent the attendee.
Makes echo reduction available to clients who connect to the meeting.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An optional category of meeting features that contains audio-specific configurations, such as operating parameters for Amazon Voice Focus.
" + } + }, + "com.amazonaws.chimesdkmeetings#BadRequestException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmeetings#String" + }, + "Message": { + "target": "com.amazonaws.chimesdkmeetings#String" + }, + "RequestId": { + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "The request id associated with the call responsible for the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input parameters don't match the service's restrictions.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.chimesdkmeetings#BatchCreateAttendee": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmeetings#BatchCreateAttendeeRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmeetings#BatchCreateAttendeeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmeetings#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#LimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates up to 100 attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
", + "smithy.api#http": { + "method": "POST", + "uri": "/meetings/{MeetingId}/attendees?operation=batch-create", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmeetings#BatchCreateAttendeeErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmeetings#CreateAttendeeError" + } + }, + "com.amazonaws.chimesdkmeetings#BatchCreateAttendeeRequest": { + "type": "structure", + "members": { + "MeetingId": { + "target": "com.amazonaws.chimesdkmeetings#GuidString", + "traits": { + "smithy.api#documentation": "The Amazon Chime SDK ID of the meeting to which you're adding attendees.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Attendees": { + "target": "com.amazonaws.chimesdkmeetings#CreateAttendeeRequestItemList", + "traits": { + "smithy.api#documentation": "The attendee information, including attendees' IDs and join tokens.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmeetings#BatchCreateAttendeeResponse": { + "type": "structure", + "members": { + "Attendees": { + "target": "com.amazonaws.chimesdkmeetings#AttendeeList", + "traits": { + "smithy.api#documentation": "The attendee information, including attendees' IDs and join tokens.
" + } + }, + "Errors": { + "target": "com.amazonaws.chimesdkmeetings#BatchCreateAttendeeErrorList", + "traits": { + "smithy.api#documentation": "If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.
" + } + } + } + }, + "com.amazonaws.chimesdkmeetings#Boolean": { + "type": "boolean" + }, + "com.amazonaws.chimesdkmeetings#ChimeMeetingsSDKService": { + "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Chime SDK Meetings", + "arnNamespace": "chime", + "cloudFormationName": "ChimeSDKMeetings", + "cloudTrailEventSource": "chimesdkmeetings.amazonaws.com", + "endpointPrefix": "meetings-chime" + }, + "aws.auth#sigv4": { + "name": "chime" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and \n receive meeting notifications. For more information \n about the meeting APIs, see Amazon Chime SDK meetings.
", + "smithy.api#title": "Amazon Chime SDK Meetings" + }, + "version": "2021-07-15", + "operations": [ + { + "target": "com.amazonaws.chimesdkmeetings#BatchCreateAttendee" + }, + { + "target": "com.amazonaws.chimesdkmeetings#CreateAttendee" + }, + { + "target": "com.amazonaws.chimesdkmeetings#CreateMeeting" + }, + { + "target": "com.amazonaws.chimesdkmeetings#CreateMeetingWithAttendees" + }, + { + "target": "com.amazonaws.chimesdkmeetings#DeleteAttendee" + }, + { + "target": "com.amazonaws.chimesdkmeetings#DeleteMeeting" + }, + { + "target": "com.amazonaws.chimesdkmeetings#GetAttendee" + }, + { + "target": "com.amazonaws.chimesdkmeetings#GetMeeting" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ListAttendees" + }, + { + "target": "com.amazonaws.chimesdkmeetings#StartMeetingTranscription" + }, + { + "target": "com.amazonaws.chimesdkmeetings#StopMeetingTranscription" + } + ] + }, + "com.amazonaws.chimesdkmeetings#ClientRequestToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 64 + }, + "smithy.api#pattern": "^[-_a-zA-Z0-9]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkmeetings#CreateAttendee": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmeetings#CreateAttendeeRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmeetings#CreateAttendeeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmeetings#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#LimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#UnauthorizedException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#UnprocessableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "\n Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK\n in the \n Amazon Chime Developer Guide.\n
", + "smithy.api#http": { + "method": "POST", + "uri": "/meetings/{MeetingId}/attendees", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmeetings#CreateAttendeeError": { + "type": "structure", + "members": { + "ExternalUserId": { + "target": "com.amazonaws.chimesdkmeetings#ExternalUserId", + "traits": { + "smithy.api#documentation": "The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
" + } + }, + "ErrorCode": { + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "The error code.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "The error message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The list of errors returned when errors are encountered during the BatchCreateAttendee and CreateAttendee actions. This includes external user IDs, error codes, and error messages.
" + } + }, + "com.amazonaws.chimesdkmeetings#CreateAttendeeRequest": { + "type": "structure", + "members": { + "MeetingId": { + "target": "com.amazonaws.chimesdkmeetings#GuidString", + "traits": { + "smithy.api#documentation": "The unique ID of the meeting.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExternalUserId": { + "target": "com.amazonaws.chimesdkmeetings#ExternalUserId", + "traits": { + "smithy.api#documentation": "The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmeetings#CreateAttendeeRequestItem": { + "type": "structure", + "members": { + "ExternalUserId": { + "target": "com.amazonaws.chimesdkmeetings#ExternalUserId", + "traits": { + "smithy.api#documentation": "The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.
" + } + }, + "com.amazonaws.chimesdkmeetings#CreateAttendeeRequestItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmeetings#CreateAttendeeRequestItem" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.chimesdkmeetings#CreateAttendeeResponse": { + "type": "structure", + "members": { + "Attendee": { + "target": "com.amazonaws.chimesdkmeetings#Attendee", + "traits": { + "smithy.api#documentation": "The attendee information, including attendee ID and join token.
" + } + } + } + }, + "com.amazonaws.chimesdkmeetings#CreateMeeting": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmeetings#CreateMeetingRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmeetings#CreateMeetingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmeetings#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#LimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see \n Amazon Chime SDK Media Regions\n in the Amazon Chime Developer Guide. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK\n in the \n Amazon Chime Developer Guide.\n
", + "smithy.api#http": { + "method": "POST", + "uri": "/meetings", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmeetings#CreateMeetingRequest": { + "type": "structure", + "members": { + "ClientRequestToken": { + "target": "com.amazonaws.chimesdkmeetings#ClientRequestToken", + "traits": { + "smithy.api#documentation": "The unique identifier for the client request. Use a different token for different meetings.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "MediaRegion": { + "target": "com.amazonaws.chimesdkmeetings#MediaRegion", + "traits": { + "smithy.api#documentation": "The Region in which to create the meeting.
\n \n\n Available values: \n af-south-1\n , \n ap-northeast-1\n , \n ap-northeast-2\n , \n ap-south-1\n , \n ap-southeast-1\n , \n ap-southeast-2\n , \n ca-central-1\n , \n eu-central-1\n , \n eu-north-1\n , \n eu-south-1\n , \n eu-west-1\n , \n eu-west-2\n , \n eu-west-3\n , \n sa-east-1\n , \n us-east-1\n , \n us-east-2\n , \n us-west-1\n , \n us-west-2\n .\n
Reserved.
" + } + }, + "ExternalMeetingId": { + "target": "com.amazonaws.chimesdkmeetings#ExternalMeetingId", + "traits": { + "smithy.api#documentation": "The external meeting ID.
", + "smithy.api#required": {} + } + }, + "NotificationsConfiguration": { + "target": "com.amazonaws.chimesdkmeetings#NotificationsConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for resource targets to receive notifications when meeting and attendee events occur.
" + } + }, + "MeetingFeatures": { + "target": "com.amazonaws.chimesdkmeetings#MeetingFeaturesConfiguration", + "traits": { + "smithy.api#documentation": "Lists the audio and video features enabled for a meeting, such as echo reduction.
" + } + } + } + }, + "com.amazonaws.chimesdkmeetings#CreateMeetingResponse": { + "type": "structure", + "members": { + "Meeting": { + "target": "com.amazonaws.chimesdkmeetings#Meeting", + "traits": { + "smithy.api#documentation": "The meeting information, including the meeting ID and \n MediaPlacement.
\n Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see \n Amazon Chime SDK Media Regions\n in the Amazon Chime Developer Guide. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK\n in the Amazon Chime Developer Guide.\n
", + "smithy.api#http": { + "method": "POST", + "uri": "/meetings?operation=create-attendees", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmeetings#CreateMeetingWithAttendeesRequest": { + "type": "structure", + "members": { + "ClientRequestToken": { + "target": "com.amazonaws.chimesdkmeetings#ClientRequestToken", + "traits": { + "smithy.api#documentation": "The unique identifier for the client request. Use a different token for different meetings.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "MediaRegion": { + "target": "com.amazonaws.chimesdkmeetings#MediaRegion", + "traits": { + "smithy.api#documentation": "The Region in which to create the meeting.
", + "smithy.api#required": {} + } + }, + "MeetingHostId": { + "target": "com.amazonaws.chimesdkmeetings#ExternalUserId", + "traits": { + "smithy.api#documentation": "Reserved.
" + } + }, + "ExternalMeetingId": { + "target": "com.amazonaws.chimesdkmeetings#ExternalMeetingId", + "traits": { + "smithy.api#documentation": "The external meeting ID.
", + "smithy.api#required": {} + } + }, + "MeetingFeatures": { + "target": "com.amazonaws.chimesdkmeetings#MeetingFeaturesConfiguration", + "traits": { + "smithy.api#documentation": "Lists the audio and video features enabled for a meeting, such as echo reduction.
" + } + }, + "NotificationsConfiguration": { + "target": "com.amazonaws.chimesdkmeetings#NotificationsConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for resource targets to receive notifications when meeting and attendee events occur.
" + } + }, + "Attendees": { + "target": "com.amazonaws.chimesdkmeetings#CreateMeetingWithAttendeesRequestItemList", + "traits": { + "smithy.api#documentation": "The attendee information, including attendees' IDs and join tokens.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmeetings#CreateMeetingWithAttendeesRequestItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmeetings#CreateAttendeeRequestItem" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.chimesdkmeetings#CreateMeetingWithAttendeesResponse": { + "type": "structure", + "members": { + "Meeting": { + "target": "com.amazonaws.chimesdkmeetings#Meeting", + "traits": { + "smithy.api#documentation": "The meeting information, including the meeting ID and \n MediaPlacement.
The attendee information, including attendees' IDs and join tokens.
" + } + }, + "Errors": { + "target": "com.amazonaws.chimesdkmeetings#BatchCreateAttendeeErrorList", + "traits": { + "smithy.api#documentation": "If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.
" + } + } + } + }, + "com.amazonaws.chimesdkmeetings#DeleteAttendee": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmeetings#DeleteAttendeeRequest" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmeetings#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their \n JoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK\n in the Amazon Chime Developer Guide.
The Amazon Chime SDK meeting ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AttendeeId": { + "target": "com.amazonaws.chimesdkmeetings#GuidString", + "traits": { + "smithy.api#documentation": "The Amazon Chime SDK attendee ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmeetings#DeleteMeeting": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmeetings#DeleteMeetingRequest" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmeetings#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ForbiddenException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from \n joining the meeting. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK in the \n Amazon Chime Developer Guide.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/meetings/{MeetingId}", + "code": 204 + } + } + }, + "com.amazonaws.chimesdkmeetings#DeleteMeetingRequest": { + "type": "structure", + "members": { + "MeetingId": { + "target": "com.amazonaws.chimesdkmeetings#GuidString", + "traits": { + "smithy.api#documentation": "The Amazon Chime SDK meeting ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmeetings#EngineTranscribeMedicalSettings": { + "type": "structure", + "members": { + "LanguageCode": { + "target": "com.amazonaws.chimesdkmeetings#TranscribeMedicalLanguageCode", + "traits": { + "smithy.api#documentation": "The language code specified for the Amazon Transcribe Medical engine.
", + "smithy.api#required": {} + } + }, + "Specialty": { + "target": "com.amazonaws.chimesdkmeetings#TranscribeMedicalSpecialty", + "traits": { + "smithy.api#documentation": "The specialty specified for the Amazon Transcribe Medical engine.
", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.chimesdkmeetings#TranscribeMedicalType", + "traits": { + "smithy.api#documentation": "The type of transcription.
", + "smithy.api#required": {} + } + }, + "VocabularyName": { + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "The name of the vocabulary passed to Amazon Transcribe Medical.
" + } + }, + "Region": { + "target": "com.amazonaws.chimesdkmeetings#TranscribeMedicalRegion", + "traits": { + "smithy.api#documentation": "The AWS Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region.
" + } + }, + "ContentIdentificationType": { + "target": "com.amazonaws.chimesdkmeetings#TranscribeMedicalContentIdentificationType", + "traits": { + "smithy.api#documentation": "Set this field to PHI to identify personal health information in the transcription output.
Settings specific to the Amazon Transcribe Medical engine.
" + } + }, + "com.amazonaws.chimesdkmeetings#EngineTranscribeSettings": { + "type": "structure", + "members": { + "LanguageCode": { + "target": "com.amazonaws.chimesdkmeetings#TranscribeLanguageCode", + "traits": { + "smithy.api#documentation": "The language code specified for the Amazon Transcribe engine.
", + "smithy.api#required": {} + } + }, + "VocabularyFilterMethod": { + "target": "com.amazonaws.chimesdkmeetings#TranscribeVocabularyFilterMethod", + "traits": { + "smithy.api#documentation": "The filtering method passed to Amazon Transcribe.
" + } + }, + "VocabularyFilterName": { + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "The name of the vocabulary filter passed to Amazon Transcribe.
" + } + }, + "VocabularyName": { + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "The name of the vocabulary passed to Amazon Transcribe.
" + } + }, + "Region": { + "target": "com.amazonaws.chimesdkmeetings#TranscribeRegion", + "traits": { + "smithy.api#documentation": "The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the meeting's Region.
" + } + }, + "EnablePartialResultsStabilization": { + "target": "com.amazonaws.chimesdkmeetings#Boolean", + "traits": { + "smithy.api#documentation": "Generates partial transcription results that are less likely to change as meeting attendees speak. It does so by only allowing the last few words from the partial results to change.
" + } + }, + "PartialResultsStability": { + "target": "com.amazonaws.chimesdkmeetings#TranscribePartialResultsStability", + "traits": { + "smithy.api#documentation": "The stabity level of a partial results transcription. Determines how stable you want the transcription results to be. A higher level means the transcription results are less likely to change.
" + } + }, + "ContentIdentificationType": { + "target": "com.amazonaws.chimesdkmeetings#TranscribeContentIdentificationType", + "traits": { + "smithy.api#documentation": "Set this field to PII to identify personally identifiable information in the transcription output.
Set this field to PII to redact personally identifiable information in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.
You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException.
Lists the PII entity types you want to identify or redact. To specify entity types, you must enable ContentIdentificationType or ContentRedactionType.
PIIEntityTypes must be comma-separated. The available values are: \n BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, \n ADDRESS, NAME, PHONE, SSN, and ALL.
\n PiiEntityTypes is an optional parameter with a default value of ALL.
The name of the language model used during transcription.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings specific to the Amazon Transcribe engine.
" + } + }, + "com.amazonaws.chimesdkmeetings#ExternalMeetingId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 64 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkmeetings#ExternalUserId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 64 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkmeetings#ForbiddenException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmeetings#String" + }, + "Message": { + "target": "com.amazonaws.chimesdkmeetings#String" + }, + "RequestId": { + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "The request id associated with the call responsible for the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The client is permanently forbidden from making the request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.chimesdkmeetings#GetAttendee": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmeetings#GetAttendeeRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmeetings#GetAttendeeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmeetings#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "\n Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK\n in the Amazon Chime Developer Guide.\n
", + "smithy.api#http": { + "method": "GET", + "uri": "/meetings/{MeetingId}/attendees/{AttendeeId}", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmeetings#GetAttendeeRequest": { + "type": "structure", + "members": { + "MeetingId": { + "target": "com.amazonaws.chimesdkmeetings#GuidString", + "traits": { + "smithy.api#documentation": "The Amazon Chime SDK meeting ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AttendeeId": { + "target": "com.amazonaws.chimesdkmeetings#GuidString", + "traits": { + "smithy.api#documentation": "The Amazon Chime SDK attendee ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmeetings#GetAttendeeResponse": { + "type": "structure", + "members": { + "Attendee": { + "target": "com.amazonaws.chimesdkmeetings#Attendee", + "traits": { + "smithy.api#documentation": "The Amazon Chime SDK attendee information.
" + } + } + } + }, + "com.amazonaws.chimesdkmeetings#GetMeeting": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmeetings#GetMeetingRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmeetings#GetMeetingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmeetings#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK\n in the Amazon Chime Developer Guide.
", + "smithy.api#http": { + "method": "GET", + "uri": "/meetings/{MeetingId}", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmeetings#GetMeetingRequest": { + "type": "structure", + "members": { + "MeetingId": { + "target": "com.amazonaws.chimesdkmeetings#GuidString", + "traits": { + "smithy.api#documentation": "The Amazon Chime SDK meeting ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmeetings#GetMeetingResponse": { + "type": "structure", + "members": { + "Meeting": { + "target": "com.amazonaws.chimesdkmeetings#Meeting", + "traits": { + "smithy.api#documentation": "The Amazon Chime SDK meeting information.
" + } + } + } + }, + "com.amazonaws.chimesdkmeetings#GuidString": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$" + } + }, + "com.amazonaws.chimesdkmeetings#JoinTokenString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkmeetings#LimitExceededException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmeetings#String" + }, + "Message": { + "target": "com.amazonaws.chimesdkmeetings#String" + }, + "RequestId": { + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "The request id associated with the call responsible for the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request exceeds the resource limit.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.chimesdkmeetings#ListAttendees": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmeetings#ListAttendeesRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmeetings#ListAttendeesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmeetings#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "\n Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK\n in the Amazon Chime Developer Guide.\n
", + "smithy.api#http": { + "method": "GET", + "uri": "/meetings/{MeetingId}/attendees", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chimesdkmeetings#ListAttendeesRequest": { + "type": "structure", + "members": { + "MeetingId": { + "target": "com.amazonaws.chimesdkmeetings#GuidString", + "traits": { + "smithy.api#documentation": "The Amazon Chime SDK meeting ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "The token to use to retrieve the next page of results.
", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.chimesdkmeetings#ResultMax", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in a single call.
", + "smithy.api#httpQuery": "max-results" + } + } + } + }, + "com.amazonaws.chimesdkmeetings#ListAttendeesResponse": { + "type": "structure", + "members": { + "Attendees": { + "target": "com.amazonaws.chimesdkmeetings#AttendeeList", + "traits": { + "smithy.api#documentation": "The Amazon Chime SDK attendee information.
" + } + }, + "NextToken": { + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "The token to use to retrieve the next page of results.
" + } + } + } + }, + "com.amazonaws.chimesdkmeetings#MediaPlacement": { + "type": "structure", + "members": { + "AudioHostUrl": { + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "The audio host URL.
" + } + }, + "AudioFallbackUrl": { + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "The audio fallback URL.
" + } + }, + "SignalingUrl": { + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "The signaling URL.
" + } + }, + "TurnControlUrl": { + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "The turn control URL.
" + } + }, + "ScreenDataUrl": { + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "The screen data URL.
" + } + }, + "ScreenViewingUrl": { + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "The screen viewing URL.
" + } + }, + "ScreenSharingUrl": { + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "The screen sharing URL.
" + } + }, + "EventIngestionUrl": { + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "The event ingestion URL.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.
" + } + }, + "com.amazonaws.chimesdkmeetings#MediaRegion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 64 + } + } + }, + "com.amazonaws.chimesdkmeetings#Meeting": { + "type": "structure", + "members": { + "MeetingId": { + "target": "com.amazonaws.chimesdkmeetings#GuidString", + "traits": { + "smithy.api#documentation": "The Amazon Chime SDK meeting ID.
" + } + }, + "MeetingHostId": { + "target": "com.amazonaws.chimesdkmeetings#ExternalUserId", + "traits": { + "smithy.api#documentation": "Reserved.
" + } + }, + "ExternalMeetingId": { + "target": "com.amazonaws.chimesdkmeetings#ExternalMeetingId", + "traits": { + "smithy.api#documentation": "The external meeting ID.
" + } + }, + "MediaRegion": { + "target": "com.amazonaws.chimesdkmeetings#MediaRegion", + "traits": { + "smithy.api#documentation": "The Region in which you create the meeting. Available values: af-south-1, ap-northeast-1, \n ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, \n eu-central-1, eu-north-1, eu-south-1,\n eu-west-1, eu-west-2, eu-west-3,\n sa-east-1, us-east-1, us-east-2,\n us-west-1, us-west-2.
The media placement for the meeting.
" + } + }, + "MeetingFeatures": { + "target": "com.amazonaws.chimesdkmeetings#MeetingFeaturesConfiguration", + "traits": { + "smithy.api#documentation": "The features available to a meeting, such as Amazon Voice Focus.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A meeting created using the Amazon Chime SDK.
" + } + }, + "com.amazonaws.chimesdkmeetings#MeetingFeatureStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AVAILABLE", + "name": "AVAILABLE" + }, + { + "value": "UNAVAILABLE", + "name": "UNAVAILABLE" + } + ] + } + }, + "com.amazonaws.chimesdkmeetings#MeetingFeaturesConfiguration": { + "type": "structure", + "members": { + "Audio": { + "target": "com.amazonaws.chimesdkmeetings#AudioFeatures", + "traits": { + "smithy.api#documentation": "The configuration settings for the audio features available to a meeting.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration settings of the features available to a meeting.
" + } + }, + "com.amazonaws.chimesdkmeetings#NotFoundException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmeetings#String" + }, + "Message": { + "target": "com.amazonaws.chimesdkmeetings#String" + }, + "RequestId": { + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "The request id associated with the call responsible for the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "One or more of the resources in the request does not exist in the system.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.chimesdkmeetings#NotificationsConfiguration": { + "type": "structure", + "members": { + "LambdaFunctionArn": { + "target": "com.amazonaws.chimesdkmeetings#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the AWS Lambda function in the notifications configuration.
" + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.chimesdkmeetings#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the SNS topic.
" + } + }, + "SqsQueueArn": { + "target": "com.amazonaws.chimesdkmeetings#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the SQS queue.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for resource targets to receive notifications when meeting and attendee events occur.
" + } + }, + "com.amazonaws.chimesdkmeetings#ResultMax": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.chimesdkmeetings#RetryAfterSeconds": { + "type": "string" + }, + "com.amazonaws.chimesdkmeetings#ServiceUnavailableException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmeetings#String" + }, + "Message": { + "target": "com.amazonaws.chimesdkmeetings#String" + }, + "RequestId": { + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "The request id associated with the call responsible for the exception.
" + } + }, + "RetryAfterSeconds": { + "target": "com.amazonaws.chimesdkmeetings#RetryAfterSeconds", + "traits": { + "smithy.api#documentation": "The number of seconds the caller should wait before retrying.
", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "The service is currently unavailable.
", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, + "com.amazonaws.chimesdkmeetings#StartMeetingTranscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmeetings#StartMeetingTranscriptionRequest" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmeetings#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#LimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#UnauthorizedException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#UnprocessableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "Starts transcription for the specified meetingId.
The unique ID of the meeting being transcribed.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TranscriptionConfiguration": { + "target": "com.amazonaws.chimesdkmeetings#TranscriptionConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for the current transcription operation. Must contain EngineTranscribeSettings or \n EngineTranscribeMedicalSettings.
Stops transcription for the specified meetingId.
The unique ID of the meeting for which you stop transcription.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmeetings#String": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.chimesdkmeetings#TranscribeContentIdentificationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PII", + "name": "PII" + } + ] + } + }, + "com.amazonaws.chimesdkmeetings#TranscribeContentRedactionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PII", + "name": "PII" + } + ] + } + }, + "com.amazonaws.chimesdkmeetings#TranscribeLanguageCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "en-US", + "name": "EN_US" + }, + { + "value": "en-GB", + "name": "EN_GB" + }, + { + "value": "es-US", + "name": "ES_US" + }, + { + "value": "fr-CA", + "name": "FR_CA" + }, + { + "value": "fr-FR", + "name": "FR_FR" + }, + { + "value": "en-AU", + "name": "EN_AU" + }, + { + "value": "it-IT", + "name": "IT_IT" + }, + { + "value": "de-DE", + "name": "DE_DE" + }, + { + "value": "pt-BR", + "name": "PT_BR" + }, + { + "value": "ja-JP", + "name": "JA_JP" + }, + { + "value": "ko-KR", + "name": "KO_KR" + }, + { + "value": "zh-CN", + "name": "ZH_CN" + } + ] + } + }, + "com.amazonaws.chimesdkmeetings#TranscribeLanguageModelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[0-9a-zA-Z._-]+$" + } + }, + "com.amazonaws.chimesdkmeetings#TranscribeMedicalContentIdentificationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PHI", + "name": "PHI" + } + ] + } + }, + "com.amazonaws.chimesdkmeetings#TranscribeMedicalLanguageCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "en-US", + "name": "EN_US" + } + ] + } + }, + "com.amazonaws.chimesdkmeetings#TranscribeMedicalRegion": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "us-east-1", + "name": "US_EAST_1" + }, + { + "value": "us-east-2", + "name": "US_EAST_2" + }, + { + "value": "us-west-2", + "name": "US_WEST_2" + }, + { + "value": "ap-southeast-2", + "name": "AP_SOUTHEAST_2" + }, + { + "value": "ca-central-1", + "name": "CA_CENTRAL_1" + }, + { + "value": "eu-west-1", + "name": "EU_WEST_1" + }, + { + "value": "auto", + "name": "AUTO" + } + ] + } + }, + "com.amazonaws.chimesdkmeetings#TranscribeMedicalSpecialty": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PRIMARYCARE", + "name": "PRIMARYCARE" + }, + { + "value": "CARDIOLOGY", + "name": "CARDIOLOGY" + }, + { + "value": "NEUROLOGY", + "name": "NEUROLOGY" + }, + { + "value": "ONCOLOGY", + "name": "ONCOLOGY" + }, + { + "value": "RADIOLOGY", + "name": "RADIOLOGY" + }, + { + "value": "UROLOGY", + "name": "UROLOGY" + } + ] + } + }, + "com.amazonaws.chimesdkmeetings#TranscribeMedicalType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CONVERSATION", + "name": "CONVERSATION" + }, + { + "value": "DICTATION", + "name": "DICTATION" + } + ] + } + }, + "com.amazonaws.chimesdkmeetings#TranscribePartialResultsStability": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "low", + "name": "LOW" + }, + { + "value": "medium", + "name": "MEDIUM" + }, + { + "value": "high", + "name": "HIGH" + } + ] + } + }, + "com.amazonaws.chimesdkmeetings#TranscribePiiEntityTypes": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + }, + "smithy.api#pattern": "^[A-Z_, ]+$" + } + }, + "com.amazonaws.chimesdkmeetings#TranscribeRegion": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "us-east-2", + "name": "US_EAST_2" + }, + { + "value": "us-east-1", + "name": "US_EAST_1" + }, + { + "value": "us-west-2", + "name": "US_WEST_2" + }, + { + "value": "ap-northeast-2", + "name": "AP_NORTHEAST_2" + }, + { + "value": "ap-southeast-2", + "name": "AP_SOUTHEAST_2" + }, + { + "value": "ap-northeast-1", + "name": "AP_NORTHEAST_1" + }, + { + "value": "ca-central-1", + "name": "CA_CENTRAL_1" + }, + { + "value": "eu-central-1", + "name": "EU_CENTRAL_1" + }, + { + "value": "eu-west-1", + "name": "EU_WEST_1" + }, + { + "value": "eu-west-2", + "name": "EU_WEST_2" + }, + { + "value": "sa-east-1", + "name": "SA_EAST_1" + }, + { + "value": "auto", + "name": "AUTO" + } + ] + } + }, + "com.amazonaws.chimesdkmeetings#TranscribeVocabularyFilterMethod": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "remove", + "name": "REMOVE" + }, + { + "value": "mask", + "name": "MASK" + }, + { + "value": "tag", + "name": "TAG" + } + ] + } + }, + "com.amazonaws.chimesdkmeetings#TranscriptionConfiguration": { + "type": "structure", + "members": { + "EngineTranscribeSettings": { + "target": "com.amazonaws.chimesdkmeetings#EngineTranscribeSettings", + "traits": { + "smithy.api#documentation": "The transcription configuration settings passed to Amazon Transcribe.
" + } + }, + "EngineTranscribeMedicalSettings": { + "target": "com.amazonaws.chimesdkmeetings#EngineTranscribeMedicalSettings", + "traits": { + "smithy.api#documentation": "The transcription configuration settings passed to Amazon Transcribe Medical.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for the current transcription operation. Must contain EngineTranscribeSettings or EngineTranscribeMedicalSettings.
The request id associated with the call responsible for the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The user isn't authorized to request a resource.
", + "smithy.api#error": "client", + "smithy.api#httpError": 401 + } + }, + "com.amazonaws.chimesdkmeetings#UnprocessableEntityException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmeetings#String" + }, + "Message": { + "target": "com.amazonaws.chimesdkmeetings#String" + }, + "RequestId": { + "target": "com.amazonaws.chimesdkmeetings#String", + "traits": { + "smithy.api#documentation": "The request id associated with the call responsible for the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request was well-formed but was unable to be followed due to semantic errors.
", + "smithy.api#error": "client", + "smithy.api#httpError": 422 + } + } + } +} diff --git a/aws/sdk/aws-models/cloudformation.json b/aws/sdk/aws-models/cloudformation.json index 5bc1a623ae0e580d49805fc03401a97e074c7ef3..71c44d2c7d49bedc5c23a57857e1e6d8e1bd3cfc 100644 --- a/aws/sdk/aws-models/cloudformation.json +++ b/aws/sdk/aws-models/cloudformation.json @@ -47,18 +47,18 @@ "Status": { "target": "com.amazonaws.cloudformation#AccountGateStatus", "traits": { - "smithy.api#documentation": "The status of the account gate function.
\n\n SUCCEEDED: The account gate function has determined that the\n account and Region passes any requirements for a stack set operation to occur.\n CloudFormation proceeds with the stack operation in that account and Region.\n
\n FAILED: The account gate function has determined that the account\n and Region does not meet the requirements for a stack set operation to occur. AWS\n CloudFormation cancels the stack set operation in that account and Region, and sets\n the stack set operation result status for that account and Region to\n FAILED.
\n SKIPPED: CloudFormation has skipped calling the account gate\n function for this account and Region, for one of the following reasons:
An account gate function has not been specified for the account and\n Region. CloudFormation proceeds with the stack set operation in this\n account and Region.
\nThe AWSCloudFormationStackSetExecutionRole of the stack set\n adminstration account lacks permissions to invoke the function.\n CloudFormation proceeds with the stack set operation in this account and\n Region.
Either no action is necessary, or no action is possible, on the stack.\n CloudFormation skips the stack set operation in this account and\n Region.
\nThe status of the account gate function.
\n\n SUCCEEDED: The account gate function has determined that the account\n and Region passes any requirements for a stack set operation to occur. CloudFormation proceeds with the stack operation in that account and Region.\n
\n FAILED: The account gate function has determined that the account and\n Region does not meet the requirements for a stack set operation to occur. AWS CloudFormation cancels the stack set operation in that account and Region, and\n sets the stack set operation result status for that account and Region to\n FAILED.
\n SKIPPED: CloudFormation has skipped calling the account gate\n function for this account and Region, for one of the following reasons:
An account gate function has not been specified for the account and Region.\n CloudFormation proceeds with the stack set operation in this account\n and Region.
\nThe AWSCloudFormationStackSetExecutionRole of the stack set\n adminstration account lacks permissions to invoke the function. CloudFormation proceeds with the stack set operation in this account and\n Region.
Either no action is necessary, or no action is possible, on the stack.\n CloudFormation skips the stack set operation in this account and\n Region.
\nThe reason for the account gate status assigned to this account and Region for the\n stack set operation.
" + "smithy.api#documentation": "The reason for the account gate status assigned to this account and Region for the stack\n set operation.
" } } }, "traits": { - "smithy.api#documentation": "Structure that contains the results of the account gate function which CloudFormation invokes, if present, before proceeding with a stack set operation in an\n account and Region.
\nFor each account and Region, CloudFormation lets you specify a Lambda\n function that encapsulates any requirements that must be met before CloudFormation\n can proceed with a stack set operation in that account and Region. CloudFormation\n invokes the function each time a stack set operation is requested for that account and\n Region; if the function returns FAILED, CloudFormation cancels the\n operation in that account and Region, and sets the stack set operation result status for\n that account and Region to FAILED.
For more information, see Configuring a\n target account gate.
" + "smithy.api#documentation": "Structure that contains the results of the account gate function which CloudFormation invokes, if present, before proceeding with a stack set operation in an\n account and Region.
\nFor each account and Region, CloudFormation lets you specify a Lambda function\n that encapsulates any requirements that must be met before CloudFormation can\n proceed with a stack set operation in that account and Region. CloudFormation\n invokes the function each time a stack set operation is requested for that account and\n Region; if the function returns FAILED, CloudFormation cancels the\n operation in that account and Region, and sets the stack set operation result status for\n that account and Region to FAILED.
For more information, see Configuring a\n target account gate.
" } }, "com.amazonaws.cloudformation#AccountGateStatus": { @@ -423,7 +423,7 @@ } ], "traits": { - "smithy.api#documentation": "Cancels an update on the specified stack. If the call completes successfully, the\n stack rolls back the update and reverts to the previous stack configuration.
\nYou can cancel only stacks that are in the UPDATE_IN_PROGRESS state.
\nCancels an update on the specified stack. If the call completes successfully, the stack\n rolls back the update and reverts to the previous stack configuration.
\nYou can cancel only stacks that are in the UPDATE_IN_PROGRESS state.
\nA unique identifier for this CancelUpdateStack request. Specify this\n token if you plan to retry requests so that CloudFormation knows that you're not\n attempting to cancel an update on a stack with the same name. You might retry\n CancelUpdateStack requests to ensure that CloudFormation successfully\n received them.
A unique identifier for this CancelUpdateStack request. Specify this token\n if you plan to retry requests so that CloudFormation knows that you're not\n attempting to cancel an update on a stack with the same name. You might retry\n CancelUpdateStack requests to ensure that CloudFormation\n successfully received them.
A ResourceChange structure that describes the resource and action that\n CloudFormation will perform.
A ResourceChange structure that describes the resource and action that\n CloudFormation will perform.
The specified change set name or ID doesn't exit. To view valid change sets for a\n stack, use the ListChangeSets action.
The specified change set name or ID doesn't exit. To view valid change sets for a stack,\n use the ListChangeSets action.
If the change set execution status is AVAILABLE, you can execute the\n change set. If you can’t execute the change set, the status indicates why. For example, a\n change set might be in an UNAVAILABLE state because CloudFormation is\n still creating it or in an OBSOLETE state because the stack was already\n updated.
If the change set execution status is AVAILABLE, you can execute the change\n set. If you can’t execute the change set, the status indicates why. For example, a change\n set might be in an UNAVAILABLE state because CloudFormation is still\n creating it or in an OBSOLETE state because the stack was already\n updated.
The ChangeSetSummary structure describes a change set, its status, and\n the stack with which it's associated.
The ChangeSetSummary structure describes a change set, its status, and the\n stack with which it's associated.
CloudFormation allows you to create and manage Amazon Web Services infrastructure\n deployments predictably and repeatedly. You can use CloudFormation to leverage\n Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block\n Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to\n build highly-reliable, highly scalable, cost-effective applications without creating or\n configuring the underlying Amazon Web Services infrastructure.
\nWith CloudFormation, you declare all of your resources and dependencies in a\n template file. The template defines a collection of resources as a single unit called a\n stack. CloudFormation creates and deletes all member resources of the stack\n together and manages all dependencies between the resources for you.
\nFor more information about CloudFormation, see the CloudFormation Product Page.
\nCloudFormation makes use of other Amazon Web Services products. If you need\n additional technical information about a specific Amazon Web Services product, you can find\n the product's technical documentation at \n docs.aws.amazon.com\n .
CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments\n predictably and repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such\n as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification\n Service, Elastic Load Balancing, and Auto Scaling to build highly-reliable, highly\n scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services\n infrastructure.
\nWith CloudFormation, you declare all of your resources and dependencies in a\n template file. The template defines a collection of resources as a single unit called a\n stack. CloudFormation creates and deletes all member resources of the stack together\n and manages all dependencies between the resources for you.
\nFor more information about CloudFormation, see the CloudFormation Product Page.
\nCloudFormation makes use of other Amazon Web Services products. If you need additional\n technical information about a specific Amazon Web Services product, you can find the product's technical\n documentation at \n docs.aws.amazon.com\n .
For a specified stack that is in the UPDATE_ROLLBACK_FAILED state,\n continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on\n the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can\n return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and\n then try to update the stack again.
A stack goes into the UPDATE_ROLLBACK_FAILED state when\n CloudFormation cannot roll back all changes after a failed stack update. For example, you\n might have a stack that is rolling back to an old database instance that was deleted\n outside of CloudFormation. Because CloudFormation doesn't know the database was\n deleted, it assumes that the database instance still exists and attempts to roll back to\n it, causing the update rollback to fail.
For a specified stack that is in the UPDATE_ROLLBACK_FAILED state,\n continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on\n the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can\n return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and\n then try to update the stack again.
A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation cannot roll back all changes after a failed stack update. For example,\n you might have a stack that is rolling back to an old database instance that was deleted\n outside of CloudFormation. Because CloudFormation doesn't know the database\n was deleted, it assumes that the database instance still exists and attempts to roll back\n to it, causing the update rollback to fail.
The name or the unique ID of the stack that you want to continue rolling\n back.
\nDon't specify the name of a nested stack (a stack that was created by using the\n AWS::CloudFormation::Stack resource). Instead, use this operation on the\n parent stack (the stack that contains the AWS::CloudFormation::Stack\n resource).
The name or the unique ID of the stack that you want to continue rolling back.
\nDon't specify the name of a nested stack (a stack that was created by using the\n AWS::CloudFormation::Stack resource). Instead, use this operation on the\n parent stack (the stack that contains the AWS::CloudFormation::Stack\n resource).
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role\n that CloudFormation assumes to roll back the stack. CloudFormation uses the role's\n credentials to make calls on your behalf. CloudFormation always uses this role for all\n future operations on the stack. As long as users have permission to operate on the stack,\n CloudFormation uses this role even if the users don't have permission to pass it.\n Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously\n associated with the stack. If no role is available, CloudFormation uses a temporary\n session that is generated from your user credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to roll back the stack. CloudFormation uses the role's\n credentials to make calls on your behalf. CloudFormation always uses this role for\n all future operations on the stack. As long as users have permission to operate on the\n stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously\n associated with the stack. If no role is available, CloudFormation uses a temporary\n session that is generated from your user credentials.
" } }, "ResourcesToSkip": { @@ -1085,7 +1085,7 @@ "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique identifier for this ContinueUpdateRollback request. Specify\n this token if you plan to retry requests so that CloudFormationknows that you're not\n attempting to continue the rollback to a stack with the same name. You might retry\n ContinueUpdateRollback requests to ensure that CloudFormation\n successfully received them.
A unique identifier for this ContinueUpdateRollback request. Specify this\n token if you plan to retry requests so that CloudFormationknows that you're not\n attempting to continue the rollback to a stack with the same name. You might retry\n ContinueUpdateRollback requests to ensure that CloudFormation\n successfully received them.
Creates a list of changes that will be applied to a stack so that you can review the\n changes before executing them. You can create a change set for a stack that doesn't exist\n or an existing stack. If you create a change set for a stack that doesn't exist, the change\n set shows all of the resources that CloudFormation will create. If you create a change\n set for an existing stack, CloudFormation compares the stack's information with the\n information that you submit in the change set and lists the differences. Use change sets to\n understand which resources CloudFormation will create or change, and how it will change\n resources in an existing stack, before you create or update a stack.
\nTo create a change set for a stack that doesn't exist, for the\n ChangeSetType parameter, specify CREATE. To create a change\n set for an existing stack, specify UPDATE for the ChangeSetType\n parameter. To create a change set for an import operation, specify IMPORT for\n the ChangeSetType parameter. After the CreateChangeSet call\n successfully completes, CloudFormation starts creating the change set. To check the\n status of the change set or to review it, use the DescribeChangeSet\n action.
When you are satisfied with the changes the change set will make, execute the change\n set by using the ExecuteChangeSet action. CloudFormation doesn't make\n changes until you execute the change set.
\nTo create a change set for the entire stack hierachy, set\n IncludeNestedStacks to True.
Creates a list of changes that will be applied to a stack so that you can review the\n changes before executing them. You can create a change set for a stack that doesn't exist\n or an existing stack. If you create a change set for a stack that doesn't exist, the change\n set shows all of the resources that CloudFormation will create. If you create a\n change set for an existing stack, CloudFormation compares the stack's information\n with the information that you submit in the change set and lists the differences. Use\n change sets to understand which resources CloudFormation will create or change, and\n how it will change resources in an existing stack, before you create or update a\n stack.
\nTo create a change set for a stack that doesn't exist, for the\n ChangeSetType parameter, specify CREATE. To create a change\n set for an existing stack, specify UPDATE for the ChangeSetType\n parameter. To create a change set for an import operation, specify IMPORT for\n the ChangeSetType parameter. After the CreateChangeSet call\n successfully completes, CloudFormation starts creating the change set. To check the\n status of the change set or to review it, use the DescribeChangeSet\n action.
When you are satisfied with the changes the change set will make, execute the change set\n by using the ExecuteChangeSet action. CloudFormation doesn't make\n changes until you execute the change set.
\nTo create a change set for the entire stack hierachy, set\n IncludeNestedStacks to True.
The name or the unique ID of the stack for which you are creating a change set.\n CloudFormation generates the change set by comparing this stack's information with the\n information that you submit, such as a modified template or different parameter input\n values.
", + "smithy.api#documentation": "The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the change set by comparing this stack's information with the\n information that you submit, such as a modified template or different parameter input\n values.
", "smithy.api#required": {} } }, "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "A structure that contains the body of the revised template, with a minimum length of\n 1 byte and a maximum length of 51,200 bytes. CloudFormation generates the change set by\n comparing this template with the template of the stack that you specified.
\nConditional: You must specify only TemplateBody or\n TemplateURL.
A structure that contains the body of the revised template, with a minimum length of 1\n byte and a maximum length of 51,200 bytes. CloudFormation generates the change set\n by comparing this template with the template of the stack that you specified.
\nConditional: You must specify only TemplateBody or\n TemplateURL.
The location of the file that contains the revised template. The URL must point to a\n template (max size: 460,800 bytes) that is located in an S3 bucket or a Systems Manager\n document. CloudFormation generates the change set by comparing this template with the\n stack that you specified.
\nConditional: You must specify only TemplateBody or\n TemplateURL.
The location of the file that contains the revised template. The URL must point to a\n template (max size: 460,800 bytes) that is located in an S3 bucket or a Systems Manager\n document. CloudFormation generates the change set by comparing this template with\n the stack that you specified.
\nConditional: You must specify only TemplateBody or\n TemplateURL.
A list of Parameter structures that specify input parameters for the\n change set. For more information, see the Parameter data type.
A list of Parameter structures that specify input parameters for the change\n set. For more information, see the Parameter data type.
In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to create the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in\n your Amazon Web Services account; for example, by creating new Identity and Access Management\n (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one\n of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM\n capability.
If you have IAM resources, you can specify either\n capability.
\nIf you have IAM resources with custom names, you\n must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review\n all permissions associated with them and edit their permissions if\n necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this\n can include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change\n set from the processed template, so that they can review the changes resulting from\n the macros before actually creating the stack. If your stack template contains one or\n more macros, and you choose to create a stack directly from the processed template,\n without first reviewing the resulting changes in a change set, you must acknowledge\n this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
\nThis capacity does not apply to creating change sets, and specifying it when\n creating change sets has no effect.
\nIf you want to create a stack from a stack template that contains macros\n and nested stacks, you must create or update the stack\n directly from the template using the CreateStack or UpdateStack action, and specifying this capability.
\nFor more information on macros, see Using CloudFormation Macros to\n Perform Custom Processing on Templates.
\nIn some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to create the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new Identity and Access Management\n (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one\n of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM\n capability.
If you have IAM resources, you can specify either\n capability.
\nIf you have IAM resources with custom names, you\n must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all\n permissions associated with them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this\n can include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change\n set from the processed template, so that they can review the changes resulting from\n the macros before actually creating the stack. If your stack template contains one or\n more macros, and you choose to create a stack directly from the processed template,\n without first reviewing the resulting changes in a change set, you must acknowledge\n this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
\nThis capacity does not apply to creating change sets, and specifying it when\n creating change sets has no effect.
\nIf you want to create a stack from a stack template that contains macros\n and nested stacks, you must create or update the stack\n directly from the template using the CreateStack or UpdateStack action, and specifying this capability.
\nFor more information on macros, see Using CloudFormation Macros to\n Perform Custom Processing on Templates.
\nThe template resource types that you have permissions to work with if you execute\n this change set, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance.
If the list of resource types doesn't include a resource type that you're updating,\n the stack update fails. By default, CloudFormation grants permissions to all resource\n types. Identity and Access Management (IAM) uses this parameter for condition keys in\n IAM policies for CloudFormation. For more information, see Controlling Access with\n Identity and Access Management in the CloudFormation User\n Guide.
" + "smithy.api#documentation": "The template resource types that you have permissions to work with if you execute this\n change set, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance.
If the list of resource types doesn't include a resource type that you're updating, the\n stack update fails. By default, CloudFormation grants permissions to all resource\n types. Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies\n for CloudFormation. For more information, see Controlling Access with\n Identity and Access Management in the CloudFormation User Guide.
" } }, "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role\n that CloudFormation assumes when executing the change set. CloudFormation uses the\n role's credentials to make calls on your behalf. CloudFormation uses this role for all\n future operations on the stack. As long as users have permission to operate on the stack,\n CloudFormation uses this role even if the users don't have permission to pass it.\n Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously\n associated with the stack. If no role is available, CloudFormation uses a temporary\n session that is generated from your user credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role\n that CloudFormation assumes when executing the change set. CloudFormation\n uses the role's credentials to make calls on your behalf. CloudFormation uses this\n role for all future operations on the stack. As long as users have permission to operate on\n the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously\n associated with the stack. If no role is available, CloudFormation uses a temporary\n session that is generated from your user credentials.
" } }, "RollbackConfiguration": { @@ -1196,14 +1196,14 @@ "ChangeSetName": { "target": "com.amazonaws.cloudformation#ChangeSetName", "traits": { - "smithy.api#documentation": "The name of the change set. The name must be unique among all change sets that are\n associated with the specified stack.
\nA change set name can contain only alphanumeric, case sensitive characters and\n hyphens. It must start with an alphabetic character and cannot exceed 128\n characters.
", + "smithy.api#documentation": "The name of the change set. The name must be unique among all change sets that are\n associated with the specified stack.
\nA change set name can contain only alphanumeric, case sensitive characters and hyphens.\n It must start with an alphabetic character and cannot exceed 128 characters.
", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.cloudformation#ClientToken", "traits": { - "smithy.api#documentation": "A unique identifier for this CreateChangeSet request. Specify this token\n if you plan to retry requests so that CloudFormation knows that you're not attempting\n to create another change set with the same name. You might retry\n CreateChangeSet requests to ensure that CloudFormation successfully\n received them.
A unique identifier for this CreateChangeSet request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting\n to create another change set with the same name. You might retry\n CreateChangeSet requests to ensure that CloudFormation successfully\n received them.
The type of change set operation. To create a change set for a new stack, specify\n CREATE. To create a change set for an existing stack, specify\n UPDATE. To create a change set for an import operation, specify\n IMPORT.
If you create a change set for a new stack, CloudFormation creates a stack with a\n unique stack ID, but no template or resources. The stack will be in the \n REVIEW_IN_PROGRESS\n state until you execute the change\n set.
By default, CloudFormation specifies UPDATE. You can't use the\n UPDATE type to create a change set for a new stack or the\n CREATE type to create a change set for an existing stack.
The type of change set operation. To create a change set for a new stack, specify\n CREATE. To create a change set for an existing stack, specify\n UPDATE. To create a change set for an import operation, specify\n IMPORT.
If you create a change set for a new stack, CloudFormation creates a stack with\n a unique stack ID, but no template or resources. The stack will be in the \n REVIEW_IN_PROGRESS\n state until you execute the change\n set.
By default, CloudFormation specifies UPDATE. You can't use the\n UPDATE type to create a change set for a new stack or the\n CREATE type to create a change set for an existing stack.
Creates a stack as specified in the template. After the call completes successfully,\n the stack creation starts. You can check the status of the stack via the DescribeStacks API.
" + "smithy.api#documentation": "Creates a stack as specified in the template. After the call completes successfully, the\n stack creation starts. You can check the status of the stack via the DescribeStacks API.
" } }, "com.amazonaws.cloudformation#CreateStackInput": { @@ -1306,13 +1306,13 @@ "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "A list of Parameter structures that specify input parameters for the\n stack. For more information, see the Parameter data\n type.
A list of Parameter structures that specify input parameters for the stack.\n For more information, see the Parameter data\n type.
Set to true to disable rollback of the stack if stack creation failed.\n You can specify either DisableRollback or OnFailure, but not\n both.
Default: false\n
Set to true to disable rollback of the stack if stack creation failed. You\n can specify either DisableRollback or OnFailure, but not\n both.
Default: false\n
In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to create the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in\n your Amazon Web Services account; for example, by creating new Identity and Access Management\n (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one\n of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM\n capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review\n all permissions associated with them and edit their permissions if\n necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this\n can include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change\n set from the processed template, so that they can review the changes resulting from\n the macros before actually creating the stack. If your stack template contains one or\n more macros, and you choose to create a stack directly from the processed template,\n without first reviewing the resulting changes in a change set, you must acknowledge\n this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
\nIf you want to create a stack from a stack template that contains macros\n and nested stacks, you must create the stack directly from\n the template using this capability.
\nYou should only create stacks directly from a stack template that contains\n macros if you know what processing the macro performs.
\nEach macro relies on an underlying Lambda service function for processing stack\n templates. Be aware that the Lambda function owner can update the function\n operation without CloudFormation being notified.
\nFor more information, see Using\n CloudFormation Macros to Perform Custom Processing on\n Templates.
\nIn some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to create the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new Identity and Access Management\n (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one\n of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM\n capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all\n permissions associated with them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this\n can include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change\n set from the processed template, so that they can review the changes resulting from\n the macros before actually creating the stack. If your stack template contains one or\n more macros, and you choose to create a stack directly from the processed template,\n without first reviewing the resulting changes in a change set, you must acknowledge\n this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
\nIf you want to create a stack from a stack template that contains macros\n and nested stacks, you must create the stack directly from\n the template using this capability.
\nYou should only create stacks directly from a stack template that contains\n macros if you know what processing the macro performs.
\nEach macro relies on an underlying Lambda service function for processing stack\n templates. Be aware that the Lambda function owner can update the function\n operation without CloudFormation being notified.
\nFor more information, see Using\n CloudFormation Macros to Perform Custom Processing on\n Templates.
\nThe template resource types that you have permissions to work with for this create\n stack action, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance. Use the following syntax to describe template\n resource types: AWS::* (for all Amazon Web Services resources),\n Custom::* (for all custom resources),\n Custom::logical_ID\n (for a specific custom resource),\n AWS::service_name::* (for all resources of a\n particular Amazon Web Services service), and\n AWS::service_name::resource_logical_ID\n (for a specific Amazon Web Services resource).
If the list of resource types doesn't include a resource that you're creating, the\n stack creation fails. By default, CloudFormation grants permissions to all resource\n types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
" + "smithy.api#documentation": "The template resource types that you have permissions to work with for this create stack\n action, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance. Use the following syntax to describe template\n resource types: AWS::* (for all Amazon Web Services resources),\n Custom::* (for all custom resources),\n Custom::logical_ID\n (for a specific custom resource),\n AWS::service_name::* (for all resources of a\n particular Amazon Web Services service), and\n AWS::service_name::resource_logical_ID\n (for a specific Amazon Web Services resource).
If the list of resource types doesn't include a resource that you're creating, the stack\n creation fails. By default, CloudFormation grants permissions to all resource\n types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific\n condition keys in IAM policies. For more information, see Controlling Access with\n Identity and Access Management.
" } }, "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role\n that CloudFormation assumes to create the stack. CloudFormation uses the role's\n credentials to make calls on your behalf. CloudFormation always uses this role for all\n future operations on the stack. As long as users have permission to operate on the stack,\n CloudFormation uses this role even if the users don't have permission to pass it.\n Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously\n associated with the stack. If no role is available, CloudFormation uses a temporary\n session that is generated from your user credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to create the stack. CloudFormation uses the role's\n credentials to make calls on your behalf. CloudFormation always uses this role for\n all future operations on the stack. As long as users have permission to operate on the\n stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously\n associated with the stack. If no role is available, CloudFormation uses a temporary\n session that is generated from your user credentials.
" } }, "OnFailure": { @@ -1360,13 +1360,13 @@ "StackPolicyBody": { "target": "com.amazonaws.cloudformation#StackPolicyBody", "traits": { - "smithy.api#documentation": "Structure containing the stack policy body. For more information, go to Prevent Updates\n to Stack Resources in the CloudFormation User Guide.\n You can specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.
Structure containing the stack policy body. For more information, go to Prevent Updates\n to Stack Resources in the CloudFormation User\n Guide. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy\n (maximum size: 16 KB) located in an S3 bucket in the same\n Region as the stack. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (maximum\n size: 16 KB) located in an S3 bucket in the same Region as the stack. You can specify\n either the StackPolicyBody or the StackPolicyURL parameter, but\n not both.
A unique identifier for this CreateStack request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to\n create a stack with the same name. You might retry CreateStack requests to\n ensure that CloudFormation successfully received them.
All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab.\n Stack operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the\n stack operation . For example, if you create a stack using the console, each stack event\n would be assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
A unique identifier for this CreateStack request. Specify this token if you\n plan to retry requests so that CloudFormation knows that you're not attempting to\n create a stack with the same name. You might retry CreateStack requests to\n ensure that CloudFormation successfully received them.
All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab.\n Stack operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the\n stack operation . For example, if you create a stack using the console, each stack event\n would be assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
Creates stack instances for the specified accounts, within the specified Regions. A\n stack instance refers to a stack in a specific account and Region. You must specify at least one value for either Accounts or DeploymentTargets, and you must specify at least one value for Regions.
Creates stack instances for the specified accounts, within the specified Regions. A\n stack instance refers to a stack in a specific account and Region. You must specify at\n least one value for either Accounts or DeploymentTargets, and you\n must specify at least one value for Regions.
[Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create stack instances in the\n specified Region(s) for.
\nYou can specify Accounts or DeploymentTargets, but not both.
[Self-managed permissions] The names of one or more Amazon Web Services accounts that you\n want to create stack instances in the specified Region(s) for.
\nYou can specify Accounts or DeploymentTargets, but not\n both.
A list of stack set parameters whose values you want to override in the selected\n stack instances.
\nAny overridden parameter values will be applied to all stack instances in the\n specified accounts and Regions. When specifying parameters and their values, be aware of\n how CloudFormation sets parameter values during stack instance operations:
\nTo override the current value for a parameter, include the parameter and\n specify its value.
\nTo leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as\n true. (You cannot specify both a value and set\n UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set,\n specify a parameter list but do not include the parameter in the list.
\nTo leave all parameters set to their present values, do not specify this\n property at all.
\nDuring stack set updates, any parameter values overridden for a stack instance are\n not updated, but retain their overridden value.
\nYou can only override the parameter values that are specified in\n the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.
" + "smithy.api#documentation": "A list of stack set parameters whose values you want to override in the selected stack\n instances.
\nAny overridden parameter values will be applied to all stack instances in the specified\n accounts and Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance operations:
\nTo override the current value for a parameter, include the parameter and specify\n its value.
\nTo leave an overridden parameter set to its present value, include the parameter\n and specify UsePreviousValue as true. (You cannot specify\n both a value and set UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set,\n specify a parameter list but do not include the parameter in the list.
\nTo leave all parameters set to their present values, do not specify this property\n at all.
\nDuring stack set updates, any parameter values overridden for a stack instance are not\n updated, but retain their overridden value.
\nYou can only override the parameter values that are specified in\n the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.
" } }, "OperationPreferences": { @@ -1468,14 +1468,14 @@ "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "The unique identifier for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that\n CloudFormation performs the stack set operation only once, even if you retry the request\n multiple times. You might retry stack set operation requests to ensure that\n CloudFormation successfully received them.
\nIf you don't specify an operation ID, the SDK generates one\n automatically.
\nRepeating this stack set operation with a new operation ID retries all stack instances\n whose status is OUTDATED.
The unique identifier for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request\n multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.
\nIf you don't specify an operation ID, the SDK generates one\n automatically.
\nRepeating this stack set operation with a new operation ID retries all stack instances\n whose status is OUTDATED.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated\n administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in\n the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
\nThe name to associate with the stack set. The name must be unique in the Region where\n you create your stack set.
\nA stack name can contain only alphanumeric characters (case-sensitive) and\n hyphens. It must start with an alphabetic character and can't be longer than 128\n characters.
\nThe name to associate with the stack set. The name must be unique in the Region where\n you create your stack set.
\nA stack name can contain only alphanumeric characters (case-sensitive) and hyphens.\n It must start with an alphabetic character and can't be longer than 128\n characters.
\nA description of the stack set. You can use the description to identify the stack\n set's purpose or other important information.
" + "smithy.api#documentation": "A description of the stack set. You can use the description to identify the stack set's\n purpose or other important information.
" } }, "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "The structure that contains the template body, with a minimum length of 1 byte and a\n maximum length of 51,200 bytes. For more information, see Template Anatomy\n in the CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter,\n but not both.
" + "smithy.api#documentation": "The structure that contains the template body, with a minimum length of 1 byte and a\n maximum length of 51,200 bytes. For more information, see Template Anatomy\n in the CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter, but\n not both.
" } }, "TemplateURL": { "target": "com.amazonaws.cloudformation#TemplateURL", "traits": { - "smithy.api#documentation": "The location of the file that contains the template body. The URL must point to a\n template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems\n Manager document. For more information, see Template Anatomy\n in the CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter,\n but not both.
" + "smithy.api#documentation": "The location of the file that contains the template body. The URL must point to a\n template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems\n Manager document. For more information, see Template Anatomy\n in the CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter, but\n not both.
" } }, "StackId": { @@ -1571,13 +1571,13 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "In some cases, you must explicitly acknowledge that your stack set template contains\n certain capabilities in order for CloudFormation to create the stack set and related stack\n instances.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in\n your Amazon Web Services account; for example, by creating new Identity and Access Management\n (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying\n one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM\n capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review\n all permissions associated with them and edit their permissions if\n necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your stack set template references one or more\n macros, you must create the stack set directly from the processed template, without\n first reviewing the resulting changes in a change set. To create the stack set\n directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to\n Perform Custom Processing on Templates.
\nStack sets with service-managed permissions do not currently support the use of\n macros in templates. (This includes the AWS::Include and AWS::Serverless\n transforms, which are macros hosted by CloudFormation.) Even if you specify this capability\n for a stack set with service-managed permissions, if you reference a macro in your\n template the stack set operation will fail.
\nIn some cases, you must explicitly acknowledge that your stack set template contains\n certain capabilities in order for CloudFormation to create the stack set and related stack\n instances.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new Identity and Access Management\n (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying\n one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM\n capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all\n permissions associated with them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your stack set template references one or more\n macros, you must create the stack set directly from the processed template, without\n first reviewing the resulting changes in a change set. To create the stack set\n directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to\n Perform Custom Processing on Templates.
\nStack sets with service-managed permissions do not currently support the use of\n macros in templates. (This includes the AWS::Include and AWS::Serverless\n transforms, which are macros hosted by CloudFormation.) Even if you specify this capability\n for a stack set with service-managed permissions, if you reference a macro in your\n template the stack set operation will fail.
\nThe key-value pairs to associate with this stack set and the stacks created from it.\n CloudFormation also propagates these tags to supported resources that are created in\n the stacks. A maximum number of 50 tags can be specified.
\nIf you specify tags as part of a CreateStackSet action,\n CloudFormation checks to see if you have the required IAM permission to tag resources. If\n you don't, the entire CreateStackSet action fails with an access\n denied error, and the stack set is not created.
The key-value pairs to associate with this stack set and the stacks created from it.\n CloudFormation also propagates these tags to supported resources that are\n created in the stacks. A maximum number of 50 tags can be specified.
\nIf you specify tags as part of a CreateStackSet action, CloudFormation checks to see if you have the required IAM permission to tag resources.\n If you don't, the entire CreateStackSet action fails with an access\n denied error, and the stack set is not created.
A unique identifier for this CreateStackSet request. Specify this token\n if you plan to retry requests so that CloudFormation knows that you're not attempting\n to create another stack set with the same name. You might retry CreateStackSet\n requests to ensure that CloudFormation successfully received them.
If you don't specify an operation ID, the SDK generates one\n automatically.
", + "smithy.api#documentation": "A unique identifier for this CreateStackSet request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting\n to create another stack set with the same name. You might retry CreateStackSet\n requests to ensure that CloudFormation successfully received them.
If you don't specify an operation ID, the SDK generates one\n automatically.
", "smithy.api#idempotencyToken": {} } + }, + "ManagedExecution": { + "target": "com.amazonaws.cloudformation#ManagedExecution", + "traits": { + "smithy.api#documentation": "Describes whether StackSets performs non-conflicting operations concurrently and queues\n conflicting operations.
" + } } } }, @@ -1712,7 +1718,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified change set. Deleting change sets ensures that no one executes\n the wrong change set.
\nIf the call successfully completes, CloudFormation successfully deleted the\n change set.
\nIf IncludeNestedStacks specifies True during the creation of\n the nested change set, then DeleteChangeSet will delete all change sets that\n belong to the stacks hierarchy and will also delete all change sets for nested stacks with\n the status of REVIEW_IN_PROGRESS.
Deletes the specified change set. Deleting change sets ensures that no one executes the\n wrong change set.
\nIf the call successfully completes, CloudFormation successfully deleted the\n change set.
\nIf IncludeNestedStacks specifies True during the creation of\n the nested change set, then DeleteChangeSet will delete all change sets that\n belong to the stacks hierarchy and will also delete all change sets for nested stacks with\n the status of REVIEW_IN_PROGRESS.
The name or Amazon Resource Name (ARN) of the change set that you want to\n delete.
", + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the change set that you want to delete.
", "smithy.api#required": {} } }, "StackName": { "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { - "smithy.api#documentation": "If you specified the name of a change set to delete, specify the stack name or ID\n (ARN) that is associated with it.
" + "smithy.api#documentation": "If you specified the name of a change set to delete, specify the stack name or ID (ARN)\n that is associated with it.
" } } }, @@ -1754,7 +1760,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a specified stack. Once the call completes successfully, stack deletion\n starts. Deleted stacks do not show up in the DescribeStacks API if the\n deletion has been completed successfully.
" + "smithy.api#documentation": "Deletes a specified stack. Once the call completes successfully, stack deletion starts.\n Deleted stacks do not show up in the DescribeStacks API if the deletion\n has been completed successfully.
" } }, "com.amazonaws.cloudformation#DeleteStackInput": { @@ -1770,19 +1776,19 @@ "RetainResources": { "target": "com.amazonaws.cloudformation#RetainResources", "traits": { - "smithy.api#documentation": "For stacks in the DELETE_FAILED state, a list of resource logical IDs\n that are associated with the resources you want to retain. During deletion,\n CloudFormation deletes the stack but does not delete the retained resources.
Retaining resources is useful when you cannot delete a resource, such as a non-empty\n S3 bucket, but you want to delete the stack.
" + "smithy.api#documentation": "For stacks in the DELETE_FAILED state, a list of resource logical IDs that\n are associated with the resources you want to retain. During deletion, CloudFormation deletes the stack but does not delete the retained resources.
Retaining resources is useful when you cannot delete a resource, such as a non-empty S3\n bucket, but you want to delete the stack.
" } }, "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role\n that CloudFormation assumes to delete the stack. CloudFormation uses the role's\n credentials to make calls on your behalf.
\nIf you don't specify a value, CloudFormation uses the role that was previously\n associated with the stack. If no role is available, CloudFormation uses a temporary\n session that is generated from your user credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to delete the stack. CloudFormation uses the role's\n credentials to make calls on your behalf.
\nIf you don't specify a value, CloudFormation uses the role that was previously\n associated with the stack. If no role is available, CloudFormation uses a temporary\n session that is generated from your user credentials.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique identifier for this DeleteStack request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to\n delete a stack with the same name. You might retry DeleteStack requests to\n ensure that CloudFormation successfully received them.
All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab.\n Stack operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the\n stack operation . For example, if you create a stack using the console, each stack event\n would be assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
A unique identifier for this DeleteStack request. Specify this token if you\n plan to retry requests so that CloudFormation knows that you're not attempting to\n delete a stack with the same name. You might retry DeleteStack requests to\n ensure that CloudFormation successfully received them.
All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab.\n Stack operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the\n stack operation . For example, if you create a stack using the console, each stack event\n would be assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
[Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances for.
\nYou can specify Accounts or DeploymentTargets, but not both.
[Self-managed permissions] The names of the Amazon Web Services accounts that you want to\n delete stack instances for.
\nYou can specify Accounts or DeploymentTargets, but not\n both.
Removes the stack instances from the specified stack set, but doesn't delete the\n stacks. You can't reassociate a retained stack or add an existing, saved stack to a new\n stack set.
\nFor more information, see Stack set operation options.
", + "smithy.api#documentation": "Removes the stack instances from the specified stack set, but doesn't delete the stacks.\n You can't reassociate a retained stack or add an existing, saved stack to a new stack\n set.
\nFor more information, see Stack set operation options.
", "smithy.api#required": {} } }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "The unique identifier for this stack set operation.
\nIf you don't specify an operation ID, the SDK generates one\n automatically.
\nThe operation ID also functions as an idempotency token, to ensure that\n CloudFormation performs the stack set operation only once, even if you retry the request\n multiple times. You can retry stack set operation requests to ensure that\n CloudFormation successfully received them.
\nRepeating this stack set operation with a new operation ID retries all stack instances\n whose status is OUTDATED.
The unique identifier for this stack set operation.
\nIf you don't specify an operation ID, the SDK generates one\n automatically.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request\n multiple times. You can retry stack set operation requests to ensure that CloudFormation successfully received them.
\nRepeating this stack set operation with a new operation ID retries all stack instances\n whose status is OUTDATED.
The name or unique ID of the stack set that you're deleting. You can obtain this\n value by running ListStackSets.
", + "smithy.api#documentation": "The name or unique ID of the stack set that you're deleting. You can obtain this value\n by running ListStackSets.
", "smithy.api#required": {} } }, @@ -2036,7 +2042,7 @@ "target": "com.amazonaws.cloudformation#DescribeAccountLimitsOutput" }, "traits": { - "smithy.api#documentation": "Retrieves your account's CloudFormation limits, such as the maximum number of\n stacks that you can create in your account. For more information about account limits, see\n CloudFormation\n Limits in the CloudFormation User Guide.
", + "smithy.api#documentation": "Retrieves your account's CloudFormation limits, such as the maximum number of\n stacks that you can create in your account. For more information about account limits, see\n CloudFormation Limits in the CloudFormation User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2070,7 +2076,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of limits.\n If no additional page exists, this value is null.
" + "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of limits. If\n no additional page exists, this value is null.
" } } }, @@ -2207,7 +2213,7 @@ "ExecutionStatus": { "target": "com.amazonaws.cloudformation#ExecutionStatus", "traits": { - "smithy.api#documentation": "If the change set execution status is AVAILABLE, you can execute the\n change set. If you can’t execute the change set, the status indicates why. For example, a\n change set might be in an UNAVAILABLE state because CloudFormation is\n still creating it or in an OBSOLETE state because the stack was already\n updated.
If the change set execution status is AVAILABLE, you can execute the change\n set. If you can’t execute the change set, the status indicates why. For example, a change\n set might be in an UNAVAILABLE state because CloudFormation is still\n creating it or in an OBSOLETE state because the stack was already\n updated.
If you execute the change set, the tags that will be associated with the\n stack.
" + "smithy.api#documentation": "If you execute the change set, the tags that will be associated with the stack.
" } }, "Changes": { "target": "com.amazonaws.cloudformation#Changes", "traits": { - "smithy.api#documentation": "A list of Change structures that describes the resources\n CloudFormation changes if you execute the change set.
A list of Change structures that describes the resources CloudFormation changes if you execute the change set.
If the output exceeds 1 MB, a string that identifies the next page of changes. If\n there is no additional page, this value is null.
" + "smithy.api#documentation": "If the output exceeds 1 MB, a string that identifies the next page of changes. If there\n is no additional page, this value is null.
" } }, "IncludeNestedStacks": { @@ -2376,20 +2382,20 @@ "StackDriftDetectionId": { "target": "com.amazonaws.cloudformation#StackDriftDetectionId", "traits": { - "smithy.api#documentation": "The ID of the drift detection results of this operation.
\nCloudFormation generates new results, with a new drift detection ID, each time this operation\n is run. However, the number of reports CloudFormation retains for any given stack, and for how long,\n may vary.
", + "smithy.api#documentation": "The ID of the drift detection results of this operation.
\nCloudFormation generates new results, with a new drift detection ID, each time this operation is\n run. However, the number of reports CloudFormation retains for any given stack, and for how long,\n may vary.
", "smithy.api#required": {} } }, "StackDriftStatus": { "target": "com.amazonaws.cloudformation#StackDriftStatus", "traits": { - "smithy.api#documentation": "Status of the stack's actual configuration compared to its expected\n configuration.
\n\n DRIFTED: The stack differs from its expected template\n configuration. A stack is considered to have drifted if one or more of its resources\n have drifted.
\n NOT_CHECKED: CloudFormation has not checked if the stack differs from its\n expected template configuration.
\n IN_SYNC: The stack's actual configuration matches its expected\n template configuration.
\n UNKNOWN: This value is reserved for future use.
Status of the stack's actual configuration compared to its expected\n configuration.
\n\n DRIFTED: The stack differs from its expected template configuration.\n A stack is considered to have drifted if one or more of its resources have\n drifted.
\n NOT_CHECKED: CloudFormation has not checked if the stack differs from its\n expected template configuration.
\n IN_SYNC: The stack's actual configuration matches its expected\n template configuration.
\n UNKNOWN: This value is reserved for future use.
The status of the stack drift detection operation.
\n\n DETECTION_COMPLETE: The stack drift detection operation has\n successfully completed for all resources in the stack that support drift detection.\n (Resources that do not currently support stack detection remain unchecked.)
If you specified logical resource IDs for CloudFormation to use as a filter for the\n stack drift detection operation, only the resources with those logical IDs are\n checked for drift.
\n\n DETECTION_FAILED: The stack drift detection operation has failed\n for at least one resource in the stack. Results will be available for resources on\n which CloudFormation successfully completed drift detection.
\n DETECTION_IN_PROGRESS: The stack drift detection operation is\n currently in progress.
The status of the stack drift detection operation.
\n\n DETECTION_COMPLETE: The stack drift detection operation has\n successfully completed for all resources in the stack that support drift detection.\n (Resources that do not currently support stack detection remain unchecked.)
If you specified logical resource IDs for CloudFormation to use as a filter for the stack\n drift detection operation, only the resources with those logical IDs are checked for\n drift.
\n\n DETECTION_FAILED: The stack drift detection operation has failed for\n at least one resource in the stack. Results will be available for resources on which\n CloudFormation successfully completed drift detection.
\n DETECTION_IN_PROGRESS: The stack drift detection operation is\n currently in progress.
Returns all stack related events for a specified stack in reverse chronological\n order. For more information about a stack's event history, go to Stacks in the CloudFormation User Guide.
\nYou can list events for stacks that have failed to create or have been deleted by\n specifying the unique stack identifier (stack ID).
\nReturns all stack related events for a specified stack in reverse chronological order.\n For more information about a stack's event history, go to Stacks in the\n CloudFormation User Guide.
\nYou can list events for stacks that have failed to create or have been deleted by\n specifying the unique stack identifier (stack ID).
\nThe name or the unique stack ID that is associated with the stack, which are not\n always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack\n ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" + "smithy.api#documentation": "The name or the unique stack ID that is associated with the stack, which are not always\n interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack\n ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" } }, "NextToken": { @@ -2463,7 +2469,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of events.\n If no additional page exists, this value is null.
" + "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of events. If\n no additional page exists, this value is null.
" } } }, @@ -2488,7 +2494,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the stack instance that's associated with the specified stack set, Amazon Web Services account, and Region.
\nFor a list of stack instances that are associated with a specific stack set, use\n ListStackInstances.
" + "smithy.api#documentation": "Returns the stack instance that's associated with the specified stack set, Amazon Web Services account, and Region.
\nFor a list of stack instances that are associated with a specific stack set, use ListStackInstances.
" } }, "com.amazonaws.cloudformation#DescribeStackInstanceInput": { @@ -2504,7 +2510,7 @@ "StackInstanceAccount": { "target": "com.amazonaws.cloudformation#Account", "traits": { - "smithy.api#documentation": "The ID of an Amazon Web Services account that's associated with this stack instance.
", + "smithy.api#documentation": "The ID of an Amazon Web Services account that's associated with this stack\n instance.
", "smithy.api#required": {} } }, @@ -2543,7 +2549,7 @@ "target": "com.amazonaws.cloudformation#DescribeStackResourceOutput" }, "traits": { - "smithy.api#documentation": "Returns a description of the specified resource in the specified stack.
\nFor deleted stacks, DescribeStackResource returns resource information for up to 90\n days after the stack has been deleted.
" + "smithy.api#documentation": "Returns a description of the specified resource in the specified stack.
\nFor deleted stacks, DescribeStackResource returns resource information for up to 90 days\n after the stack has been deleted.
" } }, "com.amazonaws.cloudformation#DescribeStackResourceDrifts": { @@ -2555,7 +2561,7 @@ "target": "com.amazonaws.cloudformation#DescribeStackResourceDriftsOutput" }, "traits": { - "smithy.api#documentation": "Returns drift information for the resources that have been checked for drift in the\n specified stack. This includes actual and expected configuration values for resources where\n CloudFormation detects configuration drift.
\nFor a given stack, there will be one StackResourceDrift for each stack\n resource that has been checked for drift. Resources that haven't yet been checked for drift\n are not included. Resources that do not currently support drift detection are not checked,\n and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection.
Use DetectStackResourceDrift to detect drift on individual\n resources, or DetectStackDrift to detect drift on all supported resources\n for a given stack.
", + "smithy.api#documentation": "Returns drift information for the resources that have been checked for drift in the\n specified stack. This includes actual and expected configuration values for resources where\n CloudFormation detects configuration drift.
\nFor a given stack, there will be one StackResourceDrift for each stack\n resource that has been checked for drift. Resources that haven't yet been checked for drift\n are not included. Resources that do not currently support drift detection are not checked,\n and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection.
Use DetectStackResourceDrift to detect drift on individual resources,\n or DetectStackDrift to detect drift on all supported resources for a\n given stack.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2576,7 +2582,7 @@ "StackResourceDriftStatusFilters": { "target": "com.amazonaws.cloudformation#StackResourceDriftStatusFilters", "traits": { - "smithy.api#documentation": "The resource drift status values to use as filters for the resource drift results\n returned.
\n\n DELETED: The resource differs from its expected template\n configuration in that the resource has been deleted.
\n MODIFIED: One or more resource properties differ from their\n expected template values.
\n IN_SYNC: The resources's actual configuration matches its expected\n template configuration.
\n NOT_CHECKED: CloudFormation does not currently return this value.
The resource drift status values to use as filters for the resource drift results\n returned.
\n\n DELETED: The resource differs from its expected template\n configuration in that the resource has been deleted.
\n MODIFIED: One or more resource properties differ from their expected\n template values.
\n IN_SYNC: The resources's actual configuration matches its expected\n template configuration.
\n NOT_CHECKED: CloudFormation does not currently return this value.
The name or the unique stack ID that is associated with the stack, which are not\n always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack\n ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
", + "smithy.api#documentation": "The name or the unique stack ID that is associated with the stack, which are not always\n interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack\n ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
", "smithy.api#required": {} } }, @@ -2639,7 +2645,7 @@ "StackResourceDetail": { "target": "com.amazonaws.cloudformation#StackResourceDetail", "traits": { - "smithy.api#documentation": "A StackResourceDetail structure containing the description of the\n specified resource in the specified stack.
A StackResourceDetail structure containing the description of the specified\n resource in the specified stack.
Returns Amazon Web Services resource descriptions for running and deleted stacks. If\n StackName is specified, all the associated resources that are part of the\n stack are returned. If PhysicalResourceId is specified, the associated\n resources of the stack that the resource belongs to are returned.
Only the first 100 resources will be returned. If your stack has more resources\n than this, you should use ListStackResources instead.
For deleted stacks, DescribeStackResources returns resource information\n for up to 90 days after the stack has been deleted.
You must specify either StackName or PhysicalResourceId,\n but not both. In addition, you can specify LogicalResourceId to filter the\n returned result. For more information about resources, the LogicalResourceId\n and PhysicalResourceId, go to the CloudFormation User\n Guide.
A ValidationError is returned if you specify both\n StackName and PhysicalResourceId in the same\n request.
Returns Amazon Web Services resource descriptions for running and deleted stacks. If\n StackName is specified, all the associated resources that are part of the\n stack are returned. If PhysicalResourceId is specified, the associated\n resources of the stack that the resource belongs to are returned.
Only the first 100 resources will be returned. If your stack has more resources than\n this, you should use ListStackResources instead.
For deleted stacks, DescribeStackResources returns resource information for\n up to 90 days after the stack has been deleted.
You must specify either StackName or PhysicalResourceId, but\n not both. In addition, you can specify LogicalResourceId to filter the\n returned result. For more information about resources, the LogicalResourceId\n and PhysicalResourceId, go to the CloudFormation User\n Guide.
A ValidationError is returned if you specify both StackName\n and PhysicalResourceId in the same request.
The name or the unique stack ID that is associated with the stack, which are not\n always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack\n ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
\nRequired: Conditional. If you do not specify StackName, you must specify\n PhysicalResourceId.
The name or the unique stack ID that is associated with the stack, which are not always\n interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack\n ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
\nRequired: Conditional. If you do not specify StackName, you must specify\n PhysicalResourceId.
The name or unique identifier that corresponds to a physical instance ID of a\n resource supported by CloudFormation.
\nFor example, for an Amazon Elastic Compute Cloud (EC2) instance,\n PhysicalResourceId corresponds to the InstanceId. You can pass\n the EC2 InstanceId to DescribeStackResources to find which stack\n the instance belongs to and what other resources are part of the stack.
Required: Conditional. If you do not specify PhysicalResourceId, you\n must specify StackName.
Default: There is no default value.
" + "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource\n supported by CloudFormation.
\nFor example, for an Amazon Elastic Compute Cloud (EC2) instance,\n PhysicalResourceId corresponds to the InstanceId. You can pass\n the EC2 InstanceId to DescribeStackResources to find which stack\n the instance belongs to and what other resources are part of the stack.
Required: Conditional. If you do not specify PhysicalResourceId, you must\n specify StackName.
Default: There is no default value.
" } } }, @@ -2810,7 +2816,7 @@ "target": "com.amazonaws.cloudformation#DescribeStacksOutput" }, "traits": { - "smithy.api#documentation": "Returns the description for the specified stack; if no stack name was specified, then\n it returns the description for all the stacks created.
\nIf the stack does not exist, an ValidationError is\n returned.
Returns the description for the specified stack; if no stack name was specified, then it\n returns the description for all the stacks created.
\nIf the stack does not exist, an ValidationError is returned.
The name or the unique stack ID that is associated with the stack, which are not\n always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack\n ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" + "smithy.api#documentation": "The name or the unique stack ID that is associated with the stack, which are not always\n interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack\n ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" } }, "NextToken": { @@ -3202,7 +3208,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of stacks.\n If no additional page exists, this value is null.
" + "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If\n no additional page exists, this value is null.
" } } }, @@ -3544,7 +3550,7 @@ "target": "com.amazonaws.cloudformation#DetectStackDriftOutput" }, "traits": { - "smithy.api#documentation": "Detects whether a stack's actual configuration differs, or has\n drifted, from it's expected configuration, as defined in the stack\n template and any values specified as template parameters. For each resource in the stack\n that supports drift detection, CloudFormation compares the actual configuration of the resource with\n its expected template configuration. Only resource properties explicitly defined in the\n stack template are checked for drift. A stack is considered to have drifted if one or more\n of its resources differ from their expected template configurations. For more information,\n see Detecting\n Unregulated Configuration Changes to Stacks and Resources.
\nUse DetectStackDrift to detect drift on all supported resources for a\n given stack, or DetectStackResourceDrift to detect drift on individual\n resources.
For a list of stack resources that currently support drift detection, see Resources that Support Drift Detection.
\n\n DetectStackDrift can take up to several minutes, depending on the number\n of resources contained within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack\n drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and\n its resources.
When detecting drift on a stack, CloudFormation does not detect drift on any nested stacks\n belonging to that stack. Perform DetectStackDrift directly on the nested stack\n itself.
Detects whether a stack's actual configuration differs, or has\n drifted, from it's expected configuration, as defined in the stack\n template and any values specified as template parameters. For each resource in the stack\n that supports drift detection, CloudFormation compares the actual configuration of the resource with\n its expected template configuration. Only resource properties explicitly defined in the\n stack template are checked for drift. A stack is considered to have drifted if one or more\n of its resources differ from their expected template configurations. For more information,\n see Detecting\n Unregulated Configuration Changes to Stacks and Resources.
\nUse DetectStackDrift to detect drift on all supported resources for a given\n stack, or DetectStackResourceDrift to detect drift on individual\n resources.
For a list of stack resources that currently support drift detection, see Resources that Support Drift Detection.
\n\n DetectStackDrift can take up to several minutes, depending on the number of\n resources contained within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack drift operation. Once the drift detection\n operation has completed, use DescribeStackResourceDrifts to return drift\n information about the stack and its resources.
When detecting drift on a stack, CloudFormation does not detect drift on any nested stacks\n belonging to that stack. Perform DetectStackDrift directly on the nested stack\n itself.
Returns information about whether a resource's actual configuration differs, or has\n drifted, from it's expected configuration, as defined in the stack\n template and any values specified as template parameters. This information includes actual\n and expected property values for resources in which CloudFormation detects drift. Only resource\n properties explicitly defined in the stack template are checked for drift. For more\n information about stack and resource drift, see Detecting\n Unregulated Configuration Changes to Stacks and Resources.
\nUse DetectStackResourceDrift to detect drift on individual resources, or\n DetectStackDrift to detect drift on all resources in a given stack\n that support drift detection.
Resources that do not currently support drift detection cannot be checked. For a list\n of resources that support drift detection, see Resources that Support Drift Detection.
" + "smithy.api#documentation": "Returns information about whether a resource's actual configuration differs, or has\n drifted, from it's expected configuration, as defined in the stack\n template and any values specified as template parameters. This information includes actual\n and expected property values for resources in which CloudFormation detects drift. Only resource\n properties explicitly defined in the stack template are checked for drift. For more\n information about stack and resource drift, see Detecting\n Unregulated Configuration Changes to Stacks and Resources.
\nUse DetectStackResourceDrift to detect drift on individual resources, or\n DetectStackDrift to detect drift on all resources in a given stack\n that support drift detection.
Resources that do not currently support drift detection cannot be checked. For a list of\n resources that support drift detection, see Resources that Support Drift Detection.
" } }, "com.amazonaws.cloudformation#DetectStackResourceDriftInput": { @@ -3748,7 +3754,7 @@ "target": "com.amazonaws.cloudformation#EstimateTemplateCostOutput" }, "traits": { - "smithy.api#documentation": "Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple\n Monthly Calculator URL with a query string that describes the resources required to run the\n template.
" + "smithy.api#documentation": "Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly Calculator URL with a query string that describes the\n resources required to run the template.
" } }, "com.amazonaws.cloudformation#EstimateTemplateCostInput": { @@ -3763,7 +3769,7 @@ "TemplateURL": { "target": "com.amazonaws.cloudformation#TemplateURL", "traits": { - "smithy.api#documentation": "Location of file containing the template body. The URL must point to a template that\n is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to\n Template Anatomy\n in the CloudFormation User Guide.
\nConditional: You must pass TemplateURL or TemplateBody. If\n both are passed, only TemplateBody is used.
Location of file containing the template body. The URL must point to a template that is\n located in an Amazon S3 bucket or a Systems Manager document. For more information, go to\n Template Anatomy\n in the CloudFormation User Guide.
\nConditional: You must pass TemplateURL or TemplateBody. If\n both are passed, only TemplateBody is used.
An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources\n required to run the template.
" + "smithy.api#documentation": "An Amazon Web Services Simple Monthly Calculator URL with a query string that describes\n the resources required to run the template.
" } } }, @@ -3832,7 +3838,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a stack using the input information that was provided when the specified\n change set was created. After the call successfully completes, CloudFormation starts\n updating the stack. Use the DescribeStacks action to view the status of\n the update.
\nWhen you execute a change set, CloudFormation deletes all other change sets\n associated with the stack because they aren't valid for the updated stack.
\nIf a stack policy is associated with the stack, CloudFormation enforces the\n policy during the update. You can't specify a temporary stack policy that overrides the\n current policy.
\nTo create a change set for the entire stack hierachy, IncludeNestedStacks\n must have been set to True.
Updates a stack using the input information that was provided when the specified change\n set was created. After the call successfully completes, CloudFormation starts\n updating the stack. Use the DescribeStacks action to view the status of\n the update.
\nWhen you execute a change set, CloudFormation deletes all other change sets\n associated with the stack because they aren't valid for the updated stack.
\nIf a stack policy is associated with the stack, CloudFormation enforces the\n policy during the update. You can't specify a temporary stack policy that overrides the\n current policy.
\nTo create a change set for the entire stack hierachy, IncludeNestedStacks\n must have been set to True.
A unique identifier for this ExecuteChangeSet request. Specify this\n token if you plan to retry requests so that CloudFormation knows that you're not\n attempting to execute a change set to update a stack with the same name. You might retry\n ExecuteChangeSet requests to ensure that CloudFormation successfully\n received them.
A unique identifier for this ExecuteChangeSet request. Specify this token\n if you plan to retry requests so that CloudFormation knows that you're not\n attempting to execute a change set to update a stack with the same name. You might retry\n ExecuteChangeSet requests to ensure that CloudFormation\n successfully received them.
The name of exported output value. Use this name and the Fn::ImportValue\n function to import the associated value into other stacks. The name is defined in the\n Export field in the associated stack's Outputs\n section.
The name of exported output value. Use this name and the Fn::ImportValue\n function to import the associated value into other stacks. The name is defined in the\n Export field in the associated stack's Outputs section.
The value of the exported output, such as a resource physical ID. This value is\n defined in the Export field in the associated stack's Outputs\n section.
The value of the exported output, such as a resource physical ID. This value is defined\n in the Export field in the associated stack's Outputs\n section.
Returns the stack policy for a specified stack. If a stack doesn't have a policy, a\n null value is returned.
" + "smithy.api#documentation": "Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null\n value is returned.
" } }, "com.amazonaws.cloudformation#GetStackPolicyInput": { @@ -3999,7 +4005,7 @@ "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { - "smithy.api#documentation": "The name or unique stack ID that is associated with the stack whose policy you want\n to get.
", + "smithy.api#documentation": "The name or unique stack ID that is associated with the stack whose policy you want to\n get.
", "smithy.api#required": {} } } @@ -4036,7 +4042,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the template body for a specified stack. You can get the template for running\n or deleted stacks.
\nFor deleted stacks, GetTemplate returns the template for up to 90 days after the\n stack has been deleted.
\nIf the template does not exist, a ValidationError is returned.
Returns the template body for a specified stack. You can get the template for running or\n deleted stacks.
\nFor deleted stacks, GetTemplate returns the template for up to 90 days after the stack\n has been deleted.
\nIf the template does not exist, a ValidationError is returned.
The name or the unique stack ID that is associated with the stack, which are not\n always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack\n ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" + "smithy.api#documentation": "The name or the unique stack ID that is associated with the stack, which are not always\n interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack\n ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" } }, "ChangeSetName": { @@ -4077,7 +4083,7 @@ "StagesAvailable": { "target": "com.amazonaws.cloudformation#StageList", "traits": { - "smithy.api#documentation": "The stage of the template that you can retrieve. For stacks, the\n Original and Processed templates are always available. For\n change sets, the Original template is always available. After\n CloudFormation finishes creating the change set, the Processed template\n becomes available.
The stage of the template that you can retrieve. For stacks, the Original\n and Processed templates are always available. For change sets, the\n Original template is always available. After CloudFormation\n finishes creating the change set, the Processed template becomes\n available.
Returns information about a new or existing template. The\n GetTemplateSummary action is useful for viewing parameter information, such\n as default parameter values and parameter types, before you create or update a stack or\n stack set.
You can use the GetTemplateSummary action when you submit a template, or\n you can get template information for a stack set, or a running or deleted stack.
For deleted stacks, GetTemplateSummary returns the template information\n for up to 90 days after the stack has been deleted. If the template does not exist, a\n ValidationError is returned.
Returns information about a new or existing template. The\n GetTemplateSummary action is useful for viewing parameter information, such\n as default parameter values and parameter types, before you create or update a stack or\n stack set.
You can use the GetTemplateSummary action when you submit a template, or\n you can get template information for a stack set, or a running or deleted stack.
For deleted stacks, GetTemplateSummary returns the template information for\n up to 90 days after the stack has been deleted. If the template does not exist, a\n ValidationError is returned.
The capabilities found within the template. If your template contains IAM resources,\n you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when\n you use the CreateStack or UpdateStack actions with\n your template; otherwise, those actions return an InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
" + "smithy.api#documentation": "The capabilities found within the template. If your template contains IAM\n resources, you must specify the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template;\n otherwise, those actions return an InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in CloudFormation\n Templates.
" } }, "CapabilitiesReason": { @@ -4182,7 +4188,7 @@ "Metadata": { "target": "com.amazonaws.cloudformation#Metadata", "traits": { - "smithy.api#documentation": "The value that is defined for the Metadata property of the\n template.
The value that is defined for the Metadata property of the template.
Import existing stacks into a new stack sets. Use the stack import operation to import\n up to 10 stacks into a new stack set in the same account as the source stack or in a\n different administrator account and Region, by specifying the stack ID of the stack you\n intend to import.
\n\n ImportStacksToStackSet is only supported by self-managed permissions.
Use the stack import operations for self-managed or service-managed StackSets. For\n self-managed StackSets, the import operation can import stacks in the administrator account\n or in different target accounts and Amazon Web Services Regions. For service-managed\n StackSets, the import operation can import any stack in the same AWS Organizations as the\n management account. The import operation can import up to 10 stacks using inline stack IDs\n or up to 10,000 stacks using an Amazon S3 object.
" } }, "com.amazonaws.cloudformation#ImportStacksToStackSetInput": { @@ -4336,8 +4342,19 @@ "StackIds": { "target": "com.amazonaws.cloudformation#StackIdList", "traits": { - "smithy.api#documentation": "The IDs of the stacks you are importing into a stack set. You import up to 10 stacks per\n stack set at a time.
", - "smithy.api#required": {} + "smithy.api#documentation": "The IDs of the stacks you are importing into a stack set. You import up to 10 stacks per\n stack set at a time.
\nSpecify either StackIds or StackIdsUrl.
The Amazon S3 URL which contains list of stack ids to be inputted.
\nSpecify either StackIds or StackIdsUrl.
The list of OU ID’s to which the stacks being imported has to be mapped as deployment\n target.
" } }, "OperationPreferences": { @@ -4426,7 +4443,7 @@ "code": "InvalidChangeSetStatus", "httpResponseCode": 400 }, - "smithy.api#documentation": "The specified change set can't be used to update the stack. For example, the change\n set status might be CREATE_IN_PROGRESS, or the stack status might be\n UPDATE_IN_PROGRESS.
The specified change set can't be used to update the stack. For example, the change set\n status might be CREATE_IN_PROGRESS, or the stack status might be\n UPDATE_IN_PROGRESS.
Returns the ID and status of each active change set for a stack. For example,\n CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or\n CREATE_PENDING state.
Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or\n CREATE_PENDING state.
A string (provided by the ListExports response output) that\n identifies the next page of exported output values that you asked to retrieve.
" + "smithy.api#documentation": "A string (provided by the ListExports response output) that identifies\n the next page of exported output values that you asked to retrieve.
" } } } @@ -4613,7 +4630,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the output exceeds 100 exported output values, a string that identifies the next\n page of exports. If there is no additional page, this value is null.
" + "smithy.api#documentation": "If the output exceeds 100 exported output values, a string that identifies the next page\n of exports. If there is no additional page, this value is null.
" } } } @@ -4665,7 +4682,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "A string that identifies the next page of exports. If there is no additional page,\n this value is null.
" + "smithy.api#documentation": "A string that identifies the next page of exports. If there is no additional page, this\n value is null.
" } } } @@ -4684,7 +4701,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns summary information about stack instances that are associated with the\n specified stack set. You can filter for stack instances that are associated with a specific\n Amazon Web Services account name or Region, or that have a specific status.
", + "smithy.api#documentation": "Returns summary information about stack instances that are associated with the specified\n stack set. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that have a specific status.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4699,7 +4716,7 @@ "StackSetName": { "target": "com.amazonaws.cloudformation#StackSetName", "traits": { - "smithy.api#documentation": "The name or unique ID of the stack set that you want to list stack instances\n for.
", + "smithy.api#documentation": "The name or unique ID of the stack set that you want to list stack instances for.
", "smithy.api#required": {} } }, @@ -4724,7 +4741,7 @@ "StackInstanceAccount": { "target": "com.amazonaws.cloudformation#Account", "traits": { - "smithy.api#documentation": "The name of the Amazon Web Services account that you want to list stack instances for.
" + "smithy.api#documentation": "The name of the Amazon Web Services account that you want to list stack instances\n for.
" } }, "StackInstanceRegion": { @@ -4753,7 +4770,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the request doesn't return all of the remaining results, NextToken is\n set to a token. To retrieve the next set of results, call ListStackInstances\n again and assign that token to the request object's NextToken parameter. If\n the request returns all results, NextToken is set to\n null.
If the request doesn't return all of the remaining results, NextToken is\n set to a token. To retrieve the next set of results, call ListStackInstances\n again and assign that token to the request object's NextToken parameter. If\n the request returns all results, NextToken is set to null.
The name or the unique stack ID that is associated with the stack, which are not\n always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack\n ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
", + "smithy.api#documentation": "The name or the unique stack ID that is associated with the stack, which are not always\n interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack\n ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
", "smithy.api#required": {} } }, @@ -4808,7 +4825,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the output exceeds 1 MB, a string that identifies the next page of stack\n resources. If no additional page exists, this value is null.
" + "smithy.api#documentation": "If the output exceeds 1 MB, a string that identifies the next page of stack resources.\n If no additional page exists, this value is null.
" } } }, @@ -4891,7 +4908,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the request doesn't return all results, NextToken is set to a token.\n To retrieve the next set of results, call ListOperationResults again and\n assign that token to the request object's NextToken parameter. If there are no\n remaining results, NextToken is set to null.
If the request doesn't return all results, NextToken is set to a token. To\n retrieve the next set of results, call ListOperationResults again and assign\n that token to the request object's NextToken parameter. If there are no\n remaining results, NextToken is set to null.
If the request doesn't return all results, NextToken is set to a token.\n To retrieve the next set of results, call ListOperationResults again and\n assign that token to the request object's NextToken parameter. If there are no\n remaining results, NextToken is set to null.
If the request doesn't return all results, NextToken is set to a token. To\n retrieve the next set of results, call ListOperationResults again and assign\n that token to the request object's NextToken parameter. If there are no\n remaining results, NextToken is set to null.
Returns summary information about stack sets that are associated with the\n user.
\n[Self-managed permissions] If you set the CallAs parameter to\n SELF while signed in to your Amazon Web Services account,\n ListStackSets returns all self-managed stack sets in your Amazon Web Services account.
[Service-managed permissions] If you set the CallAs parameter to\n SELF while signed in to the organization's management account,\n ListStackSets returns all stack sets in the management\n account.
[Service-managed permissions] If you set the CallAs parameter to\n DELEGATED_ADMIN while signed in to your member account,\n ListStackSets returns all stack sets with service-managed permissions\n in the management account.
Returns summary information about stack sets that are associated with the user.
\n[Self-managed permissions] If you set the CallAs parameter to\n SELF while signed in to your Amazon Web Services account,\n ListStackSets returns all self-managed stack sets in your Amazon Web Services account.
[Service-managed permissions] If you set the CallAs parameter to\n SELF while signed in to the organization's management account,\n ListStackSets returns all stack sets in the management\n account.
[Service-managed permissions] If you set the CallAs parameter to\n DELEGATED_ADMIN while signed in to your member account,\n ListStackSets returns all stack sets with service-managed permissions\n in the management account.
The status of the stack sets that you want to get summary information\n about.
" + "smithy.api#documentation": "The status of the stack sets that you want to get summary information about.
" } }, "CallAs": { @@ -5025,7 +5042,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the request doesn't return all of the remaining results, NextToken is\n set to a token. To retrieve the next set of results, call ListStackInstances\n again and assign that token to the request object's NextToken parameter. If\n the request returns all results, NextToken is set to\n null.
If the request doesn't return all of the remaining results, NextToken is\n set to a token. To retrieve the next set of results, call ListStackInstances\n again and assign that token to the request object's NextToken parameter. If\n the request returns all results, NextToken is set to null.
If the output exceeds 1 MB in size, a string that identifies the next page of stacks.\n If no additional page exists, this value is null.
" + "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If\n no additional page exists, this value is null.
" } } }, @@ -5309,7 +5326,7 @@ "Filters": { "target": "com.amazonaws.cloudformation#TypeFilters", "traits": { - "smithy.api#documentation": "Filter criteria to use in determining which extensions to return.
\nIf you specify a filter, CloudFormation ignores any specified Visibility\n value when returning the list of types.
Filter criteria to use in determining which extensions to return.
\nFilters must be compatible with Visibility to return valid results. For\n example, specifying AWS_TYPES for Category and\n PRIVATE for Visibility returns an empty list of types, but\n specifying PUBLIC for Visibility returns the desired list.
When true, StackSets performs non-conflicting operations concurrently and\n queues conflicting operations. After conflicting operations finish, StackSets starts queued\n operations in request order.
If there are already running or queued operations, StackSets queues all incoming\n operations even if they are non-conflicting.
\nYou can't modify your stack set's execution configuration while there are running or\n queued operations for that stack set.
\nWhen false (default), StackSets performs one operation at a time in request\n order.
Describes whether StackSets performs non-conflicting operations concurrently and queues\n conflicting operations.
" + } + }, + "com.amazonaws.cloudformation#ManagedExecutionNullable": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.cloudformation#MaxConcurrentCount": { "type": "integer", "traits": { @@ -5560,7 +5597,7 @@ "code": "OperationInProgressException", "httpResponseCode": 409 }, - "smithy.api#documentation": "Another operation is currently in progress for this stack set. Only one operation can\n be performed for a stack set at a given time.
", + "smithy.api#documentation": "Another operation is currently in progress for this stack set. Only one operation can be\n performed for a stack set at a given time.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -5693,7 +5730,7 @@ "ParameterKey": { "target": "com.amazonaws.cloudformation#ParameterKey", "traits": { - "smithy.api#documentation": "The key associated with the parameter. If you don't specify a key and value for a\n particular parameter, CloudFormation uses the default value that is specified in your\n template.
" + "smithy.api#documentation": "The key associated with the parameter. If you don't specify a key and value for a\n particular parameter, CloudFormation uses the default value that is specified in\n your template.
" } }, "ParameterValue": { @@ -5711,7 +5748,7 @@ "ResolvedValue": { "target": "com.amazonaws.cloudformation#ParameterValue", "traits": { - "smithy.api#documentation": "Read-only. The value that corresponds to a Systems Manager parameter key. This field\n is returned only for \n SSM parameter types in the template.
Read-only. Read-only. The value that corresponds to a SSM parameter key.\n This field is returned only for \n SSM\n parameter types in the template.
A set of criteria that CloudFormation uses to validate parameter values. Although\n other constraints might be defined in the stack template, CloudFormation returns only\n the AllowedValues property.
A set of criteria that CloudFormation uses to validate parameter values.\n Although other constraints might be defined in the stack template, CloudFormation\n returns only the AllowedValues property.
The expected property value of the resource property, as defined in the stack\n template and any values specified as template parameters.
", + "smithy.api#documentation": "The expected property value of the resource property, as defined in the stack template\n and any values specified as template parameters.
", "smithy.api#required": {} } }, @@ -5890,7 +5927,7 @@ "DifferenceType": { "target": "com.amazonaws.cloudformation#DifferenceType", "traits": { - "smithy.api#documentation": "The type of property difference.
\n\n ADD: A value has been added to a resource property that is an\n array or list data type.
\n REMOVE: The property has been removed from the current resource\n configuration.
\n NOT_EQUAL: The current property value differs from its expected\n value (as defined in the stack template and any values specified as template\n parameters).
The type of property difference.
\n\n ADD: A value has been added to a resource property that is an array\n or list data type.
\n REMOVE: The property has been removed from the current resource\n configuration.
\n NOT_EQUAL: The current property value differs from its expected value\n (as defined in the stack template and any values specified as template\n parameters).
The version number to assign to this version of the extension.
\nUse the following format, and adhere to semantic versioning when assigning a version\n number to your extension:
\n\n MAJOR.MINOR.PATCH\n
For more information, see Semantic Versioning\n 2.0.0.
\nIf you do not specify a version number, CloudFormation increments the version number by\n one minor version release.
\nThe first time you publish a type, CloudFormation sets the version number to 1.0.0,\n regardless of the value you specify.
The version number to assign to this version of the extension.
\nUse the following format, and adhere to semantic versioning when assigning a version\n number to your extension:
\n\n MAJOR.MINOR.PATCH\n
For more information, see Semantic Versioning\n 2.0.0.
\nIf you do not specify a version number, CloudFormation increments the version number by\n one minor version release.
\nYou cannot specify a version number the first time you publish a type. CloudFormation\n automatically sets the first version number to be 1.0.0.
For the Modify action, indicates whether CloudFormation will replace\n the resource by creating a new one and deleting the old one. This value depends on the\n value of the RequiresRecreation property in the\n ResourceTargetDefinition structure. For example, if the\n RequiresRecreation field is Always and the\n Evaluation field is Static, Replacement is\n True. If the RequiresRecreation field is Always\n and the Evaluation field is Dynamic, Replacement is\n Conditionally.
If you have multiple changes with different RequiresRecreation values,\n the Replacement value depends on the change with the most impact. A\n RequiresRecreation value of Always has the most impact,\n followed by Conditionally, and then Never.
For the Modify action, indicates whether CloudFormation will\n replace the resource by creating a new one and deleting the old one. This value depends on\n the value of the RequiresRecreation property in the\n ResourceTargetDefinition structure. For example, if the\n RequiresRecreation field is Always and the\n Evaluation field is Static, Replacement is\n True. If the RequiresRecreation field is Always\n and the Evaluation field is Dynamic, Replacement is\n Conditionally.
If you have multiple changes with different RequiresRecreation values, the\n Replacement value depends on the change with the most impact. A\n RequiresRecreation value of Always has the most impact,\n followed by Conditionally, and then Never.
For the Modify action, a list of ResourceChangeDetail\n structures that describes the changes that CloudFormation will make to the resource.\n
For the Modify action, a list of ResourceChangeDetail\n structures that describes the changes that CloudFormation will make to the\n resource.
The ResourceChange structure describes the resource and the action that\n CloudFormation will perform on it if you execute this change set.
The ResourceChange structure describes the resource and the action that\n CloudFormation will perform on it if you execute this change set.
A ResourceTargetDefinition structure that describes the field that\n CloudFormation will change and whether the resource will be recreated.
A ResourceTargetDefinition structure that describes the field that CloudFormation will change and whether the resource will be recreated.
Indicates whether CloudFormation can determine the target value, and whether the\n target value will change before you execute a change set.
\nFor Static evaluations, CloudFormation can determine that the target\n value will change, and its value. For example, if you directly modify the\n InstanceType property of an EC2 instance, CloudFormation knows that\n this property value will change, and its value, so this is a Static\n evaluation.
For Dynamic evaluations, cannot determine the target value because it\n depends on the result of an intrinsic function, such as a Ref or\n Fn::GetAtt intrinsic function, when the stack is updated. For example, if\n your template includes a reference to a resource that is conditionally recreated, the value\n of the reference (the physical ID of the resource) might change, depending on if the\n resource is recreated. If the resource is recreated, it will have a new physical ID, so all\n references to that resource will also be updated.
Indicates whether CloudFormation can determine the target value, and whether the\n target value will change before you execute a change set.
\nFor Static evaluations, CloudFormation can determine that the\n target value will change, and its value. For example, if you directly modify the\n InstanceType property of an EC2 instance, CloudFormation knows that\n this property value will change, and its value, so this is a Static\n evaluation.
For Dynamic evaluations, cannot determine the target value because it\n depends on the result of an intrinsic function, such as a Ref or\n Fn::GetAtt intrinsic function, when the stack is updated. For example, if\n your template includes a reference to a resource that is conditionally recreated, the value\n of the reference (the physical ID of the resource) might change, depending on if the\n resource is recreated. If the resource is recreated, it will have a new physical ID, so all\n references to that resource will also be updated.
The group to which the CausingEntity value belongs. There are five\n entity groups:
\n ResourceReference entities are Ref intrinsic functions that\n refer to resources in the template, such as { \"Ref\" : \"MyEC2InstanceResource\"\n }.
\n ParameterReference entities are Ref intrinsic functions\n that get template parameter values, such as { \"Ref\" : \"MyPasswordParameter\"\n }.
\n ResourceAttribute entities are Fn::GetAtt intrinsic\n functions that get resource attribute values, such as { \"Fn::GetAtt\" : [\n \"MyEC2InstanceResource\", \"PublicDnsName\" ] }.
\n DirectModification entities are changes that are made directly to the\n template.
\n Automatic entities are AWS::CloudFormation::Stack resource\n types, which are also known as nested stacks. If you made no changes to the\n AWS::CloudFormation::Stack resource, CloudFormation sets the\n ChangeSource to Automatic because the nested stack's\n template might have changed. Changes to a nested stack's template aren't visible to\n CloudFormation until you run an update on the parent stack.
The group to which the CausingEntity value belongs. There are five entity\n groups:
\n ResourceReference entities are Ref intrinsic functions that\n refer to resources in the template, such as { \"Ref\" : \"MyEC2InstanceResource\"\n }.
\n ParameterReference entities are Ref intrinsic functions\n that get template parameter values, such as { \"Ref\" : \"MyPasswordParameter\"\n }.
\n ResourceAttribute entities are Fn::GetAtt intrinsic\n functions that get resource attribute values, such as { \"Fn::GetAtt\" : [\n \"MyEC2InstanceResource\", \"PublicDnsName\" ] }.
\n DirectModification entities are changes that are made directly to the\n template.
\n Automatic entities are AWS::CloudFormation::Stack resource\n types, which are also known as nested stacks. If you made no changes to the\n AWS::CloudFormation::Stack resource, CloudFormation sets the\n ChangeSource to Automatic because the nested stack's\n template might have changed. Changes to a nested stack's template aren't visible to\n CloudFormation until you run an update on the parent stack.
The identity of the entity that triggered this change. This entity is a member of the\n group that is specified by the ChangeSource field. For example, if you\n modified the value of the KeyPairName parameter, the\n CausingEntity is the name of the parameter\n (KeyPairName).
If the ChangeSource value is DirectModification, no value\n is given for CausingEntity.
The identity of the entity that triggered this change. This entity is a member of the\n group that is specified by the ChangeSource field. For example, if you\n modified the value of the KeyPairName parameter, the\n CausingEntity is the name of the parameter\n (KeyPairName).
If the ChangeSource value is DirectModification, no value is\n given for CausingEntity.
For a resource with Modify as the action, the\n ResourceChange structure describes the changes CloudFormation will make\n to that resource.
For a resource with Modify as the action, the ResourceChange\n structure describes the changes CloudFormation will make to that resource.
The triggers to monitor during stack creation or update actions.
\nBy default, CloudFormation saves the rollback triggers specified for a stack and applies them\n to any subsequent update operations for the stack, unless you specify otherwise. If you do\n specify rollback triggers for this parameter, those triggers replace any list of triggers\n previously specified for the stack. This means:
\nTo use the rollback triggers previously specified for this stack, if any, don't\n specify this parameter.
\nTo specify new or updated rollback triggers, you must specify\n all the triggers that you want used for this stack, even\n triggers you've specifed before (for example, when creating the stack or during a\n previous stack update). Any triggers that you don't include in the updated list of\n triggers are no longer applied to the stack.
\nTo remove all currently specified triggers, specify an empty list for this\n parameter.
\nIf a specified trigger is missing, the entire stack operation fails and is rolled\n back.
" + "smithy.api#documentation": "The triggers to monitor during stack creation or update actions.
\nBy default, CloudFormation saves the rollback triggers specified for a stack and applies them to\n any subsequent update operations for the stack, unless you specify otherwise. If you do\n specify rollback triggers for this parameter, those triggers replace any list of triggers\n previously specified for the stack. This means:
\nTo use the rollback triggers previously specified for this stack, if any, don't\n specify this parameter.
\nTo specify new or updated rollback triggers, you must specify\n all the triggers that you want used for this stack, even\n triggers you've specifed before (for example, when creating the stack or during a\n previous stack update). Any triggers that you don't include in the updated list of\n triggers are no longer applied to the stack.
\nTo remove all currently specified triggers, specify an empty list for this\n parameter.
\nIf a specified trigger is missing, the entire stack operation fails and is rolled back.\n
" } }, "MonitoringTimeInMinutes": { "target": "com.amazonaws.cloudformation#MonitoringTimeInMinutes", "traits": { - "smithy.api#documentation": "The amount of time, in minutes, during which CloudFormation should monitor all the\n rollback triggers after the stack creation or update operation deploys all necessary\n resources.
\nThe default is 0 minutes.
\nIf you specify a monitoring period but do not specify any rollback triggers,\n CloudFormation still waits the specified period of time before cleaning up old resources\n after update operations. You can use this monitoring period to perform any manual stack\n validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.
\nIf you specify 0 for this parameter, CloudFormation still monitors the specified\n rollback triggers during stack creation and update operations. Then, for update operations,\n it begins disposing of old resources immediately once the operation completes.
" + "smithy.api#documentation": "The amount of time, in minutes, during which CloudFormation should monitor all\n the rollback triggers after the stack creation or update operation deploys all necessary\n resources.
\nThe default is 0 minutes.
\nIf you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old\n resources after update operations. You can use this monitoring period to perform any manual\n stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.
\nIf you specify 0 for this parameter, CloudFormation still monitors the\n specified rollback triggers during stack creation and update operations. Then, for update\n operations, it begins disposing of old resources immediately once the operation\n completes.
" } } }, "traits": { - "smithy.api#documentation": "Structure containing the rollback triggers for CloudFormation to monitor during stack creation\n and updating operations, and for the specified monitoring period afterwards.
\nRollback triggers enable you to have CloudFormation monitor the state of your application\n during stack creation and updating, and to roll back that operation if the application\n breaches the threshold of any of the alarms you've specified. For more information, see\n Monitor and Roll Back Stack\n Operations.
" + "smithy.api#documentation": "Structure containing the rollback triggers for CloudFormation to monitor during stack creation\n and updating operations, and for the specified monitoring period afterwards.
\nRollback triggers enable you to have CloudFormation monitor the state of your application during\n stack creation and updating, and to roll back that operation if the application breaches\n the threshold of any of the alarms you've specified. For more information, see Monitor and Roll Back Stack\n Operations.
" } }, "com.amazonaws.cloudformation#RollbackStack": { @@ -6910,7 +6947,7 @@ } ], "traits": { - "smithy.api#documentation": "When specifying RollbackStack, you preserve the state of previously provisioned resources when an operation fails. You can check the status of the stack through the DescribeStacks API.
Rolls back the specified stack to the last known stable state from CREATE_FAILED or UPDATE_FAILED stack statuses.
This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state includes any status in a *_COMPLETE. This includes the following stack statuses.
\n CREATE_COMPLETE\n
\n UPDATE_COMPLETE\n
\n UPDATE_ROLLBACK_COMPLETE\n
\n IMPORT_COMPLETE\n
\n IMPORT_ROLLBACK_COMPLETE\n
When specifying RollbackStack, you preserve the state of previously\n provisioned resources when an operation fails. You can check the status of the stack\n through the DescribeStacks API.
Rolls back the specified stack to the last known stable state from\n CREATE_FAILED or UPDATE_FAILED stack statuses.
This operation will delete a stack if it doesn't contain a last known stable state. A\n last known stable state includes any status in a *_COMPLETE. This includes the\n following stack statuses.
\n CREATE_COMPLETE\n
\n UPDATE_COMPLETE\n
\n UPDATE_ROLLBACK_COMPLETE\n
\n IMPORT_COMPLETE\n
\n IMPORT_ROLLBACK_COMPLETE\n
The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation assumes to rollback the stack.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation\n assumes to rollback the stack.
" } }, "ClientRequestToken": { @@ -6954,20 +6991,20 @@ "Arn": { "target": "com.amazonaws.cloudformation#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the rollback trigger.
\nIf a specified trigger is missing, the entire stack operation fails and is rolled\n back.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the rollback trigger.
\nIf a specified trigger is missing, the entire stack operation fails and is rolled back.\n
", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.cloudformation#Type", "traits": { - "smithy.api#documentation": "The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.
", + "smithy.api#documentation": "The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A rollback trigger CloudFormation monitors during creation and updating of stacks. If any of\n the alarms you specify goes to ALARM state during the stack operation or within the\n specified monitoring period afterwards, CloudFormation rolls back the entire stack\n operation.
" + "smithy.api#documentation": "A rollback trigger CloudFormation monitors during creation and updating of stacks. If any of the\n alarms you specify goes to ALARM state during the stack operation or within the specified\n monitoring period afterwards, CloudFormation rolls back the entire stack\n operation.
" } }, "com.amazonaws.cloudformation#RollbackTriggers": { @@ -7029,13 +7066,13 @@ "StackPolicyBody": { "target": "com.amazonaws.cloudformation#StackPolicyBody", "traits": { - "smithy.api#documentation": "Structure containing the stack policy body. For more information, go to Prevent Updates\n to Stack Resources in the CloudFormation User Guide. You can specify either\n the StackPolicyBody or the StackPolicyURL parameter, but not\n both.
Structure containing the stack policy body. For more information, go to Prevent Updates\n to Stack Resources in the CloudFormation User Guide. You can specify\n either the StackPolicyBody or the StackPolicyURL parameter, but\n not both.
Location of a file containing the stack policy. The URL must point to a policy\n (maximum size: 16 KB) located in an S3 bucket in the same\n Region as the stack. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (maximum\n size: 16 KB) located in an S3 bucket in the same Region as the stack. You can specify\n either the StackPolicyBody or the StackPolicyURL parameter, but\n not both.
Sends a signal to the specified resource with a success or failure status. You can\n use the SignalResource API in conjunction with a creation policy or update policy.\n CloudFormation doesn't proceed with a stack creation or update until resources receive the\n required number of signals or the timeout period is exceeded. The SignalResource API is\n useful in cases where you want to send signals from anywhere other than an Amazon EC2\n instance.
" + "smithy.api#documentation": "Sends a signal to the specified resource with a success or failure status. You can use\n the SignalResource API in conjunction with a creation policy or update policy. CloudFormation doesn't proceed with a stack creation or update until resources receive\n the required number of signals or the timeout period is exceeded. The SignalResource API is\n useful in cases where you want to send signals from anywhere other than an Amazon EC2\n instance.
" } }, "com.amazonaws.cloudformation#SignalResourceInput": { @@ -7193,14 +7230,14 @@ "UniqueId": { "target": "com.amazonaws.cloudformation#ResourceSignalUniqueId", "traits": { - "smithy.api#documentation": "A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling\n groups, specify the instance ID that you are signaling as the unique ID. If you send\n multiple signals to a single resource (such as signaling a wait condition), each signal\n requires a different unique ID.
", + "smithy.api#documentation": "A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups,\n specify the instance ID that you are signaling as the unique ID. If you send multiple\n signals to a single resource (such as signaling a wait condition), each signal requires a\n different unique ID.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.cloudformation#ResourceSignalStatus", "traits": { - "smithy.api#documentation": "The status of the signal, which is either success or failure. A failure signal causes\n CloudFormation to immediately fail the stack creation or update.
", + "smithy.api#documentation": "The status of the signal, which is either success or failure. A failure signal causes\n CloudFormation to immediately fail the stack creation or update.
", "smithy.api#required": {} } } @@ -7259,7 +7296,7 @@ "LastUpdatedTime": { "target": "com.amazonaws.cloudformation#LastUpdatedTime", "traits": { - "smithy.api#documentation": "The time the stack was last updated. This field will only be returned if the stack\n has been updated at least once.
" + "smithy.api#documentation": "The time the stack was last updated. This field will only be returned if the stack has\n been updated at least once.
" } }, "RollbackConfiguration": { @@ -7314,7 +7351,7 @@ "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role\n that is associated with the stack. During a stack operation, CloudFormation uses this\n role's credentials to make calls on your behalf.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that is\n associated with the stack. During a stack operation, CloudFormation uses this\n role's credentials to make calls on your behalf.
" } }, "Tags": { @@ -7332,13 +7369,13 @@ "ParentId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "For nested stacks--stacks created as resources for another stack--the stack ID of the\n direct parent of this stack. For the first level of nested stacks, the root stack is also\n the parent stack.
\nFor more information, see Working with Nested Stacks in the\n CloudFormation User Guide.
" + "smithy.api#documentation": "For nested stacks--stacks created as resources for another stack--the stack ID of the\n direct parent of this stack. For the first level of nested stacks, the root stack is also\n the parent stack.
\nFor more information, see Working with Nested Stacks in the CloudFormation User Guide.
" } }, "RootId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "For nested stacks--stacks created as resources for another stack--the stack ID of the\n top-level stack to which the nested stack ultimately belongs.
\nFor more information, see Working with Nested Stacks in the\n CloudFormation User Guide.
" + "smithy.api#documentation": "For nested stacks--stacks created as resources for another stack--the stack ID of the\n top-level stack to which the nested stack ultimately belongs.
\nFor more information, see Working with Nested Stacks in the CloudFormation User Guide.
" } }, "DriftInformation": { @@ -7389,14 +7426,14 @@ "StackDriftStatus": { "target": "com.amazonaws.cloudformation#StackDriftStatus", "traits": { - "smithy.api#documentation": "Status of the stack's actual configuration compared to its expected template\n configuration.
\n\n DRIFTED: The stack differs from its expected template\n configuration. A stack is considered to have drifted if one or more of its resources\n have drifted.
\n NOT_CHECKED: CloudFormation has not checked if the stack differs from its\n expected template configuration.
\n IN_SYNC: The stack's actual configuration matches its expected\n template configuration.
\n UNKNOWN: This value is reserved for future use.
Status of the stack's actual configuration compared to its expected template\n configuration.
\n\n DRIFTED: The stack differs from its expected template configuration.\n A stack is considered to have drifted if one or more of its resources have\n drifted.
\n NOT_CHECKED: CloudFormation has not checked if the stack differs from its\n expected template configuration.
\n IN_SYNC: The stack's actual configuration matches its expected\n template configuration.
\n UNKNOWN: This value is reserved for future use.
Most recent time when a drift detection operation was initiated on the stack, or any\n of its individual resources that support drift detection.
" + "smithy.api#documentation": "Most recent time when a drift detection operation was initiated on the stack, or any of\n its individual resources that support drift detection.
" } } }, @@ -7410,14 +7447,14 @@ "StackDriftStatus": { "target": "com.amazonaws.cloudformation#StackDriftStatus", "traits": { - "smithy.api#documentation": "Status of the stack's actual configuration compared to its expected template\n configuration.
\n\n DRIFTED: The stack differs from its expected template\n configuration. A stack is considered to have drifted if one or more of its resources\n have drifted.
\n NOT_CHECKED: CloudFormation has not checked if the stack differs from its\n expected template configuration.
\n IN_SYNC: The stack's actual configuration matches its expected\n template configuration.
\n UNKNOWN: This value is reserved for future use.
Status of the stack's actual configuration compared to its expected template\n configuration.
\n\n DRIFTED: The stack differs from its expected template configuration.\n A stack is considered to have drifted if one or more of its resources have\n drifted.
\n NOT_CHECKED: CloudFormation has not checked if the stack differs from its\n expected template configuration.
\n IN_SYNC: The stack's actual configuration matches its expected\n template configuration.
\n UNKNOWN: This value is reserved for future use.
Most recent time when a drift detection operation was initiated on the stack, or any\n of its individual resources that support drift detection.
" + "smithy.api#documentation": "Most recent time when a drift detection operation was initiated on the stack, or any of\n its individual resources that support drift detection.
" } } }, @@ -7487,7 +7524,7 @@ "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { - "smithy.api#documentation": "Type of resource. (For more information, go to Amazon Web Services\n Resource Types Reference in the CloudFormation User Guide.)
" + "smithy.api#documentation": "Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User\n Guide.)
" } }, "Timestamp": { @@ -7518,7 +7555,7 @@ "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "The token passed to the operation that generated this event.
\nAll events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab.\n Stack operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the\n stack operation . For example, if you create a stack using the console, each stack event\n would be assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
The token passed to the operation that generated this event.
\nAll events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab.\n Stack operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the\n stack operation . For example, if you create a stack using the console, each stack event\n would be assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
The name of the Amazon Web Services Region that the stack instance is associated with.
" + "smithy.api#documentation": "The name of the Amazon Web Services Region that the stack instance is associated\n with.
" } }, "Account": { "target": "com.amazonaws.cloudformation#Account", "traits": { - "smithy.api#documentation": "[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.
" + "smithy.api#documentation": "[Self-managed permissions] The name of the Amazon Web Services account that the stack\n instance is associated with.
" } }, "StackId": { @@ -7577,7 +7624,7 @@ "Status": { "target": "com.amazonaws.cloudformation#StackInstanceStatus", "traits": { - "smithy.api#documentation": "The status of the stack instance, in terms of its synchronization with its associated\n stack set.
\n\n INOPERABLE: A DeleteStackInstances operation has\n failed and left the stack in an unstable state. Stacks in this state are excluded\n from further UpdateStackSet operations. You might need to perform a\n DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack\n manually.
\n OUTDATED: The stack isn't currently up to date with the stack set\n because:
The associated stack failed during a CreateStackSet or\n UpdateStackSet operation.
The stack was part of a CreateStackSet or\n UpdateStackSet operation that failed or was stopped before the\n stack was created or updated.
\n CURRENT: The stack is currently up to date with the stack\n set.
The status of the stack instance, in terms of its synchronization with its associated\n stack set.
\n\n INOPERABLE: A DeleteStackInstances operation has failed\n and left the stack in an unstable state. Stacks in this state are excluded from\n further UpdateStackSet operations. You might need to perform a\n DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack\n manually.
\n OUTDATED: The stack isn't currently up to date with the stack set\n because:
The associated stack failed during a CreateStackSet or\n UpdateStackSet operation.
The stack was part of a CreateStackSet or\n UpdateStackSet operation that failed or was stopped before the\n stack was created or updated.
\n CURRENT: The stack is currently up to date with the stack set.
An CloudFormation stack, in a specific account and Region, that's part of a stack\n set operation. A stack instance is a reference to an attempted or actual stack in a given\n account within a given Region. A stack instance can exist without a stack—for example, if\n the stack couldn't be created for some reason. A stack instance is associated with only one\n stack set. Each stack instance contains the ID of its associated stack set, as well as the\n ID of the actual stack and the stack status.
" + "smithy.api#documentation": "An CloudFormation stack, in a specific account and Region, that's part of a\n stack set operation. A stack instance is a reference to an attempted or actual stack in a\n given account within a given Region. A stack instance can exist without a stack—for\n example, if the stack couldn't be created for some reason. A stack instance is associated\n with only one stack set. Each stack instance contains the ID of its associated stack set,\n as well as the ID of the actual stack and the stack status.
" } }, "com.amazonaws.cloudformation#StackInstanceComprehensiveStatus": { @@ -7766,13 +7813,13 @@ "Region": { "target": "com.amazonaws.cloudformation#Region", "traits": { - "smithy.api#documentation": "The name of the Amazon Web Services Region that the stack instance is associated with.
" + "smithy.api#documentation": "The name of the Amazon Web Services Region that the stack instance is associated\n with.
" } }, "Account": { "target": "com.amazonaws.cloudformation#Account", "traits": { - "smithy.api#documentation": "[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.
" + "smithy.api#documentation": "[Self-managed permissions] The name of the Amazon Web Services account that the stack\n instance is associated with.
" } }, "StackId": { @@ -7784,13 +7831,13 @@ "Status": { "target": "com.amazonaws.cloudformation#StackInstanceStatus", "traits": { - "smithy.api#documentation": "The status of the stack instance, in terms of its synchronization with its associated\n stack set.
\n\n INOPERABLE: A DeleteStackInstances operation has\n failed and left the stack in an unstable state. Stacks in this state are excluded\n from further UpdateStackSet operations. You might need to perform a\n DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack\n manually.
\n OUTDATED: The stack isn't currently up to date with the stack set\n because:
The associated stack failed during a CreateStackSet or\n UpdateStackSet operation.
The stack was part of a CreateStackSet or\n UpdateStackSet operation that failed or was stopped before the\n stack was created or updated.
\n CURRENT: The stack is currently up to date with the stack\n set.
The status of the stack instance, in terms of its synchronization with its associated\n stack set.
\n\n INOPERABLE: A DeleteStackInstances operation has failed\n and left the stack in an unstable state. Stacks in this state are excluded from\n further UpdateStackSet operations. You might need to perform a\n DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack\n manually.
\n OUTDATED: The stack isn't currently up to date with the stack set\n because:
The associated stack failed during a CreateStackSet or\n UpdateStackSet operation.
The stack was part of a CreateStackSet or\n UpdateStackSet operation that failed or was stopped before the\n stack was created or updated.
\n CURRENT: The stack is currently up to date with the stack set.
The explanation for the specific status code assigned to this stack\n instance.
" + "smithy.api#documentation": "The explanation for the specific status code assigned to this stack instance.
" } }, "StackInstanceStatus": { @@ -7912,13 +7959,13 @@ "PhysicalResourceId": { "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { - "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a\n resource supported by CloudFormation.
" + "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource\n supported by CloudFormation.
" } }, "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { - "smithy.api#documentation": "Type of resource. (For more information, go to Amazon Web Services\n Resource Types Reference in the CloudFormation User Guide.)
", + "smithy.api#documentation": "Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User\n Guide.)
", "smithy.api#required": {} } }, @@ -7990,13 +8037,13 @@ "PhysicalResourceId": { "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { - "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a\n resource supported by CloudFormation.
" + "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource\n supported by CloudFormation.
" } }, "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { - "smithy.api#documentation": "Type of resource. ((For more information, go to Amazon Web Services\n Resource Types Reference in the CloudFormation User Guide.)
", + "smithy.api#documentation": "Type of resource. ((For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User\n Guide.)
", "smithy.api#required": {} } }, @@ -8029,7 +8076,7 @@ "Metadata": { "target": "com.amazonaws.cloudformation#Metadata", "traits": { - "smithy.api#documentation": "The content of the Metadata attribute declared for the resource. For\n more information, see Metadata\n Attribute in the CloudFormation User Guide.
The content of the Metadata attribute declared for the resource. For more\n information, see Metadata\n Attribute in the CloudFormation User Guide.
The name or unique identifier that corresponds to a physical instance ID of a\n resource supported by CloudFormation.
" + "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource\n supported by CloudFormation.
" } }, "PhysicalResourceIdContext": { @@ -8088,25 +8135,25 @@ "ExpectedProperties": { "target": "com.amazonaws.cloudformation#Properties", "traits": { - "smithy.api#documentation": "A JSON structure containing the expected property values of the stack resource, as\n defined in the stack template and any values specified as template parameters.
\nFor resources whose StackResourceDriftStatus is DELETED,\n this structure will not be present.
A JSON structure containing the expected property values of the stack resource, as\n defined in the stack template and any values specified as template parameters.
\nFor resources whose StackResourceDriftStatus is DELETED, this\n structure will not be present.
A JSON structure containing the actual property values of the stack\n resource.
\nFor resources whose StackResourceDriftStatus is DELETED,\n this structure will not be present.
A JSON structure containing the actual property values of the stack resource.
\nFor resources whose StackResourceDriftStatus is DELETED, this\n structure will not be present.
A collection of the resource properties whose actual values differ from their\n expected values. These will be present only for resources whose\n StackResourceDriftStatus is MODIFIED.\n
A collection of the resource properties whose actual values differ from their expected\n values. These will be present only for resources whose\n StackResourceDriftStatus is MODIFIED.\n
Status of the resource's actual configuration compared to its expected\n configuration
\n\n DELETED: The resource differs from its expected template\n configuration because the resource has been deleted.
\n MODIFIED: One or more resource properties differ from their\n expected values (as defined in the stack template and any values specified as\n template parameters).
\n IN_SYNC: The resources's actual configuration matches its expected\n template configuration.
\n NOT_CHECKED: CloudFormation does not currently return this value.
Status of the resource's actual configuration compared to its expected\n configuration
\n\n DELETED: The resource differs from its expected template\n configuration because the resource has been deleted.
\n MODIFIED: One or more resource properties differ from their expected\n values (as defined in the stack template and any values specified as template\n parameters).
\n IN_SYNC: The resources's actual configuration matches its expected\n template configuration.
\n NOT_CHECKED: CloudFormation does not currently return this value.
Contains the drift information for a resource that has been checked for drift. This\n includes actual and expected property values for resources in which CloudFormation has detected\n drift. Only resource properties explicitly defined in the stack template are checked for\n drift. For more information, see Detecting\n Unregulated Configuration Changes to Stacks and Resources.
\nResources that do not currently support drift detection cannot be checked. For a list\n of resources that support drift detection, see Resources that Support\n Drift Detection.
\nUse DetectStackResourceDrift to detect drift on individual\n resources, or DetectStackDrift to detect drift on all resources in a\n given stack that support drift detection.
" + "smithy.api#documentation": "Contains the drift information for a resource that has been checked for drift. This\n includes actual and expected property values for resources in which CloudFormation has detected\n drift. Only resource properties explicitly defined in the stack template are checked for\n drift. For more information, see Detecting\n Unregulated Configuration Changes to Stacks and Resources.
\nResources that do not currently support drift detection cannot be checked. For a list of\n resources that support drift detection, see Resources that Support\n Drift Detection.
\nUse DetectStackResourceDrift to detect drift on individual resources,\n or DetectStackDrift to detect drift on all resources in a given stack\n that support drift detection.
" } }, "com.amazonaws.cloudformation#StackResourceDriftInformation": { @@ -8134,7 +8181,7 @@ "StackResourceDriftStatus": { "target": "com.amazonaws.cloudformation#StackResourceDriftStatus", "traits": { - "smithy.api#documentation": "Status of the resource's actual configuration compared to its expected\n configuration
\n\n DELETED: The resource differs from its expected configuration in\n that it has been deleted.
\n MODIFIED: The resource differs from its expected\n configuration.
\n NOT_CHECKED: CloudFormation has not checked if the resource differs from\n its expected configuration.
Any resources that do not currently support drift detection have a status of\n NOT_CHECKED. For more information, see Resources that Support Drift Detection.
\n IN_SYNC: The resources's actual configuration matches its expected\n configuration.
Status of the resource's actual configuration compared to its expected\n configuration
\n\n DELETED: The resource differs from its expected configuration in that\n it has been deleted.
\n MODIFIED: The resource differs from its expected\n configuration.
\n NOT_CHECKED: CloudFormation has not checked if the resource differs from its\n expected configuration.
Any resources that do not currently support drift detection have a status of\n NOT_CHECKED. For more information, see Resources that Support Drift Detection.
\n IN_SYNC: The resources's actual configuration matches its expected\n configuration.
Contains information about whether the resource's actual configuration differs, or\n has drifted, from its expected configuration.
" + "smithy.api#documentation": "Contains information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration.
" } }, "com.amazonaws.cloudformation#StackResourceDriftInformationSummary": { @@ -8155,7 +8202,7 @@ "StackResourceDriftStatus": { "target": "com.amazonaws.cloudformation#StackResourceDriftStatus", "traits": { - "smithy.api#documentation": "Status of the resource's actual configuration compared to its expected\n configuration
\n\n DELETED: The resource differs from its expected configuration in\n that it has been deleted.
\n MODIFIED: The resource differs from its expected\n configuration.
\n NOT_CHECKED: CloudFormation has not checked if the resource differs from\n its expected configuration.
Any resources that do not currently support drift detection have a status of\n NOT_CHECKED. For more information, see Resources that Support Drift Detection. If you performed an ContinueUpdateRollback operation on a stack, any resources included in\n ResourcesToSkip will also have a status of NOT_CHECKED.\n For more information on skipping resources during rollback operations, see Continue Rolling Back an Update in the CloudFormation User Guide.
\n IN_SYNC: The resources's actual configuration matches its expected\n configuration.
Status of the resource's actual configuration compared to its expected\n configuration
\n\n DELETED: The resource differs from its expected configuration in that\n it has been deleted.
\n MODIFIED: The resource differs from its expected\n configuration.
\n NOT_CHECKED: CloudFormation has not checked if the resource differs from its\n expected configuration.
Any resources that do not currently support drift detection have a status of\n NOT_CHECKED. For more information, see Resources that Support Drift Detection. If you performed an ContinueUpdateRollback operation on a stack, any resources included in\n ResourcesToSkip will also have a status of NOT_CHECKED.\n For more information on skipping resources during rollback operations, see Continue Rolling Back an Update in the CloudFormation User Guide.
\n IN_SYNC: The resources's actual configuration matches its expected\n configuration.
Summarizes information about whether the resource's actual configuration differs, or\n has drifted, from its expected configuration.
" + "smithy.api#documentation": "Summarizes information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration.
" } }, "com.amazonaws.cloudformation#StackResourceDriftStatus": { @@ -8236,7 +8283,7 @@ "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { - "smithy.api#documentation": "Type of resource. (For more information, go to Amazon Web Services\n Resource Types Reference in the CloudFormation User Guide.)
", + "smithy.api#documentation": "Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User\n Guide.)
", "smithy.api#required": {} } }, @@ -8313,7 +8360,7 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "The structure that contains the body of the template that was used to create or\n update the stack set.
" + "smithy.api#documentation": "The structure that contains the body of the template that was used to create or update\n the stack set.
" } }, "Parameters": { @@ -8325,13 +8372,13 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "The capabilities that are allowed in the stack set. Some stack set templates might\n include resources that can affect permissions in your Amazon Web Services account—for example, by creating\n new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in CloudFormation Templates.\n
" + "smithy.api#documentation": "The capabilities that are allowed in the stack set. Some stack set templates might\n include resources that can affect permissions in your Amazon Web Services account—for\n example, by creating new Identity and Access Management (IAM) users. For more information, see\n Acknowledging IAM Resources in CloudFormation Templates.\n
" } }, "Tags": { "target": "com.amazonaws.cloudformation#Tags", "traits": { - "smithy.api#documentation": "A list of tags that specify information about the stack set. A maximum number of 50\n tags can be specified.
" + "smithy.api#documentation": "A list of tags that specify information about the stack set. A maximum number of 50 tags\n can be specified.
" } }, "StackSetARN": { @@ -8375,10 +8422,16 @@ "traits": { "smithy.api#documentation": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs\n that you specified for DeploymentTargets.
" } + }, + "ManagedExecution": { + "target": "com.amazonaws.cloudformation#ManagedExecution", + "traits": { + "smithy.api#documentation": "Describes whether StackSets performs non-conflicting operations concurrently and queues\n conflicting operations.
" + } } }, "traits": { - "smithy.api#documentation": "A structure that contains information about a stack set. A stack set enables you to\n provision stacks into Amazon Web Services accounts and across Regions by using a single CloudFormation\n template. In the stack set, you specify the template to use, as well as any parameters and\n capabilities that the template requires.
" + "smithy.api#documentation": "A structure that contains information about a stack set. A stack set enables you to\n provision stacks into Amazon Web Services accounts and across Regions by using a single\n CloudFormation template. In the stack set, you specify the template to use, as\n well as any parameters and capabilities that the template requires.
" } }, "com.amazonaws.cloudformation#StackSetARN": { @@ -8556,19 +8609,19 @@ "Status": { "target": "com.amazonaws.cloudformation#StackSetOperationStatus", "traits": { - "smithy.api#documentation": "The status of the operation.
\n\n FAILED: The operation exceeded the specified failure tolerance.\n The failure tolerance value that you've set for an operation is applied for each\n Region during stack create and update operations. If the number of failed stacks\n within a Region exceeds the failure tolerance, the status of the operation in the\n Region is set to FAILED. This in turn sets the status of the operation\n as a whole to FAILED, and CloudFormation cancels the operation in\n any remaining Regions.
\n QUEUED: [Service-managed permissions] For automatic deployments that\n require a sequence of operations, the operation is queued to be performed. For more\n information, see the stack set operation status codes in the CloudFormation User\n Guide.
\n RUNNING: The operation is currently being performed.
\n STOPPED: The user has cancelled the operation.
\n STOPPING: The operation is in the process of stopping, at user\n request.
\n SUCCEEDED: The operation completed creating or updating all the\n specified stacks without exceeding the failure tolerance for the operation.
The status of the operation.
\n\n FAILED: The operation exceeded the specified failure tolerance. The\n failure tolerance value that you've set for an operation is applied for each Region\n during stack create and update operations. If the number of failed stacks within a\n Region exceeds the failure tolerance, the status of the operation in the Region is\n set to FAILED. This in turn sets the status of the operation as a whole\n to FAILED, and CloudFormation cancels the operation in any\n remaining Regions.
\n QUEUED: [Service-managed permissions] For automatic deployments that\n require a sequence of operations, the operation is queued to be performed. For more\n information, see the stack set operation status codes in the CloudFormation User\n Guide.
\n RUNNING: The operation is currently being performed.
\n STOPPED: The user has cancelled the operation.
\n STOPPING: The operation is in the process of stopping, at user\n request.
\n SUCCEEDED: The operation completed creating or updating all the\n specified stacks without exceeding the failure tolerance for the operation.
The preferences for how CloudFormation performs this stack set\n operation.
" + "smithy.api#documentation": "The preferences for how CloudFormation performs this stack set operation.
" } }, "RetainStacks": { "target": "com.amazonaws.cloudformation#RetainStacksNullable", "traits": { - "smithy.api#documentation": "For stack set operations of action type DELETE, specifies whether to\n remove the stack instances from the specified stack set, but doesn't delete the stacks. You\n can't reassociate a retained stack, or add an existing, saved stack to a new stack\n set.
For stack set operations of action type DELETE, specifies whether to remove\n the stack instances from the specified stack set, but doesn't delete the stacks. You can't\n reassociate a retained stack, or add an existing, saved stack to a new stack set.
The time at which the operation was initiated. Note that the creation times for the\n stack set operation might differ from the creation time of the individual stacks\n themselves. This is because CloudFormation needs to perform preparatory work for the\n operation, such as dispatching the work to the requested Regions, before actually creating\n the first stacks.
" + "smithy.api#documentation": "The time at which the operation was initiated. Note that the creation times for the\n stack set operation might differ from the creation time of the individual stacks\n themselves. This is because CloudFormation needs to perform preparatory work for\n the operation, such as dispatching the work to the requested Regions, before actually\n creating the first stacks.
" } }, "EndTimestamp": { @@ -8653,25 +8706,25 @@ "FailureToleranceCount": { "target": "com.amazonaws.cloudformation#FailureToleranceCount", "traits": { - "smithy.api#documentation": "The number of accounts, per Region, for which this operation can fail before\n CloudFormation stops the operation in that Region. If the operation is stopped in a Region,\n CloudFormation doesn't attempt the operation in any subsequent Regions.
\nConditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage (but not both).
By default, 0 is specified.
The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a\n Region, CloudFormation doesn't attempt the operation in any subsequent\n Regions.
\nConditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage (but not both).
By default, 0 is specified.
The percentage of accounts, per Region, for which this stack operation can fail\n before CloudFormation stops the operation in that Region. If the operation is stopped\n in a Region, CloudFormation doesn't attempt the operation in any subsequent\n Regions.
\nWhen calculating the number of accounts based on the specified percentage,\n CloudFormation rounds down to the next whole number.
\nConditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage, but not both.
By default, 0 is specified.
The percentage of accounts, per Region, for which this stack operation can fail before\n CloudFormation stops the operation in that Region. If the operation is stopped\n in a Region, CloudFormation doesn't attempt the operation in any subsequent\n Regions.
\nWhen calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number.
\nConditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage, but not both.
By default, 0 is specified.
The maximum number of accounts in which to perform this operation at one time. This\n is dependent on the value of\n FailureToleranceCount. MaxConcurrentCount is at most one more\n than the FailureToleranceCount.
Note that this setting lets you specify the maximum for\n operations. For large deployments, under certain circumstances the actual number of\n accounts acted upon concurrently may be lower due to service throttling.
\nConditional: You must specify either MaxConcurrentCount or\n MaxConcurrentPercentage, but not both.
By default, 1 is specified.
The maximum number of accounts in which to perform this operation at one time. This is\n dependent on the value of FailureToleranceCount.\n MaxConcurrentCount is at most one more than the\n FailureToleranceCount.
Note that this setting lets you specify the maximum for operations.\n For large deployments, under certain circumstances the actual number of accounts acted upon\n concurrently may be lower due to service throttling.
\nConditional: You must specify either MaxConcurrentCount or\n MaxConcurrentPercentage, but not both.
By default, 1 is specified.
The maximum percentage of accounts in which to perform this operation at one\n time.
\nWhen calculating the number of accounts based on the specified percentage,\n CloudFormation rounds down to the next whole number. This is true except in cases where\n rounding down would result is zero. In this case, CloudFormation sets the number as one\n instead.
\nNote that this setting lets you specify the maximum for\n operations. For large deployments, under certain circumstances the actual number of\n accounts acted upon concurrently may be lower due to service throttling.
\nConditional: You must specify either MaxConcurrentCount or\n MaxConcurrentPercentage, but not both.
By default, 1 is specified.
The maximum percentage of accounts in which to perform this operation at one\n time.
\nWhen calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where\n rounding down would result is zero. In this case, CloudFormation sets the number\n as one instead.
\nNote that this setting lets you specify the maximum for operations.\n For large deployments, under certain circumstances the actual number of accounts acted upon\n concurrently may be lower due to service throttling.
\nConditional: You must specify either MaxConcurrentCount or\n MaxConcurrentPercentage, but not both.
By default, 1 is specified.
[Self-managed permissions] The name of the Amazon Web Services account for this operation result.
" + "smithy.api#documentation": "[Self-managed permissions] The name of the Amazon Web Services account for this operation\n result.
" } }, "Region": { @@ -8730,7 +8783,7 @@ "Status": { "target": "com.amazonaws.cloudformation#StackSetOperationResultStatus", "traits": { - "smithy.api#documentation": "The result status of the stack set operation for the given account in the given\n Region.
\n\n CANCELLED: The operation in the specified account and Region has\n been cancelled. This is either because a user has stopped the stack set operation, or\n because the failure tolerance of the stack set operation has been exceeded.
\n FAILED: The operation in the specified account and Region failed.
If the stack set operation fails in enough accounts within a Region, the\n failure tolerance for the stack set operation as a whole might be exceeded.\n
\n\n RUNNING: The operation in the specified account and Region is\n currently in progress.
\n PENDING: The operation in the specified account and Region has yet\n to start.
\n SUCCEEDED: The operation in the specified account and Region\n completed successfully.
The result status of the stack set operation for the given account in the given\n Region.
\n\n CANCELLED: The operation in the specified account and Region has been\n cancelled. This is either because a user has stopped the stack set operation, or\n because the failure tolerance of the stack set operation has been exceeded.
\n FAILED: The operation in the specified account and Region failed.
If the stack set operation fails in enough accounts within a Region, the failure\n tolerance for the stack set operation as a whole might be exceeded.
\n\n RUNNING: The operation in the specified account and Region is\n currently in progress.
\n PENDING: The operation in the specified account and Region has yet to\n start.
\n SUCCEEDED: The operation in the specified account and Region\n completed successfully.
The type of operation: CREATE, UPDATE, or\n DELETE. Create and delete operations affect only the specified stack\n instances that are associated with the specified stack set. Update operations affect both\n the stack set itself as well as all associated stack set\n instances.
The type of operation: CREATE, UPDATE, or DELETE.\n Create and delete operations affect only the specified stack instances that are associated\n with the specified stack set. Update operations affect both the stack set itself as well as\n all associated stack set instances.
The overall status of the operation.
\n\n FAILED: The operation exceeded the specified failure tolerance.\n The failure tolerance value that you've set for an operation is applied for each\n Region during stack create and update operations. If the number of failed stacks\n within a Region exceeds the failure tolerance, the status of the operation in the\n Region is set to FAILED. This in turn sets the status of the operation\n as a whole to FAILED, and CloudFormation cancels the operation in\n any remaining Regions.
\n QUEUED: [Service-managed permissions] For automatic deployments that\n require a sequence of operations, the operation is queued to be performed. For more\n information, see the stack set operation status codes in the CloudFormation User\n Guide.
\n RUNNING: The operation is currently being performed.
\n STOPPED: The user has cancelled the operation.
\n STOPPING: The operation is in the process of stopping, at user\n request.
\n SUCCEEDED: The operation completed creating or updating all the\n specified stacks without exceeding the failure tolerance for the operation.
The overall status of the operation.
\n\n FAILED: The operation exceeded the specified failure tolerance. The\n failure tolerance value that you've set for an operation is applied for each Region\n during stack create and update operations. If the number of failed stacks within a\n Region exceeds the failure tolerance, the status of the operation in the Region is\n set to FAILED. This in turn sets the status of the operation as a whole\n to FAILED, and CloudFormation cancels the operation in any\n remaining Regions.
\n QUEUED: [Service-managed permissions] For automatic deployments that\n require a sequence of operations, the operation is queued to be performed. For more\n information, see the stack set operation status codes in the CloudFormation User\n Guide.
\n RUNNING: The operation is currently being performed.
\n STOPPED: The user has cancelled the operation.
\n STOPPING: The operation is in the process of stopping, at user\n request.
\n SUCCEEDED: The operation completed creating or updating all the\n specified stacks without exceeding the failure tolerance for the operation.
The time at which the operation was initiated. Note that the creation times for the\n stack set operation might differ from the creation time of the individual stacks\n themselves. This is because CloudFormation needs to perform preparatory work for the\n operation, such as dispatching the work to the requested Regions, before actually creating\n the first stacks.
" + "smithy.api#documentation": "The time at which the operation was initiated. Note that the creation times for the\n stack set operation might differ from the creation time of the individual stacks\n themselves. This is because CloudFormation needs to perform preparatory work for\n the operation, such as dispatching the work to the requested Regions, before actually\n creating the first stacks.
" } }, "EndTimestamp": { @@ -8828,7 +8881,7 @@ } }, "traits": { - "smithy.api#documentation": "The structures that contain summary information about the specified\n operation.
" + "smithy.api#documentation": "The structures that contain summary information about the specified operation.
" } }, "com.amazonaws.cloudformation#StackSetStatus": { @@ -8902,10 +8955,16 @@ "traits": { "smithy.api#documentation": "Most recent time when CloudFormation performed a drift detection operation on\n the stack set. This value will be NULL for any stack set on which drift\n detection has not yet been performed.
Describes whether StackSets performs non-conflicting operations concurrently and queues\n conflicting operations.
" + } } }, "traits": { - "smithy.api#documentation": "The structures that contain summary information about the specified stack\n set.
" + "smithy.api#documentation": "The structures that contain summary information about the specified stack set.
" } }, "com.amazonaws.cloudformation#StackStatus": { @@ -9054,7 +9113,7 @@ "LastUpdatedTime": { "target": "com.amazonaws.cloudformation#LastUpdatedTime", "traits": { - "smithy.api#documentation": "The time the stack was last updated. This field will only be returned if the stack\n has been updated at least once.
" + "smithy.api#documentation": "The time the stack was last updated. This field will only be returned if the stack has\n been updated at least once.
" } }, "DeletionTime": { @@ -9079,13 +9138,13 @@ "ParentId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "For nested stacks--stacks created as resources for another stack--the stack ID of the\n direct parent of this stack. For the first level of nested stacks, the root stack is also\n the parent stack.
\nFor more information, see Working with Nested Stacks in the\n CloudFormation User Guide.
" + "smithy.api#documentation": "For nested stacks--stacks created as resources for another stack--the stack ID of the\n direct parent of this stack. For the first level of nested stacks, the root stack is also\n the parent stack.
\nFor more information, see Working with Nested Stacks in the CloudFormation User Guide.
" } }, "RootId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "For nested stacks--stacks created as resources for another stack--the stack ID of the\n top-level stack to which the nested stack ultimately belongs.
\nFor more information, see Working with Nested Stacks in the\n CloudFormation User Guide.
" + "smithy.api#documentation": "For nested stacks--stacks created as resources for another stack--the stack ID of the\n top-level stack to which the nested stack ultimately belongs.
\nFor more information, see Working with Nested Stacks in the CloudFormation User Guide.
" } }, "DriftInformation": { @@ -9123,7 +9182,7 @@ "code": "StaleRequestException", "httpResponseCode": 409 }, - "smithy.api#documentation": "Another operation has been performed on this stack set since the specified operation\n was performed.
", + "smithy.api#documentation": "Another operation has been performed on this stack set since the specified operation was\n performed.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -9166,7 +9225,7 @@ "StackSetName": { "target": "com.amazonaws.cloudformation#StackSetName", "traits": { - "smithy.api#documentation": "The name or unique ID of the stack set that you want to stop the operation\n for.
", + "smithy.api#documentation": "The name or unique ID of the stack set that you want to stop the operation for.
", "smithy.api#required": {} } }, @@ -9211,7 +9270,7 @@ "Key": { "target": "com.amazonaws.cloudformation#TagKey", "traits": { - "smithy.api#documentation": "\n Required. A string used to identify this tag. You can specify a\n maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (Amazon Web Services) have the\n reserved prefix: aws:.
\n Required. A string used to identify this tag. You can specify a\n maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (Amazon Web Services) have the reserved prefix: aws:.
The category of extensions to return.
\n\n REGISTERED: Private extensions that have been registered for this\n account and region.
\n ACTIVATED: Public extensions that have been activated for this\n account and region.
\n THIRD-PARTY: Extensions available for use from publishers other than\n Amazon. This includes:
Private extensions registered in the account.
\nPublic extensions from publishers other than Amazon, whether activated or\n not.
\n\n AWS-TYPES: Extensions available for use from Amazon.
The category of extensions to return.
\n\n REGISTERED: Private extensions that have been registered for this\n account and region.
\n ACTIVATED: Public extensions that have been activated for this\n account and region.
\n THIRD_PARTY: Extensions available for use from publishers other than\n Amazon. This includes:
Private extensions registered in the account.
\nPublic extensions from publishers other than Amazon, whether activated or\n not.
\n\n AWS_TYPES: Extensions available for use from Amazon.
The id of the publisher of the extension.
\nExtensions published by Amazon are not assigned a publisher ID. Use the\n AWS-TYPES category to specify a list of types published by Amazon.
The id of the publisher of the extension.
\nExtensions published by Amazon are not assigned a publisher ID. Use the\n AWS_TYPE category to specify a list of types published by Amazon.
Updates a stack as specified in the template. After the call completes successfully,\n the stack update starts. You can check the status of the stack via the DescribeStacks action.
\nTo get a copy of the template for an existing stack, you can use the GetTemplate action.
\nFor more information about creating an update template, updating a stack, and\n monitoring the progress of the update, see Updating a\n Stack.
" + "smithy.api#documentation": "Updates a stack as specified in the template. After the call completes successfully, the\n stack update starts. You can check the status of the stack via the DescribeStacks action.
\nTo get a copy of the template for an existing stack, you can use the GetTemplate action.
\nFor more information about creating an update template, updating a stack, and monitoring\n the progress of the update, see Updating a\n Stack.
" } }, "com.amazonaws.cloudformation#UpdateStackInput": { @@ -9950,7 +10009,7 @@ "TemplateURL": { "target": "com.amazonaws.cloudformation#TemplateURL", "traits": { - "smithy.api#documentation": "Location of file containing the template body. The URL must point to a template that\n is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to\n Template Anatomy\n in the CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters:\n TemplateBody, TemplateURL, or set the\n UsePreviousTemplate to true.
Location of file containing the template body. The URL must point to a template that is\n located in an Amazon S3 bucket or a Systems Manager document. For more information, go to\n Template Anatomy\n in the CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters:\n TemplateBody, TemplateURL, or set the\n UsePreviousTemplate to true.
Structure containing the temporary overriding stack policy body. You can specify\n either the StackPolicyDuringUpdateBody or the\n StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack\n policy during this update. If you do not specify a stack policy, the current policy that is\n associated with the stack will be used.
" + "smithy.api#documentation": "Structure containing the temporary overriding stack policy body. You can specify either\n the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL\n parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy\n during this update. If you do not specify a stack policy, the current policy that is\n associated with the stack will be used.
" } }, "StackPolicyDuringUpdateURL": { "target": "com.amazonaws.cloudformation#StackPolicyDuringUpdateURL", "traits": { - "smithy.api#documentation": "Location of a file containing the temporary overriding stack policy. The URL must\n point to a policy (max size: 16KB) located in an S3 bucket in\n the same Region as the stack. You can specify either the\n StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL\n parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack\n policy during this update. If you do not specify a stack policy, the current policy that is\n associated with the stack will be used.
" + "smithy.api#documentation": "Location of a file containing the temporary overriding stack policy. The URL must point\n to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. You\n can specify either the StackPolicyDuringUpdateBody or the\n StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy\n during this update. If you do not specify a stack policy, the current policy that is\n associated with the stack will be used.
" } }, "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "A list of Parameter structures that specify input parameters for the\n stack. For more information, see the Parameter data\n type.
A list of Parameter structures that specify input parameters for the stack.\n For more information, see the Parameter data\n type.
In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to update the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in\n your Amazon Web Services account; for example, by creating new Identity and Access Management\n (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one\n of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM\n capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review\n all permissions associated with them and edit their permissions if\n necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this\n can include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change\n set from the processed template, so that they can review the changes resulting from\n the macros before actually updating the stack. If your stack template contains one or\n more macros, and you choose to update a stack directly from the processed template,\n without first reviewing the resulting changes in a change set, you must acknowledge\n this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
\nIf you want to update a stack from a stack template that contains macros\n and nested stacks, you must update the stack directly from\n the template using this capability.
\nYou should only update stacks directly from a stack template that contains\n macros if you know what processing the macro performs.
\nEach macro relies on an underlying Lambda service function for processing stack\n templates. Be aware that the Lambda function owner can update the function\n operation without CloudFormation being notified.
\nFor more information, see Using\n CloudFormation Macros to Perform Custom Processing on\n Templates.
\nIn some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to update the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new Identity and Access Management\n (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one\n of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM\n capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all\n permissions associated with them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this\n can include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change\n set from the processed template, so that they can review the changes resulting from\n the macros before actually updating the stack. If your stack template contains one or\n more macros, and you choose to update a stack directly from the processed template,\n without first reviewing the resulting changes in a change set, you must acknowledge\n this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
\nIf you want to update a stack from a stack template that contains macros\n and nested stacks, you must update the stack directly from\n the template using this capability.
\nYou should only update stacks directly from a stack template that contains\n macros if you know what processing the macro performs.
\nEach macro relies on an underlying Lambda service function for processing stack\n templates. Be aware that the Lambda function owner can update the function\n operation without CloudFormation being notified.
\nFor more information, see Using\n CloudFormation Macros to Perform Custom Processing on\n Templates.
\nThe template resource types that you have permissions to work with for this update\n stack action, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance.
If the list of resource types doesn't include a resource that you're updating, the\n stack update fails. By default, CloudFormation grants permissions to all resource\n types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
" + "smithy.api#documentation": "The template resource types that you have permissions to work with for this update stack\n action, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance.
If the list of resource types doesn't include a resource that you're updating, the stack\n update fails. By default, CloudFormation grants permissions to all resource types.\n Identity and Access Management (IAM) uses this parameter for CloudFormation-specific\n condition keys in IAM policies. For more information, see Controlling Access with\n Identity and Access Management.
" } }, "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role\n that CloudFormation assumes to update the stack. CloudFormation uses the role's\n credentials to make calls on your behalf. CloudFormation always uses this role for all\n future operations on the stack. As long as users have permission to operate on the stack,\n CloudFormation uses this role even if the users don't have permission to pass it.\n Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously\n associated with the stack. If no role is available, CloudFormation uses a temporary\n session that is generated from your user credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's\n credentials to make calls on your behalf. CloudFormation always uses this role for\n all future operations on the stack. As long as users have permission to operate on the\n stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously\n associated with the stack. If no role is available, CloudFormation uses a temporary\n session that is generated from your user credentials.
" } }, "RollbackConfiguration": { @@ -10004,19 +10063,19 @@ "StackPolicyBody": { "target": "com.amazonaws.cloudformation#StackPolicyBody", "traits": { - "smithy.api#documentation": "Structure containing a new stack policy body. You can specify either the\n StackPolicyBody or the StackPolicyURL parameter, but not\n both.
You might update the stack policy, for example, in order to protect a new resource\n that you created during a stack update. If you do not specify a stack policy, the current\n policy that is associated with the stack is unchanged.
" + "smithy.api#documentation": "Structure containing a new stack policy body. You can specify either the\n StackPolicyBody or the StackPolicyURL parameter, but not\n both.
You might update the stack policy, for example, in order to protect a new resource that\n you created during a stack update. If you do not specify a stack policy, the current policy\n that is associated with the stack is unchanged.
" } }, "StackPolicyURL": { "target": "com.amazonaws.cloudformation#StackPolicyURL", "traits": { - "smithy.api#documentation": "Location of a file containing the updated stack policy. The URL must point to a\n policy (max size: 16KB) located in an S3 bucket in the same\n Region as the stack. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource\n that you created during a stack update. If you do not specify a stack policy, the current\n policy that is associated with the stack is unchanged.
" + "smithy.api#documentation": "Location of a file containing the updated stack policy. The URL must point to a policy\n (max size: 16KB) located in an S3 bucket in the same Region as the stack. You can specify\n either the StackPolicyBody or the StackPolicyURL parameter, but\n not both.
You might update the stack policy, for example, in order to protect a new resource that\n you created during a stack update. If you do not specify a stack policy, the current policy\n that is associated with the stack is unchanged.
" } }, "NotificationARNs": { "target": "com.amazonaws.cloudformation#NotificationARNs", "traits": { - "smithy.api#documentation": "Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that\n CloudFormation associates with the stack. Specify an empty list to remove all notification\n topics.
" + "smithy.api#documentation": "Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack. Specify an empty list to remove all\n notification topics.
" } }, "Tags": { @@ -10034,7 +10093,7 @@ "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique identifier for this UpdateStack request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to\n update a stack with the same name. You might retry UpdateStack requests to\n ensure that CloudFormation successfully received them.
All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab.\n Stack operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the\n stack operation . For example, if you create a stack using the console, each stack event\n would be assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
A unique identifier for this UpdateStack request. Specify this token if you\n plan to retry requests so that CloudFormation knows that you're not attempting to\n update a stack with the same name. You might retry UpdateStack requests to\n ensure that CloudFormation successfully received them.
All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab.\n Stack operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the\n stack operation . For example, if you create a stack using the console, each stack event\n would be assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
Updates the parameter values for stack instances for the specified accounts, within\n the specified Regions. A stack instance refers to a stack in a specific account and Region.
\nYou can only update stack instances in Regions and accounts where they already exist;\n to create additional stack instances, use CreateStackInstances.
\nDuring stack set updates, any parameters overridden for a stack instance are not\n updated, but retain their overridden value.
\nYou can only update the parameter values that are specified in\n the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a\n template, before you can override the parameter value specified in the stack set you must\n first use UpdateStackSet to update all stack instances with the updated template and\n parameter value specified in the stack set. Once a stack instance has been updated with the\n new parameter, you can then override the parameter value using\n UpdateStackInstances.
Updates the parameter values for stack instances for the specified accounts, within the\n specified Regions. A stack instance refers to a stack in a specific account and Region.
\nYou can only update stack instances in Regions and accounts where they already exist; to\n create additional stack instances, use CreateStackInstances.
\nDuring stack set updates, any parameters overridden for a stack instance are not\n updated, but retain their overridden value.
\nYou can only update the parameter values that are specified in the\n stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a\n template, before you can override the parameter value specified in the stack set you must\n first use UpdateStackSet to update all stack instances with the updated template and\n parameter value specified in the stack set. Once a stack instance has been updated with the\n new parameter, you can then override the parameter value using\n UpdateStackInstances.
[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values\n for stack instances. The overridden parameter values will be applied to all stack instances\n in the specified accounts and Regions.
\nYou can specify Accounts or DeploymentTargets, but not both.
[Self-managed permissions] The names of one or more Amazon Web Services accounts for\n which you want to update parameter values for stack instances. The overridden parameter\n values will be applied to all stack instances in the specified accounts and Regions.
\nYou can specify Accounts or DeploymentTargets, but not\n both.
The names of one or more Regions in which you want to update parameter values for\n stack instances. The overridden parameter values will be applied to all stack instances in\n the specified accounts and Regions.
", + "smithy.api#documentation": "The names of one or more Regions in which you want to update parameter values for stack\n instances. The overridden parameter values will be applied to all stack instances in the\n specified accounts and Regions.
", "smithy.api#required": {} } }, "ParameterOverrides": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "A list of input parameters whose values you want to update for the specified stack\n instances.
\nAny overridden parameter values will be applied to all stack instances in the\n specified accounts and Regions. When specifying parameters and their values, be aware of\n how CloudFormation sets parameter values during stack instance update\n operations:
\nTo override the current value for a parameter, include the parameter and\n specify its value.
\nTo leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as\n true. (You cannot specify both a value and set\n UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set,\n specify a parameter list but do not include the parameter in the list.
\nTo leave all parameters set to their present values, do not specify this\n property at all.
\nDuring stack set updates, any parameter values overridden for a stack instance are\n not updated, but retain their overridden value.
\nYou can only override the parameter values that are specified in\n the stack set; to add or delete a parameter itself, use UpdateStackSet to\n update the stack set template. If you add a parameter to a template, before you can\n override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and\n parameter value specified in the stack set. Once a stack instance has been updated with the\n new parameter, you can then override the parameter value using\n UpdateStackInstances.
A list of input parameters whose values you want to update for the specified stack\n instances.
\nAny overridden parameter values will be applied to all stack instances in the specified\n accounts and Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:
\nTo override the current value for a parameter, include the parameter and specify\n its value.
\nTo leave an overridden parameter set to its present value, include the parameter\n and specify UsePreviousValue as true. (You cannot specify\n both a value and set UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set,\n specify a parameter list but do not include the parameter in the list.
\nTo leave all parameters set to their present values, do not specify this property\n at all.
\nDuring stack set updates, any parameter values overridden for a stack instance are not\n updated, but retain their overridden value.
\nYou can only override the parameter values that are specified in\n the stack set; to add or delete a parameter itself, use UpdateStackSet to\n update the stack set template. If you add a parameter to a template, before you can\n override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and\n parameter value specified in the stack set. Once a stack instance has been updated with the\n new parameter, you can then override the parameter value using\n UpdateStackInstances.
The unique identifier for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that\n CloudFormation performs the stack set operation only once, even if you retry the request\n multiple times. You might retry stack set operation requests to ensure that\n CloudFormation successfully received them.
\nIf you don't specify an operation ID, the SDK generates one automatically.\n
", + "smithy.api#documentation": "The unique identifier for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request\n multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.
\nIf you don't specify an operation ID, the SDK generates one automatically.\n
", "smithy.api#idempotencyToken": {} } }, @@ -10184,7 +10243,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the stack set, and associated stack instances in the specified accounts and\n Regions.
\nEven if the stack set operation created by updating the stack set fails (completely\n or partially, below or above a specified failure tolerance), the stack set is updated with\n your changes. Subsequent CreateStackInstances calls on the specified\n stack set use the updated stack set.
" + "smithy.api#documentation": "Updates the stack set, and associated stack instances in the specified accounts and\n Regions.
\nEven if the stack set operation created by updating the stack set fails (completely or\n partially, below or above a specified failure tolerance), the stack set is updated with\n your changes. Subsequent CreateStackInstances calls on the specified\n stack set use the updated stack set.
" } }, "com.amazonaws.cloudformation#UpdateStackSetInput": { @@ -10230,13 +10289,13 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to update the stack set and its associated stack\n instances.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in\n your Amazon Web Services account; for example, by creating new Identity and Access Management\n (IAM) users. For those stacks sets, you must explicitly acknowledge this by\n specifying one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM\n capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review\n all permissions associated with them and edit their permissions if\n necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your stack set template references one or more\n macros, you must update the stack set directly from the processed template, without\n first reviewing the resulting changes in a change set. To update the stack set\n directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to\n Perform Custom Processing on Templates.
\nStack sets with service-managed permissions do not currently support the use of\n macros in templates. (This includes the AWS::Include and AWS::Serverless\n transforms, which are macros hosted by CloudFormation.) Even if you specify this capability\n for a stack set with service-managed permissions, if you reference a macro in your\n template the stack set operation will fail.
\nIn some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to update the stack set and its associated stack\n instances.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new Identity and Access Management\n (IAM) users. For those stacks sets, you must explicitly acknowledge this by\n specifying one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM\n capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all\n permissions associated with them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your stack set template references one or more\n macros, you must update the stack set directly from the processed template, without\n first reviewing the resulting changes in a change set. To update the stack set\n directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to\n Perform Custom Processing on Templates.
\nStack sets with service-managed permissions do not currently support the use of\n macros in templates. (This includes the AWS::Include and AWS::Serverless\n transforms, which are macros hosted by CloudFormation.) Even if you specify this capability\n for a stack set with service-managed permissions, if you reference a macro in your\n template the stack set operation will fail.
\nThe key-value pairs to associate with this stack set and the stacks created from it.\n CloudFormation also propagates these tags to supported resources that are created in\n the stacks. You can specify a maximum number of 50 tags.
\nIf you specify tags for this parameter, those tags replace any list of tags that are\n currently associated with this stack set. This means:
\nIf you don't specify this parameter, CloudFormation doesn't modify the\n stack's tags.
\nIf you specify any tags using this parameter, you must\n specify all the tags that you want associated with this stack\n set, even tags you've specifed before (for example, when creating the stack set or\n during a previous update of the stack set.). Any tags that you don't include in the\n updated list of tags are removed from the stack set, and therefore from the stacks\n and resources as well.
\nIf you specify an empty value, CloudFormation removes all currently\n associated tags.
\nIf you specify new tags as part of an UpdateStackSet action,\n CloudFormation checks to see if you have the required IAM permission to tag resources. If\n you omit tags that are currently associated with the stack set from the list of tags you\n specify, CloudFormation assumes that you want to remove those tags from the stack set,\n and checks to see if you have permission to untag resources. If you don't have the\n necessary permission(s), the entire UpdateStackSet action fails with an\n access denied error, and the stack set is not updated.
The key-value pairs to associate with this stack set and the stacks created from it.\n CloudFormation also propagates these tags to supported resources that are\n created in the stacks. You can specify a maximum number of 50 tags.
\nIf you specify tags for this parameter, those tags replace any list of tags that are\n currently associated with this stack set. This means:
\nIf you don't specify this parameter, CloudFormation doesn't modify the\n stack's tags.
\nIf you specify any tags using this parameter, you must\n specify all the tags that you want associated with this stack\n set, even tags you've specifed before (for example, when creating the stack set or\n during a previous update of the stack set.). Any tags that you don't include in the\n updated list of tags are removed from the stack set, and therefore from the stacks\n and resources as well.
\nIf you specify an empty value, CloudFormation removes all currently\n associated tags.
\nIf you specify new tags as part of an UpdateStackSet action, CloudFormation checks to see if you have the required IAM permission to tag resources.\n If you omit tags that are currently associated with the stack set from the list of tags you\n specify, CloudFormation assumes that you want to remove those tags from the stack\n set, and checks to see if you have permission to untag resources. If you don't have the\n necessary permission(s), the entire UpdateStackSet action fails with an\n access denied error, and the stack set is not updated.
The unique ID for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that\n CloudFormation performs the stack set operation only once, even if you retry the request\n multiple times. You might retry stack set operation requests to ensure that\n CloudFormation successfully received them.
\nIf you don't specify an operation ID, CloudFormation generates one\n automatically.
\nRepeating this stack set operation with a new operation ID retries all stack\n instances whose status is OUTDATED.
The unique ID for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request\n multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.
\nIf you don't specify an operation ID, CloudFormation generates one\n automatically.
\nRepeating this stack set operation with a new operation ID retries all stack instances\n whose status is OUTDATED.
[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in\n the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
\nDescribes whether StackSets performs non-conflicting operations concurrently and queues\n conflicting operations.
" + } } } }, @@ -10322,7 +10387,7 @@ "target": "com.amazonaws.cloudformation#UpdateTerminationProtectionOutput" }, "traits": { - "smithy.api#documentation": "Updates termination protection for the specified stack. If a user attempts to delete\n a stack with termination protection enabled, the operation fails and the stack remains\n unchanged. For more information, see Protecting a\n Stack From Being Deleted in the CloudFormation User Guide.
\nFor nested\n stacks, termination protection is set on the root stack and cannot be changed\n directly on the nested stack.
" + "smithy.api#documentation": "Updates termination protection for the specified stack. If a user attempts to delete a\n stack with termination protection enabled, the operation fails and the stack remains\n unchanged. For more information, see Protecting a\n Stack From Being Deleted in the CloudFormation User Guide.
\nFor nested\n stacks, termination protection is set on the root stack and cannot be changed\n directly on the nested stack.
" } }, "com.amazonaws.cloudformation#UpdateTerminationProtectionInput": { @@ -10379,7 +10444,7 @@ "target": "com.amazonaws.cloudformation#ValidateTemplateOutput" }, "traits": { - "smithy.api#documentation": "Validates a specified template. CloudFormation first checks if the template is\n valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If both\n these checks fail, CloudFormation returns a template validation error.
" + "smithy.api#documentation": "Validates a specified template. CloudFormation first checks if the template is\n valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If\n both these checks fail, CloudFormation returns a template validation error.
" } }, "com.amazonaws.cloudformation#ValidateTemplateInput": { @@ -10420,7 +10485,7 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "The capabilities found within the template. If your template contains IAM resources,\n you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when\n you use the CreateStack or UpdateStack actions with\n your template; otherwise, those actions return an InsufficientCapabilities error.
\nFor more information, see Acknowledging IAM Resources in CloudFormation Templates.
" + "smithy.api#documentation": "The capabilities found within the template. If your template contains IAM resources, you\n must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you\n use the CreateStack or UpdateStack actions with your\n template; otherwise, those actions return an InsufficientCapabilities error.
\nFor more information, see Acknowledging IAM Resources in CloudFormation Templates.
" } }, "CapabilitiesReason": { diff --git a/aws/sdk/aws-models/compute-optimizer.json b/aws/sdk/aws-models/compute-optimizer.json index c82e32c79d93363236cf63dafd9122a76c5f76dc..0d06b593e15db0f961c2e73c372d7384f6bc3037 100644 --- a/aws/sdk/aws-models/compute-optimizer.json +++ b/aws/sdk/aws-models/compute-optimizer.json @@ -60,7 +60,7 @@ "statusReason": { "target": "com.amazonaws.computeoptimizer#StatusReason", "traits": { - "smithy.api#documentation": "The reason for the account enrollment status.
\n\nFor example, an account might show a status of Pending because member\n accounts of an organization require more time to be enrolled in the service.
The reason for the account enrollment status.
\nFor example, an account might show a status of Pending because member\n accounts of an organization require more time to be enrolled in the service.
The finding classification of the Auto Scaling group.
\n\nFindings for Auto Scaling groups include:
\n\n\n \n NotOptimized\n —An Auto Scaling group is considered not optimized when Compute Optimizer identifies a\n recommendation that can provide better performance for your workload.
\n \n Optimized\n —An Auto Scaling\n group is considered optimized when Compute Optimizer determines that the group\n is correctly provisioned to run your workload based on the chosen instance type.\n For optimized resources, Compute Optimizer might recommend a new generation\n instance type.
The finding classification of the Auto Scaling group.
\nFindings for Auto Scaling groups include:
\n\n \n NotOptimized\n —An Auto Scaling group is considered not optimized when Compute Optimizer identifies a\n recommendation that can provide better performance for your workload.
\n \n Optimized\n —An Auto Scaling\n group is considered optimized when Compute Optimizer determines that the group\n is correctly provisioned to run your workload based on the chosen instance type.\n For optimized resources, Compute Optimizer might recommend a new generation\n instance type.
The timestamp of when the Auto Scaling group recommendation was last\n refreshed.
" + "smithy.api#documentation": "The timestamp of when the Auto Scaling group recommendation was last\n generated.
" + } + }, + "currentPerformanceRisk": { + "target": "com.amazonaws.computeoptimizer#CurrentPerformanceRisk", + "traits": { + "smithy.api#documentation": "The risk of the current Auto Scaling group not meeting the performance needs of\n its workloads. The higher the risk, the more likely the current Auto Scaling group\n configuration has insufficient capacity and cannot meet workload requirements.
" + } + }, + "effectiveRecommendationPreferences": { + "target": "com.amazonaws.computeoptimizer#EffectiveRecommendationPreferences", + "traits": { + "smithy.api#documentation": "An object that describes the effective recommendation preferences for the Auto Scaling group.
" } } }, @@ -207,19 +219,25 @@ "projectedUtilizationMetrics": { "target": "com.amazonaws.computeoptimizer#ProjectedUtilizationMetrics", "traits": { - "smithy.api#documentation": "An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option.
\n\nThe Cpu and Memory metrics are the only projected\n utilization metrics returned. Additionally, the Memory metric is\n returned only for resources that have the unified CloudWatch agent installed\n on them. For more information, see Enabling Memory\n Utilization with the CloudWatch Agent.
An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option.
\nThe Cpu and Memory metrics are the only projected\n utilization metrics returned. Additionally, the Memory metric is\n returned only for resources that have the unified CloudWatch agent installed\n on them. For more information, see Enabling Memory\n Utilization with the CloudWatch Agent.
The performance risk of the Auto Scaling group configuration\n recommendation.
\n\nPerformance risk indicates the likelihood of the recommended instance type not meeting\n the resource needs of your workload. Compute Optimizer calculates an individual\n performance risk score for each specification of the recommended instance, including\n CPU, memory, EBS throughput, EBS IOPS, disk throughput, disk IOPS, network throughput,\n and network PPS.\n The performance\n risk of the recommended instance is calculated as the maximum performance risk score\n across the analyzed resource specifications.
\n\nThe value ranges from 0 - 4, with 0 meaning\n that the recommended resource is predicted to always provide enough hardware capability.\n The higher the performance risk is, the more likely you should validate whether the\n recommendation will meet the performance requirements of your workload before migrating\n your resource.
The performance risk of the Auto Scaling group configuration\n recommendation.
\nPerformance risk indicates the likelihood of the recommended instance type not meeting\n the resource needs of your workload. Compute Optimizer calculates an individual\n performance risk score for each specification of the recommended instance, including\n CPU, memory, EBS throughput, EBS IOPS, disk throughput, disk IOPS, network throughput,\n and network PPS.\n The performance\n risk of the recommended instance is calculated as the maximum performance risk score\n across the analyzed resource specifications.
\nThe value ranges from 0 - 4, with 0 meaning\n that the recommended resource is predicted to always provide enough hardware capability.\n The higher the performance risk is, the more likely you should validate whether the\n recommendation will meet the performance requirements of your workload before migrating\n your resource.
The rank of the Auto Scaling group recommendation option.
\n\nThe top recommendation option is ranked as 1.
The rank of the Auto Scaling group recommendation option.
\nThe top recommendation option is ranked as 1.
An object that describes the savings opportunity for the Auto Scaling group\n recommendation option. Savings opportunity includes the estimated monthly savings amount\n and percentage.
" } } }, @@ -244,8 +262,26 @@ }, "com.amazonaws.computeoptimizer#ComputeOptimizerService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Compute Optimizer", + "arnNamespace": "compute-optimizer", + "cloudFormationName": "ComputeOptimizer", + "cloudTrailEventSource": "computeoptimizer.amazonaws.com", + "endpointPrefix": "compute-optimizer" + }, + "aws.auth#sigv4": { + "name": "compute-optimizer" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "Compute Optimizer is a service that analyzes the configuration and utilization\n metrics of your Amazon Web Services compute resources, such as Amazon EC2\n instances, Amazon EC2 Auto Scaling groups, Lambda functions, and Amazon EBS volumes. It reports whether your resources are optimal, and generates\n optimization recommendations to reduce the cost and improve the performance of your\n workloads. Compute Optimizer also provides recent utilization metric data, in addition\n to projected utilization metric data for the recommendations, which you can use to\n evaluate which recommendation provides the best price-performance trade-off. The\n analysis of your usage patterns can help you decide when to move or resize your running\n resources, and still meet your performance and capacity requirements. For more\n information about Compute Optimizer, including the required permissions to use the\n service, see the Compute Optimizer User Guide.
", + "smithy.api#title": "AWS Compute Optimizer" + }, "version": "2019-11-01", "operations": [ + { + "target": "com.amazonaws.computeoptimizer#DeleteRecommendationPreferences" + }, { "target": "com.amazonaws.computeoptimizer#DescribeRecommendationExportJobs" }, @@ -273,6 +309,9 @@ { "target": "com.amazonaws.computeoptimizer#GetEC2RecommendationProjectedMetrics" }, + { + "target": "com.amazonaws.computeoptimizer#GetEffectiveRecommendationPreferences" + }, { "target": "com.amazonaws.computeoptimizer#GetEnrollmentStatus" }, @@ -282,28 +321,19 @@ { "target": "com.amazonaws.computeoptimizer#GetLambdaFunctionRecommendations" }, + { + "target": "com.amazonaws.computeoptimizer#GetRecommendationPreferences" + }, { "target": "com.amazonaws.computeoptimizer#GetRecommendationSummaries" }, + { + "target": "com.amazonaws.computeoptimizer#PutRecommendationPreferences" + }, { "target": "com.amazonaws.computeoptimizer#UpdateEnrollmentStatus" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Compute Optimizer", - "arnNamespace": "compute-optimizer", - "cloudFormationName": "ComputeOptimizer", - "cloudTrailEventSource": "computeoptimizer.amazonaws.com", - "endpointPrefix": "compute-optimizer" - }, - "aws.auth#sigv4": { - "name": "compute-optimizer" - }, - "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "Compute Optimizer is a service that analyzes the configuration and utilization\n metrics of your Amazon Web Services compute resources, such as Amazon EC2\n instances, Amazon EC2 Auto Scaling groups, Lambda functions, and Amazon EBS volumes. It reports whether your resources are optimal, and generates\n optimization recommendations to reduce the cost and improve the performance of your\n workloads. Compute Optimizer also provides recent utilization metric data, in addition\n to projected utilization metric data for the recommendations, which you can use to\n evaluate which recommendation provides the best price-performance trade-off. The\n analysis of your usage patterns can help you decide when to move or resize your running\n resources, and still meet your performance and capacity requirements. For more\n information about Compute Optimizer, including the required permissions to use the\n service, see the Compute Optimizer User Guide.
", - "smithy.api#title": "AWS Compute Optimizer" - } + ] }, "com.amazonaws.computeoptimizer#CpuVendorArchitecture": { "type": "string", @@ -329,9 +359,146 @@ "com.amazonaws.computeoptimizer#CreationTimestamp": { "type": "timestamp" }, + "com.amazonaws.computeoptimizer#Currency": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "USD", + "name": "USD" + }, + { + "value": "CNY", + "name": "CNY" + } + ] + } + }, "com.amazonaws.computeoptimizer#CurrentInstanceType": { "type": "string" }, + "com.amazonaws.computeoptimizer#CurrentPerformanceRisk": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "VeryLow", + "name": "VERY_LOW" + }, + { + "value": "Low", + "name": "LOW" + }, + { + "value": "Medium", + "name": "MEDIUM" + }, + { + "value": "High", + "name": "HIGH" + } + ] + } + }, + "com.amazonaws.computeoptimizer#CurrentPerformanceRiskRatings": { + "type": "structure", + "members": { + "high": { + "target": "com.amazonaws.computeoptimizer#High", + "traits": { + "smithy.api#documentation": "A count of the applicable resource types with a high performance risk rating.
" + } + }, + "medium": { + "target": "com.amazonaws.computeoptimizer#Medium", + "traits": { + "smithy.api#documentation": "A count of the applicable resource types with a medium performance risk rating.
" + } + }, + "low": { + "target": "com.amazonaws.computeoptimizer#Low", + "traits": { + "smithy.api#documentation": "A count of the applicable resource types with a low performance risk rating.
" + } + }, + "veryLow": { + "target": "com.amazonaws.computeoptimizer#VeryLow", + "traits": { + "smithy.api#documentation": "A count of the applicable resource types with a very low performance risk\n rating.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the performance risk ratings for a given resource type.
\nResources with a high or medium rating are at risk of not\n meeting the performance needs of their workloads, while resources with a\n low rating are performing well in their workloads.
Deletes a recommendation preference, such as enhanced infrastructure metrics.
\nFor more information, see Activating\n enhanced infrastructure metrics in the Compute Optimizer User\n Guide.
" + } + }, + "com.amazonaws.computeoptimizer#DeleteRecommendationPreferencesRequest": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.computeoptimizer#ResourceType", + "traits": { + "smithy.api#documentation": "The target resource type of the recommendation preference to delete.
\nThe Ec2Instance option encompasses standalone instances and instances\n that are part of Auto Scaling groups. The AutoScalingGroup option\n encompasses only instances that are part of an Auto Scaling group.
An object that describes the scope of the recommendation preference to delete.
\nYou can delete recommendation preferences that are created at the organization level\n (for management accounts of an organization only), account level, and resource level.\n For more information, see Activating\n enhanced infrastructure metrics in the Compute Optimizer User\n Guide.
" + } + }, + "recommendationPreferenceNames": { + "target": "com.amazonaws.computeoptimizer#RecommendationPreferenceNames", + "traits": { + "smithy.api#documentation": "The name of the recommendation preference to delete.
\nEnhanced infrastructure metrics (EnhancedInfrastructureMetrics) is the\n only feature that can be activated through preferences. Therefore, it is also the only\n recommendation preference that can be deleted.
Describes recommendation export jobs created in the last seven days.
\n\nUse the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your\n recommendations. Then use the DescribeRecommendationExportJobs action\n to view your export jobs.
" + "smithy.api#documentation": "Describes recommendation export jobs created in the last seven days.
\nUse the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your\n recommendations. Then use the DescribeRecommendationExportJobs action\n to view your export jobs.
" } }, "com.amazonaws.computeoptimizer#DescribeRecommendationExportJobsRequest": { @@ -376,7 +543,7 @@ "jobIds": { "target": "com.amazonaws.computeoptimizer#JobIds", "traits": { - "smithy.api#documentation": "The identification numbers of the export jobs to return.
\n\nAn export job ID is returned when you create an export using the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions.
\n\nAll export jobs created in the last seven days are returned if this parameter is\n omitted.
" + "smithy.api#documentation": "The identification numbers of the export jobs to return.
\nAn export job ID is returned when you create an export using the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions.
\nAll export jobs created in the last seven days are returned if this parameter is\n omitted.
" } }, "filters": { @@ -394,7 +561,7 @@ "maxResults": { "target": "com.amazonaws.computeoptimizer#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of export jobs to return with a single request.
\n\nTo retrieve the remaining results, make another request with the returned\n nextToken value.
The maximum number of export jobs to return with a single request.
\nTo retrieve the remaining results, make another request with the returned\n nextToken value.
The token to use to advance to the next page of export jobs.
\n\nThis value is null when there are no more pages of export jobs to return.
" + "smithy.api#documentation": "The token to use to advance to the next page of export jobs.
\nThis value is null when there are no more pages of export jobs to return.
" } } } @@ -434,18 +601,18 @@ "name": { "target": "com.amazonaws.computeoptimizer#EBSFilterName", "traits": { - "smithy.api#documentation": "The name of the filter.
\n\nSpecify Finding to return recommendations with a specific finding\n classification (for example, NotOptimized).
The name of the filter.
\nSpecify Finding to return recommendations with a specific finding\n classification (for example, NotOptimized).
The value of the filter.
\n\nThe valid values are Optimized, or NotOptimized.
The value of the filter.
\nThe valid values are Optimized, or NotOptimized.
Describes a filter that returns a more specific list of Amazon Elastic Block Store\n (Amazon EBS) volume recommendations. Use this filter with the GetEBSVolumeRecommendations action.
\n\nYou can use LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, JobFilter with the\n DescribeRecommendationExportJobs action, and Filter\n with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
Describes a filter that returns a more specific list of Amazon Elastic Block Store\n (Amazon EBS) volume recommendations. Use this filter with the GetEBSVolumeRecommendations action.
\nYou can use LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, JobFilter with the\n DescribeRecommendationExportJobs action, and Filter\n with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
The name of the utilization metric.
\n\nThe following utilization metrics are available:
\n\n VolumeReadOpsPerSecond - The completed read operations per second\n from the volume in a specified period of time.
Unit: Count
\n\n VolumeWriteOpsPerSecond - The completed write operations per\n second to the volume in a specified period of time.
Unit: Count
\n\n VolumeReadBytesPerSecond - The bytes read per second from the\n volume in a specified period of time.
Unit: Bytes
\n\n VolumeWriteBytesPerSecond - The bytes written to the volume in a\n specified period of time.
Unit: Bytes
\nThe name of the utilization metric.
\nThe following utilization metrics are available:
\n\n VolumeReadOpsPerSecond - The completed read operations per second\n from the volume in a specified period of time.
Unit: Count
\n\n VolumeWriteOpsPerSecond - The completed write operations per\n second to the volume in a specified period of time.
Unit: Count
\n\n VolumeReadBytesPerSecond - The bytes read per second from the\n volume in a specified period of time.
Unit: Bytes
\n\n VolumeWriteBytesPerSecond - The bytes written to the volume in a\n specified period of time.
Unit: Bytes
\nThe statistic of the utilization metric.
\n\nThe Compute Optimizer API, Command Line Interface (CLI), and SDKs\n return utilization metrics using only the Maximum statistic, which is the\n highest value observed during the specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the\n Average statistic, which is the value of Sum /\n SampleCount during the specified period. For more information, see\n Viewing resource\n recommendations in the Compute Optimizer User\n Guide. You can also get averaged utilization metric data for your resources\n using Amazon CloudWatch. For more information, see the Amazon CloudWatch\n User Guide.
The statistic of the utilization metric.
\nThe Compute Optimizer API, Command Line Interface (CLI), and SDKs\n return utilization metrics using only the Maximum statistic, which is the\n highest value observed during the specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the\n Average statistic, which is the value of Sum /\n SampleCount during the specified period. For more information, see\n Viewing resource\n recommendations in the Compute Optimizer User\n Guide. You can also get averaged utilization metric data for your resources\n using Amazon CloudWatch. For more information, see the Amazon CloudWatch\n User Guide.
Describes a utilization metric of an Amazon Elastic Block Store (Amazon EBS)\n volume.
\n\nCompare the utilization metric data of your resource against its projected utilization\n metric data to determine the performance difference between your current resource and\n the recommended option.
" + "smithy.api#documentation": "Describes a utilization metric of an Amazon Elastic Block Store (Amazon EBS)\n volume.
\nCompare the utilization metric data of your resource against its projected utilization\n metric data to determine the performance difference between your current resource and\n the recommended option.
" } }, "com.amazonaws.computeoptimizer#EBSUtilizationMetrics": { @@ -535,19 +702,54 @@ "target": "com.amazonaws.computeoptimizer#EBSUtilizationMetric" } }, + "com.amazonaws.computeoptimizer#EffectiveRecommendationPreferences": { + "type": "structure", + "members": { + "cpuVendorArchitectures": { + "target": "com.amazonaws.computeoptimizer#CpuVendorArchitectures", + "traits": { + "smithy.api#documentation": "Describes the CPU vendor and architecture for an instance or Auto Scaling group\n recommendations.
\nFor example, when you specify AWS_ARM64 with:
A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer\n returns recommendations that consist of Graviton2 instance types only.
\nA GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type\n recommendations only.
\nA ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer\n exports recommendations that consist of Graviton2 instance types only.
\nDescribes the activation status of the enhanced infrastructure metrics\n preference.
\nA status of Active confirms that the preference is applied in the latest\n recommendation refresh, and a status of Inactive confirms that it's not yet\n applied.
Describes the effective recommendation preferences for a resource.
" + } + }, + "com.amazonaws.computeoptimizer#EnhancedInfrastructureMetrics": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Active", + "name": "ACTIVE" + }, + { + "value": "Inactive", + "name": "INACTIVE" + } + ] + } + }, "com.amazonaws.computeoptimizer#EnrollmentFilter": { "type": "structure", "members": { "name": { "target": "com.amazonaws.computeoptimizer#EnrollmentFilterName", "traits": { - "smithy.api#documentation": "The name of the filter.
\n\nSpecify Status to return accounts with a specific enrollment status (for\n example, Active).
The name of the filter.
\nSpecify Status to return accounts with a specific enrollment status (for\n example, Active).
The value of the filter.
\n\nThe valid values are Active, Inactive, Pending,\n and Failed.
The value of the filter.
\nThe valid values are Active, Inactive, Pending,\n and Failed.
The currency of the estimated monthly\n savings.
" + } + }, + "value": { + "target": "com.amazonaws.computeoptimizer#Value", + "traits": { + "smithy.api#documentation": "The value of the estimated monthly savings.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the estimated monthly savings amount possible for a given resource based on\n On-Demand instance pricing
\nFor more information, see Estimated monthly savings and savings opportunities in the\n Compute Optimizer User Guide.
" + } + }, "com.amazonaws.computeoptimizer#ExportAutoScalingGroupRecommendations": { "type": "operation", "input": { @@ -610,7 +832,7 @@ } ], "traits": { - "smithy.api#documentation": "Exports optimization recommendations for Auto Scaling groups.
\n\nRecommendations are exported in a comma-separated values (.csv) file, and its metadata\n in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting\n Recommendations in the Compute Optimizer User\n Guide.
\n\nYou can have only one Auto Scaling group export job in progress per Amazon Web Services Region.
" + "smithy.api#documentation": "Exports optimization recommendations for Auto Scaling groups.
\nRecommendations are exported in a comma-separated values (.csv) file, and its metadata\n in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting\n Recommendations in the Compute Optimizer User\n Guide.
\nYou can have only one Auto Scaling group export job in progress per Amazon Web Services Region.
" } }, "com.amazonaws.computeoptimizer#ExportAutoScalingGroupRecommendationsRequest": { @@ -619,7 +841,7 @@ "accountIds": { "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { - "smithy.api#documentation": "The IDs of the Amazon Web Services accounts for which to export Auto Scaling group\n recommendations.
\n\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to export recommendations.
\n\nThis parameter cannot be specified together with the include member accounts\n parameter. The parameters are mutually exclusive.
\n\nRecommendations for member accounts are not included in the export if this parameter,\n or the include member accounts parameter, is omitted.
\n\nYou can specify multiple account IDs per request.
" + "smithy.api#documentation": "The IDs of the Amazon Web Services accounts for which to export Auto Scaling group\n recommendations.
\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to export recommendations.
\nThis parameter cannot be specified together with the include member accounts\n parameter. The parameters are mutually exclusive.
\nRecommendations for member accounts are not included in the export if this parameter,\n or the include member accounts parameter, is omitted.
\nYou can specify multiple account IDs per request.
" } }, "filters": { @@ -637,20 +859,20 @@ "s3DestinationConfig": { "target": "com.amazonaws.computeoptimizer#S3DestinationConfig", "traits": { - "smithy.api#documentation": "An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket\n name and key prefix for the export job.
\n\nYou must create the destination Amazon S3 bucket for your recommendations\n export before you create the export job. Compute Optimizer does not create the S3 bucket\n for you. After you create the S3 bucket, ensure that it has the required permissions\n policy to allow Compute Optimizer to write the export file to it. If you plan to\n specify an object prefix when you create the export job, you must include the object\n prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the\n Compute Optimizer User Guide.
", + "smithy.api#documentation": "An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket\n name and key prefix for the export job.
\nYou must create the destination Amazon S3 bucket for your recommendations\n export before you create the export job. Compute Optimizer does not create the S3 bucket\n for you. After you create the S3 bucket, ensure that it has the required permissions\n policy to allow Compute Optimizer to write the export file to it. If you plan to specify\n an object prefix when you create the export job, you must include the object prefix in\n the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the\n Compute Optimizer User Guide.
", "smithy.api#required": {} } }, "fileFormat": { "target": "com.amazonaws.computeoptimizer#FileFormat", "traits": { - "smithy.api#documentation": "The format of the export file.
\n\nThe only export file format currently supported is Csv.
The format of the export file.
\nThe only export file format currently supported is Csv.
Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the management account of an organization.
\n\nThe member accounts must also be opted in to Compute Optimizer, and trusted access for\n Compute Optimizer must be enabled in the organization account. For more information,\n see Compute Optimizer and Amazon Web Services Organizations trusted access in the\n Compute Optimizer User Guide.
\n\nRecommendations for member accounts of the organization are not included in the export\n file if this parameter is omitted.
\n\nThis parameter cannot be specified together with the account IDs parameter. The\n parameters are mutually exclusive.
\n\nRecommendations for member accounts are not included in the export if this parameter,\n or the account IDs parameter, is omitted.
" + "smithy.api#documentation": "Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the management account of an organization.
\nThe member accounts must also be opted in to Compute Optimizer, and trusted access for\n Compute Optimizer must be enabled in the organization account. For more information,\n see Compute Optimizer and Amazon Web Services Organizations trusted access in the\n Compute Optimizer User Guide.
\nRecommendations for member accounts of the organization are not included in the export\n file if this parameter is omitted.
\nThis parameter cannot be specified together with the account IDs parameter. The\n parameters are mutually exclusive.
\nRecommendations for member accounts are not included in the export if this parameter,\n or the account IDs parameter, is omitted.
" } }, "recommendationPreferences": { @@ -667,7 +889,7 @@ "jobId": { "target": "com.amazonaws.computeoptimizer#JobId", "traits": { - "smithy.api#documentation": "The identification number of the export job.
\n\nUse the DescribeRecommendationExportJobs action, and specify the job\n ID to view the status of an export job.
" + "smithy.api#documentation": "The identification number of the export job.
\nUse the DescribeRecommendationExportJobs action, and specify the job\n ID to view the status of an export job.
" } }, "s3Destination": { @@ -727,7 +949,7 @@ } ], "traits": { - "smithy.api#documentation": "Exports optimization recommendations for Amazon EBS volumes.
\n\nRecommendations are exported in a comma-separated values (.csv) file, and its metadata\n in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see\n Exporting\n Recommendations in the Compute Optimizer User\n Guide.
\n\nYou can have only one Amazon EBS volume export job in progress per Amazon Web Services Region.
" + "smithy.api#documentation": "Exports optimization recommendations for Amazon EBS volumes.
\nRecommendations are exported in a comma-separated values (.csv) file, and its metadata\n in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting\n Recommendations in the Compute Optimizer User\n Guide.
\nYou can have only one Amazon EBS volume export job in progress per Amazon Web Services Region.
" } }, "com.amazonaws.computeoptimizer#ExportEBSVolumeRecommendationsRequest": { @@ -736,7 +958,7 @@ "accountIds": { "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { - "smithy.api#documentation": "The IDs of the Amazon Web Services accounts for which to export Amazon EBS\n volume recommendations.
\n\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to export recommendations.
\n\nThis parameter cannot be specified together with the include member accounts\n parameter. The parameters are mutually exclusive.
\n\nRecommendations for member accounts are not included in the export if this parameter,\n or the include member accounts parameter, is omitted.
\n\nYou can specify multiple account IDs per request.
" + "smithy.api#documentation": "The IDs of the Amazon Web Services accounts for which to export Amazon EBS\n volume recommendations.
\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to export recommendations.
\nThis parameter cannot be specified together with the include member accounts\n parameter. The parameters are mutually exclusive.
\nRecommendations for member accounts are not included in the export if this parameter,\n or the include member accounts parameter, is omitted.
\nYou can specify multiple account IDs per request.
" } }, "filters": { @@ -760,13 +982,13 @@ "fileFormat": { "target": "com.amazonaws.computeoptimizer#FileFormat", "traits": { - "smithy.api#documentation": "The format of the export file.
\n\nThe only export file format currently supported is Csv.
The format of the export file.
\nThe only export file format currently supported is Csv.
Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the management account of an organization.
\n\nThe member accounts must also be opted in to Compute Optimizer, and trusted access for\n Compute Optimizer must be enabled in the organization account. For more information,\n see Compute Optimizer and Amazon Web Services Organizations trusted access in the\n Compute Optimizer User Guide.
\n\nRecommendations for member accounts of the organization are not included in the export\n file if this parameter is omitted.
\n\nThis parameter cannot be specified together with the account IDs parameter. The\n parameters are mutually exclusive.
\n\nRecommendations for member accounts are not included in the export if this parameter,\n or the account IDs parameter, is omitted.
" + "smithy.api#documentation": "Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the management account of an organization.
\nThe member accounts must also be opted in to Compute Optimizer, and trusted access for\n Compute Optimizer must be enabled in the organization account. For more information,\n see Compute Optimizer and Amazon Web Services Organizations trusted access in the\n Compute Optimizer User Guide.
\nRecommendations for member accounts of the organization are not included in the export\n file if this parameter is omitted.
\nThis parameter cannot be specified together with the account IDs parameter. The\n parameters are mutually exclusive.
\nRecommendations for member accounts are not included in the export if this parameter,\n or the account IDs parameter, is omitted.
" } } } @@ -777,7 +999,7 @@ "jobId": { "target": "com.amazonaws.computeoptimizer#JobId", "traits": { - "smithy.api#documentation": "The identification number of the export job.
\n\nUse the DescribeRecommendationExportJobs action, and specify the job\n ID to view the status of an export job.
" + "smithy.api#documentation": "The identification number of the export job.
\nUse the DescribeRecommendationExportJobs action, and specify the job\n ID to view the status of an export job.
" } }, "s3Destination": { @@ -820,7 +1042,7 @@ } ], "traits": { - "smithy.api#documentation": "Exports optimization recommendations for Amazon EC2 instances.
\n\nRecommendations are exported in a comma-separated values (.csv) file, and its metadata\n in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see\n Exporting\n Recommendations in the Compute Optimizer User\n Guide.
\n\nYou can have only one Amazon EC2 instance export job in progress per Amazon Web Services Region.
" + "smithy.api#documentation": "Exports optimization recommendations for Amazon EC2 instances.
\nRecommendations are exported in a comma-separated values (.csv) file, and its metadata\n in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting\n Recommendations in the Compute Optimizer User\n Guide.
\nYou can have only one Amazon EC2 instance export job in progress per Amazon Web Services Region.
" } }, "com.amazonaws.computeoptimizer#ExportEC2InstanceRecommendationsRequest": { @@ -829,7 +1051,7 @@ "accountIds": { "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { - "smithy.api#documentation": "The IDs of the Amazon Web Services accounts for which to export instance\n recommendations.
\n\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to export recommendations.
\n\nThis parameter cannot be specified together with the include member accounts\n parameter. The parameters are mutually exclusive.
\n\nRecommendations for member accounts are not included in the export if this parameter,\n or the include member accounts parameter, is omitted.
\n\nYou can specify multiple account IDs per request.
" + "smithy.api#documentation": "The IDs of the Amazon Web Services accounts for which to export instance\n recommendations.
\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to export recommendations.
\nThis parameter cannot be specified together with the include member accounts\n parameter. The parameters are mutually exclusive.
\nRecommendations for member accounts are not included in the export if this parameter,\n or the include member accounts parameter, is omitted.
\nYou can specify multiple account IDs per request.
" } }, "filters": { @@ -847,20 +1069,20 @@ "s3DestinationConfig": { "target": "com.amazonaws.computeoptimizer#S3DestinationConfig", "traits": { - "smithy.api#documentation": "An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket\n name and key prefix for the export job.
\n\nYou must create the destination Amazon S3 bucket for your recommendations\n export before you create the export job. Compute Optimizer does not create the S3 bucket\n for you. After you create the S3 bucket, ensure that it has the required permissions\n policy policy to allow Compute Optimizer to write the export file to it. If you plan to\n specify an object prefix when you create the export job, you must include the object\n prefix in the that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the\n Compute Optimizer User Guide.
", + "smithy.api#documentation": "An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket\n name and key prefix for the export job.
\nYou must create the destination Amazon S3 bucket for your recommendations\n export before you create the export job. Compute Optimizer does not create the S3 bucket\n for you. After you create the S3 bucket, ensure that it has the required permissions\n policy to allow Compute Optimizer to write the export file to it.\n If you plan to\n specify an object prefix when you create the export job, you must include the object\n prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the\n Compute Optimizer User Guide.
", "smithy.api#required": {} } }, "fileFormat": { "target": "com.amazonaws.computeoptimizer#FileFormat", "traits": { - "smithy.api#documentation": "The format of the export file.
\n\nThe only export file format currently supported is Csv.
The format of the export file.
\nThe only export file format currently supported is Csv.
Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the management account of an organization.
\n\nThe member accounts must also be opted in to Compute Optimizer, and trusted access for\n Compute Optimizer must be enabled in the organization account. For more information,\n see Compute Optimizer and Amazon Web Services Organizations trusted access in the\n Compute Optimizer User Guide.
\n\nRecommendations for member accounts of the organization are not included in the export\n file if this parameter is omitted.
\n\nRecommendations for member accounts are not included in the export if this parameter,\n or the account IDs parameter, is omitted.
" + "smithy.api#documentation": "Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the management account of an organization.
\nThe member accounts must also be opted in to Compute Optimizer, and trusted access for\n Compute Optimizer must be enabled in the organization account. For more information,\n see Compute Optimizer and Amazon Web Services Organizations trusted access in the\n Compute Optimizer User Guide.
\nRecommendations for member accounts of the organization are not included in the export\n file if this parameter is omitted.
\nRecommendations for member accounts are not included in the export if this parameter,\n or the account IDs parameter, is omitted.
" } }, "recommendationPreferences": { @@ -877,7 +1099,7 @@ "jobId": { "target": "com.amazonaws.computeoptimizer#JobId", "traits": { - "smithy.api#documentation": "The identification number of the export job.
\n\nUse the DescribeRecommendationExportJobs action, and specify the job\n ID to view the status of an export job.
" + "smithy.api#documentation": "The identification number of the export job.
\nUse the DescribeRecommendationExportJobs action, and specify the job\n ID to view the status of an export job.
" } }, "s3Destination": { @@ -923,7 +1145,7 @@ } ], "traits": { - "smithy.api#documentation": "Exports optimization recommendations for Lambda functions.
\n\nRecommendations are exported in a comma-separated values (.csv) file, and its metadata\n in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see\n Exporting\n Recommendations in the Compute Optimizer User\n Guide.
\n\nYou can have only one Lambda function export job in progress per Amazon Web Services Region.
" + "smithy.api#documentation": "Exports optimization recommendations for Lambda functions.
\nRecommendations are exported in a comma-separated values (.csv) file, and its metadata\n in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting\n Recommendations in the Compute Optimizer User\n Guide.
\nYou can have only one Lambda function export job in progress per Amazon Web Services Region.
" } }, "com.amazonaws.computeoptimizer#ExportLambdaFunctionRecommendationsRequest": { @@ -932,7 +1154,7 @@ "accountIds": { "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { - "smithy.api#documentation": "The IDs of the Amazon Web Services accounts for which to export Lambda\n function recommendations.
\n\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to export recommendations.
\n\nThis parameter cannot be specified together with the include member accounts\n parameter. The parameters are mutually exclusive.
\n\nRecommendations for member accounts are not included in the export if this parameter,\n or the include member accounts parameter, is omitted.
\n\nYou can specify multiple account IDs per request.
" + "smithy.api#documentation": "The IDs of the Amazon Web Services accounts for which to export Lambda\n function recommendations.
\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to export recommendations.
\nThis parameter cannot be specified together with the include member accounts\n parameter. The parameters are mutually exclusive.
\nRecommendations for member accounts are not included in the export if this parameter,\n or the include member accounts parameter, is omitted.
\nYou can specify multiple account IDs per request.
" } }, "filters": { @@ -956,13 +1178,13 @@ "fileFormat": { "target": "com.amazonaws.computeoptimizer#FileFormat", "traits": { - "smithy.api#documentation": "The format of the export file.
\n\nThe only export file format currently supported is Csv.
The format of the export file.
\nThe only export file format currently supported is Csv.
Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the management account of an organization.
\n\nThe member accounts must also be opted in to Compute Optimizer, and trusted access for\n Compute Optimizer must be enabled in the organization account. For more information,\n see Compute Optimizer and Amazon Web Services Organizations trusted access in the\n Compute Optimizer User Guide.
\n\nRecommendations for member accounts of the organization are not included in the export\n file if this parameter is omitted.
\n\nThis parameter cannot be specified together with the account IDs parameter. The\n parameters are mutually exclusive.
\n\nRecommendations for member accounts are not included in the export if this parameter,\n or the account IDs parameter, is omitted.
" + "smithy.api#documentation": "Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the management account of an organization.
\nThe member accounts must also be opted in to Compute Optimizer, and trusted access for\n Compute Optimizer must be enabled in the organization account. For more information,\n see Compute Optimizer and Amazon Web Services Organizations trusted access in the\n Compute Optimizer User Guide.
\nRecommendations for member accounts of the organization are not included in the export\n file if this parameter is omitted.
\nThis parameter cannot be specified together with the account IDs parameter. The\n parameters are mutually exclusive.
\nRecommendations for member accounts are not included in the export if this parameter,\n or the account IDs parameter, is omitted.
" } } } @@ -973,7 +1195,7 @@ "jobId": { "target": "com.amazonaws.computeoptimizer#JobId", "traits": { - "smithy.api#documentation": "The identification number of the export job.
\n\nUse the DescribeRecommendationExportJobs action, and specify the job\n ID to view the status of an export job.
" + "smithy.api#documentation": "The identification number of the export job.
\nUse the DescribeRecommendationExportJobs action, and specify the job\n ID to view the status of an export job.
" } }, "s3Destination": { @@ -1164,6 +1386,30 @@ { "value": "LastRefreshTimestamp", "name": "LAST_REFRESH_TIMESTAMP" + }, + { + "value": "CurrentPerformanceRisk", + "name": "CURRENT_PERFORMANCE_RISK" + }, + { + "value": "RecommendationOptionsSavingsOpportunityPercentage", + "name": "RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_PERCENTAGE" + }, + { + "value": "RecommendationOptionsEstimatedMonthlySavingsCurrency", + "name": "RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY" + }, + { + "value": "RecommendationOptionsEstimatedMonthlySavingsValue", + "name": "RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE" + }, + { + "value": "EffectiveRecommendationPreferencesCpuVendorArchitectures", + "name": "EFFECTIVE_RECOMMENDATION_PREFERENCES_CPU_VENDOR_ARCHITECTURES" + }, + { + "value": "EffectiveRecommendationPreferencesEnhancedInfrastructureMetrics", + "name": "EFFECTIVE_RECOMMENDATION_PREFERENCES_ENHANCED_INFRASTRUCTURE_METRICS" } ] } @@ -1349,6 +1595,30 @@ { "value": "LastRefreshTimestamp", "name": "LAST_REFRESH_TIMESTAMP" + }, + { + "value": "CurrentPerformanceRisk", + "name": "CURRENT_PERFORMANCE_RISK" + }, + { + "value": "RecommendationOptionsSavingsOpportunityPercentage", + "name": "RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_PERCENTAGE" + }, + { + "value": "RecommendationOptionsEstimatedMonthlySavingsCurrency", + "name": "RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY" + }, + { + "value": "RecommendationOptionsEstimatedMonthlySavingsValue", + "name": "RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE" + }, + { + "value": "EffectiveRecommendationPreferencesCpuVendorArchitectures", + "name": "EFFECTIVE_RECOMMENDATION_PREFERENCES_CPU_VENDOR_ARCHITECTURES" + }, + { + "value": "EffectiveRecommendationPreferencesEnhancedInfrastructureMetrics", + "name": "EFFECTIVE_RECOMMENDATION_PREFERENCES_ENHANCED_INFRASTRUCTURE_METRICS" } ] } @@ -1450,6 +1720,22 @@ { "value": "LastRefreshTimestamp", "name": "LAST_REFRESH_TIMESTAMP" + }, + { + "value": "CurrentPerformanceRisk", + "name": "CURRENT_PERFORMANCE_RISK" + }, + { + "value": "RecommendationOptionsSavingsOpportunityPercentage", + "name": "RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_PERCENTAGE" + }, + { + "value": "RecommendationOptionsEstimatedMonthlySavingsCurrency", + "name": "RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY" + }, + { + "value": "RecommendationOptionsEstimatedMonthlySavingsValue", + "name": "RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE" } ] } @@ -1559,6 +1845,22 @@ { "value": "LastRefreshTimestamp", "name": "LAST_REFRESH_TIMESTAMP" + }, + { + "value": "CurrentPerformanceRisk", + "name": "CURRENT_PERFORMANCE_RISK" + }, + { + "value": "RecommendationOptionsSavingsOpportunityPercentage", + "name": "RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_PERCENTAGE" + }, + { + "value": "RecommendationOptionsEstimatedMonthlySavingsCurrency", + "name": "RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY" + }, + { + "value": "RecommendationOptionsEstimatedMonthlySavingsValue", + "name": "RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE" } ] } @@ -1589,18 +1891,18 @@ "name": { "target": "com.amazonaws.computeoptimizer#FilterName", "traits": { - "smithy.api#documentation": "The name of the filter.
\n\nSpecify Finding to return recommendations with a specific finding\n classification (for example, Underprovisioned).
Specify RecommendationSourceType to return recommendations of a specific\n resource type (for example, Ec2Instance).
Specify FindingReasonCodes to return recommendations with a specific\n finding reason code (for example, CPUUnderprovisioned).
The name of the filter.
\nSpecify Finding to return recommendations with a specific finding\n classification (for example, Underprovisioned).
Specify RecommendationSourceType to return recommendations of a specific\n resource type (for example, Ec2Instance).
Specify FindingReasonCodes to return recommendations with a specific\n finding reason code (for example, CPUUnderprovisioned).
The value of the filter.
\n\nThe valid values for this parameter are as follows, depending on what you specify for\n the name parameter and the resource type that you wish to filter results\n for:
Specify Optimized or NotOptimized if you specify the\n name parameter as Finding and you want to filter\n results for Auto Scaling groups.
Specify Underprovisioned, Overprovisioned, or\n Optimized if you specify the name parameter as\n Finding and you want to filter results for EC2\n instances.
Specify Ec2Instance or AutoScalingGroup if you\n specify the name parameter as\n RecommendationSourceType.
Specify one of the following options if you specify the name\n parameter as FindingReasonCodes:
\n \n CPUOverprovisioned\n — The\n instance’s CPU configuration can be sized down while still meeting the\n performance requirements of your workload.
\n \n CPUUnderprovisioned\n —\n The instance’s CPU configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type\n that provides better CPU performance.
\n \n MemoryOverprovisioned\n —\n The instance’s memory configuration can be sized down while still\n meeting the performance requirements of your workload.
\n \n MemoryUnderprovisioned\n —\n The instance’s memory configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type\n that provides better memory performance.
\n \n EBSThroughputOverprovisioned\n — The\n instance’s EBS throughput configuration can be sized down while still\n meeting the performance requirements of your workload.
\n \n EBSThroughputUnderprovisioned\n — The\n instance’s EBS throughput configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type\n that provides better EBS throughput performance.
\n \n EBSIOPSOverprovisioned\n —\n The instance’s EBS IOPS configuration can be sized down while still\n meeting the performance requirements of your workload.
\n \n EBSIOPSUnderprovisioned\n \n — The instance’s EBS IOPS configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type\n that provides better EBS IOPS performance.
\n \n NetworkBandwidthOverprovisioned\n — The\n instance’s network bandwidth configuration can be sized down while still\n meeting the performance requirements of your workload.
\n \n NetworkBandwidthUnderprovisioned\n — The\n instance’s network bandwidth configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type\n that provides better network bandwidth performance. This finding reason\n happens when the NetworkIn or NetworkOut\n performance of an instance is impacted.
\n \n NetworkPPSOverprovisioned\n — The instance’s\n network PPS (packets per second) configuration can be sized down while\n still meeting the performance requirements of your workload.
\n \n NetworkPPSUnderprovisioned\n — The instance’s\n network PPS (packets per second) configuration doesn't meet the\n performance requirements of your workload and there is an alternative\n instance type that provides better network PPS performance.
\n \n DiskIOPSOverprovisioned\n \n — The instance’s disk IOPS configuration can be sized down while still\n meeting the performance requirements of your workload.
\n \n DiskIOPSUnderprovisioned\n \n — The instance’s disk IOPS configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type\n that provides better disk IOPS performance.
\n \n DiskThroughputOverprovisioned\n — The\n instance’s disk throughput configuration can be sized down while still\n meeting the performance requirements of your workload.
\n \n DiskThroughputUnderprovisioned\n — The\n instance’s disk throughput configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type\n that provides better disk throughput performance.
The value of the filter.
\nThe valid values for this parameter are as follows, depending on what you specify for\n the name parameter and the resource type that you wish to filter results\n for:
Specify Optimized or NotOptimized if you specify the\n name parameter as Finding and you want to filter\n results for Auto Scaling groups.
Specify Underprovisioned, Overprovisioned, or\n Optimized if you specify the name parameter as\n Finding and you want to filter results for EC2\n instances.
Specify Ec2Instance or AutoScalingGroup if you\n specify the name parameter as\n RecommendationSourceType.
Specify one of the following options if you specify the name\n parameter as FindingReasonCodes:
\n \n CPUOverprovisioned\n — The\n instance’s CPU configuration can be sized down while still meeting the\n performance requirements of your workload.
\n \n CPUUnderprovisioned\n —\n The instance’s CPU configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type\n that provides better CPU performance.
\n \n MemoryOverprovisioned\n —\n The instance’s memory configuration can be sized down while still\n meeting the performance requirements of your workload.
\n \n MemoryUnderprovisioned\n —\n The instance’s memory configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type\n that provides better memory performance.
\n \n EBSThroughputOverprovisioned\n — The\n instance’s EBS throughput configuration can be sized down while still\n meeting the performance requirements of your workload.
\n \n EBSThroughputUnderprovisioned\n — The\n instance’s EBS throughput configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type\n that provides better EBS throughput performance.
\n \n EBSIOPSOverprovisioned\n —\n The instance’s EBS IOPS configuration can be sized down while still\n meeting the performance requirements of your workload.
\n \n EBSIOPSUnderprovisioned\n \n — The instance’s EBS IOPS configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type\n that provides better EBS IOPS performance.
\n \n NetworkBandwidthOverprovisioned\n — The\n instance’s network bandwidth configuration can be sized down while still\n meeting the performance requirements of your workload.
\n \n NetworkBandwidthUnderprovisioned\n — The\n instance’s network bandwidth configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type\n that provides better network bandwidth performance. This finding reason\n happens when the NetworkIn or NetworkOut\n performance of an instance is impacted.
\n \n NetworkPPSOverprovisioned\n — The instance’s\n network PPS (packets per second) configuration can be sized down while\n still meeting the performance requirements of your workload.
\n \n NetworkPPSUnderprovisioned\n — The instance’s\n network PPS (packets per second) configuration doesn't meet the\n performance requirements of your workload and there is an alternative\n instance type that provides better network PPS performance.
\n \n DiskIOPSOverprovisioned\n \n — The instance’s disk IOPS configuration can be sized down while still\n meeting the performance requirements of your workload.
\n \n DiskIOPSUnderprovisioned\n \n — The instance’s disk IOPS configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type\n that provides better disk IOPS performance.
\n \n DiskThroughputOverprovisioned\n — The\n instance’s disk throughput configuration can be sized down while still\n meeting the performance requirements of your workload.
\n \n DiskThroughputUnderprovisioned\n — The\n instance’s disk throughput configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type\n that provides better disk throughput performance.
Describes a filter that returns a more specific list of recommendations. Use this\n filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
\n\nYou can use EBSFilter with the GetEBSVolumeRecommendations action,\n LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, and JobFilter with\n the DescribeRecommendationExportJobs action.
Describes a filter that returns a more specific list of recommendations. Use this\n filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
\nYou can use EBSFilter with the GetEBSVolumeRecommendations action,\n LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, and JobFilter with\n the DescribeRecommendationExportJobs action.
Returns Auto Scaling group recommendations.
\n\nCompute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that\n meet a specific set of requirements. For more information, see the Supported\n resources and requirements in the Compute Optimizer User\n Guide.
" + "smithy.api#documentation": "Returns Auto Scaling group recommendations.
\nCompute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that\n meet a specific set of requirements. For more information, see the Supported\n resources and requirements in the Compute Optimizer User\n Guide.
" } }, "com.amazonaws.computeoptimizer#GetAutoScalingGroupRecommendationsRequest": { @@ -1731,7 +2033,7 @@ "accountIds": { "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { - "smithy.api#documentation": "The ID of the Amazon Web Services account for which to return Auto Scaling group\n recommendations.
\n\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return Auto Scaling group\n recommendations.
\n\nOnly one account ID can be specified per request.
" + "smithy.api#documentation": "The ID of the Amazon Web Services account for which to return Auto Scaling group\n recommendations.
\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return Auto Scaling group\n recommendations.
\nOnly one account ID can be specified per request.
" } }, "autoScalingGroupArns": { @@ -1749,7 +2051,7 @@ "maxResults": { "target": "com.amazonaws.computeoptimizer#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of Auto Scaling group recommendations to return with a single\n request.
\n\nTo retrieve the remaining results, make another request with the returned\n nextToken value.
The maximum number of Auto Scaling group recommendations to return with a single\n request.
\nTo retrieve the remaining results, make another request with the returned\n nextToken value.
The token to use to advance to the next page of Auto Scaling group\n recommendations.
\n\nThis value is null when there are no more pages of Auto Scaling group\n recommendations to return.
" + "smithy.api#documentation": "The token to use to advance to the next page of Auto Scaling group\n recommendations.
\nThis value is null when there are no more pages of Auto Scaling group\n recommendations to return.
" } }, "autoScalingGroupRecommendations": { @@ -1784,7 +2086,7 @@ "errors": { "target": "com.amazonaws.computeoptimizer#GetRecommendationErrors", "traits": { - "smithy.api#documentation": "An array of objects that describe errors of the request.
\n\nFor example, an error is returned if you request recommendations for an unsupported\n Auto Scaling group.
" + "smithy.api#documentation": "An array of objects that describe errors of the request.
\nFor example, an error is returned if you request recommendations for an unsupported\n Auto Scaling group.
" } } } @@ -1824,7 +2126,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.
\n\nCompute Optimizer generates recommendations for Amazon EBS volumes that\n meet a specific set of requirements. For more information, see the Supported\n resources and requirements in the Compute Optimizer User\n Guide.
" + "smithy.api#documentation": "Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.
\nCompute Optimizer generates recommendations for Amazon EBS volumes that\n meet a specific set of requirements. For more information, see the Supported\n resources and requirements in the Compute Optimizer User\n Guide.
" } }, "com.amazonaws.computeoptimizer#GetEBSVolumeRecommendationsRequest": { @@ -1845,7 +2147,7 @@ "maxResults": { "target": "com.amazonaws.computeoptimizer#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of volume recommendations to return with a single request.
\n\nTo retrieve the remaining results, make another request with the returned\n nextToken value.
The maximum number of volume recommendations to return with a single request.
\nTo retrieve the remaining results, make another request with the returned\n nextToken value.
The ID of the Amazon Web Services account for which to return volume\n recommendations.
\n\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return volume recommendations.
\n\nOnly one account ID can be specified per request.
" + "smithy.api#documentation": "The ID of the Amazon Web Services account for which to return volume\n recommendations.
\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return volume recommendations.
\nOnly one account ID can be specified per request.
" } } } @@ -1868,7 +2170,7 @@ "nextToken": { "target": "com.amazonaws.computeoptimizer#NextToken", "traits": { - "smithy.api#documentation": "The token to use to advance to the next page of volume recommendations.
\n\nThis value is null when there are no more pages of volume recommendations to\n return.
" + "smithy.api#documentation": "The token to use to advance to the next page of volume recommendations.
\nThis value is null when there are no more pages of volume recommendations to\n return.
" } }, "volumeRecommendations": { @@ -1880,7 +2182,7 @@ "errors": { "target": "com.amazonaws.computeoptimizer#GetRecommendationErrors", "traits": { - "smithy.api#documentation": "An array of objects that describe errors of the request.
\n\nFor example, an error is returned if you request recommendations for an unsupported\n volume.
" + "smithy.api#documentation": "An array of objects that describe errors of the request.
\nFor example, an error is returned if you request recommendations for an unsupported\n volume.
" } } } @@ -1920,7 +2222,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns Amazon EC2 instance recommendations.
\n\nCompute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a specific set of requirements. For more\n information, see the Supported resources and\n requirements in the Compute Optimizer User\n Guide.
" + "smithy.api#documentation": "Returns Amazon EC2 instance recommendations.
\nCompute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a specific set of requirements. For more\n information, see the Supported resources and\n requirements in the Compute Optimizer User\n Guide.
" } }, "com.amazonaws.computeoptimizer#GetEC2InstanceRecommendationsRequest": { @@ -1941,7 +2243,7 @@ "maxResults": { "target": "com.amazonaws.computeoptimizer#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of instance recommendations to return with a single request.
\n\nTo retrieve the remaining results, make another request with the returned\n nextToken value.
The maximum number of instance recommendations to return with a single request.
\nTo retrieve the remaining results, make another request with the returned\n nextToken value.
The ID of the Amazon Web Services account for which to return instance\n recommendations.
\n\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return instance recommendations.
\n\nOnly one account ID can be specified per request.
" + "smithy.api#documentation": "The ID of the Amazon Web Services account for which to return instance\n recommendations.
\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return instance recommendations.
\nOnly one account ID can be specified per request.
" } }, "recommendationPreferences": { @@ -1970,7 +2272,7 @@ "nextToken": { "target": "com.amazonaws.computeoptimizer#NextToken", "traits": { - "smithy.api#documentation": "The token to use to advance to the next page of instance recommendations.
\n\nThis value is null when there are no more pages of instance recommendations to\n return.
" + "smithy.api#documentation": "The token to use to advance to the next page of instance recommendations.
\nThis value is null when there are no more pages of instance recommendations to\n return.
" } }, "instanceRecommendations": { @@ -1982,7 +2284,7 @@ "errors": { "target": "com.amazonaws.computeoptimizer#GetRecommendationErrors", "traits": { - "smithy.api#documentation": "An array of objects that describe errors of the request.
\n\nFor example, an error is returned if you request recommendations for an instance of an\n unsupported instance family.
" + "smithy.api#documentation": "An array of objects that describe errors of the request.
\nFor example, an error is returned if you request recommendations for an instance of an\n unsupported instance family.
" } } } @@ -2022,7 +2324,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the projected utilization metrics of Amazon EC2 instance\n recommendations.
\n\nThe Cpu and Memory metrics are the only projected\n utilization metrics returned when you run this action. Additionally, the\n Memory metric is returned only for resources that have the unified\n CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.
Returns the projected utilization metrics of Amazon EC2 instance\n recommendations.
\nThe Cpu and Memory metrics are the only projected\n utilization metrics returned when you run this action. Additionally, the\n Memory metric is returned only for resources that have the unified\n CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.
Returns the recommendation preferences that are in effect for a given resource, such\n as enhanced infrastructure metrics. Considers all applicable preferences that you might\n have set at the resource, account, and organization level.
\nWhen you create a recommendation preference, you can set its status to\n Active or Inactive. Use this action to view the\n recommendation preferences that are in effect, or Active.
The Amazon Resource Name (ARN) of the resource for which to confirm effective\n recommendation preferences. Only EC2 instance and Auto Scaling group ARNs are\n currently supported.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.computeoptimizer#GetEffectiveRecommendationPreferencesResponse": { + "type": "structure", + "members": { + "enhancedInfrastructureMetrics": { + "target": "com.amazonaws.computeoptimizer#EnhancedInfrastructureMetrics", + "traits": { + "smithy.api#documentation": "The status of the enhanced infrastructure metrics recommendation preference. Considers\n all applicable preferences that you might have set at the resource, account, and\n organization level.
\nA status of Active confirms that the preference is applied in the latest\n recommendation refresh, and a status of Inactive confirms that it's not yet\n applied.
To validate whether the preference is applied to your last generated set of\n recommendations, review the effectiveRecommendationPreferences value in the\n response of the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
Returns the enrollment (opt in) status of an account to the Compute Optimizer\n service.
\n\nIf the account is the management account of an organization, this action also confirms\n the enrollment status of member accounts of the organization. Use the GetEnrollmentStatusesForOrganization action to get detailed information\n about the enrollment status of member accounts of an organization.
" + "smithy.api#documentation": "Returns the enrollment (opt in) status of an account to the Compute Optimizer\n service.
\nIf the account is the management account of an organization, this action also confirms\n the enrollment status of member accounts of the organization. Use the GetEnrollmentStatusesForOrganization action to get detailed information\n about the enrollment status of member accounts of an organization.
" } }, "com.amazonaws.computeoptimizer#GetEnrollmentStatusRequest": { @@ -2130,7 +2493,7 @@ "statusReason": { "target": "com.amazonaws.computeoptimizer#StatusReason", "traits": { - "smithy.api#documentation": "The reason for the enrollment status of the account.
\n\nFor example, an account might show a status of Pending because member\n accounts of an organization require more time to be enrolled in the service.
The reason for the enrollment status of the account.
\nFor example, an account might show a status of Pending because member\n accounts of an organization require more time to be enrolled in the service.
Returns the Compute Optimizer enrollment (opt-in) status of organization member\n accounts, if your account is an organization management account.
\n\nTo get the enrollment status of standalone accounts, use the GetEnrollmentStatus action.
" + "smithy.api#documentation": "Returns the Compute Optimizer enrollment (opt-in) status of organization member\n accounts, if your account is an organization management account.
\nTo get the enrollment status of standalone accounts, use the GetEnrollmentStatus action.
" } }, "com.amazonaws.computeoptimizer#GetEnrollmentStatusesForOrganizationRequest": { @@ -2203,7 +2566,7 @@ "maxResults": { "target": "com.amazonaws.computeoptimizer#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of account enrollment statuses to return with a single request. You\n can specify up to 100 statuses to return with each request.
\n\nTo retrieve the remaining results, make another request with the returned\n nextToken value.
The maximum number of account enrollment statuses to return with a single request. You\n can specify up to 100 statuses to return with each request.
\nTo retrieve the remaining results, make another request with the returned\n nextToken value.
The token to use to advance to the next page of account enrollment statuses.
\n\nThis value is null when there are no more pages of account enrollment statuses to\n return.
" + "smithy.api#documentation": "The token to use to advance to the next page of account enrollment statuses.
\nThis value is null when there are no more pages of account enrollment statuses to\n return.
" } } } @@ -2260,7 +2623,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns Lambda function recommendations.
\n\nCompute Optimizer generates recommendations for functions that meet a specific set\n of requirements. For more information, see the Supported resources and\n requirements in the Compute Optimizer User\n Guide.
" + "smithy.api#documentation": "Returns Lambda function recommendations.
\nCompute Optimizer generates recommendations for functions that meet a specific set\n of requirements. For more information, see the Supported resources and\n requirements in the Compute Optimizer User\n Guide.
" } }, "com.amazonaws.computeoptimizer#GetLambdaFunctionRecommendationsRequest": { @@ -2269,13 +2632,13 @@ "functionArns": { "target": "com.amazonaws.computeoptimizer#FunctionArns", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the functions for which to return\n recommendations.
\n\nYou can specify a qualified or unqualified ARN. If you specify an unqualified ARN\n without a function version suffix, Compute Optimizer will return recommendations for the\n latest ($LATEST) version of the function. If you specify a qualified ARN\n with a version suffix, Compute Optimizer will return recommendations for the specified\n function version. For more information about using function versions, see Using\n versions in the Lambda Developer\n Guide.
The Amazon Resource Name (ARN) of the functions for which to return\n recommendations.
\nYou can specify a qualified or unqualified ARN. If you specify an unqualified ARN\n without a function version suffix, Compute Optimizer will return recommendations for the\n latest ($LATEST) version of the function. If you specify a qualified ARN\n with a version suffix, Compute Optimizer will return recommendations for the specified\n function version. For more information about using function versions, see Using\n versions in the Lambda Developer\n Guide.
The ID of the Amazon Web Services account for which to return function\n recommendations.
\n\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return function recommendations.
\n\nOnly one account ID can be specified per request.
" + "smithy.api#documentation": "The ID of the Amazon Web Services account for which to return function\n recommendations.
\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return function recommendations.
\nOnly one account ID can be specified per request.
" } }, "filters": { @@ -2293,7 +2656,7 @@ "maxResults": { "target": "com.amazonaws.computeoptimizer#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of function recommendations to return with a single request.
\n\nTo retrieve the remaining results, make another request with the returned\n nextToken value.
The maximum number of function recommendations to return with a single request.
\nTo retrieve the remaining results, make another request with the returned\n nextToken value.
The token to use to advance to the next page of function recommendations.
\n\nThis value is null when there are no more pages of function recommendations to\n return.
" + "smithy.api#documentation": "The token to use to advance to the next page of function recommendations.
\nThis value is null when there are no more pages of function recommendations to\n return.
" } }, "lambdaFunctionRecommendations": { @@ -2338,7 +2701,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes an error experienced when getting recommendations.
\n\nFor example, an error is returned if you request recommendations for an unsupported\n Auto Scaling group, or if you request recommendations for an instance of an\n unsupported instance family.
" + "smithy.api#documentation": "Describes an error experienced when getting recommendations.
\nFor example, an error is returned if you request recommendations for an unsupported\n Auto Scaling group, or if you request recommendations for an instance of an\n unsupported instance family.
" } }, "com.amazonaws.computeoptimizer#GetRecommendationErrors": { @@ -2347,6 +2710,91 @@ "target": "com.amazonaws.computeoptimizer#GetRecommendationError" } }, + "com.amazonaws.computeoptimizer#GetRecommendationPreferences": { + "type": "operation", + "input": { + "target": "com.amazonaws.computeoptimizer#GetRecommendationPreferencesRequest" + }, + "output": { + "target": "com.amazonaws.computeoptimizer#GetRecommendationPreferencesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.computeoptimizer#AccessDeniedException" + }, + { + "target": "com.amazonaws.computeoptimizer#InternalServerException" + }, + { + "target": "com.amazonaws.computeoptimizer#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.computeoptimizer#MissingAuthenticationToken" + }, + { + "target": "com.amazonaws.computeoptimizer#OptInRequiredException" + }, + { + "target": "com.amazonaws.computeoptimizer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.computeoptimizer#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.computeoptimizer#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Returns existing recommendation preferences, such as enhanced infrastructure\n metrics.
\nUse the scope parameter to specify which preferences to return. You can\n specify to return preferences for an organization, a specific account ID, or a specific\n EC2 instance or Auto Scaling group Amazon Resource Name (ARN).
For more information, see Activating\n enhanced infrastructure metrics in the Compute Optimizer User\n Guide.
" + } + }, + "com.amazonaws.computeoptimizer#GetRecommendationPreferencesRequest": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.computeoptimizer#ResourceType", + "traits": { + "smithy.api#documentation": "The target resource type of the recommendation preference for which to return\n preferences.
\nThe Ec2Instance option encompasses standalone instances and instances\n that are part of Auto Scaling groups. The AutoScalingGroup option\n encompasses only instances that are part of an Auto Scaling group.
An object that describes the scope of the recommendation preference to return.
\nYou can return recommendation preferences that are created at the organization level\n (for management accounts of an organization only), account level, and resource level.\n For more information, see Activating\n enhanced infrastructure metrics in the Compute Optimizer User\n Guide.
" + } + }, + "nextToken": { + "target": "com.amazonaws.computeoptimizer#NextToken", + "traits": { + "smithy.api#documentation": "The token to advance to the next page of recommendation preferences.
" + } + }, + "maxResults": { + "target": "com.amazonaws.computeoptimizer#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of recommendation preferences to return with a single\n request.
\nTo retrieve the remaining results, make another request with the returned\n nextToken value.
The token to use to advance to the next page of recommendation preferences.
\nThis value is null when there are no more pages of recommendation preferences to\n return.
" + } + }, + "recommendationPreferencesDetails": { + "target": "com.amazonaws.computeoptimizer#RecommendationPreferencesDetails", + "traits": { + "smithy.api#documentation": "An array of objects that describe recommendation preferences.
" + } + } + } + }, "com.amazonaws.computeoptimizer#GetRecommendationSummaries": { "type": "operation", "input": { @@ -2379,7 +2827,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the optimization findings for an account.
\n\nIt returns the number of:
\n\nAmazon EC2 instances in an account that are\n Underprovisioned, Overprovisioned, or\n Optimized.
Auto Scaling groups in an account that are NotOptimized, or\n Optimized.
Amazon EBS volumes in an account that are NotOptimized,\n or Optimized.
Lambda functions in an account that are NotOptimized,\n or Optimized.
Returns the optimization findings for an account.
\nIt returns the number of:
\nAmazon EC2 instances in an account that are\n Underprovisioned, Overprovisioned, or\n Optimized.
Auto Scaling groups in an account that are NotOptimized, or\n Optimized.
Amazon EBS volumes in an account that are NotOptimized,\n or Optimized.
Lambda functions in an account that are NotOptimized,\n or Optimized.
The ID of the Amazon Web Services account for which to return recommendation\n summaries.
\n\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return recommendation summaries.
\n\nOnly one account ID can be specified per request.
" + "smithy.api#documentation": "The ID of the Amazon Web Services account for which to return recommendation\n summaries.
\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return recommendation summaries.
\nOnly one account ID can be specified per request.
" } }, "nextToken": { @@ -2400,7 +2848,7 @@ "maxResults": { "target": "com.amazonaws.computeoptimizer#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of recommendation summaries to return with a single request.
\n\nTo retrieve the remaining results, make another request with the returned\n nextToken value.
The maximum number of recommendation summaries to return with a single request.
\nTo retrieve the remaining results, make another request with the returned\n nextToken value.
The token to use to advance to the next page of recommendation summaries.
\n\nThis value is null when there are no more pages of recommendation summaries to\n return.
" + "smithy.api#documentation": "The token to use to advance to the next page of recommendation summaries.
\nThis value is null when there are no more pages of recommendation summaries to\n return.
" } }, "recommendationSummaries": { @@ -2422,6 +2870,9 @@ } } }, + "com.amazonaws.computeoptimizer#High": { + "type": "long" + }, "com.amazonaws.computeoptimizer#Identifier": { "type": "string" }, @@ -2470,13 +2921,13 @@ "finding": { "target": "com.amazonaws.computeoptimizer#Finding", "traits": { - "smithy.api#documentation": "The finding classification of the instance.
\n\nFindings for instances include:
\n\n\n \n Underprovisioned\n —An instance is\n considered under-provisioned when at least one specification of your instance,\n such as CPU, memory, or network, does not meet the performance requirements of\n your workload. Under-provisioned instances may lead to poor application\n performance.
\n \n Overprovisioned\n —An instance is\n considered over-provisioned when at least one specification of your instance,\n such as CPU, memory, or network, can be sized down while still meeting the\n performance requirements of your workload, and no specification is\n under-provisioned. Over-provisioned instances may lead to unnecessary\n infrastructure cost.
\n \n Optimized\n —An instance is\n considered optimized when all specifications of your instance, such as CPU,\n memory, and network, meet the performance requirements of your workload and is\n not over provisioned. For optimized resources, Compute Optimizer might\n recommend a new generation instance type.
The finding classification of the instance.
\nFindings for instances include:
\n\n \n Underprovisioned\n —An instance is\n considered under-provisioned when at least one specification of your instance,\n such as CPU, memory, or network, does not meet the performance requirements of\n your workload. Under-provisioned instances may lead to poor application\n performance.
\n \n Overprovisioned\n —An instance is\n considered over-provisioned when at least one specification of your instance,\n such as CPU, memory, or network, can be sized down while still meeting the\n performance requirements of your workload, and no specification is\n under-provisioned. Over-provisioned instances may lead to unnecessary\n infrastructure cost.
\n \n Optimized\n —An instance is\n considered optimized when all specifications of your instance, such as CPU,\n memory, and network, meet the performance requirements of your workload and is\n not over provisioned. For optimized resources, Compute Optimizer might\n recommend a new generation instance type.
The reason for the finding classification of the instance.
\n\nFinding reason codes for instances include:
\n\n\n \n CPUOverprovisioned\n — The\n instance’s CPU configuration can be sized down while still meeting the\n performance requirements of your workload. This is identified by analyzing the\n CPUUtilization metric of the current instance during the\n look-back period.
\n \n CPUUnderprovisioned\n — The\n instance’s CPU configuration doesn't meet the performance requirements of your\n workload and there is an alternative instance type that provides better CPU\n performance. This is identified by analyzing the CPUUtilization\n metric of the current instance during the look-back period.
\n \n MemoryOverprovisioned\n — The\n instance’s memory configuration can be sized down while still meeting the\n performance requirements of your workload. This is identified by analyzing the\n memory utilization metric of the current instance during the look-back\n period.
\n \n MemoryUnderprovisioned\n — The\n instance’s memory configuration doesn't meet the performance requirements of\n your workload and there is an alternative instance type that provides better\n memory performance. This is identified by analyzing the memory utilization\n metric of the current instance during the look-back period.
Memory utilization is analyzed only for resources that have the unified\n CloudWatch agent installed on them. For more information, see\n Enabling memory\n utilization with the Amazon CloudWatch Agent in the\n Compute Optimizer User Guide. On Linux\n instances, Compute Optimizer analyses the mem_used_percent\n metric in the CWAgent namespace, or the legacy\n MemoryUtilization metric in the System/Linux\n namespace. On Windows instances, Compute Optimizer analyses the Memory\n % Committed Bytes In Use metric in the CWAgent\n namespace.
\n \n EBSThroughputOverprovisioned\n —\n The instance’s EBS throughput configuration can be sized down while still\n meeting the performance requirements of your workload. This is identified by\n analyzing the VolumeReadOps and VolumeWriteOps metrics\n of EBS volumes attached to the current instance during the look-back\n period.
\n \n EBSThroughputUnderprovisioned\n —\n The instance’s EBS throughput configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type that\n provides better EBS throughput performance. This is identified by analyzing the\n VolumeReadOps and VolumeWriteOps metrics of EBS\n volumes attached to the current instance during the look-back period.
\n \n EBSIOPSOverprovisioned\n — The\n instance’s EBS IOPS configuration can be sized down while still meeting the\n performance requirements of your workload. This is identified by analyzing the\n VolumeReadBytes and VolumeWriteBytes metric of EBS\n volumes attached to the current instance during the look-back period.
\n \n EBSIOPSUnderprovisioned\n — The\n instance’s EBS IOPS configuration doesn't meet the performance requirements of\n your workload and there is an alternative instance type that provides better EBS\n IOPS performance. This is identified by analyzing the\n VolumeReadBytes and VolumeWriteBytes metric of EBS\n volumes attached to the current instance during the look-back period.
\n \n NetworkBandwidthOverprovisioned\n \n — The instance’s network bandwidth configuration can be sized down while still\n meeting the performance requirements of your workload. This is identified by\n analyzing the NetworkIn and NetworkOut metrics of the\n current instance during the look-back period.
\n \n NetworkBandwidthUnderprovisioned\n \n — The instance’s network bandwidth configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type that\n provides better network bandwidth performance. This is identified by analyzing\n the NetworkIn and NetworkOut metrics of the current\n instance during the look-back period. This finding reason happens when the\n NetworkIn or NetworkOut performance of an instance\n is impacted.
\n \n NetworkPPSOverprovisioned\n — The\n instance’s network PPS (packets per second) configuration can be sized down\n while still meeting the performance requirements of your workload. This is\n identified by analyzing the NetworkPacketsIn and\n NetworkPacketsIn metrics of the current instance during the\n look-back period.
\n \n NetworkPPSUnderprovisioned\n — The\n instance’s network PPS (packets per second) configuration doesn't meet the\n performance requirements of your workload and there is an alternative instance\n type that provides better network PPS performance. This is identified by\n analyzing the NetworkPacketsIn and NetworkPacketsIn\n metrics of the current instance during the look-back period.
\n \n DiskIOPSOverprovisioned\n — The\n instance’s disk IOPS configuration can be sized down while still meeting the\n performance requirements of your workload. This is identified by analyzing the\n DiskReadOps and DiskWriteOps metrics of the\n current instance during the look-back period.
\n \n DiskIOPSUnderprovisioned\n — The\n instance’s disk IOPS configuration doesn't meet the performance requirements of\n your workload and there is an alternative instance type that provides better\n disk IOPS performance. This is identified by analyzing the\n DiskReadOps and DiskWriteOps metrics of the\n current instance during the look-back period.
\n \n DiskThroughputOverprovisioned\n —\n The instance’s disk throughput configuration can be sized down while still\n meeting the performance requirements of your workload. This is identified by\n analyzing the DiskReadBytes and DiskWriteBytes metrics\n of the current instance during the look-back period.
\n \n DiskThroughputUnderprovisioned\n —\n The instance’s disk throughput configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type that\n provides better disk throughput performance. This is identified by analyzing the\n DiskReadBytes and DiskWriteBytes metrics of the\n current instance during the look-back period.
For more information about instance metrics, see List the\n available CloudWatch metrics for your instances in the\n Amazon Elastic Compute Cloud User Guide. For more information\n about EBS volume metrics, see Amazon CloudWatch\n metrics for Amazon EBS in the Amazon Elastic Compute Cloud\n User Guide.
\nThe reason for the finding classification of the instance.
\nFinding reason codes for instances include:
\n\n \n CPUOverprovisioned\n — The\n instance’s CPU configuration can be sized down while still meeting the\n performance requirements of your workload. This is identified by analyzing the\n CPUUtilization metric of the current instance during the\n look-back period.
\n \n CPUUnderprovisioned\n — The\n instance’s CPU configuration doesn't meet the performance requirements of your\n workload and there is an alternative instance type that provides better CPU\n performance. This is identified by analyzing the CPUUtilization\n metric of the current instance during the look-back period.
\n \n MemoryOverprovisioned\n — The\n instance’s memory configuration can be sized down while still meeting the\n performance requirements of your workload. This is identified by analyzing the\n memory utilization metric of the current instance during the look-back\n period.
\n \n MemoryUnderprovisioned\n — The\n instance’s memory configuration doesn't meet the performance requirements of\n your workload and there is an alternative instance type that provides better\n memory performance. This is identified by analyzing the memory utilization\n metric of the current instance during the look-back period.
Memory utilization is analyzed only for resources that have the unified\n CloudWatch agent installed on them. For more information, see\n Enabling memory\n utilization with the Amazon CloudWatch Agent in the\n Compute Optimizer User Guide. On Linux\n instances, Compute Optimizer analyses the mem_used_percent\n metric in the CWAgent namespace, or the legacy\n MemoryUtilization metric in the System/Linux\n namespace. On Windows instances, Compute Optimizer analyses the Memory\n % Committed Bytes In Use metric in the CWAgent\n namespace.
\n \n EBSThroughputOverprovisioned\n —\n The instance’s EBS throughput configuration can be sized down while still\n meeting the performance requirements of your workload. This is identified by\n analyzing the VolumeReadOps and VolumeWriteOps metrics\n of EBS volumes attached to the current instance during the look-back\n period.
\n \n EBSThroughputUnderprovisioned\n —\n The instance’s EBS throughput configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type that\n provides better EBS throughput performance. This is identified by analyzing the\n VolumeReadOps and VolumeWriteOps metrics of EBS\n volumes attached to the current instance during the look-back period.
\n \n EBSIOPSOverprovisioned\n — The\n instance’s EBS IOPS configuration can be sized down while still meeting the\n performance requirements of your workload. This is identified by analyzing the\n VolumeReadBytes and VolumeWriteBytes metric of EBS\n volumes attached to the current instance during the look-back period.
\n \n EBSIOPSUnderprovisioned\n — The\n instance’s EBS IOPS configuration doesn't meet the performance requirements of\n your workload and there is an alternative instance type that provides better EBS\n IOPS performance. This is identified by analyzing the\n VolumeReadBytes and VolumeWriteBytes metric of EBS\n volumes attached to the current instance during the look-back period.
\n \n NetworkBandwidthOverprovisioned\n \n — The instance’s network bandwidth configuration can be sized down while still\n meeting the performance requirements of your workload. This is identified by\n analyzing the NetworkIn and NetworkOut metrics of the\n current instance during the look-back period.
\n \n NetworkBandwidthUnderprovisioned\n \n — The instance’s network bandwidth configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type that\n provides better network bandwidth performance. This is identified by analyzing\n the NetworkIn and NetworkOut metrics of the current\n instance during the look-back period. This finding reason happens when the\n NetworkIn or NetworkOut performance of an instance\n is impacted.
\n \n NetworkPPSOverprovisioned\n — The\n instance’s network PPS (packets per second) configuration can be sized down\n while still meeting the performance requirements of your workload. This is\n identified by analyzing the NetworkPacketsIn and\n NetworkPacketsIn metrics of the current instance during the\n look-back period.
\n \n NetworkPPSUnderprovisioned\n — The\n instance’s network PPS (packets per second) configuration doesn't meet the\n performance requirements of your workload and there is an alternative instance\n type that provides better network PPS performance. This is identified by\n analyzing the NetworkPacketsIn and NetworkPacketsIn\n metrics of the current instance during the look-back period.
\n \n DiskIOPSOverprovisioned\n — The\n instance’s disk IOPS configuration can be sized down while still meeting the\n performance requirements of your workload. This is identified by analyzing the\n DiskReadOps and DiskWriteOps metrics of the\n current instance during the look-back period.
\n \n DiskIOPSUnderprovisioned\n — The\n instance’s disk IOPS configuration doesn't meet the performance requirements of\n your workload and there is an alternative instance type that provides better\n disk IOPS performance. This is identified by analyzing the\n DiskReadOps and DiskWriteOps metrics of the\n current instance during the look-back period.
\n \n DiskThroughputOverprovisioned\n —\n The instance’s disk throughput configuration can be sized down while still\n meeting the performance requirements of your workload. This is identified by\n analyzing the DiskReadBytes and DiskWriteBytes metrics\n of the current instance during the look-back period.
\n \n DiskThroughputUnderprovisioned\n —\n The instance’s disk throughput configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type that\n provides better disk throughput performance. This is identified by analyzing the\n DiskReadBytes and DiskWriteBytes metrics of the\n current instance during the look-back period.
For more information about instance metrics, see List the\n available CloudWatch metrics for your instances in the\n Amazon Elastic Compute Cloud User Guide. For more information\n about EBS volume metrics, see Amazon CloudWatch\n metrics for Amazon EBS in the Amazon Elastic Compute Cloud\n User Guide.
\nThe timestamp of when the instance recommendation was last refreshed.
" + "smithy.api#documentation": "The timestamp of when the instance recommendation was last generated.
" + } + }, + "currentPerformanceRisk": { + "target": "com.amazonaws.computeoptimizer#CurrentPerformanceRisk", + "traits": { + "smithy.api#documentation": "The risk of the current instance not meeting the performance needs of its workloads.\n The higher the risk, the more likely the current Lambda function requires\n more memory.
" + } + }, + "effectiveRecommendationPreferences": { + "target": "com.amazonaws.computeoptimizer#EffectiveRecommendationPreferences", + "traits": { + "smithy.api#documentation": "An object that describes the effective recommendation preferences for the\n instance.
" } } }, @@ -2603,25 +3066,31 @@ "projectedUtilizationMetrics": { "target": "com.amazonaws.computeoptimizer#ProjectedUtilizationMetrics", "traits": { - "smithy.api#documentation": "An array of objects that describe the projected utilization metrics of the instance\n recommendation option.
\n\nThe Cpu and Memory metrics are the only projected\n utilization metrics returned. Additionally, the Memory metric is\n returned only for resources that have the unified CloudWatch agent installed\n on them. For more information, see Enabling Memory\n Utilization with the CloudWatch Agent.
An array of objects that describe the projected utilization metrics of the instance\n recommendation option.
\nThe Cpu and Memory metrics are the only projected\n utilization metrics returned. Additionally, the Memory metric is\n returned only for resources that have the unified CloudWatch agent installed\n on them. For more information, see Enabling Memory\n Utilization with the CloudWatch Agent.
Describes the configuration differences between the current instance and the\n recommended instance type. You should consider the configuration differences before\n migrating your workloads from the current instance to the recommended instance type. The\n Change the instance type guide for Linux and Change the instance type\n guide for Windows provide general guidance for getting started with an\n instance migration.
\n\nPlatform differences include:
\n\n\n \n Hypervisor\n — The hypervisor of\n the recommended instance type is different than that of the current instance.\n For example, the recommended instance type uses a Nitro hypervisor and the\n current instance uses a Xen hypervisor. The differences that you should consider\n between these hypervisors are covered in the Nitro Hypervisor section of the\n Amazon EC2 frequently asked questions. For more information, see\n Instances built on the Nitro System in the Amazon EC2\n User Guide for Linux, or Instances built on the Nitro System in the Amazon EC2\n User Guide for Windows.
\n \n NetworkInterface\n — The network\n interface of the recommended instance type is different than that of the current\n instance. For example, the recommended instance type supports enhanced\n networking and the current instance might not. To enable enhanced networking for\n the recommended instance type, you must install the Elastic Network Adapter\n (ENA) driver or the Intel 82599 Virtual Function driver. For more information,\n see Networking and storage features and Enhanced networking\n on Linux in the Amazon EC2 User Guide for\n Linux, or Networking and storage features and Enhanced\n networking on Windows in the Amazon EC2 User Guide for\n Windows.
\n \n StorageInterface\n — The storage\n interface of the recommended instance type is different than that of the current\n instance. For example, the recommended instance type uses an NVMe storage\n interface and the current instance does not. To access NVMe volumes for the\n recommended instance type, you will need to install or upgrade the NVMe driver.\n For more information, see Networking and storage features and Amazon EBS and NVMe on\n Linux instances in the Amazon EC2 User Guide for\n Linux, or Networking and storage features and Amazon EBS and NVMe\n on Windows instances in the Amazon EC2 User Guide for\n Windows.
\n \n InstanceStoreAvailability\n — The\n recommended instance type does not support instance store volumes and the\n current instance does. Before migrating, you might need to back up the data on\n your instance store volumes if you want to preserve them. For more information,\n see How do I back up an instance store volume on my Amazon EC2 instance\n to Amazon EBS? in the Amazon Web Services Premium\n Support Knowledge Base. For more information, see Networking and storage features and Amazon EC2\n instance store in the Amazon EC2 User Guide for\n Linux, or see Networking and storage features and Amazon EC2\n instance store in the Amazon EC2 User Guide for\n Windows.
\n \n VirtualizationType\n — The\n recommended instance type uses the hardware virtual machine (HVM) virtualization\n type and the current instance uses the paravirtual (PV) virtualization type. For\n more information about the differences between these virtualization types, see\n Linux AMI\n virtualization types in the Amazon EC2 User Guide for\n Linux, or Windows AMI virtualization types in the Amazon EC2 User\n Guide for Windows.
\n \n Architecture\n — The CPU\n architecture between the recommended instance type and the current instance is\n different. For example, the recommended instance type might use an Arm CPU\n architecture and the current instance type might use a different one, such as\n x86. Before migrating, you should consider recompiling the software on your\n instance for the new architecture. Alternatively, you might switch to an Amazon\n Machine Image (AMI) that supports the new architecture. For more information\n about the CPU architecture for each instance type, see Amazon EC2 Instance Types.
Describes the configuration differences between the current instance and the\n recommended instance type. You should consider the configuration differences before\n migrating your workloads from the current instance to the recommended instance type. The\n Change the instance type guide for Linux and Change the instance type\n guide for Windows provide general guidance for getting started with an\n instance migration.
\nPlatform differences include:
\n\n \n Hypervisor\n — The hypervisor of\n the recommended instance type is different than that of the current instance.\n For example, the recommended instance type uses a Nitro hypervisor and the\n current instance uses a Xen hypervisor. The differences that you should consider\n between these hypervisors are covered in the Nitro Hypervisor section of the\n Amazon EC2 frequently asked questions. For more information, see\n Instances built on the Nitro System in the Amazon EC2\n User Guide for Linux, or Instances built on the Nitro System in the Amazon EC2\n User Guide for Windows.
\n \n NetworkInterface\n — The network\n interface of the recommended instance type is different than that of the current\n instance. For example, the recommended instance type supports enhanced\n networking and the current instance might not. To enable enhanced networking for\n the recommended instance type, you must install the Elastic Network Adapter\n (ENA) driver or the Intel 82599 Virtual Function driver. For more information,\n see Networking and storage features and Enhanced networking\n on Linux in the Amazon EC2 User Guide for\n Linux, or Networking and storage features and Enhanced\n networking on Windows in the Amazon EC2 User Guide for\n Windows.
\n \n StorageInterface\n — The storage\n interface of the recommended instance type is different than that of the current\n instance. For example, the recommended instance type uses an NVMe storage\n interface and the current instance does not. To access NVMe volumes for the\n recommended instance type, you will need to install or upgrade the NVMe driver.\n For more information, see Networking and storage features and Amazon EBS and NVMe on\n Linux instances in the Amazon EC2 User Guide for\n Linux, or Networking and storage features and Amazon EBS and NVMe\n on Windows instances in the Amazon EC2 User Guide for\n Windows.
\n \n InstanceStoreAvailability\n — The\n recommended instance type does not support instance store volumes and the\n current instance does. Before migrating, you might need to back up the data on\n your instance store volumes if you want to preserve them. For more information,\n see How do I back up an instance store volume on my Amazon EC2 instance\n to Amazon EBS? in the Amazon Web Services Premium\n Support Knowledge Base. For more information, see Networking and storage features and Amazon EC2\n instance store in the Amazon EC2 User Guide for\n Linux, or see Networking and storage features and Amazon EC2\n instance store in the Amazon EC2 User Guide for\n Windows.
\n \n VirtualizationType\n — The\n recommended instance type uses the hardware virtual machine (HVM) virtualization\n type and the current instance uses the paravirtual (PV) virtualization type. For\n more information about the differences between these virtualization types, see\n Linux AMI\n virtualization types in the Amazon EC2 User Guide for\n Linux, or Windows AMI virtualization types in the Amazon EC2 User\n Guide for Windows.
\n \n Architecture\n — The CPU\n architecture between the recommended instance type and the current instance is\n different. For example, the recommended instance type might use an Arm CPU\n architecture and the current instance type might use a different one, such as\n x86. Before migrating, you should consider recompiling the software on your\n instance for the new architecture. Alternatively, you might switch to an Amazon\n Machine Image (AMI) that supports the new architecture. For more information\n about the CPU architecture for each instance type, see Amazon EC2 Instance Types.
The performance risk of the instance recommendation option.
\n\nPerformance risk indicates the likelihood of the recommended instance type not meeting\n the resource needs of your workload. Compute Optimizer calculates an individual\n performance risk score for each specification of the recommended instance, including\n CPU, memory, EBS throughput, EBS IOPS, disk throughput, disk IOPS, network throughput,\n and network PPS.\n The performance\n risk of the recommended instance is calculated as the maximum performance risk score\n across the analyzed resource specifications.
\n\nThe value ranges from 0 - 4, with 0 meaning\n that the recommended resource is predicted to always provide enough hardware capability.\n The higher the performance risk is, the more likely you should validate whether the\n recommendation will meet the performance requirements of your workload before migrating\n your resource.
The performance risk of the instance recommendation option.
\nPerformance risk indicates the likelihood of the recommended instance type not meeting\n the resource needs of your workload. Compute Optimizer calculates an individual\n performance risk score for each specification of the recommended instance, including\n CPU, memory, EBS throughput, EBS IOPS, disk throughput, disk IOPS, network throughput,\n and network PPS.\n The performance\n risk of the recommended instance is calculated as the maximum performance risk score\n across the analyzed resource specifications.
\nThe value ranges from 0 - 4, with 0 meaning\n that the recommended resource is predicted to always provide enough hardware capability.\n The higher the performance risk is, the more likely you should validate whether the\n recommendation will meet the performance requirements of your workload before migrating\n your resource.
The rank of the instance recommendation option.
\n\nThe top recommendation option is ranked as 1.
The rank of the instance recommendation option.
\nThe top recommendation option is ranked as 1.
An object that describes the savings opportunity for the instance recommendation\n option. Savings opportunity includes the estimated monthly savings amount and\n percentage.
" } } }, @@ -2670,18 +3139,18 @@ "name": { "target": "com.amazonaws.computeoptimizer#JobFilterName", "traits": { - "smithy.api#documentation": "The name of the filter.
\n\nSpecify ResourceType to return export jobs of a specific resource type\n (for example, Ec2Instance).
Specify JobStatus to return export jobs with a specific status (e.g,\n Complete).
The name of the filter.
\nSpecify ResourceType to return export jobs of a specific resource type\n (for example, Ec2Instance).
Specify JobStatus to return export jobs with a specific status (e.g,\n Complete).
The value of the filter.
\n\nThe valid values for this parameter are as follows, depending on what you specify for\n the name parameter:
Specify Ec2Instance or AutoScalingGroup if you\n specify the name parameter as ResourceType. There is\n no filter for EBS volumes because volume recommendations cannot be exported at\n this time.
Specify Queued, InProgress, Complete,\n or Failed if you specify the name parameter as\n JobStatus.
The value of the filter.
\nThe valid values for this parameter are as follows, depending on what you specify for\n the name parameter:
Specify Ec2Instance or AutoScalingGroup if you\n specify the name parameter as ResourceType. There is\n no filter for EBS volumes because volume recommendations cannot be exported at\n this time.
Specify Queued, InProgress, Complete,\n or Failed if you specify the name parameter as\n JobStatus.
Describes a filter that returns a more specific list of recommendation export jobs.\n Use this filter with the DescribeRecommendationExportJobs\n action.
\n\nYou can use EBSFilter with the GetEBSVolumeRecommendations action,\n LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, and Filter with\n the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
Describes a filter that returns a more specific list of recommendation export jobs.\n Use this filter with the DescribeRecommendationExportJobs\n action.
\nYou can use EBSFilter with the GetEBSVolumeRecommendations action,\n LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, and Filter with\n the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
The rank of the function recommendation option.
\n\nThe top recommendation option is ranked as 1.
The rank of the function recommendation option.
\nThe top recommendation option is ranked as 1.
An array of objects that describe the projected utilization metrics of the function\n recommendation option.
" } + }, + "savingsOpportunity": { + "target": "com.amazonaws.computeoptimizer#SavingsOpportunity", + "traits": { + "smithy.api#documentation": "An object that describes the savings opportunity for the Lambda function\n recommendation option. Savings opportunity includes the estimated monthly savings amount\n and percentage.
" + } } }, "traits": { @@ -2909,13 +3384,13 @@ "lastRefreshTimestamp": { "target": "com.amazonaws.computeoptimizer#LastRefreshTimestamp", "traits": { - "smithy.api#documentation": "The timestamp of when the function recommendation was last refreshed.
" + "smithy.api#documentation": "The timestamp of when the function recommendation was last generated.
" } }, "finding": { "target": "com.amazonaws.computeoptimizer#LambdaFunctionRecommendationFinding", "traits": { - "smithy.api#documentation": "The finding classification of the function.
\n\nFindings for functions include:
\n\n \n Optimized\n — The function is\n correctly provisioned to run your workload based on its current configuration\n and its utilization history. This finding classification does not include\n finding reason codes.
\n \n NotOptimized\n — The function is\n performing at a higher level (over-provisioned) or at a lower level\n (under-provisioned) than required for your workload because its current\n configuration is not optimal. Over-provisioned resources might lead to\n unnecessary infrastructure cost, and under-provisioned resources might lead to\n poor application performance. This finding classification can include the\n MemoryUnderprovisioned and MemoryUnderprovisioned\n finding reason codes.
\n \n Unavailable\n — Compute Optimizer\n was unable to generate a recommendation for the function. This could be because\n the function has not accumulated sufficient metric data, or the function does\n not qualify for a recommendation. This finding classification can include the\n InsufficientData and Inconclusive finding reason\n codes.
Functions with a finding of unavailable are not returned unless you\n specify the filter parameter with a value of\n Unavailable in your\n GetLambdaFunctionRecommendations request.
The finding classification of the function.
\nFindings for functions include:
\n\n \n Optimized\n — The function is\n correctly provisioned to run your workload based on its current configuration\n and its utilization history. This finding classification does not include\n finding reason codes.
\n \n NotOptimized\n — The function is\n performing at a higher level (over-provisioned) or at a lower level\n (under-provisioned) than required for your workload because its current\n configuration is not optimal. Over-provisioned resources might lead to\n unnecessary infrastructure cost, and under-provisioned resources might lead to\n poor application performance. This finding classification can include the\n MemoryUnderprovisioned and MemoryUnderprovisioned\n finding reason codes.
\n \n Unavailable\n — Compute Optimizer\n was unable to generate a recommendation for the function. This could be because\n the function has not accumulated sufficient metric data, or the function does\n not qualify for a recommendation. This finding classification can include the\n InsufficientData and Inconclusive finding reason\n codes.
Functions with a finding of unavailable are not returned unless you\n specify the filter parameter with a value of\n Unavailable in your\n GetLambdaFunctionRecommendations request.
An array of objects that describe the memory configuration recommendation options for\n the function.
" } + }, + "currentPerformanceRisk": { + "target": "com.amazonaws.computeoptimizer#CurrentPerformanceRisk", + "traits": { + "smithy.api#documentation": "The risk of the current Lambda function not meeting the performance needs\n of its workloads. The higher the risk, the more likely the current Lambda\n function configuration is underperforming in its workload.
" + } } }, "traits": { @@ -2941,18 +3422,18 @@ "name": { "target": "com.amazonaws.computeoptimizer#LambdaFunctionRecommendationFilterName", "traits": { - "smithy.api#documentation": "The name of the filter.
\n\nSpecify Finding to return recommendations with a specific finding\n classification (for example, NotOptimized).
Specify FindingReasonCode to return recommendations with a specific\n finding reason code (for example, MemoryUnderprovisioned).
The name of the filter.
\nSpecify Finding to return recommendations with a specific finding\n classification (for example, NotOptimized).
Specify FindingReasonCode to return recommendations with a specific\n finding reason code (for example, MemoryUnderprovisioned).
The value of the filter.
\n\nThe valid values for this parameter are as follows, depending on what you specify for\n the name parameter:
Specify Optimized, NotOptimized, or\n Unavailable if you specify the name parameter as\n Finding.
Specify MemoryOverprovisioned,\n MemoryUnderprovisioned, InsufficientData, or\n Inconclusive if you specify the name parameter as\n FindingReasonCode.
The value of the filter.
\nThe valid values for this parameter are as follows, depending on what you specify for\n the name parameter:
Specify Optimized, NotOptimized, or\n Unavailable if you specify the name parameter as\n Finding.
Specify MemoryOverprovisioned,\n MemoryUnderprovisioned, InsufficientData, or\n Inconclusive if you specify the name parameter as\n FindingReasonCode.
Describes a filter that returns a more specific list of Lambda\n function recommendations. Use this filter with the GetLambdaFunctionRecommendations action.
\n\nYou can use EBSFilter with the GetEBSVolumeRecommendations action, JobFilter with the\n DescribeRecommendationExportJobs action, and Filter\n with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
Describes a filter that returns a more specific list of Lambda\n function recommendations. Use this filter with the GetLambdaFunctionRecommendations action.
\nYou can use EBSFilter with the GetEBSVolumeRecommendations action, JobFilter with the\n DescribeRecommendationExportJobs action, and Filter\n with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
The name of the utilization metric.
\n\nThe following utilization metrics are available:
\n\n Duration - The amount of time that your function code spends\n processing an event.
\n Memory - The amount of memory used per invocation.
The name of the utilization metric.
\nThe following utilization metrics are available:
\n\n Duration - The amount of time that your function code spends\n processing an event.
\n Memory - The amount of memory used per invocation.
The statistic of the utilization metric.
\n\nThe Compute Optimizer API, Command Line Interface (CLI), and SDKs\n return utilization metrics using only the Maximum statistic, which is the\n highest value observed during the specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the\n Average statistic, which is the value of Sum /\n SampleCount during the specified period. For more information, see\n Viewing resource\n recommendations in the Compute Optimizer User\n Guide. You can also get averaged utilization metric data for your resources\n using Amazon CloudWatch. For more information, see the Amazon CloudWatch\n User Guide.
The statistic of the utilization metric.
\nThe Compute Optimizer API, Command Line Interface (CLI), and SDKs\n return utilization metrics using only the Maximum statistic, which is the\n highest value observed during the specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the\n Average statistic, which is the value of Sum /\n SampleCount during the specified period. For more information, see\n Viewing resource\n recommendations in the Compute Optimizer User\n Guide. You can also get averaged utilization metric data for your resources\n using Amazon CloudWatch. For more information, see the Amazon CloudWatch\n User Guide.
The name of the projected utilization metric.
\n\nThe following projected utilization metrics are returned:
\n\n Cpu - The projected percentage of allocated EC2 compute units\n that would be in use on the recommendation option had you used that resource\n during the analyzed period. This metric identifies the processing power required\n to run an application on the recommendation option.
Depending on the instance type, tools in your operating system can show a\n lower percentage than CloudWatch when the instance is not allocated a full\n processor core.
\nUnits: Percent
\n\n Memory - The percentage of memory that would be in use on the\n recommendation option had you used that resource during the analyzed period.\n This metric identifies the amount of memory required to run an application on\n the recommendation option.
Units: Percent
\nThe Memory metric is returned only for resources that have\n the unified CloudWatch agent installed on them. For more information,\n see Enabling Memory\n Utilization with the CloudWatch Agent.
The name of the projected utilization metric.
\nThe following projected utilization metrics are returned:
\n\n Cpu - The projected percentage of allocated EC2 compute units\n that would be in use on the recommendation option had you used that resource\n during the analyzed period. This metric identifies the processing power required\n to run an application on the recommendation option.
Depending on the instance type, tools in your operating system can show a\n lower percentage than CloudWatch when the instance is not allocated a full\n processor core.
\nUnits: Percent
\n\n Memory - The percentage of memory that would be in use on the\n recommendation option had you used that resource during the analyzed period.\n This metric identifies the amount of memory required to run an application on\n the recommendation option.
Units: Percent
\nThe Memory metric is returned only for resources that have\n the unified CloudWatch agent installed on them. For more information,\n see Enabling Memory\n Utilization with the CloudWatch Agent.
Describes a projected utilization metric of a recommendation option, such as an\n Amazon EC2 instance. This represents the projected utilization of a\n recommendation option had you used that resource during the analyzed period.
\n\nCompare the utilization metric data of your resource against its projected utilization\n metric data to determine the performance difference between your current resource and\n the recommended option.
\n\nThe Cpu and Memory metrics are the only projected\n utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. Additionally, the\n Memory metric is returned only for resources that have the unified\n CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.
Describes a projected utilization metric of a recommendation option, such as an\n Amazon EC2 instance. This represents the projected utilization of a\n recommendation option had you used that resource during the analyzed period.
\nCompare the utilization metric data of your resource against its projected utilization\n metric data to determine the performance difference between your current resource and\n the recommended option.
\nThe Cpu and Memory metrics are the only projected\n utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. Additionally, the\n Memory metric is returned only for resources that have the unified\n CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.
Creates a new recommendation preference or updates an existing recommendation\n preference, such as enhanced infrastructure metrics.
\nFor more information, see Activating\n enhanced infrastructure metrics in the Compute Optimizer User\n Guide.
" + } + }, + "com.amazonaws.computeoptimizer#PutRecommendationPreferencesRequest": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.computeoptimizer#ResourceType", + "traits": { + "smithy.api#documentation": "The target resource type of the recommendation preference to create.
\nThe Ec2Instance option encompasses standalone instances and instances\n that are part of Auto Scaling groups. The AutoScalingGroup option\n encompasses only instances that are part of an Auto Scaling group.
An object that describes the scope of the recommendation preference to create.
\nYou can create recommendation preferences at the organization level (for management\n accounts of an organization only), account level, and resource level. For more\n information, see Activating\n enhanced infrastructure metrics in the Compute Optimizer User\n Guide.
\nYou cannot create recommendation preferences for Auto Scaling groups at the\n organization and account levels. You can create recommendation preferences for\n Auto Scaling groups only at the resource level by specifying a scope name\n of ResourceArn and a scope value of the Auto Scaling group Amazon\n Resource Name (ARN). This will configure the preference for all instances that are\n part of the specified the Auto Scaling group.
The status of the enhanced infrastructure metrics recommendation preference to create\n or update.
\nA status of Active confirms that the preference is applied in the latest\n recommendation refresh, and a status of Inactive confirms that it's not yet\n applied.
Describes a recommendation export job.
\n\n\nUse the DescribeRecommendationExportJobs action to view your\n recommendation export jobs.
\n\n\nUse the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your\n recommendations.
" + "smithy.api#documentation": "Describes a recommendation export job.
\nUse the DescribeRecommendationExportJobs action to view your\n recommendation export jobs.
\nUse the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your\n recommendations.
" } }, "com.amazonaws.computeoptimizer#RecommendationExportJobs": { @@ -3411,18 +3964,67 @@ "target": "com.amazonaws.computeoptimizer#InstanceRecommendationOption" } }, + "com.amazonaws.computeoptimizer#RecommendationPreferenceName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EnhancedInfrastructureMetrics", + "name": "ENHANCED_INFRASTRUCTURE_METRICS" + } + ] + } + }, + "com.amazonaws.computeoptimizer#RecommendationPreferenceNames": { + "type": "list", + "member": { + "target": "com.amazonaws.computeoptimizer#RecommendationPreferenceName" + } + }, "com.amazonaws.computeoptimizer#RecommendationPreferences": { "type": "structure", "members": { "cpuVendorArchitectures": { "target": "com.amazonaws.computeoptimizer#CpuVendorArchitectures", "traits": { - "smithy.api#documentation": "Specifies the CPU vendor and architecture for Amazon EC2 instance and Auto Scaling group recommendations.
\n\nFor example, when you specify AWS_ARM64 with:
A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer\n returns recommendations that consist of Graviton2 instance types only.
\nA GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type\n recommendations only.
\nA ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer\n exports recommendations that consist of Graviton2 instance types only.
\nSpecifies the CPU vendor and architecture for Amazon EC2 instance and Auto Scaling group recommendations.
\nFor example, when you specify AWS_ARM64 with:
A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer\n returns recommendations that consist of Graviton2 instance types only.
\nA GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type\n recommendations only.
\nA ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer\n exports recommendations that consist of Graviton2 instance types only.
\nDescribes the recommendation preferences to return in the response of a GetAutoScalingGroupRecommendations, GetEC2InstanceRecommendations, and GetEC2RecommendationProjectedMetrics request.
" + } + }, + "com.amazonaws.computeoptimizer#RecommendationPreferencesDetail": { + "type": "structure", + "members": { + "scope": { + "target": "com.amazonaws.computeoptimizer#Scope", + "traits": { + "smithy.api#documentation": "An object that describes the scope of the recommendation preference.
\nRecommendation preferences can be created at the organization level (for management\n accounts of an organization only), account level, and resource level. For more\n information, see Activating\n enhanced infrastructure metrics in the Compute Optimizer User\n Guide.
" + } + }, + "resourceType": { + "target": "com.amazonaws.computeoptimizer#ResourceType", + "traits": { + "smithy.api#documentation": "The target resource type of the recommendation preference to create.
\nThe Ec2Instance option encompasses standalone instances and instances\n that are part of Auto Scaling groups. The AutoScalingGroup option\n encompasses only instances that are part of an Auto Scaling group.
The status of the enhanced infrastructure metrics recommendation preference.
\nA status of Active confirms that the preference is applied in the latest\n recommendation refresh, and a status of Inactive confirms that it's not yet\n applied.
Describes preferences for recommendations.
" + "smithy.api#documentation": "Describes a recommendation preference.
" + } + }, + "com.amazonaws.computeoptimizer#RecommendationPreferencesDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.computeoptimizer#RecommendationPreferencesDetail" } }, "com.amazonaws.computeoptimizer#RecommendationSource": { @@ -3495,7 +4097,7 @@ "recommendationResourceType": { "target": "com.amazonaws.computeoptimizer#RecommendationSourceType", "traits": { - "smithy.api#documentation": "The resource type of the recommendation.
" + "smithy.api#documentation": "The resource type that the recommendation summary applies to.
" } }, "accountId": { @@ -3503,6 +4105,18 @@ "traits": { "smithy.api#documentation": "The Amazon Web Services account ID of the recommendation summary.
" } + }, + "savingsOpportunity": { + "target": "com.amazonaws.computeoptimizer#SavingsOpportunity", + "traits": { + "smithy.api#documentation": "An object that describes the savings opportunity for a given resource type. Savings\n opportunity includes the estimated monthly savings amount and percentage.
" + } + }, + "currentPerformanceRiskRatings": { + "target": "com.amazonaws.computeoptimizer#CurrentPerformanceRiskRatings", + "traits": { + "smithy.api#documentation": "An object that describes the performance risk ratings for a given resource\n type.
" + } } }, "traits": { @@ -3524,7 +4138,7 @@ "rank": { "target": "com.amazonaws.computeoptimizer#Rank", "traits": { - "smithy.api#documentation": "The rank of the recommendation option projected metric.
\n\nThe top recommendation option is ranked as 1.
The projected metric rank correlates to the recommendation option rank. For example,\n the projected metric ranked as 1 is related to the recommendation option\n that is also ranked as 1 in the same response.
The rank of the recommendation option projected metric.
\nThe top recommendation option is ranked as 1.
The projected metric rank correlates to the recommendation option rank. For example,\n the projected metric ranked as 1 is related to the recommendation option\n that is also ranked as 1 in the same response.
Describes a projected utilization metric of a recommendation option.
\n\nThe Cpu and Memory metrics are the only projected\n utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. Additionally, the\n Memory metric is returned only for resources that have the unified\n CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.
Describes a projected utilization metric of a recommendation option.
\nThe Cpu and Memory metrics are the only projected\n utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. Additionally, the\n Memory metric is returned only for resources that have the unified\n CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.
The Amazon S3 bucket key of an export file.
\n\nThe key uniquely identifies the object, or export file, in the S3 bucket.
" + "smithy.api#documentation": "The Amazon S3 bucket key of an export file.
\nThe key uniquely identifies the object, or export file, in the S3 bucket.
" } }, "metadataKey": { "target": "com.amazonaws.computeoptimizer#MetadataKey", "traits": { - "smithy.api#documentation": "The Amazon S3 bucket key of a metadata file.
\n\nThe key uniquely identifies the object, or metadata file, in the S3 bucket.
" + "smithy.api#documentation": "The Amazon S3 bucket key of a metadata file.
\nThe key uniquely identifies the object, or metadata file, in the S3 bucket.
" } } }, @@ -3623,9 +4240,74 @@ } }, "traits": { - "smithy.api#documentation": "Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and\n key prefix for a recommendations export job.
\n\nYou must create the destination Amazon S3 bucket for your recommendations\n export before you create the export job. Compute Optimizer does not create the S3 bucket\n for you. After you create the S3 bucket, ensure that it has the required permission\n policy to allow Compute Optimizer to write the export file to it. If you plan to specify\n an object prefix when you create the export job, you must include the object prefix in\n the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the\n Compute Optimizer User Guide.
" + "smithy.api#documentation": "Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and\n key prefix for a recommendations export job.
\nYou must create the destination Amazon S3 bucket for your recommendations\n export before you create the export job. Compute Optimizer does not create the S3 bucket\n for you. After you create the S3 bucket, ensure that it has the required permission\n policy to allow Compute Optimizer to write the export file to it. If you plan to specify\n an object prefix when you create the export job, you must include the object prefix in\n the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the\n Compute Optimizer User Guide.
" + } + }, + "com.amazonaws.computeoptimizer#SavingsOpportunity": { + "type": "structure", + "members": { + "savingsOpportunityPercentage": { + "target": "com.amazonaws.computeoptimizer#SavingsOpportunityPercentage", + "traits": { + "smithy.api#documentation": "The estimated monthly savings possible as a percentage of monthly cost.
" + } + }, + "estimatedMonthlySavings": { + "target": "com.amazonaws.computeoptimizer#EstimatedMonthlySavings", + "traits": { + "smithy.api#documentation": "An object that describes the estimated monthly savings amount possible based on\n On-Demand instance pricing.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the savings opportunity for recommendations of a given resource type or for\n the recommendation option of an individual resource.
\nSavings opportunity represents the estimated monthly savings you can achieve by\n implementing a given Compute Optimizer recommendation.
\nSavings opportunity data requires that you opt in to Cost Explorer, as well as\n activate Receive Amazon EC2 resource\n recommendations in the Cost Explorer preferences page. That\n creates a connection between Cost Explorer and Compute Optimizer. With this\n connection, Cost Explorer generates savings estimates considering the price of\n existing resources, the price of recommended resources, and historical usage data.\n Estimated monthly savings reflects the projected dollar savings associated with each\n of the recommendations generated. For more information, see Enabling Cost Explorer and Optimizing your cost\n with Rightsizing Recommendations in the Cost Management User\n Guide.
\nThe name of the scope.
\nThe following scopes are possible:
\n\n Organization - Specifies that the recommendation preference\n applies at the organization level, for all member accounts of an\n organization.
\n AccountId - Specifies that the recommendation preference applies\n at the account level, for all resources of a given resource type in an\n account.
\n ResourceArn - Specifies that the recommendation preference\n applies at the individual resource level.
The value of the scope.
\nIf you specified the name of the scope as:
\n Organization - The value must be\n ALL_ACCOUNTS.
\n AccountId - The value must be a 12-digit Amazon Web Services account ID.
\n ResourceArn - The value must be the Amazon Resource\n Name (ARN) of an EC2 instance or an Auto Scaling group.
Only EC2 instance and Auto Scaling group ARNs are currently supported.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the scope of a recommendation preference.
\nRecommendation preferences can be created at the organization level (for management\n accounts of an organization only), account level, and resource level. For more\n information, see Activating\n enhanced infrastructure metrics in the Compute Optimizer User\n Guide.
\nYou cannot create recommendation preferences for Auto Scaling groups at the\n organization and account levels. You can create recommendation preferences for\n Auto Scaling groups only at the resource level by specifying a scope name\n of ResourceArn and a scope value of the Auto Scaling group Amazon\n Resource Name (ARN). This will configure the preference for all instances that are\n part of the specified the Auto Scaling group.
Updates the enrollment (opt in and opt out) status of an account to the Compute Optimizer service.
\n\nIf the account is a management account of an organization, this action can also be\n used to enroll member accounts of the organization.
\n\nYou must have the appropriate permissions to opt in to Compute Optimizer, to view its\n recommendations, and to opt out. For more information, see Controlling access with Amazon Web Services Identity and Access Management in the Compute Optimizer User Guide.
\n\nWhen you opt in, Compute Optimizer automatically creates a service-linked role in your\n account to access its data. For more information, see Using\n Service-Linked Roles for Compute Optimizer in the Compute Optimizer User Guide.
" + "smithy.api#documentation": "Updates the enrollment (opt in and opt out) status of an account to the Compute Optimizer service.
\nIf the account is a management account of an organization, this action can also be\n used to enroll member accounts of the organization.
\nYou must have the appropriate permissions to opt in to Compute Optimizer, to view its\n recommendations, and to opt out. For more information, see Controlling access with Amazon Web Services Identity and Access Management in the Compute Optimizer User Guide.
\nWhen you opt in, Compute Optimizer automatically creates a service-linked role in your\n account to access its data. For more information, see Using\n Service-Linked Roles for Compute Optimizer in the Compute Optimizer User Guide.
" } }, "com.amazonaws.computeoptimizer#UpdateEnrollmentStatusRequest": { @@ -3763,7 +4445,7 @@ "status": { "target": "com.amazonaws.computeoptimizer#Status", "traits": { - "smithy.api#documentation": "The new enrollment status of the account.
\n\nThe following status options are available:
\n\n\n Active - Opts in your account to the Compute Optimizer service.\n Compute Optimizer begins analyzing the configuration and utilization metrics\n of your Amazon Web Services resources after you opt in. For more information, see\n Metrics analyzed by Compute Optimizer in the Compute Optimizer User Guide.
\n Inactive - Opts out your account from the Compute Optimizer\n service. Your account's recommendations and related metrics data will be deleted\n from Compute Optimizer after you opt out.
The Pending and Failed options cannot be used to update\n the enrollment status of an account. They are returned in the response of a request\n to update the enrollment status of an account.
The new enrollment status of the account.
\nThe following status options are available:
\n\n Active - Opts in your account to the Compute Optimizer service.\n Compute Optimizer begins analyzing the configuration and utilization metrics\n of your Amazon Web Services resources after you opt in. For more information, see\n Metrics analyzed by Compute Optimizer in the Compute Optimizer User Guide.
\n Inactive - Opts out your account from the Compute Optimizer\n service. Your account's recommendations and related metrics data will be deleted\n from Compute Optimizer after you opt out.
The Pending and Failed options cannot be used to update\n the enrollment status of an account. They are returned in the response of a request\n to update the enrollment status of an account.
The name of the utilization metric.
\n\nThe following utilization metrics are available:
\n\n Cpu - The percentage of allocated EC2 compute units that are\n currently in use on the instance. This metric identifies the processing power\n required to run an application on the instance.
Depending on the instance type, tools in your operating system can show a\n lower percentage than CloudWatch when the instance is not allocated a full\n processor core.
\nUnits: Percent
\n\n Memory - The percentage of memory that is currently in use on the\n instance. This metric identifies the amount of memory required to run an\n application on the instance.
Units: Percent
\nThe Memory metric is returned only for resources that have\n the unified CloudWatch agent installed on them. For more information,\n see Enabling Memory\n Utilization with the CloudWatch Agent.
\n EBS_READ_OPS_PER_SECOND - The completed read operations from all\n EBS volumes attached to the instance in a specified period of time.
Unit: Count
\n\n EBS_WRITE_OPS_PER_SECOND - The completed write operations to all\n EBS volumes attached to the instance in a specified period of time.
Unit: Count
\n\n EBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes\n attached to the instance in a specified period of time.
Unit: Bytes
\n\n EBS_WRITE_BYTES_PER_SECOND - The bytes written to all EBS volumes\n attached to the instance in a specified period of time.
Unit: Bytes
\n\n DISK_READ_OPS_PER_SECOND - The completed read operations from all\n instance store volumes available to the instance in a specified period of\n time.
If there are no instance store volumes, either the value is 0 or\n the metric is not reported.
\n DISK_WRITE_OPS_PER_SECOND - The completed write operations from\n all instance store volumes available to the instance in a specified period of\n time.
If there are no instance store volumes, either the value is 0 or\n the metric is not reported.
\n DISK_READ_BYTES_PER_SECOND - The bytes read from all instance\n store volumes available to the instance. This metric is used to determine the\n volume of the data the application reads from the disk of the instance. This can\n be used to determine the speed of the application.
If there are no instance store volumes, either the value is 0 or\n the metric is not reported.
\n DISK_WRITE_BYTES_PER_SECOND - The bytes written to all instance\n store volumes available to the instance. This metric is used to determine the\n volume of the data the application writes onto the disk of the instance. This\n can be used to determine the speed of the application.
If there are no instance store volumes, either the value is 0 or\n the metric is not reported.
\n NETWORK_IN_BYTES_PER_SECOND - The number of bytes received by the\n instance on all network interfaces. This metric identifies the volume of\n incoming network traffic to a single instance.
\n NETWORK_OUT_BYTES_PER_SECOND - The number of bytes sent out by\n the instance on all network interfaces. This metric identifies the volume of\n outgoing network traffic from a single instance.
\n NETWORK_PACKETS_IN_PER_SECOND - The number of packets received by\n the instance on all network interfaces. This metric identifies the volume of\n incoming traffic in terms of the number of packets on a single instance.
\n NETWORK_PACKETS_OUT_PER_SECOND - The number of packets sent out\n by the instance on all network interfaces. This metric identifies the volume of\n outgoing traffic in terms of the number of packets on a single instance.
The name of the utilization metric.
\nThe following utilization metrics are available:
\n\n Cpu - The percentage of allocated EC2 compute units that are\n currently in use on the instance. This metric identifies the processing power\n required to run an application on the instance.
Depending on the instance type, tools in your operating system can show a\n lower percentage than CloudWatch when the instance is not allocated a full\n processor core.
\nUnits: Percent
\n\n Memory - The percentage of memory that is currently in use on the\n instance. This metric identifies the amount of memory required to run an\n application on the instance.
Units: Percent
\nThe Memory metric is returned only for resources that have\n the unified CloudWatch agent installed on them. For more information,\n see Enabling Memory\n Utilization with the CloudWatch Agent.
\n EBS_READ_OPS_PER_SECOND - The completed read operations from all\n EBS volumes attached to the instance in a specified period of time.
Unit: Count
\n\n EBS_WRITE_OPS_PER_SECOND - The completed write operations to all\n EBS volumes attached to the instance in a specified period of time.
Unit: Count
\n\n EBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes\n attached to the instance in a specified period of time.
Unit: Bytes
\n\n EBS_WRITE_BYTES_PER_SECOND - The bytes written to all EBS volumes\n attached to the instance in a specified period of time.
Unit: Bytes
\n\n DISK_READ_OPS_PER_SECOND - The completed read operations from all\n instance store volumes available to the instance in a specified period of\n time.
If there are no instance store volumes, either the value is 0 or\n the metric is not reported.
\n DISK_WRITE_OPS_PER_SECOND - The completed write operations from\n all instance store volumes available to the instance in a specified period of\n time.
If there are no instance store volumes, either the value is 0 or\n the metric is not reported.
\n DISK_READ_BYTES_PER_SECOND - The bytes read from all instance\n store volumes available to the instance. This metric is used to determine the\n volume of the data the application reads from the disk of the instance. This can\n be used to determine the speed of the application.
If there are no instance store volumes, either the value is 0 or\n the metric is not reported.
\n DISK_WRITE_BYTES_PER_SECOND - The bytes written to all instance\n store volumes available to the instance. This metric is used to determine the\n volume of the data the application writes onto the disk of the instance. This\n can be used to determine the speed of the application.
If there are no instance store volumes, either the value is 0 or\n the metric is not reported.
\n NETWORK_IN_BYTES_PER_SECOND - The number of bytes received by the\n instance on all network interfaces. This metric identifies the volume of\n incoming network traffic to a single instance.
\n NETWORK_OUT_BYTES_PER_SECOND - The number of bytes sent out by\n the instance on all network interfaces. This metric identifies the volume of\n outgoing network traffic from a single instance.
\n NETWORK_PACKETS_IN_PER_SECOND - The number of packets received by\n the instance on all network interfaces. This metric identifies the volume of\n incoming traffic in terms of the number of packets on a single instance.
\n NETWORK_PACKETS_OUT_PER_SECOND - The number of packets sent out\n by the instance on all network interfaces. This metric identifies the volume of\n outgoing traffic in terms of the number of packets on a single instance.
The statistic of the utilization metric.
\n\nThe Compute Optimizer API, Command Line Interface (CLI), and SDKs\n return utilization metrics using only the Maximum statistic, which is the\n highest value observed during the specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the\n Average statistic, which is the value of Sum /\n SampleCount during the specified period. For more information, see\n Viewing resource\n recommendations in the Compute Optimizer User\n Guide. You can also get averaged utilization metric data for your resources\n using Amazon CloudWatch. For more information, see the Amazon CloudWatch\n User Guide.
The statistic of the utilization metric.
\nThe Compute Optimizer API, Command Line Interface (CLI), and SDKs\n return utilization metrics using only the Maximum statistic, which is the\n highest value observed during the specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the\n Average statistic, which is the value of Sum /\n SampleCount during the specified period. For more information, see\n Viewing resource\n recommendations in the Compute Optimizer User\n Guide. You can also get averaged utilization metric data for your resources\n using Amazon CloudWatch. For more information, see the Amazon CloudWatch\n User Guide.
Describes a utilization metric of a resource, such as an Amazon EC2\n instance.
\n\nCompare the utilization metric data of your resource against its projected utilization\n metric data to determine the performance difference between your current resource and\n the recommended option.
" + "smithy.api#documentation": "Describes a utilization metric of a resource, such as an Amazon EC2\n instance.
\nCompare the utilization metric data of your resource against its projected utilization\n metric data to determine the performance difference between your current resource and\n the recommended option.
" } }, "com.amazonaws.computeoptimizer#UtilizationMetrics": { @@ -3824,6 +4506,12 @@ "target": "com.amazonaws.computeoptimizer#UtilizationMetric" } }, + "com.amazonaws.computeoptimizer#Value": { + "type": "double" + }, + "com.amazonaws.computeoptimizer#VeryLow": { + "type": "long" + }, "com.amazonaws.computeoptimizer#VolumeArn": { "type": "string" }, @@ -3851,7 +4539,7 @@ "volumeType": { "target": "com.amazonaws.computeoptimizer#VolumeType", "traits": { - "smithy.api#documentation": "The volume type.
\n\nThis can be gp2 for General Purpose SSD, io1 or\n io2 for Provisioned IOPS SSD, st1 for Throughput Optimized\n HDD, sc1 for Cold HDD, or standard for Magnetic\n volumes.
The volume type.
\nThis can be gp2 for General Purpose SSD, io1 or\n io2 for Provisioned IOPS SSD, st1 for Throughput Optimized\n HDD, sc1 for Cold HDD, or standard for Magnetic\n volumes.
The finding classification of the volume.
\n\nFindings for volumes include:
\n\n \n NotOptimized\n —A volume is\n considered not optimized when Compute Optimizer identifies a recommendation\n that can provide better performance for your workload.
\n \n Optimized\n —An volume is\n considered optimized when Compute Optimizer determines that the volume is\n correctly provisioned to run your workload based on the chosen volume type. For\n optimized resources, Compute Optimizer might recommend a new generation volume\n type.
The finding classification of the volume.
\nFindings for volumes include:
\n\n \n NotOptimized\n —A volume is\n considered not optimized when Compute Optimizer identifies a recommendation\n that can provide better performance for your workload.
\n \n Optimized\n —An volume is\n considered optimized when Compute Optimizer determines that the volume is\n correctly provisioned to run your workload based on the chosen volume type. For\n optimized resources, Compute Optimizer might recommend a new generation volume\n type.
The timestamp of when the volume recommendation was last refreshed.
" + "smithy.api#documentation": "The timestamp of when the volume recommendation was last generated.
" + } + }, + "currentPerformanceRisk": { + "target": "com.amazonaws.computeoptimizer#CurrentPerformanceRisk", + "traits": { + "smithy.api#documentation": "The risk of the current EBS volume not meeting the performance needs of its workloads.\n The higher the risk, the more likely the current EBS volume doesn't have sufficient\n capacity.
" } } }, @@ -3957,13 +4651,19 @@ "performanceRisk": { "target": "com.amazonaws.computeoptimizer#PerformanceRisk", "traits": { - "smithy.api#documentation": "The performance risk of the volume recommendation option.
\n\nPerformance risk is the likelihood of the recommended volume type meeting the\n performance requirement of your workload.
\n\nThe value ranges from 0 - 4, with 0 meaning\n that the recommended resource is predicted to always provide enough hardware capability.\n The higher the performance risk is, the more likely you should validate whether the\n recommendation will meet the performance requirements of your workload before migrating\n your resource.
The performance risk of the volume recommendation option.
\nPerformance risk is the likelihood of the recommended volume type meeting the\n performance requirement of your workload.
\nThe value ranges from 0 - 4, with 0 meaning\n that the recommended resource is predicted to always provide enough hardware capability.\n The higher the performance risk is, the more likely you should validate whether the\n recommendation will meet the performance requirements of your workload before migrating\n your resource.
The rank of the volume recommendation option.
\n\nThe top recommendation option is ranked as 1.
The rank of the volume recommendation option.
\nThe top recommendation option is ranked as 1.
An object that describes the savings opportunity for the EBS volume recommendation\n option. Savings opportunity includes the estimated monthly savings amount and\n percentage.
" } } }, diff --git a/aws/sdk/aws-models/connect.json b/aws/sdk/aws-models/connect.json index 81aea306841be4ed29e4245e98ce7595c1e8cde6..d34d161c75d7dc58fc3a7dad3a776ca9bf33086c 100644 --- a/aws/sdk/aws-models/connect.json +++ b/aws/sdk/aws-models/connect.json @@ -44,7 +44,7 @@ "code": "AccessDeniedException", "httpResponseCode": 403 }, - "smithy.api#documentation": "You do not have sufficient access to perform this action.
", + "smithy.api#documentation": "You do not have sufficient permissions to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -152,7 +152,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "One or more tags.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } } }, @@ -307,7 +307,7 @@ "name": "connect" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer\n contact center and provide reliable customer engagement at any scale.
\nAmazon Connect provides metrics and real-time reporting that enable you to optimize contact routing.\n You can also resolve customer issues more efficiently by getting customers in touch with the\n appropriate agents.
\nThere are limits to the number of Amazon Connect resources that you can create. There are also limits\n to the number of requests that you can make per second. For more information, see Amazon Connect\n Service Quotas in the Amazon Connect Administrator Guide.
\nYou can\n connect\n programmatically to an AWS service by using an endpoint. For a list of Amazon Connect endpoints, see\n Amazon Connect\n Endpoints.
\nWorking with contact flows? Check out the Amazon Connect Flow language.
\nAmazon Connect is a cloud-based contact center solution that you use to set up and manage a customer\n contact center and provide reliable customer engagement at any scale.
\nAmazon Connect provides metrics and real-time reporting that enable you to optimize contact routing.\n You can also resolve customer issues more efficiently by getting customers in touch with the\n appropriate agents.
\nThere are limits to the number of Amazon Connect resources that you can create. There are also limits\n to the number of requests that you can make per second. For more information, see Amazon Connect\n Service Quotas in the Amazon Connect Administrator Guide.
\nYou can connect programmatically to an AWS service by using an endpoint. For a list of Amazon Connect\n endpoints, see Amazon Connect\n Endpoints.
\nWorking with contact flows? Check out the Amazon Connect Flow language.
\nThe type of the contact flow. For descriptions of the available types, see Choose a Contact Flow Type in the Amazon Connect Administrator\n Guide.
" } }, + "State": { + "target": "com.amazonaws.connect#ContactFlowState", + "traits": { + "smithy.api#documentation": "The type of contact flow.
" + } + }, "Description": { "target": "com.amazonaws.connect#ContactFlowDescription", "traits": { @@ -1602,6 +1632,168 @@ } } }, + "com.amazonaws.connect#ContactFlowModule": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN).
" + } + }, + "Id": { + "target": "com.amazonaws.connect#ContactFlowModuleId", + "traits": { + "smithy.api#documentation": "The identifier of the contact flow module.
" + } + }, + "Name": { + "target": "com.amazonaws.connect#ContactFlowModuleName", + "traits": { + "smithy.api#documentation": "The name of the contact flow module.
" + } + }, + "Content": { + "target": "com.amazonaws.connect#ContactFlowModuleContent", + "traits": { + "smithy.api#documentation": "The content of the contact flow module.
" + } + }, + "Description": { + "target": "com.amazonaws.connect#ContactFlowModuleDescription", + "traits": { + "smithy.api#documentation": "The description of the contact flow module.
" + } + }, + "State": { + "target": "com.amazonaws.connect#ContactFlowModuleState", + "traits": { + "smithy.api#documentation": "The type of contact flow module.
" + } + }, + "Status": { + "target": "com.amazonaws.connect#ContactFlowModuleStatus", + "traits": { + "smithy.api#documentation": "The status of the contact flow module.
" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a contact flow module.
" + } + }, + "com.amazonaws.connect#ContactFlowModuleContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256000 + } + } + }, + "com.amazonaws.connect#ContactFlowModuleDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.connect#ContactFlowModuleId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connect#ContactFlowModuleName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.connect#ContactFlowModuleState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "ARCHIVED", + "name": "ARCHIVED" + } + ] + } + }, + "com.amazonaws.connect#ContactFlowModuleStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PUBLISHED", + "name": "PUBLISHED" + }, + { + "value": "SAVED", + "name": "SAVED" + } + ] + } + }, + "com.amazonaws.connect#ContactFlowModuleSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#ContactFlowModuleId", + "traits": { + "smithy.api#documentation": "The identifier of the contact flow module.
" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the contact flow module.
" + } + }, + "Name": { + "target": "com.amazonaws.connect#ContactFlowModuleName", + "traits": { + "smithy.api#documentation": "The name of the contact flow module.
" + } + }, + "State": { + "target": "com.amazonaws.connect#ContactFlowModuleState", + "traits": { + "smithy.api#documentation": "The type of contact flow module.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains summary information about a contact flow.
" + } + }, + "com.amazonaws.connect#ContactFlowModulesSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ContactFlowModuleSummary" + } + }, "com.amazonaws.connect#ContactFlowName": { "type": "string", "traits": { @@ -1623,6 +1815,21 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.connect#ContactFlowState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "ARCHIVED", + "name": "ARCHIVED" + } + ] + } + }, "com.amazonaws.connect#ContactFlowSummary": { "type": "structure", "members": { @@ -1649,6 +1856,12 @@ "traits": { "smithy.api#documentation": "The type of contact flow.
" } + }, + "ContactFlowState": { + "target": "com.amazonaws.connect#ContactFlowState", + "traits": { + "smithy.api#documentation": "The type of contact flow.
" + } } }, "traits": { @@ -1866,7 +2079,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "One or more tags.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } } } @@ -1931,6 +2144,118 @@ } } }, + "com.amazonaws.connect#CreateContactFlowModule": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateContactFlowModuleRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateContactFlowModuleResponse" + }, + "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#InvalidContactFlowModuleException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a contact flow module for the specified Amazon Connect instance.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/contact-flow-modules/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#CreateContactFlowModuleRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#ContactFlowModuleName", + "traits": { + "smithy.api#documentation": "The name of the contact flow module.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.connect#ContactFlowModuleDescription", + "traits": { + "smithy.api#documentation": "The description of the contact flow module.
" + } + }, + "Content": { + "target": "com.amazonaws.connect#ContactFlowModuleContent", + "traits": { + "smithy.api#documentation": "The content of the contact flow module.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.connect#CreateContactFlowModuleResponse": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#ContactFlowModuleId", + "traits": { + "smithy.api#documentation": "The identifier of the contact flow module.
" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the contact flow module.
" + } + } + } + }, "com.amazonaws.connect#CreateContactFlowRequest": { "type": "structure", "members": { @@ -2026,7 +2351,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates hours of operation.
", + "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nCreates hours of operation.
", "smithy.api#http": { "method": "PUT", "uri": "/hours-of-operations/{InstanceId}", @@ -2075,7 +2400,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "One or more tags.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } } } @@ -2272,7 +2597,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "One or more tags.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } } } @@ -2387,7 +2712,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "One or more tags.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } } } @@ -2483,7 +2808,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "One or more tags.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } } } @@ -2500,7 +2825,7 @@ "QuickConnectId": { "target": "com.amazonaws.connect#QuickConnectId", "traits": { - "smithy.api#documentation": "The identifier for the quick connect.
" + "smithy.api#documentation": "The identifier for the quick connect. \n
" } } } @@ -2688,7 +3013,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "One or more tags.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } } } @@ -2773,7 +3098,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "One or more tags.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } } } @@ -3145,44 +3470,161 @@ ] } }, - "com.amazonaws.connect#CurrentMetricResult": { + "com.amazonaws.connect#CurrentMetricResult": { + "type": "structure", + "members": { + "Dimensions": { + "target": "com.amazonaws.connect#Dimensions", + "traits": { + "smithy.api#documentation": "The dimensions for the metrics.
" + } + }, + "Collections": { + "target": "com.amazonaws.connect#CurrentMetricDataCollections", + "traits": { + "smithy.api#documentation": "The set of metrics.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a set of real-time metrics.
" + } + }, + "com.amazonaws.connect#CurrentMetricResults": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#CurrentMetricResult" + } + }, + "com.amazonaws.connect#CurrentMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#CurrentMetric" + } + }, + "com.amazonaws.connect#Delay": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 9999 + } + } + }, + "com.amazonaws.connect#DeleteContactFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteContactFlowRequest" + }, + "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": "Deletes a contact flow for the specified Amazon Connect instance.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/contact-flows/{InstanceId}/{ContactFlowId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DeleteContactFlowModule": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteContactFlowModuleRequest" + }, + "output": { + "target": "com.amazonaws.connect#DeleteContactFlowModuleResponse" + }, + "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": "Deletes the specified contact flow module.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DeleteContactFlowModuleRequest": { "type": "structure", "members": { - "Dimensions": { - "target": "com.amazonaws.connect#Dimensions", + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "The dimensions for the metrics.
" + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "Collections": { - "target": "com.amazonaws.connect#CurrentMetricDataCollections", + "ContactFlowModuleId": { + "target": "com.amazonaws.connect#ContactFlowModuleId", "traits": { - "smithy.api#documentation": "The set of metrics.
" + "smithy.api#documentation": "The identifier of the contact flow module.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "Contains information about a set of real-time metrics.
" - } - }, - "com.amazonaws.connect#CurrentMetricResults": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#CurrentMetricResult" } }, - "com.amazonaws.connect#CurrentMetrics": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#CurrentMetric" - } + "com.amazonaws.connect#DeleteContactFlowModuleResponse": { + "type": "structure", + "members": {} }, - "com.amazonaws.connect#Delay": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 9999 + "com.amazonaws.connect#DeleteContactFlowRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "The identifier of the contact flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -3209,7 +3651,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an hours of operation.
", + "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nDeletes an hours of operation.
", "smithy.api#http": { "method": "DELETE", "uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}", @@ -3691,7 +4133,7 @@ } ], "traits": { - "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nDescribes the specified contact.
\nContact information is available in Amazon Connect for 24 months, and then it is deleted.
\nThis API is in preview release for Amazon Connect and is subject to change.
\nDescribes the specified contact.
\nContact information remains available in Amazon Connect for 24 months, and then it is\n deleted.
\nDescribes the specified contact flow module.
", + "smithy.api#http": { + "method": "GET", + "uri": "/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeContactFlowModuleRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactFlowModuleId": { + "target": "com.amazonaws.connect#ContactFlowModuleId", + "traits": { + "smithy.api#documentation": "The identifier of the contact flow module.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeContactFlowModuleResponse": { + "type": "structure", + "members": { + "ContactFlowModule": { + "target": "com.amazonaws.connect#ContactFlowModule", + "traits": { + "smithy.api#documentation": "Information about the contact flow module.
" + } + } + } + }, "com.amazonaws.connect#DescribeContactFlowRequest": { "type": "structure", "members": { @@ -3782,7 +4293,7 @@ "ContactId": { "target": "com.amazonaws.connect#ContactId", "traits": { - "smithy.api#documentation": "The identifier of the initial contact.
", + "smithy.api#documentation": "The identifier of the contact.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3826,7 +4337,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the hours of operation.
", + "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nDescribes the hours of operation.
", "smithy.api#http": { "method": "GET", "uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}", @@ -5267,7 +5778,7 @@ "CurrentMetrics": { "target": "com.amazonaws.connect#CurrentMetrics", "traits": { - "smithy.api#documentation": "The metrics to retrieve. Specify the name and unit for each metric. The following metrics\n are available. For a description of all the metrics, see Real-time Metrics\n Definitions in the Amazon Connect Administrator Guide.
\nUnit: COUNT
\nName in real-time metrics report: ACW\n
\n\nUnit: COUNT
\nName in real-time metrics report: Available\n
\nUnit: COUNT
\nName in real-time metrics report: Error\n
\nUnit: COUNT
\nName in real-time metrics report: NPT (Non-Productive Time)\n
\nUnit: COUNT
\nName in real-time metrics report: On\n contact\n
\nUnit: COUNT
\nName in real-time metrics report: On\n contact\n
\nUnit: COUNT
\nName in real-time metrics report: Online\n
\nUnit: COUNT
\nName in real-time metrics report: Staffed\n
\nUnit: COUNT
\nName in real-time metrics report: In\n queue\n
\nUnit: COUNT
\nName in real-time metrics report: Scheduled\n
\nUnit: SECONDS
\nWhen you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
\nWhen you do not use groupings, Unit says SECONDS but the Value is returned in\n MILLISECONDS. For example, if you get a response like this:
\n\n { \"Metric\": { \"Name\": \"OLDEST_CONTACT_AGE\", \"Unit\": \"SECONDS\" }, \"Value\": 24113.0\n }
The actual OLDEST_CONTACT_AGE is 24 seconds.
\n\nName in real-time metrics report: Oldest\n
\nUnit: COUNT
\nName in real-time metrics report: Active\n
\nUnit: COUNT
\nName in real-time metrics report: Availability\n
\nThe metrics to retrieve. Specify the name and unit for each metric. The following metrics\n are available. For a description of all the metrics, see Real-time Metrics\n Definitions in the Amazon Connect Administrator Guide.
\nUnit: COUNT
\nName in real-time metrics report: ACW\n
\n\nUnit: COUNT
\nName in real-time metrics report: Available\n
\nUnit: COUNT
\nName in real-time metrics report: Error\n
\nUnit: COUNT
\nName in real-time metrics report: NPT (Non-Productive Time)\n
\nUnit: COUNT
\nName in real-time metrics report: On\n contact\n
\nUnit: COUNT
\nName in real-time metrics report: On\n contact\n
\nUnit: COUNT
\nName in real-time metrics report: Online\n
\nUnit: COUNT
\nName in real-time metrics report: Staffed\n
\nUnit: COUNT
\nName in real-time metrics report: In\n queue\n
\nUnit: COUNT
\nName in real-time metrics report: Scheduled\n
\nUnit: SECONDS
\nWhen you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
\nWhen you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For\n example, if you get a response like this:
\n\n { \"Metric\": { \"Name\": \"OLDEST_CONTACT_AGE\", \"Unit\": \"SECONDS\" }, \"Value\": 24113.0\n }
The actual OLDEST_CONTACT_AGE is 24 seconds.
\n\nName in real-time metrics report: Oldest\n
\nUnit: COUNT
\nName in real-time metrics report: Active\n
\nUnit: COUNT
\nName in real-time metrics report: Availability\n
\nOne or more tags.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } } }, @@ -6164,6 +6675,19 @@ "smithy.api#documentation": "The start time or end time for an hours of operation.
" } }, + "com.amazonaws.connect#IdempotencyException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message" + } + }, + "traits": { + "smithy.api#documentation": "An entity with the same name already exists.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, "com.amazonaws.connect#InboundCallsEnabled": { "type": "boolean", "traits": { @@ -6604,6 +7128,19 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.connect#InvalidContactFlowModuleException": { + "type": "structure", + "members": { + "Problems": { + "target": "com.amazonaws.connect#Problems" + } + }, + "traits": { + "smithy.api#documentation": "The problems with the module. Please fix before trying again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.connect#InvalidParameterException": { "type": "structure", "members": { @@ -6895,29 +7432,111 @@ "uri": "/agent-status/{InstanceId}", "code": 200 }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "AgentStatusSummaryList", - "pageSize": "MaxResults" + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AgentStatusSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListApprovedOrigins": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListApprovedOriginsRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListApprovedOriginsResponse" + }, + "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": "This API is in preview release for Amazon Connect and is subject to change.
\nReturns a paginated list of all approved origins associated with the instance.
", + "smithy.api#http": { + "method": "GET", + "uri": "/instance/{InstanceId}/approved-origins", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Origins", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListApprovedOriginsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult25", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The maximum number of results to return per page.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.connect#ListApprovedOriginsResponse": { + "type": "structure", + "members": { + "Origins": { + "target": "com.amazonaws.connect#OriginsList", + "traits": { + "smithy.api#documentation": "The approved origins.
" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "If there are additional results, this is the token for the next set of results.
" + } } } }, - "com.amazonaws.connect#ListApprovedOrigins": { + "com.amazonaws.connect#ListBots": { "type": "operation", "input": { - "target": "com.amazonaws.connect#ListApprovedOriginsRequest" + "target": "com.amazonaws.connect#ListBotsRequest" }, "output": { - "target": "com.amazonaws.connect#ListApprovedOriginsResponse" + "target": "com.amazonaws.connect#ListBotsResponse" }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, { "target": "com.amazonaws.connect#InvalidRequestException" }, @@ -6929,21 +7548,21 @@ } ], "traits": { - "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nReturns a paginated list of all approved origins associated with the instance.
", + "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nFor the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the\n instance.
", "smithy.api#http": { "method": "GET", - "uri": "/instance/{InstanceId}/approved-origins", + "uri": "/instance/{InstanceId}/bots", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "Origins", + "items": "LexBots", "pageSize": "MaxResults" } } }, - "com.amazonaws.connect#ListApprovedOriginsRequest": { + "com.amazonaws.connect#ListBotsRequest": { "type": "structure", "members": { "InstanceId": { @@ -6968,16 +7587,24 @@ "smithy.api#documentation": "The maximum number of results to return per page.
", "smithy.api#httpQuery": "maxResults" } + }, + "LexVersion": { + "target": "com.amazonaws.connect#LexVersion", + "traits": { + "smithy.api#documentation": "The version of Amazon Lex or Amazon Lex V2.
", + "smithy.api#httpQuery": "lexVersion", + "smithy.api#required": {} + } } } }, - "com.amazonaws.connect#ListApprovedOriginsResponse": { + "com.amazonaws.connect#ListBotsResponse": { "type": "structure", "members": { - "Origins": { - "target": "com.amazonaws.connect#OriginsList", + "LexBots": { + "target": "com.amazonaws.connect#LexBotConfigList", "traits": { - "smithy.api#documentation": "The approved origins.
" + "smithy.api#documentation": "The names and Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified\n instance.
" } }, "NextToken": { @@ -6988,18 +7615,24 @@ } } }, - "com.amazonaws.connect#ListBots": { + "com.amazonaws.connect#ListContactFlowModules": { "type": "operation", "input": { - "target": "com.amazonaws.connect#ListBotsRequest" + "target": "com.amazonaws.connect#ListContactFlowModulesRequest" }, "output": { - "target": "com.amazonaws.connect#ListBotsResponse" + "target": "com.amazonaws.connect#ListContactFlowModulesResponse" }, "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, { "target": "com.amazonaws.connect#InternalServiceException" }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, { "target": "com.amazonaws.connect#InvalidRequestException" }, @@ -7011,21 +7644,21 @@ } ], "traits": { - "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nFor the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently\n associated with the instance.
", + "smithy.api#documentation": "Provides information about the contact flow modules for the specified Amazon Connect instance.
", "smithy.api#http": { "method": "GET", - "uri": "/instance/{InstanceId}/bots", + "uri": "/contact-flow-modules-summary/{InstanceId}", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "LexBots", + "items": "ContactFlowModulesSummaryList", "pageSize": "MaxResults" } } }, - "com.amazonaws.connect#ListBotsRequest": { + "com.amazonaws.connect#ListContactFlowModulesRequest": { "type": "structure", "members": { "InstanceId": { @@ -7044,30 +7677,29 @@ } }, "MaxResults": { - "target": "com.amazonaws.connect#MaxResult25", + "target": "com.amazonaws.connect#MaxResult1000", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "The maximum number of results to return per page.
", "smithy.api#httpQuery": "maxResults" } }, - "LexVersion": { - "target": "com.amazonaws.connect#LexVersion", + "ContactFlowModuleState": { + "target": "com.amazonaws.connect#ContactFlowModuleState", "traits": { - "smithy.api#documentation": "The version of Amazon Lex or Amazon Lex V2.
", - "smithy.api#httpQuery": "lexVersion", - "smithy.api#required": {} + "smithy.api#documentation": "The state of the contact flow module.
", + "smithy.api#httpQuery": "state" } } } }, - "com.amazonaws.connect#ListBotsResponse": { + "com.amazonaws.connect#ListContactFlowModulesResponse": { "type": "structure", "members": { - "LexBots": { - "target": "com.amazonaws.connect#LexBotConfigList", + "ContactFlowModulesSummaryList": { + "target": "com.amazonaws.connect#ContactFlowModulesSummaryList", "traits": { - "smithy.api#documentation": "The names and Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified\n instance.
" + "smithy.api#documentation": "Information about the contact flow module.
" } }, "NextToken": { @@ -7238,7 +7870,7 @@ "NextToken": { "target": "com.amazonaws.connect#NextToken", "traits": { - "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
\nThis is not expected to be set since the value returned in the previous response is always\n null.
\nThe token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
\nThis is not expected to be set, because the value returned in the previous response is\n always null.
\nThe integration type.
", "smithy.api#httpQuery": "integrationType" } }, @@ -7827,7 +8459,7 @@ "target": "com.amazonaws.connect#MaxResult25", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "The maximum number of results to return per page. If no value is specified, the default is 10.\n
", + "smithy.api#documentation": "The maximum number of results to return per page. If no value is specified, the default is 10.
", "smithy.api#httpQuery": "maxResults" } } @@ -10545,7 +11177,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "One or more tags.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } } }, @@ -10772,7 +11404,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "One or more tags.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } } }, @@ -10967,7 +11599,7 @@ "Url": { "target": "com.amazonaws.connect#UrlReference", "traits": { - "smithy.api#documentation": "Information about Url reference if the referenceType is URL. Otherwise, null.
Information about the URL reference if the referenceType is URL.\n Otherwise, null.
One or more tags.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } } }, @@ -11818,7 +12450,7 @@ } ], "traits": { - "smithy.api#documentation": "Initiates real-time message streaming for a new chat contact.
\nFor more information about message streaming, see Enable real-time chat message\n streaming in the Amazon Connect Administrator Guide.
", + "smithy.api#documentation": "Initiates real-time message streaming for a new chat contact.
\nFor more information about message streaming, see Enable real-time chat message\n streaming in the Amazon Connect Administrator Guide.
", "smithy.api#http": { "method": "POST", "uri": "/contact/start-streaming", @@ -11904,7 +12536,7 @@ } ], "traits": { - "smithy.api#documentation": "Places an outbound call to a contact, and then initiates the contact flow. It performs the\n actions in the contact flow that's specified (in ContactFlowId).
Agents do not initiate the outbound API, which means that they do not dial the contact. If\n the contact flow places an outbound call to a contact, and then puts the contact in queue, the\n call is then routed to the agent, like any other inbound case.
\n\nThere is a 60-second dialing timeout for this operation. If the call is not connected after\n 60 seconds, it fails.
\nUK numbers with a 447 prefix are not allowed by default. Before you can dial these UK\n mobile numbers, you must submit a service quota increase request. For more information, see\n Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
\nCampaign calls are not allowed by default. Before you can make a call with\n TrafficType = CAMPAIGN, you must submit a service quota increase\n request. For more information, see Amazon Connect Service Quotas\n in the Amazon Connect Administrator Guide.
Places an outbound call to a contact, and then initiates the contact flow. It performs the\n actions in the contact flow that's specified (in ContactFlowId).
Agents do not initiate the outbound API, which means that they do not dial the contact. If\n the contact flow places an outbound call to a contact, and then puts the contact in queue, the\n call is then routed to the agent, like any other inbound case.
\n\nThere is a 60-second dialing timeout for this operation. If the call is not connected after\n 60 seconds, it fails.
\nUK numbers with a 447 prefix are not allowed by default. Before you can dial these UK\n mobile numbers, you must submit a service quota increase request. For more information, see\n Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
\nCampaign calls are not allowed by default. Before you can make a call with \n TrafficType = CAMPAIGN, you must submit a service quota increase request. For more information, see \n Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
Denotes the class of traffic. Calls with different traffic types are handled differently by\n Amazon Connect. The default value is GENERAL. Use CAMPAIGN if\n EnableAnswerMachineDetection is set to true. For all other cases, use\n GENERAL.
Denotes the class of traffic. Calls with different traffic types are handled differently by\n Amazon Connect. The default value is GENERAL. Use CAMPAIGN if\n EnableAnswerMachineDetection is set to true. For all other cases, use\n GENERAL.
Initiates a contact flow to start a new task immediately or at a future date and\n time.
", + "smithy.api#documentation": "Initiates a contact flow to start a new task.
", "smithy.api#http": { "method": "PUT", "uri": "/contact/task", @@ -12451,7 +13083,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds the specified tags to the specified resource.
\nThe supported resource types are users, routing profiles, queues, quick connects, contact\n flows, agent status, and hours of operation.
\nFor sample policies that use tags, see Amazon Connect Identity-Based\n Policy Examples in the Amazon Connect Administrator Guide.
", + "smithy.api#documentation": "Adds the specified tags to the specified resource.
\nThe supported resource types are users, routing profiles, queues, quick connects, \n contact flows, agent status, and hours of operation.
\nFor sample policies that use tags, see Amazon Connect Identity-Based\n Policy Examples in the Amazon Connect Administrator Guide.
", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", @@ -12757,7 +13389,7 @@ } ], "traits": { - "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nAdds or updates user defined contact information associated with the specified contact. At\n least one field to be updated must be present in the request.
\nYou can add or update user-defined contact information for both ongoing and completed\n contacts.
\nThis API is in preview release for Amazon Connect and is subject to change.
\nAdds or updates user-defined contact information associated with the specified contact. At\n least one field to be updated must be present in the request.
\nYou can add or update user-defined contact information for both ongoing and completed\n contacts.
\nUpdates metadata about specified contact flow.
", + "smithy.api#http": { + "method": "POST", + "uri": "/contact-flows/{InstanceId}/{ContactFlowId}/metadata", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateContactFlowMetadataRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "The identifier of the contact flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#ContactFlowName", + "traits": { + "smithy.api#documentation": "TThe name of the contact flow.
" + } + }, + "Description": { + "target": "com.amazonaws.connect#ContactFlowDescription", + "traits": { + "smithy.api#documentation": "The description of the contact flow.
" + } + }, + "ContactFlowState": { + "target": "com.amazonaws.connect#ContactFlowState", + "traits": { + "smithy.api#documentation": "The state of contact flow.
" + } + } + } + }, + "com.amazonaws.connect#UpdateContactFlowModuleContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateContactFlowModuleContentRequest" + }, + "output": { + "target": "com.amazonaws.connect#UpdateContactFlowModuleContentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidContactFlowModuleException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Updates specified contact flow module for the specified Amazon Connect instance.
", + "smithy.api#http": { + "method": "POST", + "uri": "/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/content", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateContactFlowModuleContentRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactFlowModuleId": { + "target": "com.amazonaws.connect#ContactFlowModuleId", + "traits": { + "smithy.api#documentation": "The identifier of the contact flow module.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Content": { + "target": "com.amazonaws.connect#ContactFlowModuleContent", + "traits": { + "smithy.api#documentation": "The content of the contact flow module.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateContactFlowModuleContentResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connect#UpdateContactFlowModuleMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateContactFlowModuleMetadataRequest" + }, + "output": { + "target": "com.amazonaws.connect#UpdateContactFlowModuleMetadataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "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": "Updates metadata about specified contact flow module.
", + "smithy.api#http": { + "method": "POST", + "uri": "/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/metadata", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateContactFlowModuleMetadataRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactFlowModuleId": { + "target": "com.amazonaws.connect#ContactFlowModuleId", + "traits": { + "smithy.api#documentation": "The identifier of the contact flow module.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#ContactFlowModuleName", + "traits": { + "smithy.api#documentation": "The name of the contact flow module.
" + } + }, + "Description": { + "target": "com.amazonaws.connect#ContactFlowModuleDescription", + "traits": { + "smithy.api#documentation": "The description of the contact flow module.
" + } + }, + "State": { + "target": "com.amazonaws.connect#ContactFlowModuleState", + "traits": { + "smithy.api#documentation": "The state of contact flow module.
" + } + } + } + }, + "com.amazonaws.connect#UpdateContactFlowModuleMetadataResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.connect#UpdateContactFlowName": { "type": "operation", "input": { @@ -13091,7 +13948,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the hours of operation.
", + "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nUpdates the hours of operation.
", "smithy.api#http": { "method": "POST", "uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}", @@ -13198,7 +14055,7 @@ "AttributeType": { "target": "com.amazonaws.connect#InstanceAttributeType", "traits": { - "smithy.api#documentation": "The type of attribute.
\nOnly allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature,\n contact AWS Support for allowlisting.
\nThe type of attribute.
\nOnly allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact AWS Support for allowlisting.
\nThe flag that enables the auto-merging of duplicate profiles.
", + "smithy.api#required": {} + } + }, + "Consolidation": { + "target": "com.amazonaws.customerprofiles#Consolidation", + "traits": { + "smithy.api#documentation": "A list of matching attributes that represent matching criteria. If two profiles meet at\n least one of the requirements in the matching attributes list, they will be merged.
" + } + }, + "ConflictResolution": { + "target": "com.amazonaws.customerprofiles#ConflictResolution", + "traits": { + "smithy.api#documentation": "How the auto-merging process should resolve conflicts between different profiles. For\n example, if Profile A and Profile B have the same FirstName and\n LastName (and that is the matching criteria), which\n EmailAddress should be used?
Configuration settings for how to perform the auto-merging of profiles.
" + } + }, "com.amazonaws.customerprofiles#BadRequestException": { "type": "structure", "members": { @@ -246,6 +273,42 @@ "smithy.api#pattern": ".*" } }, + "com.amazonaws.customerprofiles#ConflictResolution": { + "type": "structure", + "members": { + "ConflictResolvingModel": { + "target": "com.amazonaws.customerprofiles#ConflictResolvingModel", + "traits": { + "smithy.api#documentation": "How the auto-merging process should resolve conflicts between different profiles.
\n\n RECENCY: Uses the data that was most recently updated.
\n SOURCE: Uses the data from a specific source. For example, if a\n company has been aquired or two departments have merged, data from the specified\n source is used. If two duplicate profiles are from the same source, then\n RECENCY is used again.
The ObjectType name that is used to resolve profile merging conflicts when\n choosing SOURCE as the ConflictResolvingModel.
How the auto-merging process should resolve conflicts between different profiles.
" + } + }, + "com.amazonaws.customerprofiles#ConflictResolvingModel": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RECENCY", + "name": "RECENCY" + }, + { + "value": "SOURCE", + "name": "SOURCE" + } + ] + } + }, "com.amazonaws.customerprofiles#ConnectorOperator": { "type": "structure", "members": { @@ -294,6 +357,21 @@ "smithy.api#pattern": "^[\\w/!@#+=.-]+$" } }, + "com.amazonaws.customerprofiles#Consolidation": { + "type": "structure", + "members": { + "MatchingAttributesList": { + "target": "com.amazonaws.customerprofiles#MatchingAttributesList", + "traits": { + "smithy.api#documentation": "A list of matching criteria.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The matching criteria to be used during the auto-merging process.
" + } + }, "com.amazonaws.customerprofiles#CreateDomain": { "type": "operation", "input": { @@ -320,7 +398,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a domain, which is a container for all customer data, such as customer profile\n attributes, object types, profile keys, and encryption keys. You can create multiple\n domains, and each domain can have multiple third-party integrations.
\nEach Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can\n be associated with one domain.
\nUse this API or UpdateDomain to\n enable identity\n resolution: set Matching to true.
Creates a domain, which is a container for all customer data, such as customer profile\n attributes, object types, profile keys, and encryption keys. You can create multiple\n domains, and each domain can have multiple third-party integrations.
\nEach Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can\n be associated with one domain.
\nUse this API or UpdateDomain to\n enable identity\n resolution: set Matching to true.
To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should\n apply.
", "smithy.api#http": { "method": "POST", "uri": "/domains/{DomainName}", @@ -361,7 +439,7 @@ "Matching": { "target": "com.amazonaws.customerprofiles#MatchingRequest", "traits": { - "smithy.api#documentation": "The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. \nAfter that batch process completes, use the \nGetMatches\nAPI to return and review the results.
" + "smithy.api#documentation": "The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly\nbatch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every \nSaturday at 12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the \nGetMatches\nAPI to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from\nS3.
The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. \nAfter that batch process completes, use the \nGetMatches\nAPI to return and review the results.
" + "smithy.api#documentation": "The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly\nbatch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every \nSaturday at 12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the \nGetMatches\nAPI to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from\nS3.
Welcome to the Amazon Connect Customer Profiles API Reference. This guide provides information\n about the Amazon Connect Customer Profiles API, including supported operations, data types,\n parameters, and schemas.
\nAmazon Connect Customer Profiles is a unified customer profile for your contact center that has\n pre-built connectors powered by AppFlow that make it easy to combine customer information\n from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your\n enterprise resource planning (ERP), with contact history from your Amazon Connect contact\n center.
\nIf you're new to Amazon Connect , you might find it helpful to also review the Amazon Connect Administrator Guide.
", + "smithy.api#title": "Amazon Connect Customer Profiles" + }, "version": "2020-08-15", "operations": [ { @@ -645,9 +738,15 @@ { "target": "com.amazonaws.customerprofiles#DeleteProfileObjectType" }, + { + "target": "com.amazonaws.customerprofiles#GetAutoMergingPreview" + }, { "target": "com.amazonaws.customerprofiles#GetDomain" }, + { + "target": "com.amazonaws.customerprofiles#GetIdentityResolutionJob" + }, { "target": "com.amazonaws.customerprofiles#GetIntegration" }, @@ -666,6 +765,9 @@ { "target": "com.amazonaws.customerprofiles#ListDomains" }, + { + "target": "com.amazonaws.customerprofiles#ListIdentityResolutionJobs" + }, { "target": "com.amazonaws.customerprofiles#ListIntegrations" }, @@ -708,22 +810,7 @@ { "target": "com.amazonaws.customerprofiles#UpdateProfile" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Customer Profiles", - "arnNamespace": "profile", - "cloudFormationName": "CustomerProfiles", - "cloudTrailEventSource": "customerprofiles.amazonaws.com", - "endpointPrefix": "profile" - }, - "aws.auth#sigv4": { - "name": "profile" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Welcome to the Amazon Connect Customer Profiles API Reference. This guide provides information\n about the Amazon Connect Customer Profiles API, including supported operations, data types,\n parameters, and schemas.
\nAmazon Connect Customer Profiles is a unified customer profile for your contact center that has\n pre-built connectors powered by AppFlow that make it easy to combine customer information\n from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your\n enterprise resource planning (ERP), with contact history from your Amazon Connect contact\n center.
\nIf you're new to Amazon Connect , you might find it helpful to also review the Amazon Connect Administrator Guide.
", - "smithy.api#title": "Amazon Connect Customer Profiles" - } + ] }, "com.amazonaws.customerprofiles#DataPullMode": { "type": "string", @@ -1216,6 +1303,40 @@ "smithy.api#documentation": "Usage-specific statistics about the domain.
" } }, + "com.amazonaws.customerprofiles#Double": { + "type": "double", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.customerprofiles#ExportingConfig": { + "type": "structure", + "members": { + "S3Exporting": { + "target": "com.amazonaws.customerprofiles#S3ExportingConfig", + "traits": { + "smithy.api#documentation": "The S3 location where Identity Resolution Jobs write result files.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration information about the S3 bucket where Identity Resolution Jobs writes result files.
\nYou need to give Customer Profiles service principal write permission to your S3 bucket.\n Otherwise, you'll get an exception in the API response. For an example policy, see\n Amazon Connect Customer Profiles cross-service confused deputy prevention.\n
\nInformation about the S3 location where Identity Resolution Jobs write result files.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The S3 location where Identity Resolution Jobs write result files.
" + } + }, "com.amazonaws.customerprofiles#FieldContentType": { "type": "string", "traits": { @@ -1480,6 +1601,97 @@ ] } }, + "com.amazonaws.customerprofiles#GetAutoMergingPreview": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#GetAutoMergingPreviewRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#GetAutoMergingPreviewResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly\n selects a sample of matching groups from the existing matching results, and applies the\n automerging settings that you provided. You can then view the number of profiles in the\n sample, the number of matches, and the number of profiles identified to be merged. This\n enables you to evaluate the accuracy of the attributes in your matching list.
\nYou can't view which profiles are matched and would be merged.
\nWe strongly recommend you use this API to do a dry run of the automerging process\n before running the Identity Resolution Job. Include at least two matching\n attributes. If your matching list includes too few attributes (such as only\n FirstName or only LastName), there may be a large number of\n matches. This increases the chances of erroneous merges.
The unique name of the domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Consolidation": { + "target": "com.amazonaws.customerprofiles#Consolidation", + "traits": { + "smithy.api#documentation": "A list of matching attributes that represent matching criteria.
", + "smithy.api#required": {} + } + }, + "ConflictResolution": { + "target": "com.amazonaws.customerprofiles#ConflictResolution", + "traits": { + "smithy.api#documentation": "How the auto-merging process should resolve conflicts between different profiles.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.customerprofiles#GetAutoMergingPreviewResponse": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "The unique name of the domain.
", + "smithy.api#required": {} + } + }, + "NumberOfMatchesInSample": { + "target": "com.amazonaws.customerprofiles#long", + "traits": { + "smithy.api#documentation": "The number of match groups in the domain that have been reviewed in this preview dry\n run.
" + } + }, + "NumberOfProfilesInSample": { + "target": "com.amazonaws.customerprofiles#long", + "traits": { + "smithy.api#documentation": "The number of profiles found in this preview dry run.
" + } + }, + "NumberOfProfilesWillBeMerged": { + "target": "com.amazonaws.customerprofiles#long", + "traits": { + "smithy.api#documentation": "The number of profiles that would be merged if this wasn't a preview dry run.
" + } + } + } + }, "com.amazonaws.customerprofiles#GetDomain": { "type": "operation", "input": { @@ -1564,7 +1776,7 @@ "Matching": { "target": "com.amazonaws.customerprofiles#MatchingResponse", "traits": { - "smithy.api#documentation": "The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. \nAfter that batch process completes, use the \nGetMatches\nAPI to return and review the results.
" + "smithy.api#documentation": "The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly\nbatch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every \nSaturday at 12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the \nGetMatches\nAPI to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from\nS3.
Returns information about an Identity Resolution Job in a specific domain.
\nIdentity Resolution Jobs are set up using the Amazon Connect admin console. For more information, see Use\n Identity Resolution to consolidate similar profiles.
", + "smithy.api#http": { + "method": "GET", + "uri": "/domains/{DomainName}/identity-resolution-jobs/{JobId}", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#GetIdentityResolutionJobRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "The unique name of the domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "JobId": { + "target": "com.amazonaws.customerprofiles#uuid", + "traits": { + "smithy.api#documentation": "The unique identifier of the Identity Resolution Job.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.customerprofiles#GetIdentityResolutionJobResponse": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "The unique name of the domain.
" + } + }, + "JobId": { + "target": "com.amazonaws.customerprofiles#uuid", + "traits": { + "smithy.api#documentation": "The unique identifier of the Identity Resolution Job.
" + } + }, + "Status": { + "target": "com.amazonaws.customerprofiles#IdentityResolutionJobStatus", + "traits": { + "smithy.api#documentation": "The status of the Identity Resolution Job.
\n\n PENDING: The Identity Resolution Job is scheduled but has not started yet. If you turn\n off the Identity Resolution feature in your domain, jobs in the PENDING state are\n deleted.
\n PREPROCESSING: The Identity Resolution Job is loading your data.
\n FIND_MATCHING: The Identity Resolution Job is using the machine learning model to\n identify profiles that belong to the same matching group.
\n MERGING: The Identity Resolution Job is merging duplicate profiles.
\n COMPLETED: The Identity Resolution Job completed successfully.
\n PARTIAL_SUCCESS: There's a system error and not all of the data is\n merged. The Identity Resolution Job writes a message indicating the source of the problem.
\n FAILED: The Identity Resolution Job did not merge any data. It writes a message\n indicating the source of the problem.
The error messages that are generated when the Identity Resolution Job runs.
" + } + }, + "JobStartTime": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the Identity Resolution Job was started or will be started.
" + } + }, + "JobEndTime": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the Identity Resolution Job was completed.
" + } + }, + "LastUpdatedAt": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the Identity Resolution Job was most recently edited.
" + } + }, + "JobExpirationTime": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the Identity Resolution Job will expire.
" + } + }, + "AutoMerging": { + "target": "com.amazonaws.customerprofiles#AutoMerging", + "traits": { + "smithy.api#documentation": "Configuration settings for how to perform the auto-merging of profiles.
" + } + }, + "ExportingLocation": { + "target": "com.amazonaws.customerprofiles#ExportingLocation", + "traits": { + "smithy.api#documentation": "The S3 location where the Identity Resolution Job writes result files.
" + } + }, + "JobStats": { + "target": "com.amazonaws.customerprofiles#JobStats", + "traits": { + "smithy.api#documentation": "Statistics about the Identity Resolution Job.
" + } + } + } + }, "com.amazonaws.customerprofiles#GetIntegration": { "type": "operation", "input": { @@ -1715,7 +2053,7 @@ } ], "traits": { - "smithy.api#documentation": "This API is in preview release for Amazon Connect and subject to change.
\nBefore calling this API, use CreateDomain or\n UpdateDomain to\n enable identity resolution: set Matching to true.
GetMatches returns potentially matching profiles, based on the results of the latest run\n of a machine learning process.
\nAmazon Connect starts a batch process every Saturday at 12AM UTC to identify matching profiles.\n The results are returned up to seven days after the Saturday run.
\nAmazon Connect uses the following profile attributes to identify matches:
\nPhoneNumber
\nHomePhoneNumber
\nBusinessPhoneNumber
\nMobilePhoneNumber
\nEmailAddress
\nPersonalEmailAddress
\nBusinessEmailAddress
\nFullName
\nBusinessName
\nFor example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing\n email addresses such as JOHN_DOE@ANYCOMPANY.COM and\n johndoe@anycompany.com, or different phone number\n formats such as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer John Doe and merged into a unified profile.
", + "smithy.api#documentation": "This API is in preview release for Amazon Connect and subject to change.
\nBefore calling this API, use CreateDomain or\n UpdateDomain to\n enable identity resolution: set Matching to true.
GetMatches returns potentially matching profiles, based on the results of the latest run\n of a machine learning process.
\nThe process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly\nbatch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every \nSaturday at 12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the \nGetMatches\nAPI to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from\nS3.
Amazon Connect uses the following profile attributes to identify matches:
\nPhoneNumber
\nHomePhoneNumber
\nBusinessPhoneNumber
\nMobilePhoneNumber
\nEmailAddress
\nPersonalEmailAddress
\nBusinessEmailAddress
\nFullName
\nBusinessName
\nFor example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing\n email addresses such as JOHN_DOE@ANYCOMPANY.COM and\n johndoe@anycompany.com, or different phone number\n formats such as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer John Doe and merged into a unified profile.
", "smithy.api#http": { "method": "GET", "uri": "/domains/{DomainName}/matches", @@ -1875,6 +2213,12 @@ "smithy.api#documentation": "Indicates whether a profile should be created when data is received if one doesn’t exist\n for an object of this type. The default is FALSE. If the AllowProfileCreation\n flag is set to FALSE, then the service tries to fetch a standard profile and\n associate this object with the profile. If it is set to TRUE, and if no match\n is found, then the service creates a new standard profile.
The format of your sourceLastUpdatedTimestamp that was previously set\n up.
Indicates whether a profile should be created when data is received if one doesn’t exist\n for an object of this type. The default is FALSE. If the AllowProfileCreation\n flag is set to FALSE, then the service tries to fetch a standard profile and\n associate this object with the profile. If it is set to TRUE, and if no match\n is found, then the service creates a new standard profile.
The format of your sourceLastUpdatedTimestamp that was previously set\n up.
A map of the name and ObjectType field.
" } }, - "Keys": { - "target": "com.amazonaws.customerprofiles#KeyMap", + "Keys": { + "target": "com.amazonaws.customerprofiles#KeyMap", + "traits": { + "smithy.api#documentation": "A list of unique keys that can be used to map data to the profile.
" + } + } + } + }, + "com.amazonaws.customerprofiles#IdentityResolutionJob": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "The unique name of the domain.
" + } + }, + "JobId": { + "target": "com.amazonaws.customerprofiles#uuid", + "traits": { + "smithy.api#documentation": "The unique identifier of the Identity Resolution Job.
" + } + }, + "Status": { + "target": "com.amazonaws.customerprofiles#IdentityResolutionJobStatus", + "traits": { + "smithy.api#documentation": "The status of the Identity Resolution Job.
\n\n PENDING: The Identity Resolution Job is scheduled but has not started yet. If you turn\n off the Identity Resolution feature in your domain, jobs in the PENDING state are\n deleted.
\n PREPROCESSING: The Identity Resolution Job is loading your data.
\n FIND_MATCHING: The Identity Resolution Job is using the machine learning model to\n identify profiles that belong to the same matching group.
\n MERGING: The Identity Resolution Job is merging duplicate profiles.
\n COMPLETED: The Identity Resolution Job completed successfully.
\n PARTIAL_SUCCESS: There's a system error and not all of the data is\n merged. The Identity Resolution Job writes a message indicating the source of the problem.
\n FAILED: The Identity Resolution Job did not merge any data. It writes a message\n indicating the source of the problem.
The timestamp of when the job was started or will be started.
" + } + }, + "JobEndTime": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the job was completed.
" + } + }, + "JobStats": { + "target": "com.amazonaws.customerprofiles#JobStats", + "traits": { + "smithy.api#documentation": "Statistics about an Identity Resolution Job.
" + } + }, + "ExportingLocation": { + "target": "com.amazonaws.customerprofiles#ExportingLocation", + "traits": { + "smithy.api#documentation": "The S3 location where the Identity Resolution Job writes result files.
" + } + }, + "Message": { + "target": "com.amazonaws.customerprofiles#stringTo2048", "traits": { - "smithy.api#documentation": "A list of unique keys that can be used to map data to the profile.
" + "smithy.api#documentation": "The error messages that are generated when the Identity Resolution Job runs.
" } } + }, + "traits": { + "smithy.api#documentation": "Information about the Identity Resolution Job.
" + } + }, + "com.amazonaws.customerprofiles#IdentityResolutionJobStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "PREPROCESSING", + "name": "PREPROCESSING" + }, + { + "value": "FIND_MATCHING", + "name": "FIND_MATCHING" + }, + { + "value": "MERGING", + "name": "MERGING" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "PARTIAL_SUCCESS", + "name": "PARTIAL_SUCCESS" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.customerprofiles#IdentityResolutionJobsList": { + "type": "list", + "member": { + "target": "com.amazonaws.customerprofiles#IdentityResolutionJob" } }, "com.amazonaws.customerprofiles#IncrementalPullConfig": { @@ -2028,6 +2475,99 @@ "smithy.api#httpError": 500 } }, + "com.amazonaws.customerprofiles#JobSchedule": { + "type": "structure", + "members": { + "DayOfTheWeek": { + "target": "com.amazonaws.customerprofiles#JobScheduleDayOfTheWeek", + "traits": { + "smithy.api#documentation": "The day when the Identity Resolution Job should run every week.
", + "smithy.api#required": {} + } + }, + "Time": { + "target": "com.amazonaws.customerprofiles#JobScheduleTime", + "traits": { + "smithy.api#documentation": "The time when the Identity Resolution Job should run every week.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The day and time when do you want to start the Identity Resolution Job every week.
" + } + }, + "com.amazonaws.customerprofiles#JobScheduleDayOfTheWeek": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SUNDAY", + "name": "SUNDAY" + }, + { + "value": "MONDAY", + "name": "MONDAY" + }, + { + "value": "TUESDAY", + "name": "TUESDAY" + }, + { + "value": "WEDNESDAY", + "name": "WEDNESDAY" + }, + { + "value": "THURSDAY", + "name": "THURSDAY" + }, + { + "value": "FRIDAY", + "name": "FRIDAY" + }, + { + "value": "SATURDAY", + "name": "SATURDAY" + } + ] + } + }, + "com.amazonaws.customerprofiles#JobScheduleTime": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 5 + }, + "smithy.api#pattern": "^([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$" + } + }, + "com.amazonaws.customerprofiles#JobStats": { + "type": "structure", + "members": { + "NumberOfProfilesReviewed": { + "target": "com.amazonaws.customerprofiles#long", + "traits": { + "smithy.api#documentation": "The number of profiles reviewed.
" + } + }, + "NumberOfMatchesFound": { + "target": "com.amazonaws.customerprofiles#long", + "traits": { + "smithy.api#documentation": "The number of matches found.
" + } + }, + "NumberOfMergesDone": { + "target": "com.amazonaws.customerprofiles#long", + "traits": { + "smithy.api#documentation": "The number of merges completed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Statistics about the Identity Resolution Job.
" + } + }, "com.amazonaws.customerprofiles#KeyMap": { "type": "map", "key": { @@ -2229,6 +2769,84 @@ } } }, + "com.amazonaws.customerprofiles#ListIdentityResolutionJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#ListIdentityResolutionJobsRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#ListIdentityResolutionJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by\n JobStartTime.
The unique name of the domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.customerprofiles#token", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.customerprofiles#maxSize100", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per page.
", + "smithy.api#httpQuery": "max-results" + } + } + } + }, + "com.amazonaws.customerprofiles#ListIdentityResolutionJobsResponse": { + "type": "structure", + "members": { + "IdentityResolutionJobsList": { + "target": "com.amazonaws.customerprofiles#IdentityResolutionJobsList", + "traits": { + "smithy.api#documentation": "A list of Identity Resolution Jobs.
" + } + }, + "NextToken": { + "target": "com.amazonaws.customerprofiles#token", + "traits": { + "smithy.api#documentation": "If there are additional results, this is the token for the next set of results.
" + } + } + } + }, "com.amazonaws.customerprofiles#ListIntegrationItem": { "type": "structure", "members": { @@ -2672,7 +3290,7 @@ "ObjectFilter": { "target": "com.amazonaws.customerprofiles#ObjectFilter", "traits": { - "smithy.api#documentation": "Applies a filter to the response to include profile objects with the specified index values.\n This filter is only supported for ObjectTypeName _asset and _case.
" + "smithy.api#documentation": "Applies a filter to the response to include profile objects with the specified index\n values. This filter is only supported for ObjectTypeName _asset and _case.
" } } } @@ -2846,6 +3464,12 @@ "traits": { "smithy.api#documentation": "A list of identifiers for profiles that match.
" } + }, + "ConfidenceScore": { + "target": "com.amazonaws.customerprofiles#Double", + "traits": { + "smithy.api#documentation": "A number between 0 and 1 that represents the confidence level of assigning profiles to a\n matching group. A score of 1 likely indicates an exact match.
" + } } }, "traits": { @@ -2858,6 +3482,30 @@ "target": "com.amazonaws.customerprofiles#MatchItem" } }, + "com.amazonaws.customerprofiles#MatchingAttributes": { + "type": "list", + "member": { + "target": "com.amazonaws.customerprofiles#string1To255" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.customerprofiles#MatchingAttributesList": { + "type": "list", + "member": { + "target": "com.amazonaws.customerprofiles#MatchingAttributes" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.customerprofiles#MatchingRequest": { "type": "structure", "members": { @@ -2867,6 +3515,24 @@ "smithy.api#documentation": "The flag that enables the matching process of duplicate profiles.
", "smithy.api#required": {} } + }, + "JobSchedule": { + "target": "com.amazonaws.customerprofiles#JobSchedule", + "traits": { + "smithy.api#documentation": "The day and time when do you want to start the Identity Resolution Job every week.
" + } + }, + "AutoMerging": { + "target": "com.amazonaws.customerprofiles#AutoMerging", + "traits": { + "smithy.api#documentation": "Configuration information about the auto-merging process.
" + } + }, + "ExportingConfig": { + "target": "com.amazonaws.customerprofiles#ExportingConfig", + "traits": { + "smithy.api#documentation": "Configuration information for exporting Identity Resolution results, for example, to an S3\n bucket.
" + } } }, "traits": { @@ -2881,6 +3547,24 @@ "traits": { "smithy.api#documentation": "The flag that enables the matching process of duplicate profiles.
" } + }, + "JobSchedule": { + "target": "com.amazonaws.customerprofiles#JobSchedule", + "traits": { + "smithy.api#documentation": "The day and time when do you want to start the Identity Resolution Job every week.
" + } + }, + "AutoMerging": { + "target": "com.amazonaws.customerprofiles#AutoMerging", + "traits": { + "smithy.api#documentation": "Configuration information about the auto-merging process.
" + } + }, + "ExportingConfig": { + "target": "com.amazonaws.customerprofiles#ExportingConfig", + "traits": { + "smithy.api#documentation": "Configuration information for exporting Identity Resolution results, for example, to an S3\n bucket.
" + } } }, "traits": { @@ -2978,7 +3662,7 @@ "KeyName": { "target": "com.amazonaws.customerprofiles#name", "traits": { - "smithy.api#documentation": "A searchable identifier of a standard profile object. The predefined keys you can use to search for _asset include: _assetId, _assetName, _serialNumber.\n The predefined keys you can use to search for _case include: _caseId.
", + "smithy.api#documentation": "A searchable identifier of a standard profile object. The predefined keys you can use to\n search for _asset include: _assetId, _assetName, _serialNumber. The predefined keys you can\n use to search for _case include: _caseId.
", "smithy.api#required": {} } }, @@ -2991,7 +3675,7 @@ } }, "traits": { - "smithy.api#documentation": "The filter applied to ListProfileObjects response to include profile objects with the specified index values.\n This filter is only supported for ObjectTypeName _asset and _case.
" + "smithy.api#documentation": "The filter applied to ListProfileObjects response to include profile objects with the\n specified index values. This filter is only supported for ObjectTypeName _asset and\n _case.
" } }, "com.amazonaws.customerprofiles#ObjectTypeField": { @@ -3026,7 +3710,7 @@ "StandardIdentifiers": { "target": "com.amazonaws.customerprofiles#StandardIdentifierList", "traits": { - "smithy.api#documentation": "The types of keys that a ProfileObject can have. Each ProfileObject can have only 1\n UNIQUE key but multiple PROFILE keys. PROFILE, ASSET or CASE means that this key can be used to tie an\n object to a PROFILE, ASSET or CASE respectively. UNIQUE means that it can be used to uniquely identify an object.\n If a key a is marked as SECONDARY, it will be used to search for profiles after all other\n PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is\n not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the\n profile does not already exist before the object is ingested, otherwise it is only used for\n matching objects to profiles.
" + "smithy.api#documentation": "The types of keys that a ProfileObject can have. Each ProfileObject can have only 1\n UNIQUE key but multiple PROFILE keys. PROFILE, ASSET or CASE means that this key can be\n used to tie an object to a PROFILE, ASSET or CASE respectively. UNIQUE means that it can be\n used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to\n search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is\n only used to match a profile but is not persisted to be used for searching of the profile.\n A NEW_ONLY key is only used if the profile does not already exist before the object is\n ingested, otherwise it is only used for matching objects to profiles.
" } }, "FieldNames": { @@ -3594,6 +4278,12 @@ "smithy.api#documentation": "Indicates whether a profile should be created when data is received if one doesn’t exist\n for an object of this type. The default is FALSE. If the AllowProfileCreation\n flag is set to FALSE, then the service tries to fetch a standard profile and\n associate this object with the profile. If it is set to TRUE, and if no match\n is found, then the service creates a new standard profile.
The format of your sourceLastUpdatedTimestamp that was previously set up.\n
Indicates whether a profile should be created when data is received if one doesn’t exist\n for an object of this type. The default is FALSE. If the AllowProfileCreation\n flag is set to FALSE, then the service tries to fetch a standard profile and\n associate this object with the profile. If it is set to TRUE, and if no match\n is found, then the service creates a new standard profile.
The format of your sourceLastUpdatedTimestamp that was previously set up in\n fields that were parsed using SimpleDateFormat. If you have sourceLastUpdatedTimestamp in your\n field, you must set up sourceLastUpdatedTimestampFormat.
The name of the S3 bucket where Identity Resolution Jobs write result files.
", + "smithy.api#required": {} + } + }, + "S3KeyName": { + "target": "com.amazonaws.customerprofiles#s3KeyNameCustomerOutputConfig", + "traits": { + "smithy.api#documentation": "The S3 key name of the location where Identity Resolution Jobs write result files.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration information about the S3 bucket where Identity Resolution Jobs write result files.
" + } + }, + "com.amazonaws.customerprofiles#S3ExportingLocation": { + "type": "structure", + "members": { + "S3BucketName": { + "target": "com.amazonaws.customerprofiles#s3BucketName", + "traits": { + "smithy.api#documentation": "The name of the S3 bucket name where Identity Resolution Jobs write result files.
" + } + }, + "S3KeyName": { + "target": "com.amazonaws.customerprofiles#s3KeyName", + "traits": { + "smithy.api#documentation": "The S3 key name of the location where Identity Resolution Jobs write result files.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The S3 location where Identity Resolution Jobs write result files.
" + } + }, "com.amazonaws.customerprofiles#S3SourceProperties": { "type": "structure", "members": { @@ -4772,7 +5509,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the properties of a domain, including creating or selecting a dead letter queue\n or an encryption key.
\nAfter a domain is created, the name can’t be changed.
\nUse this API or CreateDomain to\n enable identity\n resolution: set Matching to true.
Updates the properties of a domain, including creating or selecting a dead letter queue\n or an encryption key.
\nAfter a domain is created, the name can’t be changed.
\nUse this API or CreateDomain to\n enable identity\n resolution: set Matching to true.
To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should\n apply.
", "smithy.api#http": { "method": "PUT", "uri": "/domains/{DomainName}", @@ -4812,7 +5549,7 @@ "Matching": { "target": "com.amazonaws.customerprofiles#MatchingRequest", "traits": { - "smithy.api#documentation": "The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. \nAfter that batch process completes, use the \nGetMatches\nAPI to return and review the results.
" + "smithy.api#documentation": "The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly\nbatch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every \nSaturday at 12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the \nGetMatches\nAPI to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from\nS3.
The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. \nAfter that batch process completes, use the \nGetMatches\nAPI to return and review the results.
" + "smithy.api#documentation": "The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly\nbatch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every \nSaturday at 12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the \nGetMatches\nAPI to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from\nS3.
What occurs after a certain event.
" } }, + "com.amazonaws.dataexchange#ApiDescription": { + "type": "string", + "traits": { + "smithy.api#documentation": "The description of the API.
" + } + }, + "com.amazonaws.dataexchange#ApiGatewayApiAsset": { + "type": "structure", + "members": { + "ApiDescription": { + "target": "com.amazonaws.dataexchange#ApiDescription", + "traits": { + "smithy.api#documentation": "The API description of the API asset.
" + } + }, + "ApiEndpoint": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "The API endpoint of the API asset.
" + } + }, + "ApiId": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "The unique identifier of the API asset.
" + } + }, + "ApiKey": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "The API key of the API asset.
" + } + }, + "ApiName": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "The API name of the API asset.
" + } + }, + "ApiSpecificationDownloadUrl": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "The download URL of the API specification of the API asset.
" + } + }, + "ApiSpecificationDownloadUrlExpiresAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the upload URL expires, in ISO 8601 format.
" + } + }, + "ProtocolType": { + "target": "com.amazonaws.dataexchange#ProtocolType", + "traits": { + "smithy.api#documentation": "The protocol type of the API asset.
" + } + }, + "Stage": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "The stage of the API asset.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The API Gateway API that is the asset.
" + } + }, "com.amazonaws.dataexchange#Arn": { "type": "string", "traits": { @@ -108,6 +176,12 @@ "traits": { "smithy.api#documentation": "The Amazon Redshift datashare that is the asset.
" } + }, + "ApiGatewayApiAsset": { + "target": "com.amazonaws.dataexchange#ApiGatewayApiAsset", + "traits": { + "smithy.api#documentation": "Information about the API Gateway API asset.
" + } } }, "traits": { @@ -162,7 +236,7 @@ "Name": { "target": "com.amazonaws.dataexchange#AssetName", "traits": { - "smithy.api#documentation": "The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.
", + "smithy.api#documentation": "The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key. When importing from Amazon API Gateway API, the API name is used as the asset name. When importing from Amazon Redshift, the datashare name is used as the asset name.
", "smithy.api#required": {} } }, @@ -188,13 +262,13 @@ } }, "traits": { - "smithy.api#documentation": "An asset in AWS Data Exchange is a piece of data. The asset can be a structured data file, an image file, or some other data file that can be stored as an S3 object, or an Amazon Redshift datashare (Preview). When you create an import job for your files, you create an asset in AWS Data Exchange for each of those files.
" + "smithy.api#documentation": "An asset in AWS Data Exchange is a piece of data (S3 object) or a means of fulfilling data (Amazon Redshift datashare or Amazon API Gateway API). The asset can be a structured data file, an image file, or some other data file that can be stored as an S3 object, an Amazon API Gateway API, or an Amazon Redshift datashare (Preview). When you create an import job for your files, API Gateway APIs, or Amazon Redshift datashares, you create an asset in AWS Data Exchange.
" } }, "com.amazonaws.dataexchange#AssetName": { "type": "string", "traits": { - "smithy.api#documentation": "The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.
" + "smithy.api#documentation": "The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key. When importing from Amazon API Gateway API, the API name is used as the asset name. When importing from Amazon Redshift, the datashare name is used as the asset name.
" } }, "com.amazonaws.dataexchange#AssetSourceEntry": { @@ -231,6 +305,10 @@ { "value": "REDSHIFT_DATA_SHARE", "name": "REDSHIFT_DATA_SHARE" + }, + { + "value": "API_GATEWAY_API", + "name": "API_GATEWAY_API" } ] } @@ -854,6 +932,21 @@ }, "com.amazonaws.dataexchange#DataExchange": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "DataExchange", + "arnNamespace": "dataexchange", + "cloudFormationName": "DataExchange", + "cloudTrailEventSource": "dataexchange.amazonaws.com", + "endpointPrefix": "dataexchange" + }, + "aws.auth#sigv4": { + "name": "dataexchange" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "AWS Data Exchange is a service that makes it easy for AWS customers to exchange data in the cloud. You can use the AWS Data Exchange APIs to create, update, manage, and access file-based data set in the AWS Cloud.
As a subscriber, you can view and access the data sets that you have an entitlement to through a subscription. You can use the APIS to download or copy your entitled data sets to Amazon S3 for use across a variety of AWS analytics and machine learning services.
As a provider, you can create and manage your data sets that you would like to publish to a product. Being able to package and provide your data sets into products requires a few steps to determine eligibility. For more information, visit the AWS Data Exchange User Guide.
A data set is a collection of data that can be changed or updated over time. Data sets can be updated using revisions, which represent a new version or incremental change to a data set. A revision contains one or more assets. An asset in AWS Data Exchange is a piece of data that can be stored as an Amazon S3 object. The asset can be a structured data file, an image file, or some other data file. Jobs are asynchronous import or export operations used to create or copy assets.
", + "smithy.api#title": "AWS Data Exchange" + }, "version": "2017-07-25", "operations": [ { @@ -916,6 +1009,9 @@ { "target": "com.amazonaws.dataexchange#ListTagsForResource" }, + { + "target": "com.amazonaws.dataexchange#SendApiAsset" + }, { "target": "com.amazonaws.dataexchange#StartJob" }, @@ -937,22 +1033,7 @@ { "target": "com.amazonaws.dataexchange#UpdateRevision" } - ], - "traits": { - "aws.api#service": { - "sdkId": "DataExchange", - "arnNamespace": "dataexchange", - "cloudFormationName": "DataExchange", - "cloudTrailEventSource": "dataexchange.amazonaws.com", - "endpointPrefix": "dataexchange" - }, - "aws.auth#sigv4": { - "name": "dataexchange" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "AWS Data Exchange is a service that makes it easy for AWS customers to exchange data in the cloud. You can use the AWS Data Exchange APIs to create, update, manage, and access file-based data set in the AWS Cloud.
As a subscriber, you can view and access the data sets that you have an entitlement to through a subscription. You can use the APIS to download or copy your entitled data sets to Amazon S3 for use across a variety of AWS analytics and machine learning services.
As a provider, you can create and manage your data sets that you would like to publish to a product. Being able to package and provide your data sets into products requires a few steps to determine eligibility. For more information, visit the AWS Data Exchange User Guide.
A data set is a collection of data that can be changed or updated over time. Data sets can be updated using revisions, which represent a new version or incremental change to a data set. A revision contains one or more assets. An asset in AWS Data Exchange is a piece of data that can be stored as an Amazon S3 object. The asset can be a structured data file, an image file, or some other data file. Jobs are asynchronous import or export operations used to create or copy assets.
", - "smithy.api#title": "AWS Data Exchange" - } + ] }, "com.amazonaws.dataexchange#DataSetEntry": { "type": "structure", @@ -1666,7 +1747,7 @@ "Name": { "target": "com.amazonaws.dataexchange#AssetName", "traits": { - "smithy.api#documentation": "The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.
" + "smithy.api#documentation": "The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key. When importing from Amazon API Gateway API, the API name is used as the asset name. When importing from Amazon Redshift, the datashare name is used as the asset name.
" } }, "RevisionId": { @@ -2103,6 +2184,158 @@ "smithy.api#documentation": "A unique identifier.
" } }, + "com.amazonaws.dataexchange#ImportAssetFromApiGatewayApiRequestDetails": { + "type": "structure", + "members": { + "ApiDescription": { + "target": "com.amazonaws.dataexchange#ApiDescription", + "traits": { + "smithy.api#documentation": "The API description. Markdown supported.
" + } + }, + "ApiId": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "The API Gateway API ID.
", + "smithy.api#required": {} + } + }, + "ApiKey": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "The API Gateway API key.
" + } + }, + "ApiName": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "The API name.
", + "smithy.api#required": {} + } + }, + "ApiSpecificationMd5Hash": { + "target": "com.amazonaws.dataexchange#__stringMin24Max24PatternAZaZ094AZaZ092AZaZ093", + "traits": { + "smithy.api#documentation": "The Base64-encoded MD5 hash of the OpenAPI 3.0 JSON API specification file. It is used to ensure the integrity of the file.
", + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "The data set ID.
", + "smithy.api#required": {} + } + }, + "ProtocolType": { + "target": "com.amazonaws.dataexchange#ProtocolType", + "traits": { + "smithy.api#documentation": "The protocol type.
", + "smithy.api#required": {} + } + }, + "RevisionId": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "The revision ID.
", + "smithy.api#required": {} + } + }, + "Stage": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "The API stage.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request details.
" + } + }, + "com.amazonaws.dataexchange#ImportAssetFromApiGatewayApiResponseDetails": { + "type": "structure", + "members": { + "ApiDescription": { + "target": "com.amazonaws.dataexchange#ApiDescription", + "traits": { + "smithy.api#documentation": "The API description.
" + } + }, + "ApiId": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "The API ID.
", + "smithy.api#required": {} + } + }, + "ApiKey": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "The API key.
" + } + }, + "ApiName": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "The API name.
", + "smithy.api#required": {} + } + }, + "ApiSpecificationMd5Hash": { + "target": "com.amazonaws.dataexchange#__stringMin24Max24PatternAZaZ094AZaZ092AZaZ093", + "traits": { + "smithy.api#documentation": "The Base64-encoded Md5 hash for the API asset, used to ensure the integrity of the API at that location.
", + "smithy.api#required": {} + } + }, + "ApiSpecificationUploadUrl": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "The upload URL of the API specification.
", + "smithy.api#required": {} + } + }, + "ApiSpecificationUploadUrlExpiresAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the upload URL expires, in ISO 8601 format.
", + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "The data set ID.
", + "smithy.api#required": {} + } + }, + "ProtocolType": { + "target": "com.amazonaws.dataexchange#ProtocolType", + "traits": { + "smithy.api#documentation": "The protocol type.
", + "smithy.api#required": {} + } + }, + "RevisionId": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "The revision ID.
", + "smithy.api#required": {} + } + }, + "Stage": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "The API stage.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The response details.
" + } + }, "com.amazonaws.dataexchange#ImportAssetFromSignedUrlJobErrorDetails": { "type": "structure", "members": { @@ -2568,6 +2801,18 @@ { "value": "Amazon Redshift datashare assets per revision", "name": "Amazon_Redshift_datashare_assets_per_revision" + }, + { + "value": "Concurrent in progress jobs to import assets from an API Gateway API", + "name": "Concurrent_in_progress_jobs_to_import_assets_from_an_API_Gateway_API" + }, + { + "value": "Amazon API Gateway API assets per revision", + "name": "Amazon_API_Gateway_API_assets_per_revision" + }, + { + "value": "Revisions per Amazon API Gateway API data set", + "name": "Revisions_per_Amazon_API_Gateway_API_data_set" } ] } @@ -3170,6 +3415,17 @@ "smithy.api#documentation": "Information about the origin of the data set.
" } }, + "com.amazonaws.dataexchange#ProtocolType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "REST", + "name": "REST" + } + ] + } + }, "com.amazonaws.dataexchange#RedshiftDataShareAsset": { "type": "structure", "members": { @@ -3238,6 +3494,12 @@ "traits": { "smithy.api#documentation": "Details from an import from Amazon Redshift datashare request.
" } + }, + "ImportAssetFromApiGatewayApi": { + "target": "com.amazonaws.dataexchange#ImportAssetFromApiGatewayApiRequestDetails", + "traits": { + "smithy.api#documentation": "Information about the import asset from API Gateway API request.
" + } } }, "traits": { @@ -3338,6 +3600,12 @@ "traits": { "smithy.api#documentation": "Details from an import from Amazon Redshift datashare response.
" } + }, + "ImportAssetFromApiGatewayApi": { + "target": "com.amazonaws.dataexchange#ImportAssetFromApiGatewayApiResponseDetails", + "traits": { + "smithy.api#documentation": "The response details.
" + } } }, "traits": { @@ -3463,6 +3731,129 @@ "smithy.api#documentation": "The S3 object that is the asset.
" } }, + "com.amazonaws.dataexchange#SendApiAsset": { + "type": "operation", + "input": { + "target": "com.amazonaws.dataexchange#SendApiAssetRequest" + }, + "output": { + "target": "com.amazonaws.dataexchange#SendApiAssetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.dataexchange#AccessDeniedException" + }, + { + "target": "com.amazonaws.dataexchange#InternalServerException" + }, + { + "target": "com.amazonaws.dataexchange#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dataexchange#ThrottlingException" + }, + { + "target": "com.amazonaws.dataexchange#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "This operation invokes an API Gateway API asset. The request is proxied to the provider’s API Gateway API.
", + "smithy.api#endpoint": { + "hostPrefix": "api-fulfill." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/v1", + "code": 200 + } + } + }, + "com.amazonaws.dataexchange#SendApiAssetRequest": { + "type": "structure", + "members": { + "Body": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "The request body.
", + "smithy.api#httpPayload": {} + } + }, + "QueryStringParameters": { + "target": "com.amazonaws.dataexchange#MapOf__string", + "traits": { + "smithy.api#documentation": "Attach query string parameters to the end of the URI (for example, /v1/examplePath?exampleParam=exampleValue).
", + "smithy.api#httpQueryParams": {} + } + }, + "AssetId": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "Asset ID value for the API request.
", + "smithy.api#httpHeader": "x-amzn-dataexchange-asset-id", + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "Data set ID value for the API request.
", + "smithy.api#httpHeader": "x-amzn-dataexchange-data-set-id", + "smithy.api#required": {} + } + }, + "RequestHeaders": { + "target": "com.amazonaws.dataexchange#MapOf__string", + "traits": { + "smithy.api#documentation": "Any header value prefixed with x-amzn-dataexchange-header- will have that stripped before sending the Asset API request. Use this when you want to override a header that AWS Data Exchange uses. Alternatively, you can use the header without a prefix to the HTTP request.
", + "smithy.api#httpPrefixHeaders": "x-amzn-dataexchange-header-" + } + }, + "Method": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "HTTP method value for the API request. Alternatively, you can use the appropriate verb in your request.
", + "smithy.api#httpHeader": "x-amzn-dataexchange-http-method" + } + }, + "Path": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "URI path value for the API request. Alternatively, you can set the URI path directly by invoking /v1/{pathValue}
", + "smithy.api#httpHeader": "x-amzn-dataexchange-path" + } + }, + "RevisionId": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "Revision ID value for the API request.
", + "smithy.api#httpHeader": "x-amzn-dataexchange-revision-id", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request body for SendApiAsset.
" + } + }, + "com.amazonaws.dataexchange#SendApiAssetResponse": { + "type": "structure", + "members": { + "Body": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "The response body from the underlying API tracked by the API asset.
", + "smithy.api#httpPayload": {} + } + }, + "ResponseHeaders": { + "target": "com.amazonaws.dataexchange#MapOf__string", + "traits": { + "smithy.api#documentation": "The response headers from the underlying API tracked by the API asset.
", + "smithy.api#httpPrefixHeaders": "" + } + } + } + }, "com.amazonaws.dataexchange#ServerSideEncryptionTypes": { "type": "string", "traits": { @@ -3682,6 +4073,10 @@ { "value": "IMPORT_ASSETS_FROM_REDSHIFT_DATA_SHARES", "name": "IMPORT_ASSETS_FROM_REDSHIFT_DATA_SHARES" + }, + { + "value": "IMPORT_ASSET_FROM_API_GATEWAY_API", + "name": "IMPORT_ASSET_FROM_API_GATEWAY_API" } ] } @@ -3780,7 +4175,7 @@ "Name": { "target": "com.amazonaws.dataexchange#AssetName", "traits": { - "smithy.api#documentation": "The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.
", + "smithy.api#documentation": "The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key. When importing from Amazon API Gateway API, the API name is used as the asset name. When importing from Amazon Redshift, the datashare name is used as the asset name.
", "smithy.api#required": {} } }, @@ -3839,7 +4234,7 @@ "Name": { "target": "com.amazonaws.dataexchange#AssetName", "traits": { - "smithy.api#documentation": "The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.
" + "smithy.api#documentation": "The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key. When importing from Amazon API Gateway API, the API name is used as the asset name. When importing from Amazon Redshift, the datashare name is used as the asset name.
" } }, "RevisionId": { diff --git a/aws/sdk/aws-models/devops-guru.json b/aws/sdk/aws-models/devops-guru.json index 59c0a7d01e219cb87f751e04bda6d8df9109d7a3..cb3eb4d29eef8befef621bc401b7de89a199c711 100644 --- a/aws/sdk/aws-models/devops-guru.json +++ b/aws/sdk/aws-models/devops-guru.json @@ -167,6 +167,9 @@ } } }, + "com.amazonaws.devopsguru#AnomalyDescription": { + "type": "string" + }, "com.amazonaws.devopsguru#AnomalyId": { "type": "string", "traits": { @@ -174,7 +177,7 @@ "min": 1, "max": 100 }, - "smithy.api#pattern": "^[\\w-]*$" + "smithy.api#pattern": "^[\\w~.-]*$" } }, "com.amazonaws.devopsguru#AnomalyLimit": { @@ -183,6 +186,9 @@ "smithy.api#box": {} } }, + "com.amazonaws.devopsguru#AnomalyName": { + "type": "string" + }, "com.amazonaws.devopsguru#AnomalyReportedTimeRange": { "type": "structure", "members": { @@ -204,6 +210,32 @@ "smithy.api#documentation": " A time range that specifies when DevOps Guru opens and then closes an anomaly. This\n\t\t\tis different from AnomalyTimeRange, which specifies the time range when\n\t\t\tDevOps Guru actually observes the anomalous behavior.
The name of the Amazon Web Services resource.
" + } + }, + "Type": { + "target": "com.amazonaws.devopsguru#ResourceType", + "traits": { + "smithy.api#documentation": "The type of the Amazon Web Services resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon Web Services resources in which DevOps Guru detected unusual behavior that resulted in \n \tthe generation of an anomaly. When DevOps Guru detects multiple related anomalies, it creates \n and insight with details about the anomalous behavior and suggestions about how to correct the \n problem.
" + } + }, + "com.amazonaws.devopsguru#AnomalyResources": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#AnomalyResource" + } + }, "com.amazonaws.devopsguru#AnomalySeverity": { "type": "string", "traits": { @@ -229,12 +261,18 @@ "CloudWatchMetrics": { "target": "com.amazonaws.devopsguru#CloudWatchMetricsDetails", "traits": { - "smithy.api#documentation": " An array of CloudWatchMetricsDetail object that contains information\n\t\t\tabout the analyzed metrics that displayed anomalous behavior.
An array of CloudWatchMetricsDetail objects that contain information\n\t\t\tabout analyzed CloudWatch metrics that show anomalous behavior.
An array of PerformanceInsightsMetricsDetail objects that contain information\n \t\tabout analyzed Performance Insights metrics that show anomalous behavior.
Details about the source of the anomalous operational data that triggered the\n\t\t\tanomaly. The one supported source is Amazon CloudWatch metrics.
" + "smithy.api#documentation": "Details about the source of the anomalous operational data that triggered the\n\t\t\tanomaly.
" } }, "com.amazonaws.devopsguru#AnomalyStatus": { @@ -273,6 +311,37 @@ "smithy.api#documentation": " A time range that specifies when the observed unusual behavior in an anomaly started\n\t\t\tand ended. This is different from AnomalyReportedTimeRange, which specifies\n\t\t\tthe time range when DevOps Guru opens and then closes an anomaly.
This is a list of cloudwatch metric values at given timestamp.
" + "smithy.api#documentation": "This is a list of Amazon CloudWatch metric values at given timestamp.
" } }, "StatusCode": { "target": "com.amazonaws.devopsguru#CloudWatchMetricDataStatusCode", "traits": { - "smithy.api#documentation": "This is enum of the status showing whether the metric value pair list has Partial or\n\t\t\tComplete data or there was an error.
" + "smithy.api#documentation": "This is an enum of the status showing whether the metric value pair list has partial or\n\t\t\tcomplete data, or if there was an error.
" } } }, @@ -578,7 +647,7 @@ } }, "traits": { - "smithy.api#documentation": "The dimension of a Amazon CloudWatch metric that is used when DevOps Guru analyzes the resources in\n\t\t\tyour account for operational problems and anomalous behavior. A dimension is a\n\t\t\tname/value pair that is part of the identity of a metric. A metric can have up to 10\n\t\t\tdimensions. For more information, see Dimensions in the Amazon CloudWatch User Guide.
" + "smithy.api#documentation": "The dimension of am Amazon CloudWatch metric that is used when DevOps Guru analyzes the resources in\n\t\t\tyour account for operational problems and anomalous behavior. A dimension is a\n\t\t\tname/value pair that is part of the identity of a metric. A metric can have up to 10\n\t\t\tdimensions. For more information, see Dimensions in the Amazon CloudWatch User Guide.
" } }, "com.amazonaws.devopsguru#CloudWatchMetricsDimensionName": { @@ -685,6 +754,12 @@ "traits": { "smithy.api#documentation": "An object that specifies the CloudFormation stack that defines the Amazon Web Services resources\n\t\t\tused to create a monthly estimate for DevOps Guru.
" } + }, + "Tags": { + "target": "com.amazonaws.devopsguru#TagCostEstimationResourceCollectionFilters", + "traits": { + "smithy.api#documentation": "The Amazon Web Services tags used to filter the resource collection that is used for \n \t\ta cost estimate.
\n \tTags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support\n \t\ttagging, so you can assign the same tag to resources from different services to indicate\n \t\tthat the resources are related. For example, you can assign the same tag to an Amazon DynamoDB\n \t\ttable resource that you assign to an Lambda function. For more information about\n \t\tusing tags, see the Tagging\n \t\t\tbest practices whitepaper.
\n \tEach Amazon Web Services tag has two parts.
\n \tA tag key (for example, CostCenter,\n \t\t\t\tEnvironment, Project, or Secret). Tag\n \t\t\t\tkeys are case-sensitive.
An optional field known as a tag value (for example,\n \t\t\t\t111122223333, Production, or a team\n \t\t\t\tname). Omitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive.
Together these are known as key-value pairs.
\n \tThe string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.
A ReactiveAnomaly object that represents the requested anomaly.
A ProactiveAnomaly object that represents the requested anomaly.
A ProactiveAnomaly object that represents the requested anomaly.
A ReactiveAnomaly object that represents the requested anomaly.
An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources\n\t\t\tare defined. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
", + "smithy.api#documentation": "An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources\n\t\t\tare defined. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and \n Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze \n \tthe Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.
", "smithy.api#required": {} } }, @@ -1332,7 +1419,7 @@ "CloudFormation": { "target": "com.amazonaws.devopsguru#CloudFormationHealths", "traits": { - "smithy.api#documentation": "The returned CloudFormationHealthOverview object that contains an\n\t\t\t\tInsightHealthOverview object with the requested system health\n\t\t\tinformation.
The returned CloudFormationHealthOverview object that contains an\n\t\t\tInsightHealthOverview object with the requested system health\n\t\t\tinformation.
Returns the number of open proactive insights, open reactive insights, and the Mean Time to Recover (MTTR)\n\t\t\tfor all closed insights in resource collections in your account. You specify the type of\n\t\t\tAmazon Web Services resources collection. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
", + "smithy.api#documentation": "Returns the number of open proactive insights, open reactive insights, and the Mean Time to Recover (MTTR)\n\t\t\tfor all closed insights in resource collections in your account. You specify the type of\n\t\t\tAmazon Web Services resources collection. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and \n Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze \n \tthe Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/health/resource-collection/{ResourceCollectionType}", @@ -1396,7 +1483,7 @@ "ResourceCollectionType": { "target": "com.amazonaws.devopsguru#ResourceCollectionType", "traits": { - "smithy.api#documentation": "An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources\n\t\t\tare defined. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
", + "smithy.api#documentation": "An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources\n\t\t\tare defined. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and \n Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze \n \tthe Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1416,8 +1503,7 @@ "CloudFormation": { "target": "com.amazonaws.devopsguru#CloudFormationHealths", "traits": { - "smithy.api#documentation": " The returned CloudFormationHealthOverview object that contains an\n\t\t\t\tInsightHealthOverview object with the requested system health\n\t\t\tinformation.
The returned CloudFormationHealthOverview object that contains an\n\t\t\t\tInsightHealthOverview object with the requested system health\n\t\t\tinformation.
The pagination token to use to retrieve \n the next page of results for this operation. If there are no more pages, this value is null.
" } + }, + "Tags": { + "target": "com.amazonaws.devopsguru#TagHealths", + "traits": { + "smithy.api#documentation": "The Amazon Web Services tags that are used by resources in the resource collection.
\n \tTags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support\n \t\ttagging, so you can assign the same tag to resources from different services to indicate\n \t\tthat the resources are related. For example, you can assign the same tag to an Amazon DynamoDB\n \t\ttable resource that you assign to an Lambda function. For more information about\n \t\tusing tags, see the Tagging\n \t\t\tbest practices whitepaper.
\n \tEach Amazon Web Services tag has two parts.
\n \tA tag key (for example, CostCenter,\n \t\t\t\tEnvironment, Project, or Secret). Tag\n \t\t\t\tkeys are case-sensitive.
An optional field known as a tag value (for example,\n \t\t\t\t111122223333, Production, or a team\n \t\t\t\tname). Omitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive.
Together these are known as key-value pairs.
\n \tThe string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.
Returns lists Amazon Web Services resources that are of the specified resource collection type.\n\t\t\tThe one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
", + "smithy.api#documentation": "Returns lists Amazon Web Services resources that are of the specified resource collection type.\n\t\t\tThe two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and \n Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze \n \tthe Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.
", "smithy.api#http": { "method": "GET", "uri": "/resource-collections/{ResourceCollectionType}", @@ -1871,7 +1963,7 @@ "ResourceCollection": { "target": "com.amazonaws.devopsguru#ResourceCollectionFilter", "traits": { - "smithy.api#documentation": "The requested list of Amazon Web Services resource collections.\n\t\t\tThe one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
" + "smithy.api#documentation": "The requested list of Amazon Web Services resource collections.\n\t\t\tThe two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and \n Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze \n \tthe Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.
" } }, "NextToken": { @@ -3004,6 +3096,266 @@ } } }, + "com.amazonaws.devopsguru#PerformanceInsightsMetricDimension": { + "type": "string" + }, + "com.amazonaws.devopsguru#PerformanceInsightsMetricDimensionGroup": { + "type": "structure", + "members": { + "Group": { + "target": "com.amazonaws.devopsguru#PerformanceInsightsMetricGroup", + "traits": { + "smithy.api#documentation": "The name of the dimension group. Its valid values are:
\n \t\n \t\n \t\t\t\t db - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL,\n \t\t\t\tAurora MySQL, Amazon RDS MySQL, and MariaDB)
\n \t\t\t\t db.application - The name of the application that is connected to the database (only Aurora\n \t\t\t\tPostgreSQL and RDS PostgreSQL)
\n \t\t\t\t db.host - The host name of the connected client (all engines)
\n \t\t\t\t db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)
\n \t\t\t\t db.sql - The SQL that is currently executing (all engines)
\n \t\t\t\t db.sql_tokenized - The SQL digest (all engines)
\n \t\t\t\t db.wait_event - The event for which the database backend is waiting (all engines)
\n \t\t\t\t db.wait_event_type - The type of event for which the database backend is waiting (all engines)
\n \t\t\t\t db.user - The user logged in to the database (all engines)
A list of specific dimensions from a dimension group. If this parameter is not present,\n \t\tthen it signifies that all of the dimensions in the group were requested or are present in\n \t\tthe response.
\n \tValid values for elements in the Dimensions array are:
\n \t\t\t\t db.application.name - The name of the application that is connected to the database (only\n \t\t\t\tAurora PostgreSQL and RDS PostgreSQL)
\n \t\t\t\t db.host.id - The host ID of the connected client (all engines)
\n \t\t\t\t db.host.name - The host name of the connected client (all engines)
\n \t\t\t\t db.name - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS\n \t\t\t\tPostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)
\n \t\t\t\t db.session_type.name - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)
\n \t\t\t\t db.sql.id - The SQL ID generated by Performance Insights (all engines)
\n \t\t\t\t db.sql.db_id - The SQL ID generated by the database (all engines)
\n \t\t\t\t db.sql.statement - The SQL text that is being executed (all engines)
\n \t\t\t\t db.sql.tokenized_id\n \t\t\t
\n \t\t\t\t db.sql_tokenized.id - The SQL digest ID generated by Performance Insights (all engines)
\n \t\t\t\t db.sql_tokenized.db_id - SQL digest ID generated by the database (all engines)
\n \t\t\t\t db.sql_tokenized.statement - The SQL digest text (all engines)
\n \t\t\t\t db.user.id - The ID of the user logged in to the database (all engines)
\n \t\t\t\t db.user.name - The name of the user logged in to the database (all engines)
\n \t\t\t\t db.wait_event.name - The event for which the backend is waiting (all engines)
\n \t\t\t\t db.wait_event.type - The type of event for which the backend is waiting (all engines)
\n \t\t\t\t db.wait_event_type.name - The name of the event type for which the backend is waiting (all\n \t\t\t\tengines)
The maximum number of items to fetch for this dimension group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A logical grouping of Performance Insights metrics for a related subject area. For example, the\n \t\tdb.sql dimension group consists of the following dimensions:\n \t\tdb.sql.id, db.sql.db_id, db.sql.statement, and\n \t\tdb.sql.tokenized_id.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, \n \t\t\tonly the first 500 bytes are returned.
\n \tAmazon RDS Performance Insights enables you to monitor and explore different \n \t\tdimensions of database load based on data captured from a running DB instance. \n \t\tDB load is measured as average active sessions. Performance Insights provides the \n \t\tdata to API consumers as a two-dimensional time-series dataset. The time dimension \n \t\tprovides DB load data for each time point in the queried time range. Each time point \n \t\tdecomposes overall load in relation to the requested dimensions, measured at that \n \t\ttime point. Examples include SQL, Wait event, User, and Host.
\n \t\n \tTo learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.\n \t\t\t
\n \t\tTo learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.\n \t\t\t
\n \t\tThe name of the meteric used used when querying an Performance Insights GetResourceMetrics API for \n \tanomaly metrics.
Valid values for Metric are:
\n \t\t\t\t db.load.avg - a scaled representation of the number of active sessions\n \t\t\t\tfor the database engine.
\n \t\t\t\t db.sampledload.avg - the raw number of active sessions for the\n \t\t\t\tdatabase engine.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg \n \t\tare the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg \n \t\tshowing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. \n \t\tFor most use cases, you can query db.load.avg only.
The specification for how to aggregate the data points from a Performance Insights GetResourceMetrics API query. The \n \t\tPerformance Insights query returns all of the dimensions within that group,\n \t\tunless you provide the names of specific dimensions within that group. You can also request\n \t\tthat Performance Insights return a limited number of values for a dimension.
One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:
Any number of filters by the same dimension, as specified in the GroupBy parameter.
A single filter for any other dimension in this dimension group.
\n \t\tA single query to be processed. Use these parameters to \n \t\tquery the Performance Insights GetResourceMetrics API to retrieve the metrics \n \t\tfor an anomaly. For more information, see \n GetResourceMetrics\n \n \tin the Amazon RDS Performance Insights API Reference.
Amazon RDS Performance Insights enables you to monitor and explore different \n \t\tdimensions of database load based on data captured from a running DB instance. \n \t\tDB load is measured as average active sessions. Performance Insights provides the \n \t\tdata to API consumers as a two-dimensional time-series dataset. The time dimension \n \t\tprovides DB load data for each time point in the queried time range. Each time point \n \t\tdecomposes overall load in relation to the requested dimensions, measured at that \n \t\ttime point. Examples include SQL, Wait event, User, and Host.
\n \t\n \tTo learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.\n \t\t\t
\n \t\tTo learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.\n \t\t\t
\n \t\tThe name used for a specific Performance Insights metric.
" + } + }, + "Unit": { + "target": "com.amazonaws.devopsguru#PerformanceInsightsMetricUnit", + "traits": { + "smithy.api#documentation": "The unit of measure for a metric. For example, a session or a process.
" + } + }, + "MetricQuery": { + "target": "com.amazonaws.devopsguru#PerformanceInsightsMetricQuery", + "traits": { + "smithy.api#documentation": "A single query to be processed for the metric. For more information, see \n \t\t\n PerformanceInsightsMetricQuery\n .
\n \tFor more information, see \n \t\n PerformanceInsightsReferenceData\n .\n
The metric statistics during the anomalous period detected by DevOps Guru;
" + } + }, + "StatsAtBaseline": { + "target": "com.amazonaws.devopsguru#PerformanceInsightsStats", + "traits": { + "smithy.api#documentation": "Typical metric statistics that are not considered anomalous. When DevOps Guru analyzes\n\t\t\tmetrics, it compares them to StatsAtBaseline to help determine if they are\n\t\t\tanomalous.
Details about Performance Insights metrics.
\n \t\n \tAmazon RDS Performance Insights enables you to monitor and explore different \n \t\tdimensions of database load based on data captured from a running DB instance. \n \t\tDB load is measured as average active sessions. Performance Insights provides the \n \t\tdata to API consumers as a two-dimensional time-series dataset. The time dimension \n \t\tprovides DB load data for each time point in the queried time range. Each time point \n \t\tdecomposes overall load in relation to the requested dimensions, measured at that \n \t\ttime point. Examples include SQL, Wait event, User, and Host.
\n \t\n \tTo learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.\n \t\t\t
\n \t\tTo learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.\n \t\t\t
\n \t\tA scalar value DevOps Guru for a metric that DevOps Guru compares to actual metric values. This reference value is used \n to determine if an actual metric value should be considered anomalous.
" + } + }, + "ReferenceMetric": { + "target": "com.amazonaws.devopsguru#PerformanceInsightsReferenceMetric", + "traits": { + "smithy.api#documentation": "A metric that DevOps Guru compares to actual metric values. This reference metric is used \n \t\tto determine if an actual metric should be considered anomalous.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Reference scalar values and other metrics that DevOps Guru displays on a graph in its console along with the actual metrics it \n analyzed. Compare these reference values to your actual metrics to help you understand anomalous behavior that DevOps Guru detected.
" + } + }, + "com.amazonaws.devopsguru#PerformanceInsightsReferenceData": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.devopsguru#PerformanceInsightsReferenceName", + "traits": { + "smithy.api#documentation": "The name of the reference data.
" + } + }, + "ComparisonValues": { + "target": "com.amazonaws.devopsguru#PerformanceInsightsReferenceComparisonValues", + "traits": { + "smithy.api#documentation": "The specific reference values used to evaluate the Performance Insights. For more information, see \n\t\t\t\n PerformanceInsightsReferenceComparisonValues\n .\n\t\t
Reference data used to evaluate Performance Insights to determine if its performance \n is anomalous or not.
" + } + }, + "com.amazonaws.devopsguru#PerformanceInsightsReferenceDataList": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#PerformanceInsightsReferenceData" + } + }, + "com.amazonaws.devopsguru#PerformanceInsightsReferenceMetric": { + "type": "structure", + "members": { + "MetricQuery": { + "target": "com.amazonaws.devopsguru#PerformanceInsightsMetricQuery", + "traits": { + "smithy.api#documentation": "A query to be processed on the metric.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a reference metric used to evaluate Performance Insights.
" + } + }, + "com.amazonaws.devopsguru#PerformanceInsightsReferenceName": { + "type": "string" + }, + "com.amazonaws.devopsguru#PerformanceInsightsReferenceScalar": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.devopsguru#PerformanceInsightsValueDouble", + "traits": { + "smithy.api#documentation": "The reference value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A reference value to compare Performance Insights metrics against to determine if the metrics \n demonstrate anomalous behavior.
" + } + }, + "com.amazonaws.devopsguru#PerformanceInsightsStat": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.devopsguru#PerformanceInsightsStatType", + "traits": { + "smithy.api#documentation": "The statistic type.
" + } + }, + "Value": { + "target": "com.amazonaws.devopsguru#PerformanceInsightsValueDouble", + "traits": { + "smithy.api#documentation": "The value of the statistic.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A statistic in a Performance Insights collection.
" + } + }, + "com.amazonaws.devopsguru#PerformanceInsightsStatType": { + "type": "string" + }, + "com.amazonaws.devopsguru#PerformanceInsightsStats": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#PerformanceInsightsStat" + } + }, + "com.amazonaws.devopsguru#PerformanceInsightsValueDouble": { + "type": "double", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.devopsguru#PredictionTimeRange": { "type": "structure", "members": { @@ -3043,7 +3395,7 @@ "Severity": { "target": "com.amazonaws.devopsguru#AnomalySeverity", "traits": { - "smithy.api#documentation": "The severity of a proactive anomaly.
" + "smithy.api#documentation": "The severity of the anomaly. The severity of anomalies that generate \n\tan insight determine that insight's severity. For more information, see \n\tUnderstanding \n\tinsight severities in the Amazon DevOps Guru User Guide.
" } }, "Status": { @@ -3064,7 +3416,7 @@ "AnomalyReportedTimeRange": { "target": "com.amazonaws.devopsguru#AnomalyReportedTimeRange", "traits": { - "smithy.api#documentation": "\n\t\t\tA AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.\n\t\t
\n\t\t\tAn AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.\n\t\t
The severity of the anomaly.
" + "smithy.api#documentation": "The severity of the anomaly. The severity of anomalies that generate \n\tan insight determine that insight's severity. For more information, see \n\tUnderstanding \n\tinsight severities in the Amazon DevOps Guru User Guide.
" } }, "Status": { @@ -3129,7 +3481,7 @@ "AnomalyReportedTimeRange": { "target": "com.amazonaws.devopsguru#AnomalyReportedTimeRange", "traits": { - "smithy.api#documentation": "\n\t\t\tA AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.\n\t\t
\n\t\t\tAn AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.\n\t\t
The severity of the proactive insight.
" + "smithy.api#documentation": "The severity of the insight. For more information, see \n\tUnderstanding \n\tinsight severities in the Amazon DevOps Guru User Guide.
" } }, "Status": { @@ -3226,7 +3578,7 @@ "Severity": { "target": "com.amazonaws.devopsguru#InsightSeverity", "traits": { - "smithy.api#documentation": "The severity of the proactive insight.
" + "smithy.api#documentation": "The severity of the insight. For more information, see \n\tUnderstanding \n\tinsight severities in the Amazon DevOps Guru User Guide.
" } }, "Status": { @@ -3249,6 +3601,12 @@ "traits": { "smithy.api#documentation": "A collection of the names of Amazon Web Services services.
" } + }, + "AssociatedResourceArns": { + "target": "com.amazonaws.devopsguru#AssociatedResourceArns", + "traits": { + "smithy.api#documentation": "The Amazon Resource Names (ARNs) \n\tof the Amazon Web Services resources that generated this insight.
" + } } }, "traits": { @@ -3291,7 +3649,7 @@ "Severity": { "target": "com.amazonaws.devopsguru#InsightSeverity", "traits": { - "smithy.api#documentation": "An array of severity values used to search for insights.
" + "smithy.api#documentation": "An array of severity values used to search for insights. For more information, see \n\tUnderstanding \n\tinsight severities in the Amazon DevOps Guru User Guide.
" } }, "Status": { @@ -3314,7 +3672,7 @@ } }, "traits": { - "smithy.api#documentation": "Details about a proactive insight. This object is returned by\n\t\t\t\tDescribeInsight.
Details about a proactive insight. This object is returned by\n\t\t\tDescribeInsight.
The severity of the anomaly.
" + "smithy.api#documentation": "The severity of the anomaly. The severity of anomalies that generate \n\tan insight determine that insight's severity. For more information, see \n\tUnderstanding \n\tinsight severities in the Amazon DevOps Guru User Guide.
" } }, "Status": { @@ -3408,7 +3766,7 @@ "AnomalyReportedTimeRange": { "target": "com.amazonaws.devopsguru#AnomalyReportedTimeRange", "traits": { - "smithy.api#documentation": "\n\t\t\tA AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.\n\t\t
\n\t\t\tAn AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.\n\t\t
The type of the reactive anomaly. It can be one of the following types.
\n\t\n\t \t\t CAUSAL - the anomaly can cause a new insight.
\n\t \t\t CONTEXTUAL - the anomaly contains additional information about an insight or its causal anomaly.
The name of the reactive anomaly.
" + } + }, + "Description": { + "target": "com.amazonaws.devopsguru#AnomalyDescription", + "traits": { + "smithy.api#documentation": "A description of the reactive anomaly.
" + } + }, + "CausalAnomalyId": { + "target": "com.amazonaws.devopsguru#AnomalyId", + "traits": { + "smithy.api#documentation": "The ID of the causal anomaly that is associated with this \n reactive anomaly. The ID of a `CAUSAL` anomaly is always `NULL`.
" + } + }, + "AnomalyResources": { + "target": "com.amazonaws.devopsguru#AnomalyResources", + "traits": { + "smithy.api#documentation": "The Amazon Web Services resources in which anomalous behavior was detected by DevOps Guru.
" + } } }, "traits": { @@ -3443,7 +3831,7 @@ "Severity": { "target": "com.amazonaws.devopsguru#AnomalySeverity", "traits": { - "smithy.api#documentation": "The severity of the reactive anomaly.
" + "smithy.api#documentation": "The severity of the anomaly. The severity of anomalies that generate \n\tan insight determine that insight's severity. For more information, see \n\tUnderstanding \n\tinsight severities in the Amazon DevOps Guru User Guide.
" } }, "Status": { @@ -3458,7 +3846,7 @@ "AnomalyReportedTimeRange": { "target": "com.amazonaws.devopsguru#AnomalyReportedTimeRange", "traits": { - "smithy.api#documentation": "\n\t\t\tA AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.\n\t\t
\n\t\t\tAn AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.\n\t\t
The type of the reactive anomaly. It can be one of the following types.
\n\t\n\t \t\t CAUSAL - the anomaly can cause a new insight.
\n\t \t\t CONTEXTUAL - the anomaly contains additional information about an insight or its causal anomaly.
The name of the reactive anomaly.
" + } + }, + "Description": { + "target": "com.amazonaws.devopsguru#AnomalyDescription", + "traits": { + "smithy.api#documentation": "A description of the reactive anomaly.
" + } + }, + "CausalAnomalyId": { + "target": "com.amazonaws.devopsguru#AnomalyId", + "traits": { + "smithy.api#documentation": "The ID of the causal anomaly that is associated with this \n reactive anomaly. The ID of a `CAUSAL` anomaly is always `NULL`.
" + } + }, + "AnomalyResources": { + "target": "com.amazonaws.devopsguru#AnomalyResources", + "traits": { + "smithy.api#documentation": "The Amazon Web Services resources in which anomalous behavior was detected by DevOps Guru.
" + } } }, "traits": { @@ -3499,7 +3917,7 @@ "Severity": { "target": "com.amazonaws.devopsguru#InsightSeverity", "traits": { - "smithy.api#documentation": "The severity of a reactive insight.
" + "smithy.api#documentation": "The severity of the insight. For more information, see \n\tUnderstanding \n\tinsight severities in the Amazon DevOps Guru User Guide.
" } }, "Status": { @@ -3543,7 +3961,7 @@ "Severity": { "target": "com.amazonaws.devopsguru#InsightSeverity", "traits": { - "smithy.api#documentation": "The severity of a reactive insight.
" + "smithy.api#documentation": "The severity of the insight. For more information, see \n\tUnderstanding \n\tinsight severities in the Amazon DevOps Guru User Guide.
" } }, "Status": { @@ -3563,6 +3981,12 @@ "traits": { "smithy.api#documentation": "A collection of the names of Amazon Web Services services.
" } + }, + "AssociatedResourceArns": { + "target": "com.amazonaws.devopsguru#AssociatedResourceArns", + "traits": { + "smithy.api#documentation": "The Amazon Resource Names (ARNs) \n\tof the Amazon Web Services resources that generated this insight.
" + } } }, "traits": { @@ -3587,7 +4011,7 @@ "AccountId": { "target": "com.amazonaws.devopsguru#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID of the Amazon Web Services account.
" + "smithy.api#documentation": "The ID of the Amazon Web Services account.
" } }, "OrganizationalUnitId": { @@ -3605,7 +4029,7 @@ "Severity": { "target": "com.amazonaws.devopsguru#InsightSeverity", "traits": { - "smithy.api#documentation": "An array of severity values used to search for insights.
" + "smithy.api#documentation": "An array of severity values used to search for insights. For more information, see \n\tUnderstanding \n\tinsight severities in the Amazon DevOps Guru User Guide.
" } }, "Status": { @@ -3625,7 +4049,7 @@ } }, "traits": { - "smithy.api#documentation": "Information about a reactive insight. This object is returned by\n\t\t\t\tDescribeInsight.
Information about a reactive insight. This object is returned by\n\t\t\tDescribeInsight.
Information about where the anomalous behavior related the recommendation was found.\n\t\t\tFor example, details in Amazon CloudWatch metrics.
" } + }, + "AnomalyId": { + "target": "com.amazonaws.devopsguru#AnomalyId", + "traits": { + "smithy.api#documentation": "The ID of an anomaly that generated the insight with this recommendation.
" + } } }, "traits": { @@ -3728,7 +4158,7 @@ "Type": { "target": "com.amazonaws.devopsguru#RecommendationRelatedAnomalyResourceType", "traits": { - "smithy.api#documentation": "The type of the resource.
" + "smithy.api#documentation": " The type of the resource. Resource types take the same form that is \n\t\t\tused by Amazon Web Services CloudFormation resource type identifiers, service-provider::service-name::data-type-name. \n\t\t\tFor example, AWS::RDS::DBCluster. For more information, see \n\t\t\tAmazon Web Services resource and \n\t\t\t\tproperty types reference in the Amazon Web Services CloudFormation User Guide.
An array of the names of Amazon Web Services CloudFormation stacks. The stacks define Amazon Web Services resources that\n\t\t\tDevOps Guru analyzes. You can specify up to 500 Amazon Web Services CloudFormation stacks.
" } + }, + "Tags": { + "target": "com.amazonaws.devopsguru#TagCollections", + "traits": { + "smithy.api#documentation": "The Amazon Web Services tags that are used by resources in the resource collection.
\n \tTags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support\n \t\ttagging, so you can assign the same tag to resources from different services to indicate\n \t\tthat the resources are related. For example, you can assign the same tag to an Amazon DynamoDB\n \t\ttable resource that you assign to an Lambda function. For more information about\n \t\tusing tags, see the Tagging\n \t\t\tbest practices whitepaper.
\n \tEach Amazon Web Services tag has two parts.
\n \tA tag key (for example, CostCenter,\n \t\t\t\tEnvironment, Project, or Secret). Tag\n \t\t\t\tkeys are case-sensitive.
An optional field known as a tag value (for example,\n \t\t\t\t111122223333, Production, or a team\n \t\t\t\tname). Omitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive.
Together these are known as key-value pairs.
\n \tThe string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.
A collection of Amazon Web Services resources supported by DevOps Guru.\n\t\t\tThe one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
" + "smithy.api#documentation": "A collection of Amazon Web Services resources supported by DevOps Guru.\n\t\t\tThe two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and \n Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze \n \tthe Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.
" } }, "com.amazonaws.devopsguru#ResourceCollectionFilter": { @@ -3949,6 +4394,12 @@ "traits": { "smithy.api#documentation": "Information about Amazon Web Services CloudFormation stacks. You can use up to 500\n\t\t\tstacks to specify which Amazon Web Services resources in your account to analyze. For more\n\t\t\tinformation, see Stacks in the\n\t\t\t\tAmazon Web Services CloudFormation User Guide.
" } + }, + "Tags": { + "target": "com.amazonaws.devopsguru#TagCollectionFilters", + "traits": { + "smithy.api#documentation": "The Amazon Web Services tags used to filter the resources in the resource collection.
\n \tTags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support\n \t\ttagging, so you can assign the same tag to resources from different services to indicate\n \t\tthat the resources are related. For example, you can assign the same tag to an Amazon DynamoDB\n \t\ttable resource that you assign to an Lambda function. For more information about\n \t\tusing tags, see the Tagging\n \t\t\tbest practices whitepaper.
\n \tEach Amazon Web Services tag has two parts.
\n \tA tag key (for example, CostCenter,\n \t\t\t\tEnvironment, Project, or Secret). Tag\n \t\t\t\tkeys are case-sensitive.
An optional field known as a tag value (for example,\n \t\t\t\t111122223333, Production, or a team\n \t\t\t\tname). Omitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive.
Together these are known as key-value pairs.
\n \tThe string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.
Returns a list of insights in your organization. You can specify which insights are\n\t\t\treturned by their start time, one or more statuses (ONGOING,\n\t\t\t\tCLOSED, and CLOSED), one or more severities\n\t\t\t\t(LOW, MEDIUM, and HIGH), and type\n\t\t\t\t(REACTIVE or PROACTIVE).
Use the Filters parameter to specify status and severity search\n\t\t\tparameters. Use the Type parameter to specify REACTIVE or\n\t\t\t\tPROACTIVE in your search.
Returns a list of insights in your organization. You can specify which insights are\n\t\t\treturned by their start time, one or more statuses (ONGOING,\n\t\t\tCLOSED, and CLOSED), one or more severities\n\t\t\t(LOW, MEDIUM, and HIGH), and type\n\t\t\t(REACTIVE or PROACTIVE).
Use the Filters parameter to specify status and severity search\n\t\t\tparameters. Use the Type parameter to specify REACTIVE or\n\t\t\tPROACTIVE in your search.
The type of insights you are searching for (REACTIVE or\n\t\t\t\tPROACTIVE).
The type of insights you are searching for (REACTIVE or\n\t\t\tPROACTIVE).
A time range used to specify when the behavior of an insight or anomaly started.\n\t\t
" } }, + "com.amazonaws.devopsguru#TagCollection": { + "type": "structure", + "members": { + "AppBoundaryKey": { + "target": "com.amazonaws.devopsguru#AppBoundaryKey", + "traits": { + "smithy.api#documentation": "An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that \n \tDevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make \n up your DevOps Guru application and analysis boundary.
\nThe string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.
The values in an Amazon Web Services tag collection.
\n \tThe tag's value is an optional field used to associate a string with \n\t\t\t\t\tthe tag key (for example, 111122223333, Production, or a team\n \t\t\t\tname). The key and value are the tag's key pair. \n \t\t\t\tOmitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive. You can specify a maximum of 256 characters for a tag value.
A collection of Amazon Web Services stags.
\n \tTags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support\n \t\ttagging, so you can assign the same tag to resources from different services to indicate\n \t\tthat the resources are related. For example, you can assign the same tag to an Amazon DynamoDB\n \t\ttable resource that you assign to an Lambda function. For more information about\n \t\tusing tags, see the Tagging\n \t\t\tbest practices whitepaper.
\n \tEach Amazon Web Services tag has two parts.
\n \tA tag key (for example, CostCenter,\n \t\t\t\tEnvironment, Project, or Secret). Tag\n \t\t\t\tkeys are case-sensitive.
An optional field known as a tag value (for example,\n \t\t\t\t111122223333, Production, or a team\n \t\t\t\tname). Omitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive.
Together these are known as key-value pairs.
\n \tThe string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.
An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that \n \tDevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make \n up your DevOps Guru application and analysis boundary.
\nThe string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.
The values in an Amazon Web Services tag collection.
\n \tThe tag's value is an optional field used to associate a string with \n\t\t\t\t\tthe tag key (for example, 111122223333, Production, or a team\n \t\t\t\tname). The key and value are the tag's key pair. \n \t\t\t\tOmitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive. You can specify a maximum of 256 characters for a tag value.
A collection of Amazon Web Services tags used to filter insights. This is used to return insights generated from \n only resources that contain the tags in the tag collection.
" + } + }, + "com.amazonaws.devopsguru#TagCollectionFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#TagCollectionFilter" + } + }, + "com.amazonaws.devopsguru#TagCollections": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#TagCollection" + } + }, + "com.amazonaws.devopsguru#TagCostEstimationResourceCollectionFilter": { + "type": "structure", + "members": { + "AppBoundaryKey": { + "target": "com.amazonaws.devopsguru#AppBoundaryKey", + "traits": { + "smithy.api#documentation": "An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that \n \tDevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make \n up your DevOps Guru application and analysis boundary.
\nThe string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.
The values in an Amazon Web Services tag collection.
\n \tThe tag's value is an optional field used to associate a string with \n\t\t\t\t\tthe tag key (for example, 111122223333, Production, or a team\n \t\t\t\tname). The key and value are the tag's key pair. \n \t\t\t\tOmitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive. You can specify a maximum of 256 characters for a tag value.
Information about a collection of Amazon Web Services resources that are identified by an \n \t\tAmazon Web Services tag. This collection of resources is used to create a monthly cost estimate\n \t\tfor DevOps Guru to analyze Amazon Web Services resources. The maximum number of tags you can specify for a\n \t\tcost estimate is one. The estimate created is for the cost to analyze the Amazon Web Services\n \t\tresources defined by the tag. For more information, see Stacks in the\n \t\tAmazon Web Services CloudFormation User Guide.
" + } + }, + "com.amazonaws.devopsguru#TagCostEstimationResourceCollectionFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#TagCostEstimationResourceCollectionFilter" + } + }, + "com.amazonaws.devopsguru#TagHealth": { + "type": "structure", + "members": { + "AppBoundaryKey": { + "target": "com.amazonaws.devopsguru#AppBoundaryKey", + "traits": { + "smithy.api#documentation": "An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that \n \tDevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make \n up your DevOps Guru application and analysis boundary.
\nThe string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.
The value in an Amazon Web Services tag.
\n \tThe tag's value is an optional field used to associate a string with \n\t\t\t\t\tthe tag key (for example, 111122223333, Production, or a team\n \t\t\t\tname). The key and value are the tag's key pair. \n \t\t\t\tOmitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive. You can specify a maximum of 256 characters for a tag value.
Information about the health of the Amazon Web Services resources in your account that are\n\t\t\tspecified by an Amazon Web Services tag, including the number of open proactive, open reactive\n\t\t\tinsights, and the Mean Time to Recover (MTTR) of closed insights.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the health of Amazon Web Services resources in your account that are specified by\n \t\tan Amazon Web Services tag key.
" + } + }, + "com.amazonaws.devopsguru#TagHealths": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#TagHealth" + } + }, + "com.amazonaws.devopsguru#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*|\\*)$" + } + }, + "com.amazonaws.devopsguru#TagValues": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#TagValue" + } + }, "com.amazonaws.devopsguru#ThrottlingException": { "type": "structure", "members": { @@ -4788,7 +5378,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the collection of resources that DevOps Guru analyzes.\n\t\t\tThe one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks. This method also creates the IAM role required for\n\t\t\tyou to use DevOps Guru.
", + "smithy.api#documentation": "Updates the collection of resources that DevOps Guru analyzes.\n\t\t\tThe two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and \n Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze \n \tthe Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks. This method also creates the IAM role required for\n\t\t\tyou to use DevOps Guru.
", "smithy.api#http": { "method": "PUT", "uri": "/resource-collections", @@ -4817,7 +5407,13 @@ "CloudFormation": { "target": "com.amazonaws.devopsguru#UpdateCloudFormationCollectionFilter", "traits": { - "smithy.api#documentation": "An collection of Amazon Web Services CloudFormation stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
" + "smithy.api#documentation": "A collection of Amazon Web Services CloudFormation stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
" + } + }, + "Tags": { + "target": "com.amazonaws.devopsguru#UpdateTagCollectionFilters", + "traits": { + "smithy.api#documentation": "The updated Amazon Web Services tags used to filter the resources in the resource collection.
\n \tTags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support\n \t\ttagging, so you can assign the same tag to resources from different services to indicate\n \t\tthat the resources are related. For example, you can assign the same tag to an Amazon DynamoDB\n \t\ttable resource that you assign to an Lambda function. For more information about\n \t\tusing tags, see the Tagging\n \t\t\tbest practices whitepaper.
\n \tEach Amazon Web Services tag has two parts.
\n \tA tag key (for example, CostCenter,\n \t\t\t\tEnvironment, Project, or Secret). Tag\n \t\t\t\tkeys are case-sensitive.
An optional field known as a tag value (for example,\n \t\t\t\t111122223333, Production, or a team\n \t\t\t\tname). Omitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive.
Together these are known as key-value pairs.
\n \tThe string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.
An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that \n \tDevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make \n up your DevOps Guru application and analysis boundary.
\nThe string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.
The values in an Amazon Web Services tag collection.
\n \tThe tag's value is an optional field used to associate a string with \n\t\t\t\t\tthe tag key (for example, 111122223333, Production, or a team\n \t\t\t\tname). The key and value are the tag's key pair. \n \t\t\t\tOmitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive. You can specify a maximum of 256 characters for a tag value.
A new collection of Amazon Web Services resources that are defined by an Amazon Web Services tag or tag \n key/value pair.
" + } + }, + "com.amazonaws.devopsguru#UpdateTagCollectionFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#UpdateTagCollectionFilter" + } + }, + "com.amazonaws.devopsguru#UpdateTagValues": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.devopsguru#UuidNextToken": { "type": "string", "traits": { @@ -5006,6 +5642,14 @@ { "value": "OTHER", "name": "OTHER" + }, + { + "value": "INVALID_PARAMETER_COMBINATION", + "name": "INVALID_PARAMETER_COMBINATION" + }, + { + "value": "PARAMETER_INCONSISTENT_WITH_SERVICE_STATE", + "name": "PARAMETER_INCONSISTENT_WITH_SERVICE_STATE" } ] } diff --git a/aws/sdk/aws-models/directconnect.json b/aws/sdk/aws-models/directconnect.json index 09061bdf624a29726e18e34e955240719db0f0a5..09aafecca71b46844b1065861cbde8eb1ec7bf2b 100644 --- a/aws/sdk/aws-models/directconnect.json +++ b/aws/sdk/aws-models/directconnect.json @@ -881,7 +881,7 @@ "agreementName": { "target": "com.amazonaws.directconnect#AgreementName", "traits": { - "smithy.api#documentation": "\n The name of the customer agreement.\n
" + "smithy.api#documentation": "\n\n The name of the customer agreement.\n\n
" } } } @@ -2938,7 +2938,7 @@ "virtualInterfaceName": { "target": "com.amazonaws.directconnect#VirtualInterfaceName", "traits": { - "smithy.api#documentation": "The name of the virtual interface assigned by the customer network.
" + "smithy.api#documentation": "Provides the details about a virtual interface's router.
" } } } @@ -3527,6 +3527,12 @@ "smithy.api#error": "client" } }, + "com.amazonaws.directconnect#EnableSiteLink": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.directconnect#EncryptionMode": { "type": "string" }, @@ -4286,6 +4292,12 @@ "traits": { "smithy.api#documentation": "The tags associated with the private virtual interface.
" } + }, + "enableSiteLink": { + "target": "com.amazonaws.directconnect#EnableSiteLink", + "traits": { + "smithy.api#documentation": "Indicates whether to enable or disable SiteLink.
" + } } }, "traits": { @@ -4549,6 +4561,12 @@ "traits": { "smithy.api#documentation": "The tags associated with the transitive virtual interface.
" } + }, + "enableSiteLink": { + "target": "com.amazonaws.directconnect#EnableSiteLink", + "traits": { + "smithy.api#documentation": "Indicates whether to enable or disable SiteLink.
" + } } }, "traits": { @@ -4638,6 +4656,24 @@ }, "com.amazonaws.directconnect#OvertureService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Direct Connect", + "arnNamespace": "directconnect", + "cloudFormationName": "DirectConnect", + "cloudTrailEventSource": "directconnect.amazonaws.com", + "endpointPrefix": "directconnect" + }, + "aws.auth#sigv4": { + "name": "directconnect" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Direct Connect links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. \n One end of the cable is connected to your router, the other to an Direct Connect router. With this connection\n in place, you can create virtual interfaces directly to the Amazon Web Services Cloud (for example, to Amazon EC2 \n and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A \n connection provides access to all Amazon Web Services Regions except the China (Beijing) and (China) Ningxia Regions. \n Amazon Web Services resources in the China Regions can only be accessed through locations associated with those Regions.
", + "smithy.api#title": "AWS Direct Connect", + "smithy.api#xmlNamespace": { + "uri": "http://directconnect.amazonaws.com/doc/2012-10-25/" + } + }, "version": "2012-10-25", "operations": [ { @@ -4829,25 +4865,7 @@ { "target": "com.amazonaws.directconnect#UpdateVirtualInterfaceAttributes" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Direct Connect", - "arnNamespace": "directconnect", - "cloudFormationName": "DirectConnect", - "cloudTrailEventSource": "directconnect.amazonaws.com", - "endpointPrefix": "directconnect" - }, - "aws.auth#sigv4": { - "name": "directconnect" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Direct Connect links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. \n One end of the cable is connected to your router, the other to an Direct Connect router. With this connection\n in place, you can create virtual interfaces directly to the Amazon Web Services Cloud (for example, to Amazon EC2 \n and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A \n connection provides access to all Amazon Web Services Regions except the China (Beijing) and (China) Ningxia Regions. \n Amazon Web Services resources in the China Regions can only be accessed through locations associated with those Regions.
", - "smithy.api#title": "AWS Direct Connect", - "smithy.api#xmlNamespace": { - "uri": "http://directconnect.amazonaws.com/doc/2012-10-25/" - } - } + ] }, "com.amazonaws.directconnect#OwnerAccount": { "type": "string" @@ -4993,6 +5011,12 @@ "com.amazonaws.directconnect#SecretARN": { "type": "string" }, + "com.amazonaws.directconnect#SiteLinkEnabled": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.directconnect#Software": { "type": "string" }, @@ -5513,6 +5537,18 @@ "traits": { "smithy.api#documentation": "The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
" } + }, + "enableSiteLink": { + "target": "com.amazonaws.directconnect#EnableSiteLink", + "traits": { + "smithy.api#documentation": "Indicates whether to enable or disable SiteLink.
" + } + }, + "virtualInterfaceName": { + "target": "com.amazonaws.directconnect#VirtualInterfaceName", + "traits": { + "smithy.api#documentation": "The name of the virtual private interface.
" + } } } }, @@ -5723,6 +5759,12 @@ "traits": { "smithy.api#documentation": "The tags associated with the virtual interface.
" } + }, + "siteLinkEnabled": { + "target": "com.amazonaws.directconnect#SiteLinkEnabled", + "traits": { + "smithy.api#documentation": "Indicates whether SiteLink is enabled.
" + } } }, "traits": { diff --git a/aws/sdk/aws-models/dms.json b/aws/sdk/aws-models/dms.json index 8e339597e53e768487c63bff3f5fe02a283a55e4..520e693bc5c39fa847b6e35fd57bad54e0cef1b2 100644 --- a/aws/sdk/aws-models/dms.json +++ b/aws/sdk/aws-models/dms.json @@ -3122,7 +3122,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the task assessment results from the Amazon S3 bucket that DMS creates in your\n Amazon Web Services account. This action always returns the latest results.
\nFor more information about DMS task assessments, see Creating a task assessment\n report in the Database Migration Service User Guide.
", + "smithy.api#documentation": "Returns the task assessment results from the Amazon S3 bucket that DMS creates in your\n Amazon Web Services account. This action always returns the\n latest results.
\nFor more information about DMS task assessments, see \n Creating a task assessment report\n in the Database Migration Service User Guide.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -8497,6 +8497,12 @@ "traits": { "smithy.api#documentation": "For an S3 source, when this value is set to true or y,\n each leading double quotation mark has to be followed by an\n ending double quotation mark. This formatting complies with RFC\n 4180. When this value is set to false or\n n, string literals are copied to the target as\n is. In this case, a delimiter (row or column) signals the end of\n the field. Thus, you can't use a delimiter as part of the\n string, because it signals the end of the value.
For an S3 target, an optional parameter used to set behavior to comply with RFC\n 4180 for data migrated to Amazon S3 using .csv file format only. When this\n value is set to true or y using Amazon\n S3 as a target, if the data has quotation marks or newline\n characters in it, DMS encloses the entire column with an\n additional pair of double quotation marks (\"). Every quotation\n mark within the data is repeated twice.
The default value is true. Valid values include true, false,\n y, and n.
When creating an S3 target endpoint, set DatePartitionTimezone to convert\n the current UTC time into a specified time zone. The conversion occurs when a date\n partition folder is created and a CDC filename is generated. The time zone format is Area/Location.\n Use this parameter when DatePartitionedEnabled is set to true, as shown in the\n following example.
\n s3-settings='{\"DatePartitionEnabled\": true, \"DatePartitionSequence\": \"YYYYMMDDHH\",\n \"DatePartitionDelimiter\": \"SLASH\",\n \"DatePartitionTimezone\":\"Asia/Seoul\", \"BucketName\":\n \"dms-nattarat-test\"}'\n
Starts the replication task assessment for unsupported data types in the source\n database.
" + "smithy.api#documentation": "Starts the replication task assessment for unsupported data types in the source\n database.
\nYou can only use this operation for a task if the following conditions are true:
\nThe task must be in the stopped state.
The task must have successful connections to the source and target.
\nIf either of these conditions are not met, an InvalidResourceStateFault error will result.
For information about DMS task assessments, see \n Creating a task assessment report\n in the Database Migration Service User Guide.
" } }, "com.amazonaws.databasemigrationservice#StartReplicationTaskAssessmentMessage": { diff --git a/aws/sdk/aws-models/drs.json b/aws/sdk/aws-models/drs.json new file mode 100644 index 0000000000000000000000000000000000000000..e255b87ad933a42ea830881a92d5cd447e0494c5 --- /dev/null +++ b/aws/sdk/aws-models/drs.json @@ -0,0 +1,5250 @@ +{ + "smithy": "1.0", + "shapes": { + "com.amazonaws.drs#ARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:.{16,2044}$" + } + }, + "com.amazonaws.drs#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.drs#LargeBoundedString" + }, + "code": { + "target": "com.amazonaws.drs#LargeBoundedString" + } + }, + "traits": { + "smithy.api#documentation": "TYou do not have sufficient access to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.drs#AccountID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "[0-9]{12,}" + } + }, + "com.amazonaws.drs#AccountResource": { + "type": "resource", + "identifiers": { + "accountID": { + "target": "com.amazonaws.drs#AccountID" + } + }, + "traits": { + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.drs#BoundedString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.drs#CPU": { + "type": "structure", + "members": { + "cores": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#documentation": "The number of CPU cores.
" + } + }, + "modelName": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "The model name of the CPU.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a server's CPU.
" + } + }, + "com.amazonaws.drs#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.drs#LargeBoundedString" + }, + "code": { + "target": "com.amazonaws.drs#LargeBoundedString" + }, + "resourceId": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "The ID of the resource.
" + } + }, + "resourceType": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "The type of the resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request could not be completed due to a conflict with the current state of the target resource.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.drs#Cpus": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#CPU" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.drs#CreateReplicationConfigurationTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#CreateReplicationConfigurationTemplateRequest" + }, + "output": { + "target": "com.amazonaws.drs#ReplicationConfigurationTemplate" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new ReplicationConfigurationTemplate.
", + "smithy.api#http": { + "method": "POST", + "uri": "/CreateReplicationConfigurationTemplate", + "code": 201 + } + } + }, + "com.amazonaws.drs#CreateReplicationConfigurationTemplateRequest": { + "type": "structure", + "members": { + "stagingAreaSubnetId": { + "target": "com.amazonaws.drs#SubnetID", + "traits": { + "smithy.api#documentation": "The subnet to be used by the replication staging area.
", + "smithy.api#required": {} + } + }, + "associateDefaultSecurityGroup": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
", + "smithy.api#required": {} + } + }, + "replicationServersSecurityGroupsIDs": { + "target": "com.amazonaws.drs#ReplicationServersSecurityGroupsIDs", + "traits": { + "smithy.api#documentation": "The security group IDs that will be used by the replication server.
", + "smithy.api#required": {} + } + }, + "replicationServerInstanceType": { + "target": "com.amazonaws.drs#EC2InstanceType", + "traits": { + "smithy.api#documentation": "The instance type to be used for the replication server.
", + "smithy.api#required": {} + } + }, + "useDedicatedReplicationServer": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether to use a dedicated Replication Server in the replication staging area.
", + "smithy.api#required": {} + } + }, + "defaultLargeStagingDiskType": { + "target": "com.amazonaws.drs#ReplicationConfigurationDefaultLargeStagingDiskType", + "traits": { + "smithy.api#documentation": "The Staging Disk EBS volume type to be used during replication.
", + "smithy.api#required": {} + } + }, + "ebsEncryption": { + "target": "com.amazonaws.drs#ReplicationConfigurationEbsEncryption", + "traits": { + "smithy.api#documentation": "The type of EBS encryption to be used during replication.
", + "smithy.api#required": {} + } + }, + "ebsEncryptionKeyArn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the EBS encryption key to be used during replication.
" + } + }, + "bandwidthThrottling": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#documentation": "Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
", + "smithy.api#required": {} + } + }, + "dataPlaneRouting": { + "target": "com.amazonaws.drs#ReplicationConfigurationDataPlaneRouting", + "traits": { + "smithy.api#documentation": "The data plane routing mechanism that will be used for replication.
", + "smithy.api#required": {} + } + }, + "createPublicIP": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether to create a Public IP for the Recovery Instance by default.
", + "smithy.api#required": {} + } + }, + "stagingAreaTags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
", + "smithy.api#required": {} + } + }, + "pitPolicy": { + "target": "com.amazonaws.drs#PITPolicy", + "traits": { + "smithy.api#documentation": "The Point in time (PIT) policy to manage snapshots taken during replication.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "A set of tags to be associated with the Replication Configuration Template resource.
" + } + } + } + }, + "com.amazonaws.drs#DataReplicationError": { + "type": "structure", + "members": { + "error": { + "target": "com.amazonaws.drs#DataReplicationErrorString", + "traits": { + "smithy.api#documentation": "Error in data replication.
" + } + }, + "rawError": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "Error in data replication.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Error in data replication.
" + } + }, + "com.amazonaws.drs#DataReplicationErrorString": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AGENT_NOT_SEEN", + "name": "AGENT_NOT_SEEN" + }, + { + "value": "SNAPSHOTS_FAILURE", + "name": "SNAPSHOTS_FAILURE" + }, + { + "value": "NOT_CONVERGING", + "name": "NOT_CONVERGING" + }, + { + "value": "UNSTABLE_NETWORK", + "name": "UNSTABLE_NETWORK" + }, + { + "value": "FAILED_TO_CREATE_SECURITY_GROUP", + "name": "FAILED_TO_CREATE_SECURITY_GROUP" + }, + { + "value": "FAILED_TO_LAUNCH_REPLICATION_SERVER", + "name": "FAILED_TO_LAUNCH_REPLICATION_SERVER" + }, + { + "value": "FAILED_TO_BOOT_REPLICATION_SERVER", + "name": "FAILED_TO_BOOT_REPLICATION_SERVER" + }, + { + "value": "FAILED_TO_AUTHENTICATE_WITH_SERVICE", + "name": "FAILED_TO_AUTHENTICATE_WITH_SERVICE" + }, + { + "value": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", + "name": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE" + }, + { + "value": "FAILED_TO_CREATE_STAGING_DISKS", + "name": "FAILED_TO_CREATE_STAGING_DISKS" + }, + { + "value": "FAILED_TO_ATTACH_STAGING_DISKS", + "name": "FAILED_TO_ATTACH_STAGING_DISKS" + }, + { + "value": "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", + "name": "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT" + }, + { + "value": "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", + "name": "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER" + }, + { + "value": "FAILED_TO_START_DATA_TRANSFER", + "name": "FAILED_TO_START_DATA_TRANSFER" + } + ] + } + }, + "com.amazonaws.drs#DataReplicationInfo": { + "type": "structure", + "members": { + "lagDuration": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "Data replication lag duration.
" + } + }, + "etaDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "An estimate of when the data replication will be completed.
" + } + }, + "replicatedDisks": { + "target": "com.amazonaws.drs#DataReplicationInfoReplicatedDisks", + "traits": { + "smithy.api#documentation": "The disks that should be replicated.
" + } + }, + "dataReplicationState": { + "target": "com.amazonaws.drs#DataReplicationState", + "traits": { + "smithy.api#documentation": "The state of the data replication.
" + } + }, + "dataReplicationInitiation": { + "target": "com.amazonaws.drs#DataReplicationInitiation", + "traits": { + "smithy.api#documentation": "Information about whether the data replication has been initiated.
" + } + }, + "dataReplicationError": { + "target": "com.amazonaws.drs#DataReplicationError", + "traits": { + "smithy.api#documentation": "Error in data replication.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about Data Replication
" + } + }, + "com.amazonaws.drs#DataReplicationInfoReplicatedDisk": { + "type": "structure", + "members": { + "deviceName": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "The name of the device.
" + } + }, + "totalStorageBytes": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#documentation": "The total amount of data to be replicated in bytes.
" + } + }, + "replicatedStorageBytes": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#documentation": "The amount of data replicated so far in bytes.
" + } + }, + "rescannedStorageBytes": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#documentation": "The amount of data to be rescanned in bytes.
" + } + }, + "backloggedStorageBytes": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#documentation": "The size of the replication backlog in bytes.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A disk that should be replicated.
" + } + }, + "com.amazonaws.drs#DataReplicationInfoReplicatedDisks": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#DataReplicationInfoReplicatedDisk" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 60 + } + } + }, + "com.amazonaws.drs#DataReplicationInitiation": { + "type": "structure", + "members": { + "startDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The date and time of the current attempt to initiate data replication.
" + } + }, + "nextAttemptDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The date and time of the next attempt to initiate data replication.
" + } + }, + "steps": { + "target": "com.amazonaws.drs#DataReplicationInitiationSteps", + "traits": { + "smithy.api#documentation": "The steps of the current attempt to initiate data replication.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Data replication initiation.
" + } + }, + "com.amazonaws.drs#DataReplicationInitiationStep": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.drs#DataReplicationInitiationStepName", + "traits": { + "smithy.api#documentation": "The name of the step.
" + } + }, + "status": { + "target": "com.amazonaws.drs#DataReplicationInitiationStepStatus", + "traits": { + "smithy.api#documentation": "The status of the step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Data replication initiation step.
" + } + }, + "com.amazonaws.drs#DataReplicationInitiationStepName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "WAIT", + "name": "WAIT" + }, + { + "value": "CREATE_SECURITY_GROUP", + "name": "CREATE_SECURITY_GROUP" + }, + { + "value": "LAUNCH_REPLICATION_SERVER", + "name": "LAUNCH_REPLICATION_SERVER" + }, + { + "value": "BOOT_REPLICATION_SERVER", + "name": "BOOT_REPLICATION_SERVER" + }, + { + "value": "AUTHENTICATE_WITH_SERVICE", + "name": "AUTHENTICATE_WITH_SERVICE" + }, + { + "value": "DOWNLOAD_REPLICATION_SOFTWARE", + "name": "DOWNLOAD_REPLICATION_SOFTWARE" + }, + { + "value": "CREATE_STAGING_DISKS", + "name": "CREATE_STAGING_DISKS" + }, + { + "value": "ATTACH_STAGING_DISKS", + "name": "ATTACH_STAGING_DISKS" + }, + { + "value": "PAIR_REPLICATION_SERVER_WITH_AGENT", + "name": "PAIR_REPLICATION_SERVER_WITH_AGENT" + }, + { + "value": "CONNECT_AGENT_TO_REPLICATION_SERVER", + "name": "CONNECT_AGENT_TO_REPLICATION_SERVER" + }, + { + "value": "START_DATA_TRANSFER", + "name": "START_DATA_TRANSFER" + } + ] + } + }, + "com.amazonaws.drs#DataReplicationInitiationStepStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NOT_STARTED", + "name": "NOT_STARTED" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "SUCCEEDED", + "name": "SUCCEEDED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "SKIPPED", + "name": "SKIPPED" + } + ] + } + }, + "com.amazonaws.drs#DataReplicationInitiationSteps": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#DataReplicationInitiationStep" + } + }, + "com.amazonaws.drs#DataReplicationState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "STOPPED", + "name": "STOPPED" + }, + { + "value": "INITIATING", + "name": "INITIATING" + }, + { + "value": "INITIAL_SYNC", + "name": "INITIAL_SYNC" + }, + { + "value": "BACKLOG", + "name": "BACKLOG" + }, + { + "value": "CREATING_SNAPSHOT", + "name": "CREATING_SNAPSHOT" + }, + { + "value": "CONTINUOUS", + "name": "CONTINUOUS" + }, + { + "value": "PAUSED", + "name": "PAUSED" + }, + { + "value": "RESCAN", + "name": "RESCAN" + }, + { + "value": "STALLED", + "name": "STALLED" + }, + { + "value": "DISCONNECTED", + "name": "DISCONNECTED" + } + ] + } + }, + "com.amazonaws.drs#DeleteJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DeleteJobRequest" + }, + "output": { + "target": "com.amazonaws.drs#DeleteJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a single Job by ID.
", + "smithy.api#http": { + "method": "POST", + "uri": "/DeleteJob", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.drs#DeleteJobRequest": { + "type": "structure", + "members": { + "jobID": { + "target": "com.amazonaws.drs#JobID", + "traits": { + "smithy.api#documentation": "The ID of the Job to be deleted.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#DeleteJobResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.drs#DeleteRecoveryInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DeleteRecoveryInstanceRequest" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a single Recovery Instance by ID. This deletes the Recovery Instance resource from Elastic Disaster Recovery. The Recovery Instance must be disconnected first in order to delete it.
", + "smithy.api#http": { + "method": "POST", + "uri": "/DeleteRecoveryInstance", + "code": 200 + } + } + }, + "com.amazonaws.drs#DeleteRecoveryInstanceRequest": { + "type": "structure", + "members": { + "recoveryInstanceID": { + "target": "com.amazonaws.drs#RecoveryInstanceID", + "traits": { + "smithy.api#documentation": "RThe ID of the Recovery Instance to be deleted.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#DeleteReplicationConfigurationTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DeleteReplicationConfigurationTemplateRequest" + }, + "output": { + "target": "com.amazonaws.drs#DeleteReplicationConfigurationTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a single Replication Configuration Template by ID
", + "smithy.api#http": { + "method": "POST", + "uri": "/DeleteReplicationConfigurationTemplate", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.drs#DeleteReplicationConfigurationTemplateRequest": { + "type": "structure", + "members": { + "replicationConfigurationTemplateID": { + "target": "com.amazonaws.drs#ReplicationConfigurationTemplateID", + "traits": { + "smithy.api#documentation": "The ID of the Replication Configuration Template to be deleted.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#DeleteReplicationConfigurationTemplateResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.drs#DeleteSourceServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DeleteSourceServerRequest" + }, + "output": { + "target": "com.amazonaws.drs#DeleteSourceServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a single Source Server by ID. The Source Server must be disconnected first.
", + "smithy.api#http": { + "method": "POST", + "uri": "/DeleteSourceServer", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.drs#DeleteSourceServerRequest": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "The ID of the Source Server to be deleted.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#DeleteSourceServerResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.drs#DescribeJobLogItems": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DescribeJobLogItemsRequest" + }, + "output": { + "target": "com.amazonaws.drs#DescribeJobLogItemsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a detailed Job log with pagination.
", + "smithy.api#http": { + "method": "POST", + "uri": "/DescribeJobLogItems", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "items", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#DescribeJobLogItemsRequest": { + "type": "structure", + "members": { + "jobID": { + "target": "com.amazonaws.drs#JobID", + "traits": { + "smithy.api#documentation": "The ID of the Job for which Job log items will be retrieved.
", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.drs#StrictlyPositiveInteger", + "traits": { + "smithy.api#documentation": "Maximum number of Job log items to retrieve.
" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "The token of the next Job log items to retrieve.
" + } + } + } + }, + "com.amazonaws.drs#DescribeJobLogItemsResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.drs#JobLogs", + "traits": { + "smithy.api#documentation": "An array of Job log items.
" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "The token of the next Job log items to retrieve.
" + } + } + } + }, + "com.amazonaws.drs#DescribeJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DescribeJobsRequest" + }, + "output": { + "target": "com.amazonaws.drs#DescribeJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of Jobs. Use the JobsID and fromDate and toDate filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are created by the StartRecovery, TerminateRecoveryInstances and StartFailbackLaunch APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets.
", + "smithy.api#http": { + "method": "POST", + "uri": "/DescribeJobs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "items", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#DescribeJobsRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.drs#DescribeJobsRequestFilters", + "traits": { + "smithy.api#documentation": "A set of filters by which to return Jobs.
", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.drs#StrictlyPositiveInteger", + "traits": { + "smithy.api#documentation": "Maximum number of Jobs to retrieve.
" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "The token of the next Job to retrieve.
" + } + } + } + }, + "com.amazonaws.drs#DescribeJobsRequestFilters": { + "type": "structure", + "members": { + "jobIDs": { + "target": "com.amazonaws.drs#DescribeJobsRequestFiltersJobIDs", + "traits": { + "smithy.api#documentation": "An array of Job IDs that should be returned. An empty array means all jobs.
" + } + }, + "fromDate": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The start date in a date range query.
" + } + }, + "toDate": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The end date in a date range query.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A set of filters by which to return Jobs.
" + } + }, + "com.amazonaws.drs#DescribeJobsRequestFiltersJobIDs": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#JobID" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.drs#DescribeJobsResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.drs#JobsList", + "traits": { + "smithy.api#documentation": "An array of Jobs.
" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "The token of the next Job to retrieve.
" + } + } + } + }, + "com.amazonaws.drs#DescribeRecoveryInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DescribeRecoveryInstancesRequest" + }, + "output": { + "target": "com.amazonaws.drs#DescribeRecoveryInstancesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "ec2:DescribeInstances" + ], + "smithy.api#documentation": "Lists all Recovery Instances or multiple Recovery Instances by ID.
", + "smithy.api#http": { + "method": "POST", + "uri": "/DescribeRecoveryInstances", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "items", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#DescribeRecoveryInstancesItems": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#RecoveryInstance" + } + }, + "com.amazonaws.drs#DescribeRecoveryInstancesRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.drs#DescribeRecoveryInstancesRequestFilters", + "traits": { + "smithy.api#documentation": "A set of filters by which to return Recovery Instances.
", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.drs#StrictlyPositiveInteger", + "traits": { + "smithy.api#documentation": "Maximum number of Recovery Instances to retrieve.
" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "The token of the next Recovery Instance to retrieve.
" + } + } + } + }, + "com.amazonaws.drs#DescribeRecoveryInstancesRequestFilters": { + "type": "structure", + "members": { + "recoveryInstanceIDs": { + "target": "com.amazonaws.drs#RecoveryInstanceIDs", + "traits": { + "smithy.api#documentation": "An array of Recovery Instance IDs that should be returned. An empty array means all Recovery Instances.
" + } + }, + "sourceServerIDs": { + "target": "com.amazonaws.drs#SourceServerIDs", + "traits": { + "smithy.api#documentation": "An array of Source Server IDs for which associated Recovery Instances should be returned.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A set of filters by which to return Recovery Instances.
" + } + }, + "com.amazonaws.drs#DescribeRecoveryInstancesResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "The token of the next Recovery Instance to retrieve.
" + } + }, + "items": { + "target": "com.amazonaws.drs#DescribeRecoveryInstancesItems", + "traits": { + "smithy.api#documentation": "An array of Recovery Instances.
" + } + } + } + }, + "com.amazonaws.drs#DescribeRecoverySnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DescribeRecoverySnapshotsRequest" + }, + "output": { + "target": "com.amazonaws.drs#DescribeRecoverySnapshotsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all Recovery Snapshots for a single Source Server.
", + "smithy.api#http": { + "method": "POST", + "uri": "/DescribeRecoverySnapshots", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "items", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#DescribeRecoverySnapshotsRequest": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "Filter Recovery Snapshots by Source Server ID.
", + "smithy.api#required": {} + } + }, + "filters": { + "target": "com.amazonaws.drs#DescribeRecoverySnapshotsRequestFilters", + "traits": { + "smithy.api#documentation": "A set of filters by which to return Recovery Snapshots.
" + } + }, + "order": { + "target": "com.amazonaws.drs#RecoverySnapshotsOrder", + "traits": { + "smithy.api#documentation": "The sorted ordering by which to return Recovery Snapshots.
" + } + }, + "maxResults": { + "target": "com.amazonaws.drs#StrictlyPositiveInteger", + "traits": { + "smithy.api#documentation": "Maximum number of Recovery Snapshots to retrieve.
" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "The token of the next Recovery Snapshot to retrieve.
" + } + } + } + }, + "com.amazonaws.drs#DescribeRecoverySnapshotsRequestFilters": { + "type": "structure", + "members": { + "fromDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The start date in a date range query.
" + } + }, + "toDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The end date in a date range query.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A set of filters by which to return Recovery Snapshots.
" + } + }, + "com.amazonaws.drs#DescribeRecoverySnapshotsResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.drs#RecoverySnapshotsList", + "traits": { + "smithy.api#documentation": "An array of Recovery Snapshots.
" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "The token of the next Recovery Snapshot to retrieve.
" + } + } + } + }, + "com.amazonaws.drs#DescribeReplicationConfigurationTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DescribeReplicationConfigurationTemplatesRequest" + }, + "output": { + "target": "com.amazonaws.drs#DescribeReplicationConfigurationTemplatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
", + "smithy.api#http": { + "method": "POST", + "uri": "/DescribeReplicationConfigurationTemplates", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "items", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#DescribeReplicationConfigurationTemplatesRequest": { + "type": "structure", + "members": { + "replicationConfigurationTemplateIDs": { + "target": "com.amazonaws.drs#ReplicationConfigurationTemplateIDs", + "traits": { + "smithy.api#documentation": "The IDs of the Replication Configuration Templates to retrieve. An empty list means all Replication Configuration Templates.
", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.drs#StrictlyPositiveInteger", + "traits": { + "smithy.api#documentation": "Maximum number of Replication Configuration Templates to retrieve.
" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "The token of the next Replication Configuration Template to retrieve.
" + } + } + } + }, + "com.amazonaws.drs#DescribeReplicationConfigurationTemplatesResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.drs#ReplicationConfigurationTemplates", + "traits": { + "smithy.api#documentation": "An array of Replication Configuration Templates.
" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "The token of the next Replication Configuration Template to retrieve.
" + } + } + } + }, + "com.amazonaws.drs#DescribeSourceServers": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DescribeSourceServersRequest" + }, + "output": { + "target": "com.amazonaws.drs#DescribeSourceServersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all Source Servers or multiple Source Servers filtered by ID.
", + "smithy.api#http": { + "method": "POST", + "uri": "/DescribeSourceServers", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "items", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#DescribeSourceServersRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.drs#DescribeSourceServersRequestFilters", + "traits": { + "smithy.api#documentation": "A set of filters by which to return Source Servers.
", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.drs#StrictlyPositiveInteger", + "traits": { + "smithy.api#documentation": "Maximum number of Source Servers to retrieve.
" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "The token of the next Source Server to retrieve.
" + } + } + } + }, + "com.amazonaws.drs#DescribeSourceServersRequestFilters": { + "type": "structure", + "members": { + "sourceServerIDs": { + "target": "com.amazonaws.drs#DescribeSourceServersRequestFiltersIDs", + "traits": { + "smithy.api#documentation": "An array of Source Servers IDs that should be returned. An empty array means all Source Servers.
" + } + }, + "hardwareId": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "An ID that describes the hardware of the Source Server. This is either an EC2 instance id, a VMware uuid or a mac address.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A set of filters by which to return Source Servers.
" + } + }, + "com.amazonaws.drs#DescribeSourceServersRequestFiltersIDs": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#SourceServerID" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.drs#DescribeSourceServersResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.drs#SourceServersList", + "traits": { + "smithy.api#documentation": "An array of Source Servers.
" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "The token of the next Source Server to retrieve.
" + } + } + } + }, + "com.amazonaws.drs#DisconnectRecoveryInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DisconnectRecoveryInstanceRequest" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "Disconnect a Recovery Instance from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Recovery Instance will be terminated / deleted within 90 minutes. If the agent on the Recovery Instance has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the Recovery Instance will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.
", + "smithy.api#http": { + "method": "POST", + "uri": "/DisconnectRecoveryInstance", + "code": 200 + } + } + }, + "com.amazonaws.drs#DisconnectRecoveryInstanceRequest": { + "type": "structure", + "members": { + "recoveryInstanceID": { + "target": "com.amazonaws.drs#RecoveryInstanceID", + "traits": { + "smithy.api#documentation": "The ID of the Recovery Instance to disconnect.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#DisconnectSourceServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DisconnectSourceServerRequest" + }, + "output": { + "target": "com.amazonaws.drs#SourceServer" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "Disconnects a specific Source Server from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Source Server will be terminated / deleted within 90 minutes. You cannot disconnect a Source Server if it has a Recovery Instance. If the agent on the Source Server has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.
", + "smithy.api#http": { + "method": "POST", + "uri": "/DisconnectSourceServer", + "code": 200 + } + } + }, + "com.amazonaws.drs#DisconnectSourceServerRequest": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "The ID of the Source Server to disconnect.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#Disk": { + "type": "structure", + "members": { + "deviceName": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "The disk or device name.
" + } + }, + "bytes": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#documentation": "The amount of storage on the disk in bytes.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing a data storage device on a server.
" + } + }, + "com.amazonaws.drs#Disks": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#Disk" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.drs#EC2InstanceID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^i-[0-9a-fA-F]{8,}$" + } + }, + "com.amazonaws.drs#EC2InstanceState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "STOPPING", + "name": "STOPPING" + }, + { + "value": "STOPPED", + "name": "STOPPED" + }, + { + "value": "SHUTTING-DOWN", + "name": "SHUTTING_DOWN" + }, + { + "value": "TERMINATED", + "name": "TERMINATED" + }, + { + "value": "NOT_FOUND", + "name": "NOT_FOUND" + } + ] + } + }, + "com.amazonaws.drs#EC2InstanceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.drs#EbsSnapshotsList": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#ebsSnapshot" + } + }, + "com.amazonaws.drs#EbsVolumeID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 19 + }, + "smithy.api#pattern": "^vol-([0-9a-fA-F]{8}|[0-9a-fA-F]{17})$" + } + }, + "com.amazonaws.drs#ElasticDisasterRecoveryService": { + "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "drs", + "arnNamespace": "drs", + "cloudFormationName": "ElasticDisasterRecoveryService", + "cloudTrailEventSource": "drs.amazonaws.com", + "endpointPrefix": "drs" + }, + "aws.auth#sigv4": { + "name": "drs" + }, + "aws.iam#defineConditionKeys": { + "drs:EC2InstanceARN": { + "type": "String", + "documentation": "Filters access by the EC2 instance the request originated from" + } + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "X-Amz-Content-Sha256", + "X-Amzn-Trace-Id", + "Content-Type", + "X-Amz-User-Agent" + ], + "additionalExposedHeaders": [ + "X-Amzn-Errortype", + "X-Amzn-Requestid", + "X-Amzn-Trace-Id", + "X-Amz-Apigw-Id" + ] + }, + "smithy.api#documentation": "AWS Elastic Disaster Recovery Service.
", + "smithy.api#title": "Elastic Disaster Recovery Service" + }, + "version": "2020-02-26", + "operations": [ + { + "target": "com.amazonaws.drs#InitializeService" + }, + { + "target": "com.amazonaws.drs#ListTagsForResource" + }, + { + "target": "com.amazonaws.drs#TagResource" + }, + { + "target": "com.amazonaws.drs#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.drs#AccountResource" + }, + { + "target": "com.amazonaws.drs#JobResource" + }, + { + "target": "com.amazonaws.drs#RecoveryInstanceResource" + }, + { + "target": "com.amazonaws.drs#ReplicationConfigurationTemplateResource" + }, + { + "target": "com.amazonaws.drs#SourceServerResource" + } + ] + }, + "com.amazonaws.drs#FailbackReplicationError": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AGENT_NOT_SEEN", + "name": "AGENT_NOT_SEEN" + }, + { + "value": "FAILBACK_CLIENT_NOT_SEEN", + "name": "FAILBACK_CLIENT_NOT_SEEN" + }, + { + "value": "NOT_CONVERGING", + "name": "NOT_CONVERGING" + }, + { + "value": "UNSTABLE_NETWORK", + "name": "UNSTABLE_NETWORK" + }, + { + "value": "FAILED_TO_ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION", + "name": "FAILED_TO_ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION" + }, + { + "value": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT", + "name": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT" + }, + { + "value": "FAILED_TO_CONFIGURE_REPLICATION_SOFTWARE", + "name": "FAILED_TO_CONFIGURE_REPLICATION_SOFTWARE" + }, + { + "value": "FAILED_TO_PAIR_AGENT_WITH_REPLICATION_SOFTWARE", + "name": "FAILED_TO_PAIR_AGENT_WITH_REPLICATION_SOFTWARE" + }, + { + "value": "FAILED_TO_ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION", + "name": "FAILED_TO_ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION" + } + ] + } + }, + "com.amazonaws.drs#FailbackState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FAILBACK_NOT_STARTED", + "name": "FAILBACK_NOT_STARTED" + }, + { + "value": "FAILBACK_IN_PROGRESS", + "name": "FAILBACK_IN_PROGRESS" + }, + { + "value": "FAILBACK_READY_FOR_LAUNCH", + "name": "FAILBACK_READY_FOR_LAUNCH" + }, + { + "value": "FAILBACK_COMPLETED", + "name": "FAILBACK_COMPLETED" + }, + { + "value": "FAILBACK_ERROR", + "name": "FAILBACK_ERROR" + } + ] + } + }, + "com.amazonaws.drs#GetFailbackReplicationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#GetFailbackReplicationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.drs#GetFailbackReplicationConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all Failback ReplicationConfigurations, filtered by Recovery Instance ID.
", + "smithy.api#http": { + "method": "POST", + "uri": "/GetFailbackReplicationConfiguration", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#GetFailbackReplicationConfigurationRequest": { + "type": "structure", + "members": { + "recoveryInstanceID": { + "target": "com.amazonaws.drs#RecoveryInstanceID", + "traits": { + "smithy.api#documentation": "The ID of the Recovery Instance whose failback replication configuration should be returned.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#GetFailbackReplicationConfigurationResponse": { + "type": "structure", + "members": { + "recoveryInstanceID": { + "target": "com.amazonaws.drs#RecoveryInstanceID", + "traits": { + "smithy.api#documentation": "The ID of the Recovery Instance.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "The name of the Failback Replication Configuration.
" + } + }, + "bandwidthThrottling": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#documentation": "Configure bandwidth throttling for the outbound data transfer rate of the Recovery Instance in Mbps.
" + } + }, + "usePrivateIP": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether to use Private IP for the failback replication of the Recovery Instance.
" + } + } + } + }, + "com.amazonaws.drs#GetLaunchConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#GetLaunchConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.drs#LaunchConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a LaunchConfiguration, filtered by Source Server IDs.
", + "smithy.api#http": { + "method": "POST", + "uri": "/GetLaunchConfiguration", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#GetLaunchConfigurationRequest": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "The ID of the Source Server that we want to retrieve a Launch Configuration for.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#GetReplicationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#GetReplicationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.drs#ReplicationConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a ReplicationConfiguration, filtered by Source Server ID.
", + "smithy.api#http": { + "method": "POST", + "uri": "/GetReplicationConfiguration", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#GetReplicationConfigurationRequest": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "The ID of the Source Serve for this Replication Configuration.r
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#IPsList": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#BoundedString" + } + }, + "com.amazonaws.drs#ISO8601DatetimeString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 19, + "max": 32 + }, + "smithy.api#pattern": "^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?Z$" + } + }, + "com.amazonaws.drs#IdentificationHints": { + "type": "structure", + "members": { + "fqdn": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "Fully Qualified Domain Name identification hint.
" + } + }, + "hostname": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "Hostname identification hint.
" + } + }, + "vmWareUuid": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "vCenter VM path identification hint.
" + } + }, + "awsInstanceID": { + "target": "com.amazonaws.drs#EC2InstanceID", + "traits": { + "smithy.api#documentation": "AWS Instance ID identification hint.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Hints used to uniquely identify a machine.
" + } + }, + "com.amazonaws.drs#InitializeService": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#InitializeServiceRequest" + }, + "output": { + "target": "com.amazonaws.drs#InitializeServiceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "iam:CreateServiceLinkedRole", + "iam:GetInstanceProfile", + "iam:CreateInstanceProfile", + "iam:AddRoleToInstanceProfile" + ], + "smithy.api#documentation": "Initialize Elastic Disaster Recovery.
", + "smithy.api#http": { + "method": "POST", + "uri": "/InitializeService", + "code": 204 + } + } + }, + "com.amazonaws.drs#InitializeServiceRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.drs#InitializeServiceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.drs#InitiatedBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "START_RECOVERY", + "name": "START_RECOVERY" + }, + { + "value": "START_DRILL", + "name": "START_DRILL" + }, + { + "value": "FAILBACK", + "name": "FAILBACK" + }, + { + "value": "DIAGNOSTIC", + "name": "DIAGNOSTIC" + }, + { + "value": "TERMINATE_RECOVERY_INSTANCES", + "name": "TERMINATE_RECOVERY_INSTANCES" + } + ] + } + }, + "com.amazonaws.drs#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#required": {} + } + }, + "retryAfterSeconds": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#documentation": "The number of seconds after which the request should be safe to retry.
", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "The request processing has failed because of an unknown error, exception or failure.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.drs#Job": { + "type": "structure", + "members": { + "jobID": { + "target": "com.amazonaws.drs#JobID", + "traits": { + "smithy.api#documentation": "The ID of the Job.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "The ARN of a Job.
" + } + }, + "type": { + "target": "com.amazonaws.drs#JobType", + "traits": { + "smithy.api#documentation": "The type of the Job.
" + } + }, + "initiatedBy": { + "target": "com.amazonaws.drs#InitiatedBy", + "traits": { + "smithy.api#documentation": "A string representing who initiated the Job.
" + } + }, + "creationDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The date and time of when the Job was created.
" + } + }, + "endDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The date and time of when the Job ended.
" + } + }, + "status": { + "target": "com.amazonaws.drs#JobStatus", + "traits": { + "smithy.api#documentation": "The status of the Job.
" + } + }, + "participatingServers": { + "target": "com.amazonaws.drs#ParticipatingServers", + "traits": { + "smithy.api#documentation": "A list of servers that the Job is acting upon.
" + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "A list of tags associated with the Job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A job is an asynchronous workflow.
" + } + }, + "com.amazonaws.drs#JobID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 24, + "max": 24 + }, + "smithy.api#pattern": "^drsjob-[0-9a-zA-Z]{17}$" + } + }, + "com.amazonaws.drs#JobLog": { + "type": "structure", + "members": { + "logDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The date and time the log was taken.
" + } + }, + "event": { + "target": "com.amazonaws.drs#JobLogEvent", + "traits": { + "smithy.api#documentation": "The event represents the type of a log.
" + } + }, + "eventData": { + "target": "com.amazonaws.drs#JobLogEventData", + "traits": { + "smithy.api#documentation": "Metadata associated with a Job log.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A log outputted by a Job.
" + } + }, + "com.amazonaws.drs#JobLogEvent": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "JOB_START", + "name": "JOB_START" + }, + { + "value": "SERVER_SKIPPED", + "name": "SERVER_SKIPPED" + }, + { + "value": "CLEANUP_START", + "name": "CLEANUP_START" + }, + { + "value": "CLEANUP_END", + "name": "CLEANUP_END" + }, + { + "value": "CLEANUP_FAIL", + "name": "CLEANUP_FAIL" + }, + { + "value": "SNAPSHOT_START", + "name": "SNAPSHOT_START" + }, + { + "value": "SNAPSHOT_END", + "name": "SNAPSHOT_END" + }, + { + "value": "SNAPSHOT_FAIL", + "name": "SNAPSHOT_FAIL" + }, + { + "value": "USING_PREVIOUS_SNAPSHOT", + "name": "USING_PREVIOUS_SNAPSHOT" + }, + { + "value": "USING_PREVIOUS_SNAPSHOT_FAILED", + "name": "USING_PREVIOUS_SNAPSHOT_FAILED" + }, + { + "value": "CONVERSION_START", + "name": "CONVERSION_START" + }, + { + "value": "CONVERSION_END", + "name": "CONVERSION_END" + }, + { + "value": "CONVERSION_FAIL", + "name": "CONVERSION_FAIL" + }, + { + "value": "LAUNCH_START", + "name": "LAUNCH_START" + }, + { + "value": "LAUNCH_FAILED", + "name": "LAUNCH_FAILED" + }, + { + "value": "JOB_CANCEL", + "name": "JOB_CANCEL" + }, + { + "value": "JOB_END", + "name": "JOB_END" + } + ] + } + }, + "com.amazonaws.drs#JobLogEventData": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "The ID of a Source Server.
" + } + }, + "conversionServerID": { + "target": "com.amazonaws.drs#EC2InstanceID", + "traits": { + "smithy.api#documentation": "The ID of a conversion server.
" + } + }, + "targetInstanceID": { + "target": "com.amazonaws.drs#EC2InstanceID", + "traits": { + "smithy.api#documentation": "The ID of a Recovery Instance.
" + } + }, + "rawError": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "A string representing a job error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata associated with a Job log.
" + } + }, + "com.amazonaws.drs#JobLogs": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#JobLog" + } + }, + "com.amazonaws.drs#JobResource": { + "type": "resource", + "identifiers": { + "jobID": { + "target": "com.amazonaws.drs#JobID" + } + }, + "delete": { + "target": "com.amazonaws.drs#DeleteJob" + }, + "list": { + "target": "com.amazonaws.drs#DescribeJobs" + }, + "operations": [ + { + "target": "com.amazonaws.drs#DescribeJobLogItems" + } + ], + "traits": { + "aws.api#arn": { + "template": "job/{jobID}", + "absolute": false, + "noAccount": false, + "noRegion": false + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag" + ], + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.drs#JobStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "STARTED", + "name": "STARTED" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + } + ] + } + }, + "com.amazonaws.drs#JobType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LAUNCH", + "name": "LAUNCH" + }, + { + "value": "TERMINATE", + "name": "TERMINATE" + } + ] + } + }, + "com.amazonaws.drs#JobsList": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#Job" + } + }, + "com.amazonaws.drs#LargeBoundedString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 65536 + } + } + }, + "com.amazonaws.drs#LastLaunchResult": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NOT_STARTED", + "name": "NOT_STARTED" + }, + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "SUCCEEDED", + "name": "SUCCEEDED" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.drs#LastLaunchType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RECOVERY", + "name": "RECOVERY" + }, + { + "value": "DRILL", + "name": "DRILL" + } + ] + } + }, + "com.amazonaws.drs#LaunchConfiguration": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "The ID of the Source Server for this launch configuration.
" + } + }, + "name": { + "target": "com.amazonaws.drs#SmallBoundedString", + "traits": { + "smithy.api#documentation": "The name of the launch configuration.
" + } + }, + "ec2LaunchTemplateID": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "The EC2 launch template ID of this launch configuration.
" + } + }, + "launchDisposition": { + "target": "com.amazonaws.drs#LaunchDisposition", + "traits": { + "smithy.api#documentation": "The state of the Recovery Instance in EC2 after the recovery operation.
" + } + }, + "targetInstanceTypeRightSizingMethod": { + "target": "com.amazonaws.drs#TargetInstanceTypeRightSizingMethod", + "traits": { + "smithy.api#documentation": "Whether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.
" + } + }, + "copyPrivateIp": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether we should copy the Private IP of the Source Server to the Recovery Instance.
" + } + }, + "copyTags": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.
" + } + }, + "licensing": { + "target": "com.amazonaws.drs#Licensing", + "traits": { + "smithy.api#documentation": "The licensing configuration to be used for this launch configuration.
" + } + } + } + }, + "com.amazonaws.drs#LaunchDisposition": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "STOPPED", + "name": "STOPPED" + }, + { + "value": "STARTED", + "name": "STARTED" + } + ] + } + }, + "com.amazonaws.drs#LaunchStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "LAUNCHED", + "name": "LAUNCHED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "TERMINATED", + "name": "TERMINATED" + } + ] + } + }, + "com.amazonaws.drs#Licensing": { + "type": "structure", + "members": { + "osByol": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether to enable \"Bring your own license\" or not.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration of a machine's license.
" + } + }, + "com.amazonaws.drs#LifeCycle": { + "type": "structure", + "members": { + "addedToServiceDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The date and time of when the Source Server was added to the service.
" + } + }, + "firstByteDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The date and time of the first byte that was replicated from the Source Server.
" + } + }, + "elapsedReplicationDuration": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The amount of time that the Source Server has been replicating for.
" + } + }, + "lastSeenByServiceDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The date and time this Source Server was last seen by the service.
" + } + }, + "lastLaunch": { + "target": "com.amazonaws.drs#LifeCycleLastLaunch", + "traits": { + "smithy.api#documentation": "An object containing information regarding the last launch of the Source Server.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing the Source Server Lifecycle.
" + } + }, + "com.amazonaws.drs#LifeCycleLastLaunch": { + "type": "structure", + "members": { + "initiated": { + "target": "com.amazonaws.drs#LifeCycleLastLaunchInitiated", + "traits": { + "smithy.api#documentation": "An object containing information regarding the initiation of the last launch of a Source Server.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object containing information regarding the last launch of a Source Server.
" + } + }, + "com.amazonaws.drs#LifeCycleLastLaunchInitiated": { + "type": "structure", + "members": { + "apiCallDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The date and time the last Source Server launch was initiated.
" + } + }, + "jobID": { + "target": "com.amazonaws.drs#JobID", + "traits": { + "smithy.api#documentation": "The ID of the Job that was used to last launch the Source Server.
" + } + }, + "type": { + "target": "com.amazonaws.drs#LastLaunchType", + "traits": { + "smithy.api#documentation": "The Job type that was used to last launch the Source Server.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object containing information regarding the initiation of the last launch of a Source Server.
" + } + }, + "com.amazonaws.drs#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.drs#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List all tags for your Elastic Disaster Recovery resources.
", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the resource whose tags should be returned.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "The tags of the requested resource.
" + } + } + } + }, + "com.amazonaws.drs#NetworkInterface": { + "type": "structure", + "members": { + "macAddress": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "The MAC address of the network interface.
" + } + }, + "ips": { + "target": "com.amazonaws.drs#IPsList", + "traits": { + "smithy.api#documentation": "Network interface IPs.
" + } + }, + "isPrimary": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether this is the primary network interface.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Network interface.
" + } + }, + "com.amazonaws.drs#NetworkInterfaces": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#NetworkInterface" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + } + } + }, + "com.amazonaws.drs#OS": { + "type": "structure", + "members": { + "fullString": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "The long name of the Operating System.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Operating System.
" + } + }, + "com.amazonaws.drs#PITPolicy": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#PITPolicyRule" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.drs#PITPolicyRule": { + "type": "structure", + "members": { + "ruleID": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#documentation": "The ID of the rule.
" + } + }, + "units": { + "target": "com.amazonaws.drs#PITPolicyRuleUnits", + "traits": { + "smithy.api#documentation": "The units used to measure the interval and retentionDuration.
", + "smithy.api#required": {} + } + }, + "interval": { + "target": "com.amazonaws.drs#StrictlyPositiveInteger", + "traits": { + "smithy.api#documentation": "How often, in the chosen units, a snapshot should be taken.
", + "smithy.api#required": {} + } + }, + "retentionDuration": { + "target": "com.amazonaws.drs#StrictlyPositiveInteger", + "traits": { + "smithy.api#documentation": "The duration to retain a snapshot for, in the chosen units.
", + "smithy.api#required": {} + } + }, + "enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether this rule is enabled or not.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A rule in the Point in Time (PIT) policy representing when to take snapshots and how long to retain them for.
" + } + }, + "com.amazonaws.drs#PITPolicyRuleUnits": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MINUTE", + "name": "MINUTE" + }, + { + "value": "HOUR", + "name": "HOUR" + }, + { + "value": "DAY", + "name": "DAY" + } + ] + } + }, + "com.amazonaws.drs#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.drs#ParticipatingServer": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "The Source Server ID of a participating server.
" + } + }, + "recoveryInstanceID": { + "target": "com.amazonaws.drs#RecoveryInstanceID", + "traits": { + "smithy.api#documentation": "The Recovery Instance ID of a participating server.
" + } + }, + "launchStatus": { + "target": "com.amazonaws.drs#LaunchStatus", + "traits": { + "smithy.api#documentation": "The launch status of a participating server.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a server participating in an asynchronous Job.
" + } + }, + "com.amazonaws.drs#ParticipatingServers": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#ParticipatingServer" + } + }, + "com.amazonaws.drs#PositiveInteger": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.drs#RecoveryInstance": { + "type": "structure", + "members": { + "ec2InstanceID": { + "target": "com.amazonaws.drs#EC2InstanceID", + "traits": { + "smithy.api#documentation": "The EC2 instance ID of the Recovery Instance.
" + } + }, + "ec2InstanceState": { + "target": "com.amazonaws.drs#EC2InstanceState", + "traits": { + "smithy.api#documentation": "The state of the EC2 instance for this Recovery Instance.
" + } + }, + "jobID": { + "target": "com.amazonaws.drs#JobID", + "traits": { + "smithy.api#documentation": "The ID of the Job that created the Recovery Instance.
" + } + }, + "recoveryInstanceID": { + "target": "com.amazonaws.drs#RecoveryInstanceID", + "traits": { + "smithy.api#documentation": "The ID of the Recovery Instance.
" + } + }, + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "The Source Server ID that this Recovery Instance is associated with.
" + } + }, + "arn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the Recovery Instance.
" + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "An array of tags that are associated with the Recovery Instance.
" + } + }, + "failback": { + "target": "com.amazonaws.drs#RecoveryInstanceFailback", + "traits": { + "smithy.api#documentation": "An object representing failback related information of the Recovery Instance.
" + } + }, + "dataReplicationInfo": { + "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationInfo", + "traits": { + "smithy.api#documentation": "The Data Replication Info of the Recovery Instance.
" + } + }, + "recoveryInstanceProperties": { + "target": "com.amazonaws.drs#RecoveryInstanceProperties", + "traits": { + "smithy.api#documentation": "Properties of the Recovery Instance machine.
" + } + }, + "pointInTimeSnapshotDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The date and time of the Point in Time (PIT) snapshot that this Recovery Instance was launched from.
" + } + }, + "isDrill": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether this Recovery Instance was created for a drill or for an actual Recovery event.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A Recovery Instance is a replica of a Source Server running on EC2.
" + } + }, + "com.amazonaws.drs#RecoveryInstanceDataReplicationError": { + "type": "structure", + "members": { + "error": { + "target": "com.amazonaws.drs#FailbackReplicationError", + "traits": { + "smithy.api#documentation": "Error in data replication.
" + } + }, + "rawError": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "Error in data replication.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Error in data replication.
" + } + }, + "com.amazonaws.drs#RecoveryInstanceDataReplicationInfo": { + "type": "structure", + "members": { + "lagDuration": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "Data replication lag duration.
" + } + }, + "etaDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "An estimate of when the data replication will be completed.
" + } + }, + "replicatedDisks": { + "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationInfoReplicatedDisks", + "traits": { + "smithy.api#documentation": "The disks that should be replicated.
" + } + }, + "dataReplicationState": { + "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationState", + "traits": { + "smithy.api#documentation": "The state of the data replication.
" + } + }, + "dataReplicationInitiation": { + "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiation", + "traits": { + "smithy.api#documentation": "Information about whether the data replication has been initiated.
" + } + }, + "dataReplicationError": { + "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationError", + "traits": { + "smithy.api#documentation": "Information about Data Replication
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about Data Replication
" + } + }, + "com.amazonaws.drs#RecoveryInstanceDataReplicationInfoReplicatedDisk": { + "type": "structure", + "members": { + "deviceName": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "The name of the device.
" + } + }, + "totalStorageBytes": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#documentation": "The total amount of data to be replicated in bytes.
" + } + }, + "replicatedStorageBytes": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#documentation": "The amount of data replicated so far in bytes.
" + } + }, + "rescannedStorageBytes": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#documentation": "The amount of data to be rescanned in bytes.
" + } + }, + "backloggedStorageBytes": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#documentation": "The size of the replication backlog in bytes.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A disk that should be replicated.
" + } + }, + "com.amazonaws.drs#RecoveryInstanceDataReplicationInfoReplicatedDisks": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationInfoReplicatedDisk" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 60 + } + } + }, + "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiation": { + "type": "structure", + "members": { + "startDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The date and time of the current attempt to initiate data replication.
" + } + }, + "steps": { + "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiationSteps", + "traits": { + "smithy.api#documentation": "The steps of the current attempt to initiate data replication.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Data replication initiation.
" + } + }, + "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiationStep": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiationStepName", + "traits": { + "smithy.api#documentation": "The name of the step.
" + } + }, + "status": { + "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiationStepStatus", + "traits": { + "smithy.api#documentation": "The status of the step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Data replication initiation step.
" + } + }, + "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiationStepName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LINK_FAILBACK_CLIENT_WITH_RECOVERY_INSTANCE", + "name": "LINK_FAILBACK_CLIENT_WITH_RECOVERY_INSTANCE" + }, + { + "value": "COMPLETE_VOLUME_MAPPING", + "name": "COMPLETE_VOLUME_MAPPING" + }, + { + "value": "ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION", + "name": "ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION" + }, + { + "value": "DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT", + "name": "DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT" + }, + { + "value": "CONFIGURE_REPLICATION_SOFTWARE", + "name": "CONFIGURE_REPLICATION_SOFTWARE" + }, + { + "value": "PAIR_AGENT_WITH_REPLICATION_SOFTWARE", + "name": "PAIR_AGENT_WITH_REPLICATION_SOFTWARE" + }, + { + "value": "ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION", + "name": "ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION" + } + ] + } + }, + "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiationStepStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NOT_STARTED", + "name": "NOT_STARTED" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "SUCCEEDED", + "name": "SUCCEEDED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "SKIPPED", + "name": "SKIPPED" + } + ] + } + }, + "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiationSteps": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiationStep" + } + }, + "com.amazonaws.drs#RecoveryInstanceDataReplicationState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "STOPPED", + "name": "STOPPED" + }, + { + "value": "INITIATING", + "name": "INITIATING" + }, + { + "value": "INITIAL_SYNC", + "name": "INITIAL_SYNC" + }, + { + "value": "BACKLOG", + "name": "BACKLOG" + }, + { + "value": "CREATING_SNAPSHOT", + "name": "CREATING_SNAPSHOT" + }, + { + "value": "CONTINUOUS", + "name": "CONTINUOUS" + }, + { + "value": "PAUSED", + "name": "PAUSED" + }, + { + "value": "RESCAN", + "name": "RESCAN" + }, + { + "value": "STALLED", + "name": "STALLED" + }, + { + "value": "DISCONNECTED", + "name": "DISCONNECTED" + } + ] + } + }, + "com.amazonaws.drs#RecoveryInstanceDisk": { + "type": "structure", + "members": { + "internalDeviceName": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "The internal device name of this disk. This is the name that is visible on the machine itself and not from the EC2 console.
" + } + }, + "bytes": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#documentation": "The amount of storage on the disk in bytes.
" + } + }, + "ebsVolumeID": { + "target": "com.amazonaws.drs#EbsVolumeID", + "traits": { + "smithy.api#documentation": "The EBS Volume ID of this disk.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing a block storage device on the Recovery Instance.
" + } + }, + "com.amazonaws.drs#RecoveryInstanceDisks": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#RecoveryInstanceDisk" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.drs#RecoveryInstanceFailback": { + "type": "structure", + "members": { + "failbackClientID": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "The ID of the failback client that this Recovery Instance is associated with.
" + } + }, + "failbackJobID": { + "target": "com.amazonaws.drs#JobID", + "traits": { + "smithy.api#documentation": "The Job ID of the last failback log for this Recovery Instance.
" + } + }, + "failbackInitiationTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The date and time that the failback initiation started.
" + } + }, + "state": { + "target": "com.amazonaws.drs#FailbackState", + "traits": { + "smithy.api#documentation": "The state of the failback process that this Recovery Instance is in.
" + } + }, + "agentLastSeenByServiceDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The date and time the agent on the Recovery Instance was last seen by the service.
" + } + }, + "failbackClientLastSeenByServiceDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The date and time that the failback client was last seen by the service.
" + } + }, + "failbackToOriginalServer": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether we are failing back to the original Source Server for this Recovery Instance.
" + } + }, + "firstByteDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The date and time of the first byte that was replicated from the Recovery Instance.
" + } + }, + "elapsedReplicationDuration": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The amount of time that the Recovery Instance has been replicating for.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing failback related information of the Recovery Instance.
" + } + }, + "com.amazonaws.drs#RecoveryInstanceID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 19 + }, + "smithy.api#pattern": "^i-[0-9a-fA-F]{8,}$" + } + }, + "com.amazonaws.drs#RecoveryInstanceIDs": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#RecoveryInstanceID" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.drs#RecoveryInstanceProperties": { + "type": "structure", + "members": { + "lastUpdatedDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The date and time the Recovery Instance properties were last updated on.
" + } + }, + "identificationHints": { + "target": "com.amazonaws.drs#IdentificationHints", + "traits": { + "smithy.api#documentation": "Hints used to uniquely identify a machine.
" + } + }, + "networkInterfaces": { + "target": "com.amazonaws.drs#NetworkInterfaces", + "traits": { + "smithy.api#documentation": "An array of network interfaces.
" + } + }, + "disks": { + "target": "com.amazonaws.drs#RecoveryInstanceDisks", + "traits": { + "smithy.api#documentation": "An array of disks.
" + } + }, + "cpus": { + "target": "com.amazonaws.drs#Cpus", + "traits": { + "smithy.api#documentation": "An array of CPUs.
" + } + }, + "ramBytes": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#documentation": "The amount of RAM in bytes.
" + } + }, + "os": { + "target": "com.amazonaws.drs#OS", + "traits": { + "smithy.api#documentation": "Operating system.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Properties of the Recovery Instance machine.
" + } + }, + "com.amazonaws.drs#RecoveryInstanceResource": { + "type": "resource", + "identifiers": { + "recoveryInstanceID": { + "target": "com.amazonaws.drs#RecoveryInstanceID" + } + }, + "list": { + "target": "com.amazonaws.drs#DescribeRecoveryInstances" + }, + "operations": [ + { + "target": "com.amazonaws.drs#DeleteRecoveryInstance" + }, + { + "target": "com.amazonaws.drs#DisconnectRecoveryInstance" + }, + { + "target": "com.amazonaws.drs#GetFailbackReplicationConfiguration" + }, + { + "target": "com.amazonaws.drs#StopFailback" + }, + { + "target": "com.amazonaws.drs#UpdateFailbackReplicationConfiguration" + } + ], + "collectionOperations": [ + { + "target": "com.amazonaws.drs#StartFailbackLaunch" + }, + { + "target": "com.amazonaws.drs#TerminateRecoveryInstances" + } + ], + "traits": { + "aws.api#arn": { + "template": "recovery-instance/{recoveryInstanceID}", + "absolute": false, + "noAccount": false, + "noRegion": false + }, + "aws.iam#conditionKeys": [ + "drs:EC2InstanceARN", + "aws:ResourceTag" + ], + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.drs#RecoveryInstancesForTerminationRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#RecoveryInstanceID" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.drs#RecoverySnapshot": { + "type": "structure", + "members": { + "snapshotID": { + "target": "com.amazonaws.drs#RecoverySnapshotID", + "traits": { + "smithy.api#documentation": "The ID of the Recovery Snapshot.
", + "smithy.api#required": {} + } + }, + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "The ID of the Source Server that the snapshot was taken for.
", + "smithy.api#required": {} + } + }, + "expectedTimestamp": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The timestamp of when we expect the snapshot to be taken.
", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The actual timestamp that the snapshot was taken.
" + } + }, + "ebsSnapshots": { + "target": "com.amazonaws.drs#EbsSnapshotsList", + "traits": { + "smithy.api#documentation": "A list of EBS snapshots.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A snapshot of a Source Server used during recovery.
" + } + }, + "com.amazonaws.drs#RecoverySnapshotID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 21, + "max": 21 + }, + "smithy.api#pattern": "^pit-[0-9a-zA-Z]{17}$" + } + }, + "com.amazonaws.drs#RecoverySnapshotsList": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#RecoverySnapshot" + } + }, + "com.amazonaws.drs#RecoverySnapshotsOrder": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ASC", + "name": "ASC" + }, + { + "value": "DESC", + "name": "DESC" + } + ] + } + }, + "com.amazonaws.drs#ReplicationConfiguration": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "The ID of the Source Server for this Replication Configuration.
" + } + }, + "name": { + "target": "com.amazonaws.drs#SmallBoundedString", + "traits": { + "smithy.api#documentation": "The name of the Replication Configuration.
" + } + }, + "stagingAreaSubnetId": { + "target": "com.amazonaws.drs#SubnetID", + "traits": { + "smithy.api#documentation": "The subnet to be used by the replication staging area.
" + } + }, + "associateDefaultSecurityGroup": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.
" + } + }, + "replicationServersSecurityGroupsIDs": { + "target": "com.amazonaws.drs#ReplicationServersSecurityGroupsIDs", + "traits": { + "smithy.api#documentation": "The security group IDs that will be used by the replication server.
" + } + }, + "replicationServerInstanceType": { + "target": "com.amazonaws.drs#EC2InstanceType", + "traits": { + "smithy.api#documentation": "The instance type to be used for the replication server.
" + } + }, + "useDedicatedReplicationServer": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether to use a dedicated Replication Server in the replication staging area.
" + } + }, + "defaultLargeStagingDiskType": { + "target": "com.amazonaws.drs#ReplicationConfigurationDefaultLargeStagingDiskType", + "traits": { + "smithy.api#documentation": "The Staging Disk EBS volume type to be used during replication.
" + } + }, + "replicatedDisks": { + "target": "com.amazonaws.drs#ReplicationConfigurationReplicatedDisks", + "traits": { + "smithy.api#documentation": "The configuration of the disks of the Source Server to be replicated.
" + } + }, + "ebsEncryption": { + "target": "com.amazonaws.drs#ReplicationConfigurationEbsEncryption", + "traits": { + "smithy.api#documentation": "The type of EBS encryption to be used during replication.
" + } + }, + "ebsEncryptionKeyArn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the EBS encryption key to be used during replication.
" + } + }, + "bandwidthThrottling": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#documentation": "Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
" + } + }, + "dataPlaneRouting": { + "target": "com.amazonaws.drs#ReplicationConfigurationDataPlaneRouting", + "traits": { + "smithy.api#documentation": "The data plane routing mechanism that will be used for replication.
" + } + }, + "createPublicIP": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether to create a Public IP for the Recovery Instance by default.
" + } + }, + "stagingAreaTags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
" + } + }, + "pitPolicy": { + "target": "com.amazonaws.drs#PITPolicy", + "traits": { + "smithy.api#documentation": "The Point in time (PIT) policy to manage snapshots taken during replication.
" + } + } + } + }, + "com.amazonaws.drs#ReplicationConfigurationDataPlaneRouting": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PRIVATE_IP", + "name": "PRIVATE_IP" + }, + { + "value": "PUBLIC_IP", + "name": "PUBLIC_IP" + } + ] + } + }, + "com.amazonaws.drs#ReplicationConfigurationDefaultLargeStagingDiskType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "GP2", + "name": "GP2" + }, + { + "value": "GP3", + "name": "GP3" + }, + { + "value": "ST1", + "name": "ST1" + } + ] + } + }, + "com.amazonaws.drs#ReplicationConfigurationEbsEncryption": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DEFAULT", + "name": "DEFAULT" + }, + { + "value": "CUSTOM", + "name": "CUSTOM" + } + ] + } + }, + "com.amazonaws.drs#ReplicationConfigurationReplicatedDisk": { + "type": "structure", + "members": { + "deviceName": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "The name of the device.
" + } + }, + "isBootDisk": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether to boot from this disk or not.
" + } + }, + "stagingDiskType": { + "target": "com.amazonaws.drs#ReplicationConfigurationReplicatedDiskStagingDiskType", + "traits": { + "smithy.api#documentation": "The Staging Disk EBS volume type to be used during replication.
" + } + }, + "iops": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#documentation": "The requested number of I/O operations per second (IOPS).
" + } + }, + "throughput": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#documentation": "The throughput to use for the EBS volume in MiB/s. This parameter is valid only for gp3 volumes.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of a disk of the Source Server to be replicated.
" + } + }, + "com.amazonaws.drs#ReplicationConfigurationReplicatedDiskStagingDiskType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AUTO", + "name": "AUTO" + }, + { + "value": "GP2", + "name": "GP2" + }, + { + "value": "GP3", + "name": "GP3" + }, + { + "value": "IO1", + "name": "IO1" + }, + { + "value": "SC1", + "name": "SC1" + }, + { + "value": "ST1", + "name": "ST1" + }, + { + "value": "STANDARD", + "name": "STANDARD" + } + ] + } + }, + "com.amazonaws.drs#ReplicationConfigurationReplicatedDisks": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#ReplicationConfigurationReplicatedDisk" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 60 + } + } + }, + "com.amazonaws.drs#ReplicationConfigurationTemplate": { + "type": "structure", + "members": { + "replicationConfigurationTemplateID": { + "target": "com.amazonaws.drs#ReplicationConfigurationTemplateID", + "traits": { + "smithy.api#documentation": "The Replication Configuration Template ID.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "The Replication Configuration Template ARN.
" + } + }, + "stagingAreaSubnetId": { + "target": "com.amazonaws.drs#SubnetID", + "traits": { + "smithy.api#documentation": "The subnet to be used by the replication staging area.
" + } + }, + "associateDefaultSecurityGroup": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
" + } + }, + "replicationServersSecurityGroupsIDs": { + "target": "com.amazonaws.drs#ReplicationServersSecurityGroupsIDs", + "traits": { + "smithy.api#documentation": "The security group IDs that will be used by the replication server.
" + } + }, + "replicationServerInstanceType": { + "target": "com.amazonaws.drs#EC2InstanceType", + "traits": { + "smithy.api#documentation": "The instance type to be used for the replication server.
" + } + }, + "useDedicatedReplicationServer": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether to use a dedicated Replication Server in the replication staging area.
" + } + }, + "defaultLargeStagingDiskType": { + "target": "com.amazonaws.drs#ReplicationConfigurationDefaultLargeStagingDiskType", + "traits": { + "smithy.api#documentation": "The Staging Disk EBS volume type to be used during replication.
" + } + }, + "ebsEncryption": { + "target": "com.amazonaws.drs#ReplicationConfigurationEbsEncryption", + "traits": { + "smithy.api#documentation": "The type of EBS encryption to be used during replication.
" + } + }, + "ebsEncryptionKeyArn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the EBS encryption key to be used during replication.
" + } + }, + "bandwidthThrottling": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#documentation": "Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
" + } + }, + "dataPlaneRouting": { + "target": "com.amazonaws.drs#ReplicationConfigurationDataPlaneRouting", + "traits": { + "smithy.api#documentation": "The data plane routing mechanism that will be used for replication.
" + } + }, + "createPublicIP": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether to create a Public IP for the Recovery Instance by default.
" + } + }, + "stagingAreaTags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
" + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "A set of tags to be associated with the Replication Configuration Template resource.
" + } + }, + "pitPolicy": { + "target": "com.amazonaws.drs#PITPolicy", + "traits": { + "smithy.api#documentation": "The Point in time (PIT) policy to manage snapshots taken during replication.
" + } + } + } + }, + "com.amazonaws.drs#ReplicationConfigurationTemplateID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 21, + "max": 21 + }, + "smithy.api#pattern": "^rct-[0-9a-zA-Z]{17}$" + } + }, + "com.amazonaws.drs#ReplicationConfigurationTemplateIDs": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#ReplicationConfigurationTemplateID" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.drs#ReplicationConfigurationTemplateResource": { + "type": "resource", + "identifiers": { + "replicationConfigurationTemplateID": { + "target": "com.amazonaws.drs#ReplicationConfigurationTemplateID" + } + }, + "create": { + "target": "com.amazonaws.drs#CreateReplicationConfigurationTemplate" + }, + "update": { + "target": "com.amazonaws.drs#UpdateReplicationConfigurationTemplate" + }, + "delete": { + "target": "com.amazonaws.drs#DeleteReplicationConfigurationTemplate" + }, + "list": { + "target": "com.amazonaws.drs#DescribeReplicationConfigurationTemplates" + }, + "traits": { + "aws.api#arn": { + "template": "replication-configuration-template/{replicationConfigurationTemplateID}", + "absolute": false, + "noAccount": false, + "noRegion": false + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag" + ], + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.drs#ReplicationConfigurationTemplates": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#ReplicationConfigurationTemplate" + } + }, + "com.amazonaws.drs#ReplicationServersSecurityGroupsIDs": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#SecurityGroupID" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + } + } + }, + "com.amazonaws.drs#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.drs#LargeBoundedString" + }, + "code": { + "target": "com.amazonaws.drs#LargeBoundedString" + }, + "resourceId": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "The ID of the resource.
" + } + }, + "resourceType": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "The type of the resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The resource for this operation was not found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.drs#RetryDataReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#RetryDataReplicationRequest" + }, + "output": { + "target": "com.amazonaws.drs#SourceServer" + }, + "errors": [ + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Causes the data replication initiation sequence to begin immediately upon next Handshake for the specified Source Server ID, regardless of when the previous initiation started. This command will work only if the Source Server is stalled or is in a DISCONNECTED or STOPPED state.
", + "smithy.api#http": { + "method": "POST", + "uri": "/RetryDataReplication", + "code": 200 + } + } + }, + "com.amazonaws.drs#RetryDataReplicationRequest": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "The ID of the Source Server whose data replication should be retried.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#SecurityGroupID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^sg-[0-9a-fA-F]{8,}$" + } + }, + "com.amazonaws.drs#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.drs#LargeBoundedString" + }, + "code": { + "target": "com.amazonaws.drs#LargeBoundedString" + }, + "resourceId": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "The ID of the resource.
" + } + }, + "resourceType": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "The type of the resource.
" + } + }, + "serviceCode": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "Service code.
" + } + }, + "quotaCode": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "Quota code.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request could not be completed because its exceeded the service quota.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.drs#SmallBoundedString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.drs#SourceProperties": { + "type": "structure", + "members": { + "lastUpdatedDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "The date and time the Source Properties were last updated on.
" + } + }, + "recommendedInstanceType": { + "target": "com.amazonaws.drs#EC2InstanceType", + "traits": { + "smithy.api#documentation": "The recommended EC2 instance type that will be used when recovering the Source Server.
" + } + }, + "identificationHints": { + "target": "com.amazonaws.drs#IdentificationHints", + "traits": { + "smithy.api#documentation": "Hints used to uniquely identify a machine.
" + } + }, + "networkInterfaces": { + "target": "com.amazonaws.drs#NetworkInterfaces", + "traits": { + "smithy.api#documentation": "An array of network interfaces.
" + } + }, + "disks": { + "target": "com.amazonaws.drs#Disks", + "traits": { + "smithy.api#documentation": "An array of disks.
" + } + }, + "cpus": { + "target": "com.amazonaws.drs#Cpus", + "traits": { + "smithy.api#documentation": "An array of CPUs.
" + } + }, + "ramBytes": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#documentation": "The amount of RAM in bytes.
" + } + }, + "os": { + "target": "com.amazonaws.drs#OS", + "traits": { + "smithy.api#documentation": "Operating system.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Properties of the Source Server machine.
" + } + }, + "com.amazonaws.drs#SourceServer": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "The ID of the Source Server.
" + } + }, + "arn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the Source Server.
" + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "The tags associated with the Source Server.
" + } + }, + "recoveryInstanceId": { + "target": "com.amazonaws.drs#RecoveryInstanceID", + "traits": { + "smithy.api#documentation": "The ID of the Recovery Instance associated with this Source Server.
" + } + }, + "lastLaunchResult": { + "target": "com.amazonaws.drs#LastLaunchResult", + "traits": { + "smithy.api#documentation": "The status of the last recovery launch of this Source Server.
" + } + }, + "dataReplicationInfo": { + "target": "com.amazonaws.drs#DataReplicationInfo", + "traits": { + "smithy.api#documentation": "The Data Replication Info of the Source Server.
" + } + }, + "lifeCycle": { + "target": "com.amazonaws.drs#LifeCycle", + "traits": { + "smithy.api#documentation": "The lifecycle information of this Source Server.
" + } + }, + "sourceProperties": { + "target": "com.amazonaws.drs#SourceProperties", + "traits": { + "smithy.api#documentation": "The source properties of the Source Server.
" + } + } + }, + "traits": { + "smithy.api#references": [ + { + "resource": "com.amazonaws.drs#SourceServerResource" + } + ] + } + }, + "com.amazonaws.drs#SourceServerID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 19, + "max": 19 + }, + "smithy.api#pattern": "^s-[0-9a-zA-Z]{17}$" + } + }, + "com.amazonaws.drs#SourceServerIDs": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#SourceServerID" + } + }, + "com.amazonaws.drs#SourceServerResource": { + "type": "resource", + "identifiers": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID" + } + }, + "delete": { + "target": "com.amazonaws.drs#DeleteSourceServer" + }, + "list": { + "target": "com.amazonaws.drs#DescribeSourceServers" + }, + "operations": [ + { + "target": "com.amazonaws.drs#DescribeRecoverySnapshots" + }, + { + "target": "com.amazonaws.drs#DisconnectSourceServer" + }, + { + "target": "com.amazonaws.drs#GetLaunchConfiguration" + }, + { + "target": "com.amazonaws.drs#GetReplicationConfiguration" + }, + { + "target": "com.amazonaws.drs#RetryDataReplication" + }, + { + "target": "com.amazonaws.drs#UpdateLaunchConfiguration" + }, + { + "target": "com.amazonaws.drs#UpdateReplicationConfiguration" + } + ], + "collectionOperations": [ + { + "target": "com.amazonaws.drs#StartRecovery" + } + ], + "traits": { + "aws.api#arn": { + "template": "source-server/{sourceServerID}", + "absolute": false, + "noAccount": false, + "noRegion": false + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag" + ], + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.drs#SourceServersList": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#SourceServer" + } + }, + "com.amazonaws.drs#StartFailbackLaunch": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#StartFailbackLaunchRequest" + }, + "output": { + "target": "com.amazonaws.drs#StartFailbackLaunchResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Initiates a Job for launching the machine that is being failed back to from the specified Recovery Instance. This will run conversion on the failback client and will reboot your machine, thus completing the failback process.
", + "smithy.api#http": { + "method": "POST", + "uri": "/StartFailbackLaunch", + "code": 200 + } + } + }, + "com.amazonaws.drs#StartFailbackLaunchRequest": { + "type": "structure", + "members": { + "recoveryInstanceIDs": { + "target": "com.amazonaws.drs#StartFailbackRequestRecoveryInstanceIDs", + "traits": { + "smithy.api#documentation": "The IDs of the Recovery Instance whose failback launch we want to request.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "The tags to be associated with the failback launch Job.
" + } + } + } + }, + "com.amazonaws.drs#StartFailbackLaunchResponse": { + "type": "structure", + "members": { + "job": { + "target": "com.amazonaws.drs#Job", + "traits": { + "smithy.api#documentation": "The failback launch Job.
" + } + } + } + }, + "com.amazonaws.drs#StartFailbackRequestRecoveryInstanceIDs": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#RecoveryInstanceID" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.drs#StartRecovery": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#StartRecoveryRequest" + }, + "output": { + "target": "com.amazonaws.drs#StartRecoveryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "ec2:DetachVolume", + "ec2:DescribeInstances", + "ec2:TerminateInstances", + "ec2:CreateTags", + "ec2:DescribeLaunchTemplateVersions", + "ec2:RunInstances", + "ec2:DescribeSnapshots", + "ec2:StopInstances", + "ec2:CreateLaunchTemplateVersion", + "ec2:DeleteVolume", + "ec2:StartInstances", + "ec2:DescribeVolumes", + "ec2:DeleteLaunchTemplateVersions", + "ec2:AttachVolume", + "ec2:AuthorizeSecurityGroupEgress", + "ec2:AuthorizeSecurityGroupIngress", + "ec2:CreateLaunchTemplate", + "ec2:CreateSnapshot", + "ec2:CreateVolume", + "ec2:DeleteSnapshot", + "ec2:DescribeImages", + "ec2:DescribeInstanceAttribute", + "ec2:DescribeInstanceStatus", + "ec2:DescribeLaunchTemplates", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:ModifyInstanceAttribute", + "ec2:ModifyLaunchTemplate", + "ec2:RevokeSecurityGroupEgress", + "ec2:DescribeAccountAttributes", + "ec2:DescribeAvailabilityZones", + "ec2:DescribeInstanceTypes", + "iam:PassRole", + "drs:CreateRecoveryInstanceForDrs", + "drs:ListTagsForResource" + ], + "smithy.api#documentation": "Launches Recovery Instances for the specified Source Servers. For each Source Server you may choose a point in time snapshot to launch from, or use an on demand snapshot.
", + "smithy.api#http": { + "method": "POST", + "uri": "/StartRecovery", + "code": 202 + } + } + }, + "com.amazonaws.drs#StartRecoveryRequest": { + "type": "structure", + "members": { + "sourceServers": { + "target": "com.amazonaws.drs#StartRecoveryRequestSourceServers", + "traits": { + "smithy.api#documentation": "The Source Servers that we want to start a Recovery Job for.
", + "smithy.api#required": {} + } + }, + "isDrill": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether this Source Server Recovery operation is a drill or not.
" + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "The tags to be associated with the Recovery Job.
" + } + } + } + }, + "com.amazonaws.drs#StartRecoveryRequestSourceServer": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "The ID of the Source Server you want to recover.
", + "smithy.api#required": {} + } + }, + "recoverySnapshotID": { + "target": "com.amazonaws.drs#RecoverySnapshotID", + "traits": { + "smithy.api#documentation": "The ID of a Recovery Snapshot we want to recover from. Omit this field to launch from the latest data by taking an on-demand snapshot.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing the Source Server to recover.
" + } + }, + "com.amazonaws.drs#StartRecoveryRequestSourceServers": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#StartRecoveryRequestSourceServer" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.drs#StartRecoveryResponse": { + "type": "structure", + "members": { + "job": { + "target": "com.amazonaws.drs#Job", + "traits": { + "smithy.api#documentation": "The Recovery Job.
" + } + } + } + }, + "com.amazonaws.drs#StopFailback": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#StopFailbackRequest" + }, + "errors": [ + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "Stops the failback process for a specified Recovery Instance. This changes the Failback State of the Recovery Instance back to FAILBACK_NOT_STARTED.
", + "smithy.api#http": { + "method": "POST", + "uri": "/StopFailback", + "code": 200 + } + } + }, + "com.amazonaws.drs#StopFailbackRequest": { + "type": "structure", + "members": { + "recoveryInstanceID": { + "target": "com.amazonaws.drs#RecoveryInstanceID", + "traits": { + "smithy.api#documentation": "The ID of the Recovery Instance we want to stop failback for.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#StrictlyPositiveInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.drs#SubnetID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^subnet-[0-9a-fA-F]{8,}$" + } + }, + "com.amazonaws.drs#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.drs#TagKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#TagKey" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.drs#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#TagResourceRequest" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Adds or overwrites only the specified tags for the specified Elastic Disaster Recovery resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.drs#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "ARN of the resource for which tags are to be added or updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "Array of tags to be added or updated.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.drs#TagsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.drs#TagKey" + }, + "value": { + "target": "com.amazonaws.drs#TagValue" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.drs#TargetInstanceTypeRightSizingMethod": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "BASIC", + "name": "BASIC" + } + ] + } + }, + "com.amazonaws.drs#TerminateRecoveryInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#TerminateRecoveryInstancesRequest" + }, + "output": { + "target": "com.amazonaws.drs#TerminateRecoveryInstancesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "ec2:DescribeVolumes", + "ec2:DescribeInstances", + "ec2:TerminateInstances", + "ec2:DeleteVolume" + ], + "smithy.api#documentation": "Initiates a Job for terminating the EC2 resources associated with the specified Recovery Instances, and then will delete the Recovery Instances from the Elastic Disaster Recovery service.
", + "smithy.api#http": { + "method": "POST", + "uri": "/TerminateRecoveryInstances", + "code": 200 + } + } + }, + "com.amazonaws.drs#TerminateRecoveryInstancesRequest": { + "type": "structure", + "members": { + "recoveryInstanceIDs": { + "target": "com.amazonaws.drs#RecoveryInstancesForTerminationRequest", + "traits": { + "smithy.api#documentation": "The IDs of the Recovery Instances that should be terminated.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#TerminateRecoveryInstancesResponse": { + "type": "structure", + "members": { + "job": { + "target": "com.amazonaws.drs#Job", + "traits": { + "smithy.api#documentation": "The Job for terminating the Recovery Instances.
" + } + } + } + }, + "com.amazonaws.drs#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#required": {} + } + }, + "serviceCode": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "Service code.
" + } + }, + "quotaCode": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "Quota code.
" + } + }, + "retryAfterSeconds": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "The number of seconds after which the request should be safe to retry.
", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.drs#UninitializedAccountException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.drs#LargeBoundedString" + }, + "code": { + "target": "com.amazonaws.drs#LargeBoundedString" + } + }, + "traits": { + "smithy.api#documentation": "The account performing the request has not been initialized.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.drs#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#UntagResourceRequest" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified set of tags from the specified set of Elastic Disaster Recovery resources.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.drs#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "ARN of the resource for which tags are to be removed.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.drs#TagKeys", + "traits": { + "smithy.api#documentation": "Array of tags to be removed.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#UpdateFailbackReplicationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#UpdateFailbackReplicationConfigurationRequest" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "Allows you to update the failback replication configuration of a Recovery Instance by ID.
", + "smithy.api#http": { + "method": "POST", + "uri": "/UpdateFailbackReplicationConfiguration", + "code": 200 + } + } + }, + "com.amazonaws.drs#UpdateFailbackReplicationConfigurationRequest": { + "type": "structure", + "members": { + "recoveryInstanceID": { + "target": "com.amazonaws.drs#RecoveryInstanceID", + "traits": { + "smithy.api#documentation": "The ID of the Recovery Instance.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "The name of the Failback Replication Configuration.
" + } + }, + "bandwidthThrottling": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#documentation": "Configure bandwidth throttling for the outbound data transfer rate of the Recovery Instance in Mbps.
" + } + }, + "usePrivateIP": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether to use Private IP for the failback replication of the Recovery Instance.
" + } + } + } + }, + "com.amazonaws.drs#UpdateLaunchConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#UpdateLaunchConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.drs#LaunchConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a LaunchConfiguration by Source Server ID.
", + "smithy.api#http": { + "method": "POST", + "uri": "/UpdateLaunchConfiguration", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.drs#UpdateLaunchConfigurationRequest": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "The ID of the Source Server that we want to retrieve a Launch Configuration for.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.drs#SmallBoundedString", + "traits": { + "smithy.api#documentation": "The name of the launch configuration.
" + } + }, + "launchDisposition": { + "target": "com.amazonaws.drs#LaunchDisposition", + "traits": { + "smithy.api#documentation": "The state of the Recovery Instance in EC2 after the recovery operation.
" + } + }, + "targetInstanceTypeRightSizingMethod": { + "target": "com.amazonaws.drs#TargetInstanceTypeRightSizingMethod", + "traits": { + "smithy.api#documentation": "Whether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.
" + } + }, + "copyPrivateIp": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether we should copy the Private IP of the Source Server to the Recovery Instance.
" + } + }, + "copyTags": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.
" + } + }, + "licensing": { + "target": "com.amazonaws.drs#Licensing", + "traits": { + "smithy.api#documentation": "The licensing configuration to be used for this launch configuration.
" + } + } + } + }, + "com.amazonaws.drs#UpdateReplicationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#UpdateReplicationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.drs#ReplicationConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Allows you to update a ReplicationConfiguration by Source Server ID.
", + "smithy.api#http": { + "method": "POST", + "uri": "/UpdateReplicationConfiguration", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.drs#UpdateReplicationConfigurationRequest": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "The ID of the Source Server for this Replication Configuration.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.drs#SmallBoundedString", + "traits": { + "smithy.api#documentation": "The name of the Replication Configuration.
" + } + }, + "stagingAreaSubnetId": { + "target": "com.amazonaws.drs#SubnetID", + "traits": { + "smithy.api#documentation": "The subnet to be used by the replication staging area.
" + } + }, + "associateDefaultSecurityGroup": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.
" + } + }, + "replicationServersSecurityGroupsIDs": { + "target": "com.amazonaws.drs#ReplicationServersSecurityGroupsIDs", + "traits": { + "smithy.api#documentation": "The security group IDs that will be used by the replication server.
" + } + }, + "replicationServerInstanceType": { + "target": "com.amazonaws.drs#EC2InstanceType", + "traits": { + "smithy.api#documentation": "The instance type to be used for the replication server.
" + } + }, + "useDedicatedReplicationServer": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether to use a dedicated Replication Server in the replication staging area.
" + } + }, + "defaultLargeStagingDiskType": { + "target": "com.amazonaws.drs#ReplicationConfigurationDefaultLargeStagingDiskType", + "traits": { + "smithy.api#documentation": "The Staging Disk EBS volume type to be used during replication.
" + } + }, + "replicatedDisks": { + "target": "com.amazonaws.drs#ReplicationConfigurationReplicatedDisks", + "traits": { + "smithy.api#documentation": "The configuration of the disks of the Source Server to be replicated.
" + } + }, + "ebsEncryption": { + "target": "com.amazonaws.drs#ReplicationConfigurationEbsEncryption", + "traits": { + "smithy.api#documentation": "The type of EBS encryption to be used during replication.
" + } + }, + "ebsEncryptionKeyArn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the EBS encryption key to be used during replication.
" + } + }, + "bandwidthThrottling": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#documentation": "Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
" + } + }, + "dataPlaneRouting": { + "target": "com.amazonaws.drs#ReplicationConfigurationDataPlaneRouting", + "traits": { + "smithy.api#documentation": "The data plane routing mechanism that will be used for replication.
" + } + }, + "createPublicIP": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether to create a Public IP for the Recovery Instance by default.
" + } + }, + "stagingAreaTags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
" + } + }, + "pitPolicy": { + "target": "com.amazonaws.drs#PITPolicy", + "traits": { + "smithy.api#documentation": "The Point in time (PIT) policy to manage snapshots taken during replication.
" + } + } + } + }, + "com.amazonaws.drs#UpdateReplicationConfigurationTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#UpdateReplicationConfigurationTemplateRequest" + }, + "output": { + "target": "com.amazonaws.drs#ReplicationConfigurationTemplate" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a ReplicationConfigurationTemplate by ID.
", + "smithy.api#http": { + "method": "POST", + "uri": "/UpdateReplicationConfigurationTemplate", + "code": 200 + } + } + }, + "com.amazonaws.drs#UpdateReplicationConfigurationTemplateRequest": { + "type": "structure", + "members": { + "replicationConfigurationTemplateID": { + "target": "com.amazonaws.drs#ReplicationConfigurationTemplateID", + "traits": { + "smithy.api#documentation": "The Replication Configuration Template ID.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "The Replication Configuration Template ARN.
" + } + }, + "stagingAreaSubnetId": { + "target": "com.amazonaws.drs#SubnetID", + "traits": { + "smithy.api#documentation": "The subnet to be used by the replication staging area.
" + } + }, + "associateDefaultSecurityGroup": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
" + } + }, + "replicationServersSecurityGroupsIDs": { + "target": "com.amazonaws.drs#ReplicationServersSecurityGroupsIDs", + "traits": { + "smithy.api#documentation": "The security group IDs that will be used by the replication server.
" + } + }, + "replicationServerInstanceType": { + "target": "com.amazonaws.drs#EC2InstanceType", + "traits": { + "smithy.api#documentation": "The instance type to be used for the replication server.
" + } + }, + "useDedicatedReplicationServer": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether to use a dedicated Replication Server in the replication staging area.
" + } + }, + "defaultLargeStagingDiskType": { + "target": "com.amazonaws.drs#ReplicationConfigurationDefaultLargeStagingDiskType", + "traits": { + "smithy.api#documentation": "The Staging Disk EBS volume type to be used during replication.
" + } + }, + "ebsEncryption": { + "target": "com.amazonaws.drs#ReplicationConfigurationEbsEncryption", + "traits": { + "smithy.api#documentation": "The type of EBS encryption to be used during replication.
" + } + }, + "ebsEncryptionKeyArn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the EBS encryption key to be used during replication.
" + } + }, + "bandwidthThrottling": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#documentation": "Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
" + } + }, + "dataPlaneRouting": { + "target": "com.amazonaws.drs#ReplicationConfigurationDataPlaneRouting", + "traits": { + "smithy.api#documentation": "The data plane routing mechanism that will be used for replication.
" + } + }, + "createPublicIP": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether to create a Public IP for the Recovery Instance by default.
" + } + }, + "stagingAreaTags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
" + } + }, + "pitPolicy": { + "target": "com.amazonaws.drs#PITPolicy", + "traits": { + "smithy.api#documentation": "The Point in time (PIT) policy to manage snapshots taken during replication.
" + } + } + } + }, + "com.amazonaws.drs#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.drs#LargeBoundedString" + }, + "code": { + "target": "com.amazonaws.drs#LargeBoundedString" + }, + "reason": { + "target": "com.amazonaws.drs#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "Validation exception reason.
" + } + }, + "fieldList": { + "target": "com.amazonaws.drs#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "A list of fields that failed validation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by the AWS service.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.drs#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "Validate exception field name.
" + } + }, + "message": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "Validate exception field message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Validate exception field.
" + } + }, + "com.amazonaws.drs#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#ValidationExceptionField" + } + }, + "com.amazonaws.drs#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "unknownOperation", + "name": "UNKNOWN_OPERATION" + }, + { + "value": "cannotParse", + "name": "CANNOT_PARSE" + }, + { + "value": "fieldValidationFailed", + "name": "FIELD_VALIDATION_FAILED" + }, + { + "value": "other", + "name": "OTHER" + } + ] + } + }, + "com.amazonaws.drs#ebsSnapshot": { + "type": "string", + "traits": { + "smithy.api#pattern": "^snap-[0-9a-zA-Z]{17}$" + } + } + } +} diff --git a/aws/sdk/aws-models/dynamodb.json b/aws/sdk/aws-models/dynamodb.json index 010f40951d5a494e53879e6459d59b313c99454a..5b6f3724d43712039c3c558379123e438e159262 100644 --- a/aws/sdk/aws-models/dynamodb.json +++ b/aws/sdk/aws-models/dynamodb.json @@ -762,6 +762,9 @@ "smithy.api#documentation": "The list of PartiQL statements representing the batch to run.
", "smithy.api#required": {} } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" } } }, @@ -773,6 +776,12 @@ "traits": { "smithy.api#documentation": "The response to each PartiQL statement in the batch.
" } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityMultiple", + "traits": { + "smithy.api#documentation": "The capacity units consumed by the entire operation. The values of the list are\n ordered according to the ordering of the statements.
" + } } } }, @@ -1813,6 +1822,12 @@ "traits": { "smithy.api#documentation": "Replica-specific global secondary index settings.
" } + }, + "TableClassOverride": { + "target": "com.amazonaws.dynamodb#TableClass", + "traits": { + "smithy.api#documentation": "Replica-specific table class. If not specified, uses the source table's\n table class.
" + } } }, "traits": { @@ -1913,6 +1928,12 @@ "traits": { "smithy.api#documentation": "A list of key-value pairs to label the table. For more information, see Tagging\n for DynamoDB.
" } + }, + "TableClass": { + "target": "com.amazonaws.dynamodb#TableClass", + "traits": { + "smithy.api#documentation": "The table class of the new table. Valid values are STANDARD and\n STANDARD_INFREQUENT_ACCESS.
Set this value to get remaining results, if NextToken was returned in the\n statement response.
If the response of a read request exceeds the response payload limit DynamoDB will set\n this value in the response. If set, you can use that this value in the subsequent\n request to get the remaining results.
" } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacity" } } }, @@ -3405,6 +3432,12 @@ "smithy.api#documentation": "Set this value to get remaining results, if NextToken was returned in the\n statement response.
Determines the level of detail about either provisioned or on-demand throughput consumption that is\n returned in the response. For more information, see TransactGetItems and TransactWriteItems.
" + } } } }, @@ -3416,6 +3449,12 @@ "traits": { "smithy.api#documentation": "The response to a PartiQL transaction.
" } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityMultiple", + "traits": { + "smithy.api#documentation": "The capacity units consumed by the entire operation. The values of the list are\n ordered according to the ordering of the statements.
" + } } } }, @@ -6261,6 +6300,9 @@ "traits": { "smithy.api#documentation": "The time at which the replica was first detected as inaccessible. To determine cause\n of inaccessibility check the ReplicaStatus property.
Replica global secondary index settings for the global table.
" } + }, + "ReplicaTableClassSummary": { + "target": "com.amazonaws.dynamodb#TableClassSummary" } }, "traits": { @@ -6584,6 +6629,12 @@ "traits": { "smithy.api#documentation": "Represents the settings of a global secondary index for a global table that will be\n modified.
" } + }, + "ReplicaTableClass": { + "target": "com.amazonaws.dynamodb#TableClass", + "traits": { + "smithy.api#documentation": "Replica-specific table class. If not specified, uses the source table's\n table class.
" + } } }, "traits": { @@ -7016,7 +7067,7 @@ "com.amazonaws.dynamodb#ReturnConsumedCapacity": { "type": "string", "traits": { - "smithy.api#documentation": "Determines the level of detail about provisioned throughput consumption that is\n returned in the response:
\n\n INDEXES - The response includes the aggregate\n ConsumedCapacity for the operation, together with\n ConsumedCapacity for each table and secondary index that was\n accessed.
Note that some operations, such as GetItem and\n BatchGetItem, do not access any indexes at all. In these cases,\n specifying INDEXES will only return ConsumedCapacity\n information for table(s).
\n TOTAL - The response includes only the aggregate\n ConsumedCapacity for the operation.
\n NONE - No ConsumedCapacity details are included in the\n response.
Determines the level of detail about either provisioned or on-demand throughput\n consumption that is returned in the response:
\n\n INDEXES - The response includes the aggregate\n ConsumedCapacity for the operation, together with\n ConsumedCapacity for each table and secondary index that was\n accessed.
Note that some operations, such as GetItem and\n BatchGetItem, do not access any indexes at all. In these cases,\n specifying INDEXES will only return ConsumedCapacity\n information for table(s).
\n TOTAL - The response includes only the aggregate\n ConsumedCapacity for the operation.
\n NONE - No ConsumedCapacity details are included in the\n response.
Represents the auto scaling configuration for a global table.
" } }, + "com.amazonaws.dynamodb#TableClass": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "STANDARD", + "name": "STANDARD" + }, + { + "value": "STANDARD_INFREQUENT_ACCESS", + "name": "STANDARD_INFREQUENT_ACCESS" + } + ] + } + }, + "com.amazonaws.dynamodb#TableClassSummary": { + "type": "structure", + "members": { + "TableClass": { + "target": "com.amazonaws.dynamodb#TableClass", + "traits": { + "smithy.api#documentation": "The table class of the specified table. Valid values are STANDARD and\n STANDARD_INFREQUENT_ACCESS.
The date and time at which the table class was last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details of the table class.
" + } + }, "com.amazonaws.dynamodb#TableCreationDateTime": { "type": "timestamp" }, @@ -7829,6 +7915,12 @@ "traits": { "smithy.api#documentation": "Contains information about the table archive.
" } + }, + "TableClassSummary": { + "target": "com.amazonaws.dynamodb#TableClassSummary", + "traits": { + "smithy.api#documentation": "Contains details of the table class.
" + } } }, "traits": { @@ -8959,6 +9051,12 @@ "traits": { "smithy.api#documentation": "Replica-specific global secondary index settings.
" } + }, + "TableClassOverride": { + "target": "com.amazonaws.dynamodb#TableClass", + "traits": { + "smithy.api#documentation": "Replica-specific table class. If not specified, uses the source table's\n table class.
" + } } }, "traits": { @@ -9048,6 +9146,12 @@ "traits": { "smithy.api#documentation": "A list of replica update actions (create, delete, or update) for the table.
\nThis property only applies to Version\n 2019.11.21 of global tables.
\nThe table class of the table to be updated. Valid values are STANDARD and\n STANDARD_INFREQUENT_ACCESS.
The ID of the Network Access Scope analysis.
", + "smithy.api#xmlName": "networkInsightsAccessScopeAnalysisId" + } + }, + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeId", + "smithy.api#documentation": "The ID of the Network Access Scope.
", + "smithy.api#xmlName": "networkInsightsAccessScopeId" + } + }, + "FindingId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FindingId", + "smithy.api#documentation": "The ID of the finding.
", + "smithy.api#xmlName": "findingId" + } + }, + "FindingComponents": { + "target": "com.amazonaws.ec2#PathComponentList", + "traits": { + "aws.protocols#ec2QueryName": "FindingComponentSet", + "smithy.api#documentation": "The finding components.
", + "smithy.api#xmlName": "findingComponentSet" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a finding for a Network Access Scope.
" + } + }, + "com.amazonaws.ec2#AccessScopeAnalysisFindingList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AccessScopeAnalysisFinding", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AccessScopePath": { + "type": "structure", + "members": { + "Source": { + "target": "com.amazonaws.ec2#PathStatement", + "traits": { + "aws.protocols#ec2QueryName": "Source", + "smithy.api#documentation": "The source.
", + "smithy.api#xmlName": "source" + } + }, + "Destination": { + "target": "com.amazonaws.ec2#PathStatement", + "traits": { + "aws.protocols#ec2QueryName": "Destination", + "smithy.api#documentation": "The destination.
", + "smithy.api#xmlName": "destination" + } + }, + "ThroughResources": { + "target": "com.amazonaws.ec2#ThroughResourcesStatementList", + "traits": { + "aws.protocols#ec2QueryName": "ThroughResourceSet", + "smithy.api#documentation": "The through resources.
", + "smithy.api#xmlName": "throughResourceSet" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a path.
" + } + }, + "com.amazonaws.ec2#AccessScopePathList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AccessScopePath", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AccessScopePathListRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AccessScopePathRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AccessScopePathRequest": { + "type": "structure", + "members": { + "Source": { + "target": "com.amazonaws.ec2#PathStatementRequest", + "traits": { + "smithy.api#documentation": "The source.
" + } + }, + "Destination": { + "target": "com.amazonaws.ec2#PathStatementRequest", + "traits": { + "smithy.api#documentation": "The destination.
" + } + }, + "ThroughResources": { + "target": "com.amazonaws.ec2#ThroughResourcesStatementRequestList", + "traits": { + "smithy.api#documentation": "The through resources.
", + "smithy.api#xmlName": "ThroughResource" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a path.
" + } + }, "com.amazonaws.ec2#AccountAttribute": { "type": "structure", "members": { @@ -668,6 +794,32 @@ ] } }, + "com.amazonaws.ec2#AddIpamOperatingRegion": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "The name of the operating Region.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Add an operating Region to an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only\n discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
\nFor more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.\n
" + } + }, + "com.amazonaws.ec2#AddIpamOperatingRegionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AddIpamOperatingRegion" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, "com.amazonaws.ec2#AddPrefixListEntries": { "type": "list", "member": { @@ -872,6 +1024,21 @@ ] } }, + "com.amazonaws.ec2#AddressFamily": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ipv4", + "name": "ipv4" + }, + { + "value": "ipv6", + "name": "ipv6" + } + ] + } + }, "com.amazonaws.ec2#AddressList": { "type": "list", "member": { @@ -1182,6 +1349,87 @@ "smithy.api#documentation": "Contains the output of AllocateHosts.
" } }, + "com.amazonaws.ec2#AllocateIpamPoolCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AllocateIpamPoolCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AllocateIpamPoolCidrResult" + }, + "traits": { + "smithy.api#documentation": "Allocate a CIDR from an IPAM pool. In IPAM, an allocation is a CIDR assignment from an IPAM pool to another resource or IPAM pool. For more information, see Allocate CIDRs in the Amazon VPC IPAM User Guide.\n
" + } + }, + "com.amazonaws.ec2#AllocateIpamPoolCidrRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the IPAM pool from which you would like to allocate a CIDR.
", + "smithy.api#required": {} + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "The CIDR you would like to allocate from the IPAM pool. Note the following:
\nIf there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
\nIf the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
\nPossible values: Any available IPv4 or IPv6 CIDR.
" + } + }, + "NetmaskLength": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:
\nIf there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
\nIf the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
\nPossible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "A description for the allocation.
" + } + }, + "PreviewNextCidr": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A preview of the next available CIDR in a pool.
" + } + }, + "DisallowedCidrs": { + "target": "com.amazonaws.ec2#IpamPoolAllocationDisallowedCidrs", + "traits": { + "smithy.api#documentation": "Exclude a particular CIDR range from being returned by the pool.
", + "smithy.api#xmlName": "DisallowedCidr" + } + } + } + }, + "com.amazonaws.ec2#AllocateIpamPoolCidrResult": { + "type": "structure", + "members": { + "IpamPoolAllocation": { + "target": "com.amazonaws.ec2#IpamPoolAllocation", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolAllocation", + "smithy.api#documentation": "Information about the allocation created.
", + "smithy.api#xmlName": "ipamPoolAllocation" + } + } + } + }, "com.amazonaws.ec2#AllocationId": { "type": "string" }, @@ -1387,6 +1635,9 @@ { "target": "com.amazonaws.ec2#AllocateHosts" }, + { + "target": "com.amazonaws.ec2#AllocateIpamPoolCidr" + }, { "target": "com.amazonaws.ec2#ApplySecurityGroupsToClientVpnTargetNetwork" }, @@ -1549,6 +1800,15 @@ { "target": "com.amazonaws.ec2#CreateInternetGateway" }, + { + "target": "com.amazonaws.ec2#CreateIpam" + }, + { + "target": "com.amazonaws.ec2#CreateIpamPool" + }, + { + "target": "com.amazonaws.ec2#CreateIpamScope" + }, { "target": "com.amazonaws.ec2#CreateKeyPair" }, @@ -1576,6 +1836,9 @@ { "target": "com.amazonaws.ec2#CreateNetworkAclEntry" }, + { + "target": "com.amazonaws.ec2#CreateNetworkInsightsAccessScope" + }, { "target": "com.amazonaws.ec2#CreateNetworkInsightsPath" }, @@ -1588,6 +1851,9 @@ { "target": "com.amazonaws.ec2#CreatePlacementGroup" }, + { + "target": "com.amazonaws.ec2#CreatePublicIpv4Pool" + }, { "target": "com.amazonaws.ec2#CreateReplaceRootVolumeTask" }, @@ -1726,6 +1992,15 @@ { "target": "com.amazonaws.ec2#DeleteInternetGateway" }, + { + "target": "com.amazonaws.ec2#DeleteIpam" + }, + { + "target": "com.amazonaws.ec2#DeleteIpamPool" + }, + { + "target": "com.amazonaws.ec2#DeleteIpamScope" + }, { "target": "com.amazonaws.ec2#DeleteKeyPair" }, @@ -1753,6 +2028,12 @@ { "target": "com.amazonaws.ec2#DeleteNetworkAclEntry" }, + { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsAccessScope" + }, + { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeAnalysis" + }, { "target": "com.amazonaws.ec2#DeleteNetworkInsightsAnalysis" }, @@ -1768,6 +2049,9 @@ { "target": "com.amazonaws.ec2#DeletePlacementGroup" }, + { + "target": "com.amazonaws.ec2#DeletePublicIpv4Pool" + }, { "target": "com.amazonaws.ec2#DeleteQueuedReservedInstances" }, @@ -1864,6 +2148,12 @@ { "target": "com.amazonaws.ec2#DeprovisionByoipCidr" }, + { + "target": "com.amazonaws.ec2#DeprovisionIpamPoolCidr" + }, + { + "target": "com.amazonaws.ec2#DeprovisionPublicIpv4PoolCidr" + }, { "target": "com.amazonaws.ec2#DeregisterImage" }, @@ -2026,6 +2316,15 @@ { "target": "com.amazonaws.ec2#DescribeInternetGateways" }, + { + "target": "com.amazonaws.ec2#DescribeIpamPools" + }, + { + "target": "com.amazonaws.ec2#DescribeIpams" + }, + { + "target": "com.amazonaws.ec2#DescribeIpamScopes" + }, { "target": "com.amazonaws.ec2#DescribeIpv6Pools" }, @@ -2068,6 +2367,12 @@ { "target": "com.amazonaws.ec2#DescribeNetworkAcls" }, + { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopeAnalyses" + }, + { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopes" + }, { "target": "com.amazonaws.ec2#DescribeNetworkInsightsAnalyses" }, @@ -2137,6 +2442,9 @@ { "target": "com.amazonaws.ec2#DescribeSnapshots" }, + { + "target": "com.amazonaws.ec2#DescribeSnapshotTierStatus" + }, { "target": "com.amazonaws.ec2#DescribeSpotDatafeedSubscription" }, @@ -2278,6 +2586,9 @@ { "target": "com.amazonaws.ec2#DisableImageDeprecation" }, + { + "target": "com.amazonaws.ec2#DisableIpamOrganizationAdminAccount" + }, { "target": "com.amazonaws.ec2#DisableSerialConsoleAccess" }, @@ -2335,6 +2646,9 @@ { "target": "com.amazonaws.ec2#EnableImageDeprecation" }, + { + "target": "com.amazonaws.ec2#EnableIpamOrganizationAdminAccount" + }, { "target": "com.amazonaws.ec2#EnableSerialConsoleAccess" }, @@ -2404,6 +2718,18 @@ { "target": "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirements" }, + { + "target": "com.amazonaws.ec2#GetIpamAddressHistory" + }, + { + "target": "com.amazonaws.ec2#GetIpamPoolAllocations" + }, + { + "target": "com.amazonaws.ec2#GetIpamPoolCidrs" + }, + { + "target": "com.amazonaws.ec2#GetIpamResourceCidrs" + }, { "target": "com.amazonaws.ec2#GetLaunchTemplateData" }, @@ -2413,6 +2739,12 @@ { "target": "com.amazonaws.ec2#GetManagedPrefixListEntries" }, + { + "target": "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindings" + }, + { + "target": "com.amazonaws.ec2#GetNetworkInsightsAccessScopeContent" + }, { "target": "com.amazonaws.ec2#GetPasswordData" }, @@ -2467,6 +2799,9 @@ { "target": "com.amazonaws.ec2#ImportVolume" }, + { + "target": "com.amazonaws.ec2#ListSnapshotsInRecycleBin" + }, { "target": "com.amazonaws.ec2#ModifyAddressAttribute" }, @@ -2527,6 +2862,18 @@ { "target": "com.amazonaws.ec2#ModifyInstancePlacement" }, + { + "target": "com.amazonaws.ec2#ModifyIpam" + }, + { + "target": "com.amazonaws.ec2#ModifyIpamPool" + }, + { + "target": "com.amazonaws.ec2#ModifyIpamResourceCidr" + }, + { + "target": "com.amazonaws.ec2#ModifyIpamScope" + }, { "target": "com.amazonaws.ec2#ModifyLaunchTemplate" }, @@ -2536,6 +2883,9 @@ { "target": "com.amazonaws.ec2#ModifyNetworkInterfaceAttribute" }, + { + "target": "com.amazonaws.ec2#ModifyPrivateDnsNameOptions" + }, { "target": "com.amazonaws.ec2#ModifyReservedInstances" }, @@ -2545,6 +2895,9 @@ { "target": "com.amazonaws.ec2#ModifySnapshotAttribute" }, + { + "target": "com.amazonaws.ec2#ModifySnapshotTier" + }, { "target": "com.amazonaws.ec2#ModifySpotFleetRequest" }, @@ -2614,9 +2967,18 @@ { "target": "com.amazonaws.ec2#MoveAddressToVpc" }, + { + "target": "com.amazonaws.ec2#MoveByoipCidrToIpam" + }, { "target": "com.amazonaws.ec2#ProvisionByoipCidr" }, + { + "target": "com.amazonaws.ec2#ProvisionIpamPoolCidr" + }, + { + "target": "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidr" + }, { "target": "com.amazonaws.ec2#PurchaseHostReservation" }, @@ -2662,6 +3024,9 @@ { "target": "com.amazonaws.ec2#ReleaseHosts" }, + { + "target": "com.amazonaws.ec2#ReleaseIpamPoolAllocation" + }, { "target": "com.amazonaws.ec2#ReplaceIamInstanceProfileAssociation" }, @@ -2716,6 +3081,12 @@ { "target": "com.amazonaws.ec2#RestoreManagedPrefixListVersion" }, + { + "target": "com.amazonaws.ec2#RestoreSnapshotFromRecycleBin" + }, + { + "target": "com.amazonaws.ec2#RestoreSnapshotTier" + }, { "target": "com.amazonaws.ec2#RevokeClientVpnIngress" }, @@ -2746,6 +3117,9 @@ { "target": "com.amazonaws.ec2#StartInstances" }, + { + "target": "com.amazonaws.ec2#StartNetworkInsightsAccessScopeAnalysis" + }, { "target": "com.amazonaws.ec2#StartNetworkInsightsAnalysis" }, @@ -2855,6 +3229,14 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the component.
", "smithy.api#xmlName": "arn" } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "The name of the analysis component.
", + "smithy.api#xmlName": "name" + } } }, "traits": { @@ -3951,7 +4333,7 @@ "target": "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociation", "traits": { "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociation", - "smithy.api#documentation": "Information about the IPv6 CIDR block association.
", + "smithy.api#documentation": "Information about the IPv6 association.
", "smithy.api#xmlName": "ipv6CidrBlockAssociation" } }, @@ -4201,6 +4583,30 @@ "traits": { "smithy.api#documentation": "An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
" } + }, + "Ipv4IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "Associate a CIDR allocated from an IPv4 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.
" + } + }, + "Ipv4NetmaskLength": { + "target": "com.amazonaws.ec2#NetmaskLength", + "traits": { + "smithy.api#documentation": "The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.\n
" + } + }, + "Ipv6IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "Associates a CIDR allocated from an IPv6 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.
" + } + }, + "Ipv6NetmaskLength": { + "target": "com.amazonaws.ec2#NetmaskLength", + "traits": { + "smithy.api#documentation": "The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
" + } } } }, @@ -4932,7 +5338,7 @@ "target": "com.amazonaws.ec2#AuthorizeSecurityGroupEgressResult" }, "traits": { - "smithy.api#documentation": "[VPC only] Adds the specified outbound (egress) rules to a security group for use with a VPC.
\nAn outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address \n ranges, or to the instances that are associated with the specified destination security groups.
\nYou specify a protocol for each rule (for example, TCP). \n For the TCP and UDP protocols, you must also specify the destination port or port range. \n For the ICMP protocol, you must also specify the ICMP type and code. \n You can use -1 for the type or code to mean all types or all codes.
\nRule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.
\nFor information about VPC security group quotas, see Amazon VPC quotas.
" + "smithy.api#documentation": "[VPC only] Adds the specified outbound (egress) rules to a security group for use with a VPC.
\nAn outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address \n ranges, or to the instances that are associated with the specified source security groups.
\nYou specify a protocol for each rule (for example, TCP). \n For the TCP and UDP protocols, you must also specify the destination port or port range. \n For the ICMP protocol, you must also specify the ICMP type and code. \n You can use -1 for the type or code to mean all types or all codes.
\nRule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.
\nFor information about VPC security group quotas, see Amazon VPC quotas.
" } }, "com.amazonaws.ec2#AuthorizeSecurityGroupEgressRequest": { @@ -5674,6 +6080,12 @@ ] } }, + "com.amazonaws.ec2#BoxedDouble": { + "type": "double", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.ec2#BundleId": { "type": "string" }, @@ -10011,6 +10423,12 @@ "traits": { "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Indicates whether to create an IPv6 only subnet. If you already have a default subnet\n for this Availability Zone, you must delete it before you can create an IPv6 only subnet.
" + } } } }, @@ -10897,6 +11315,256 @@ } } }, + "com.amazonaws.ec2#CreateIpam": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateIpamRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateIpamResult" + }, + "traits": { + "smithy.api#documentation": "Create an IPAM. Amazon VCP IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization.
\nFor more information, see Create an IPAM in the Amazon VPC IPAM User Guide.\n
" + } + }, + "com.amazonaws.ec2#CreateIpamPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateIpamPoolRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateIpamPoolResult" + }, + "traits": { + "smithy.api#documentation": "Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.
\nFor more information, see Create a top-level pool in the Amazon VPC IPAM User Guide.\n
" + } + }, + "com.amazonaws.ec2#CreateIpamPoolRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the scope in which you would like to create the IPAM pool.
", + "smithy.api#required": {} + } + }, + "Locale": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.
\nPossible values: Any Amazon Web Services Region, such as us-east-1.
" + } + }, + "SourceIpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR range.
" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "A description for the IPAM pool.
" + } + }, + "AddressFamily": { + "target": "com.amazonaws.ec2#AddressFamily", + "traits": { + "smithy.api#documentation": "The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.
" + } + }, + "AutoImport": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "If selected, IPAM will continuously look for resources within the CIDR range of this pool \n and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for\n these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import \n a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently \n marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM \n discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.\n
\nA locale must be set on the pool for this feature to work.
" + } + }, + "PubliclyAdvertisable": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.
The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be \n less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
" + } + }, + "AllocationMaxNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "smithy.api#documentation": "The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be \n greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
" + } + }, + "AllocationDefaultNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "smithy.api#documentation": "The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, \n new allocations will default to 10.0.0.0/16.
" + } + }, + "AllocationResourceTags": { + "target": "com.amazonaws.ec2#RequestIpamResourceTagList", + "traits": { + "smithy.api#documentation": "Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
", + "smithy.api#xmlName": "AllocationResourceTag" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "AwsService": { + "target": "com.amazonaws.ec2#IpamPoolAwsService", + "traits": { + "smithy.api#documentation": "Limits which service in Amazon Web Services that the pool can be used in. \"ec2\", for example, allows users to use space for Elastic IP addresses and VPCs.
" + } + } + } + }, + "com.amazonaws.ec2#CreateIpamPoolResult": { + "type": "structure", + "members": { + "IpamPool": { + "target": "com.amazonaws.ec2#IpamPool", + "traits": { + "aws.protocols#ec2QueryName": "IpamPool", + "smithy.api#documentation": "Information about the IPAM pool created.
", + "smithy.api#xmlName": "ipamPool" + } + } + } + }, + "com.amazonaws.ec2#CreateIpamRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
A description for the IPAM.
" + } + }, + "OperatingRegions": { + "target": "com.amazonaws.ec2#AddIpamOperatingRegionSet", + "traits": { + "smithy.api#documentation": "The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only\n discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
\nFor more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.\n
", + "smithy.api#xmlName": "OperatingRegion" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.ec2#CreateIpamResult": { + "type": "structure", + "members": { + "Ipam": { + "target": "com.amazonaws.ec2#Ipam", + "traits": { + "aws.protocols#ec2QueryName": "Ipam", + "smithy.api#documentation": "Information about the IPAM created.
", + "smithy.api#xmlName": "ipam" + } + } + } + }, + "com.amazonaws.ec2#CreateIpamScope": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateIpamScopeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateIpamScopeResult" + }, + "traits": { + "smithy.api#documentation": "Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
\nFor more information, see Add a scope in the Amazon VPC IPAM User Guide.
" + } + }, + "com.amazonaws.ec2#CreateIpamScopeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the IPAM for which you're creating this scope.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "A description for the scope you're creating.
" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.ec2#CreateIpamScopeResult": { + "type": "structure", + "members": { + "IpamScope": { + "target": "com.amazonaws.ec2#IpamScope", + "traits": { + "aws.protocols#ec2QueryName": "IpamScope", + "smithy.api#documentation": "Information about the created scope.
", + "smithy.api#xmlName": "ipamScope" + } + } + } + }, "com.amazonaws.ec2#CreateKeyPair": { "type": "operation", "input": { @@ -11521,6 +12189,79 @@ } } }, + "com.amazonaws.ec2#CreateNetworkInsightsAccessScope": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateNetworkInsightsAccessScopeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateNetworkInsightsAccessScopeResult" + }, + "traits": { + "smithy.api#documentation": "Creates a Network Access Scope.
\nAmazon Web Services Network Access Analyzer enables cloud networking and cloud operations teams \n to verify that their networks on Amazon Web Services conform to their network security and governance \n objectives. For more information, see the Amazon Web Services Network Access Analyzer Guide.
" + } + }, + "com.amazonaws.ec2#CreateNetworkInsightsAccessScopeRequest": { + "type": "structure", + "members": { + "MatchPaths": { + "target": "com.amazonaws.ec2#AccessScopePathListRequest", + "traits": { + "smithy.api#documentation": "The paths to match.
", + "smithy.api#xmlName": "MatchPath" + } + }, + "ExcludePaths": { + "target": "com.amazonaws.ec2#AccessScopePathListRequest", + "traits": { + "smithy.api#documentation": "The paths to exclude.
", + "smithy.api#xmlName": "ExcludePath" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, \n see How to ensure idempotency.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "The tags to apply.
", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The Network Access Scope.
", + "smithy.api#xmlName": "networkInsightsAccessScope" + } + }, + "NetworkInsightsAccessScopeContent": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeContent", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeContent", + "smithy.api#documentation": "The Network Access Scope content.
", + "smithy.api#xmlName": "networkInsightsAccessScopeContent" + } + } + } + }, "com.amazonaws.ec2#CreateNetworkInsightsPath": { "type": "operation", "input": { @@ -11907,6 +12648,49 @@ } } }, + "com.amazonaws.ec2#CreatePublicIpv4Pool": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreatePublicIpv4PoolRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreatePublicIpv4PoolResult" + }, + "traits": { + "smithy.api#documentation": "Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only. To monitor the status of pool creation, use DescribePublicIpv4Pools.
" + } + }, + "com.amazonaws.ec2#CreatePublicIpv4PoolRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
The ID of the public IPv4 pool.
", + "smithy.api#xmlName": "poolId" + } + } + } + }, "com.amazonaws.ec2#CreateReplaceRootVolumeTask": { "type": "operation", "input": { @@ -12232,7 +13016,10 @@ } }, "CoreNetworkArn": { - "target": "com.amazonaws.ec2#CoreNetworkArn" + "target": "com.amazonaws.ec2#CoreNetworkArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the core network.
" + } } } }, @@ -12721,14 +13508,13 @@ "CidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24. \n We modify the specified CIDR block to its canonical form; for example, if you specify \n 100.68.0.18/18, we modify it to 100.68.0.0/18.
This parameter is not supported for an IPv6 only subnet.
" } }, "Ipv6CidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a\n /64 prefix length.
" + "smithy.api#documentation": "The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a\n /64 prefix length.
\nThis parameter is required for an IPv6 only subnet.
" } }, "OutpostArn": { @@ -12751,6 +13537,12 @@ "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Indicates whether to create an IPv6 only subnet.
" + } } } }, @@ -14313,8 +15105,7 @@ "CidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The IPv4 network range for the VPC, in CIDR notation. For example,\n\t\t 10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
The IPv4 network range for the VPC, in CIDR notation. For example,\n\t\t 10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
" } }, + "Ipv4IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.\n \n
" + } + }, + "Ipv4NetmaskLength": { + "target": "com.amazonaws.ec2#NetmaskLength", + "traits": { + "smithy.api#documentation": "The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
" + } + }, + "Ipv6IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "The ID of an IPv6 IPAM pool which will be used to allocate this VPC an IPv6 CIDR. IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
" + } + }, + "Ipv6NetmaskLength": { + "target": "com.amazonaws.ec2#NetmaskLength", + "traits": { + "smithy.api#documentation": "The netmask length of the IPv6 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -15412,6 +16227,135 @@ } } }, + "com.amazonaws.ec2#DeleteIpam": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteIpamRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteIpamResult" + }, + "traits": { + "smithy.api#documentation": "Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.
\nYou cannot delete an IPAM if there are CIDRs provisioned to pools or if there are allocations in the pools within the IPAM. To deprovision pool \n CIDRs, see DeprovisionIpamPoolCidr. To release allocations, see ReleaseIpamPoolAllocation.\n
\nFor more information, see Delete an IPAM in the Amazon VPC IPAM User Guide.\n
" + } + }, + "com.amazonaws.ec2#DeleteIpamPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteIpamPoolRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteIpamPoolResult" + }, + "traits": { + "smithy.api#documentation": "Delete an IPAM pool.
\nYou cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release \n allocations, see ReleaseIpamPoolAllocation. To deprovision pool \n CIDRs, see DeprovisionIpamPoolCidr.
\nFor more information, see Delete a pool in the Amazon VPC IPAM User Guide.\n
" + } + }, + "com.amazonaws.ec2#DeleteIpamPoolRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the pool to delete.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ec2#DeleteIpamPoolResult": { + "type": "structure", + "members": { + "IpamPool": { + "target": "com.amazonaws.ec2#IpamPool", + "traits": { + "aws.protocols#ec2QueryName": "IpamPool", + "smithy.api#documentation": "Information about the results of the deletion.
", + "smithy.api#xmlName": "ipamPool" + } + } + } + }, + "com.amazonaws.ec2#DeleteIpamRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the IPAM to delete.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ec2#DeleteIpamResult": { + "type": "structure", + "members": { + "Ipam": { + "target": "com.amazonaws.ec2#Ipam", + "traits": { + "aws.protocols#ec2QueryName": "Ipam", + "smithy.api#documentation": "Information about the results of the deletion.
", + "smithy.api#xmlName": "ipam" + } + } + } + }, + "com.amazonaws.ec2#DeleteIpamScope": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteIpamScopeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteIpamScopeResult" + }, + "traits": { + "smithy.api#documentation": "Delete the scope for an IPAM. You cannot delete the default scopes.
\nFor more information, see Delete a scope in the Amazon VPC IPAM User Guide.\n
" + } + }, + "com.amazonaws.ec2#DeleteIpamScopeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the scope to delete.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ec2#DeleteIpamScopeResult": { + "type": "structure", + "members": { + "IpamScope": { + "target": "com.amazonaws.ec2#IpamScope", + "traits": { + "aws.protocols#ec2QueryName": "IpamScope", + "smithy.api#documentation": "Information about the results of the deletion.
", + "smithy.api#xmlName": "ipamScope" + } + } + } + }, "com.amazonaws.ec2#DeleteKeyPair": { "type": "operation", "input": { @@ -15908,6 +16852,92 @@ } } }, + "com.amazonaws.ec2#DeleteNetworkInsightsAccessScope": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeResult" + }, + "traits": { + "smithy.api#documentation": "Deletes the specified Network Access Scope.
" + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeAnalysisResult" + }, + "traits": { + "smithy.api#documentation": "Deletes the specified Network Access Scope analysis.
" + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeAnalysisRequest": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeAnalysisId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", + "traits": { + "smithy.api#documentation": "The ID of the Network Access Scope analysis.
", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the Network Access Scope analysis.
", + "smithy.api#xmlName": "networkInsightsAccessScopeAnalysisId" + } + } + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the Network Access Scope.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeResult": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeId", + "smithy.api#documentation": "The ID of the Network Access Scope.
", + "smithy.api#xmlName": "networkInsightsAccessScopeId" + } + } + } + }, "com.amazonaws.ec2#DeleteNetworkInsightsAnalysis": { "type": "operation", "input": { @@ -16114,6 +17144,49 @@ } } }, + "com.amazonaws.ec2#DeletePublicIpv4Pool": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeletePublicIpv4PoolRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeletePublicIpv4PoolResult" + }, + "traits": { + "smithy.api#documentation": "Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only.
" + } + }, + "com.amazonaws.ec2#DeletePublicIpv4PoolRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the public IPv4 pool you want to delete.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ec2#DeletePublicIpv4PoolResult": { + "type": "structure", + "members": { + "ReturnValue": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "ReturnValue", + "smithy.api#documentation": "Information about the result of deleting the public IPv4 pool.
", + "smithy.api#xmlName": "returnValue" + } + } + } + }, "com.amazonaws.ec2#DeleteQueuedReservedInstances": { "type": "operation", "input": { @@ -16501,7 +17574,7 @@ "target": "com.amazonaws.ec2#TagList", "traits": { "aws.protocols#ec2QueryName": "Tag", - "smithy.api#documentation": "The tags to delete. Specify a tag key and an optional tag value to delete\n specific tags. If you specify a tag key without a tag value, we delete any tag with this\n key regardless of its value. If you specify a tag key with an empty string as the tag\n value, we delete the tag only if its value is an empty string.
\nIf you omit this parameter, we delete all user-defined tags for the specified\n resources. We do not delete Amazon Web Services-generated tags (tags that have the aws:\n prefix).
The tags to delete. Specify a tag key and an optional tag value to delete\n specific tags. If you specify a tag key without a tag value, we delete any tag with this\n key regardless of its value. If you specify a tag key with an empty string as the tag\n value, we delete the tag only if its value is an empty string.
\nIf you omit this parameter, we delete all user-defined tags for the specified\n resources. We do not delete Amazon Web Services-generated tags (tags that have the aws:\n prefix).
Constraints: Up to 1000 tags.
", "smithy.api#xmlName": "tag" } } @@ -17461,6 +18534,122 @@ } } }, + "com.amazonaws.ec2#DeprovisionIpamPoolCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeprovisionIpamPoolCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeprovisionIpamPoolCidrResult" + }, + "traits": { + "smithy.api#documentation": "Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see Deprovision pool CIDRs in the Amazon VPC IPAM User Guide.
" + } + }, + "com.amazonaws.ec2#DeprovisionIpamPoolCidrRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the pool that has the CIDR you want to deprovision.
", + "smithy.api#required": {} + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "The CIDR which you want to deprovision from the pool.
" + } + } + } + }, + "com.amazonaws.ec2#DeprovisionIpamPoolCidrResult": { + "type": "structure", + "members": { + "IpamPoolCidr": { + "target": "com.amazonaws.ec2#IpamPoolCidr", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolCidr", + "smithy.api#documentation": "The deprovisioned pool CIDR.
", + "smithy.api#xmlName": "ipamPoolCidr" + } + } + } + }, + "com.amazonaws.ec2#DeprovisionPublicIpv4PoolCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeprovisionPublicIpv4PoolCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeprovisionPublicIpv4PoolCidrResult" + }, + "traits": { + "smithy.api#documentation": "Deprovision a CIDR from a public IPv4 pool.
" + } + }, + "com.amazonaws.ec2#DeprovisionPublicIpv4PoolCidrRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the pool that you want to deprovision the CIDR from.
", + "smithy.api#required": {} + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "The CIDR you want to deprovision from the pool.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ec2#DeprovisionPublicIpv4PoolCidrResult": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", + "traits": { + "aws.protocols#ec2QueryName": "PoolId", + "smithy.api#documentation": "The ID of the pool that you deprovisioned the CIDR from.
", + "smithy.api#xmlName": "poolId" + } + }, + "DeprovisionedAddresses": { + "target": "com.amazonaws.ec2#DeprovisionedAddressSet", + "traits": { + "aws.protocols#ec2QueryName": "DeprovisionedAddressSet", + "smithy.api#documentation": "The deprovisioned CIDRs.
", + "smithy.api#xmlName": "deprovisionedAddressSet" + } + } + } + }, + "com.amazonaws.ec2#DeprovisionedAddressSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#DeregisterImage": { "type": "operation", "input": { @@ -21311,7 +22500,7 @@ "target": "com.amazonaws.ec2#DescribeInstanceStatusResult" }, "traits": { - "smithy.api#documentation": "Describes the status of the specified instances or all of your instances. By default,\n only running instances are described, unless you specifically indicate to return the\n status of all instances.
\nInstance status includes the following components:
\n\n Status checks - Amazon EC2 performs status\n checks on running EC2 instances to identify hardware and software issues. For\n more information, see Status checks for your instances and Troubleshooting\n instances with failed status checks in the Amazon EC2 User Guide.
\n\n Scheduled events - Amazon EC2 can schedule\n events (such as reboot, stop, or terminate) for your instances related to\n hardware issues, software updates, or system maintenance. For more information,\n see Scheduled events for your instances in the Amazon EC2 User Guide.
\n\n Instance state - You can manage your instances\n from the moment you launch them through their termination. For more information,\n see Instance\n lifecycle in the Amazon EC2 User Guide.
\nDescribes the status of the specified instances or all of your instances. By default,\n only running instances are described, unless you specifically indicate to return the\n status of all instances.
\nInstance status includes the following components:
\n\n Status checks - Amazon EC2 performs status\n checks on running EC2 instances to identify hardware and software issues. For\n more information, see Status checks for your instances and Troubleshoot\n instances with failed status checks in the Amazon EC2 User\n Guide.
\n\n Scheduled events - Amazon EC2 can schedule\n events (such as reboot, stop, or terminate) for your instances related to\n hardware issues, software updates, or system maintenance. For more information,\n see Scheduled events for your instances in the Amazon EC2 User Guide.
\n\n Instance state - You can manage your instances\n from the moment you launch them through their termination. For more information,\n see Instance\n lifecycle in the Amazon EC2 User Guide.
\nGet information about your IPAM pools.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpamPools", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeIpamPoolsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
One or more filters for the request. For more information about filtering, see Filtering CLI output.
", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the request.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
" + } + }, + "IpamPoolIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "The IDs of the IPAM pools you would like information on.
", + "smithy.api#xmlName": "IpamPoolId" + } + } + } + }, + "com.amazonaws.ec2#DescribeIpamPoolsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the IPAM pools.
", + "smithy.api#xmlName": "ipamPoolSet" + } + } + } + }, + "com.amazonaws.ec2#DescribeIpamScopes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeIpamScopesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeIpamScopesResult" + }, + "traits": { + "smithy.api#documentation": "Get information about your IPAM scopes.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpamScopes", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeIpamScopesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
One or more filters for the request. For more information about filtering, see Filtering CLI output.
", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the request.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
" + } + }, + "IpamScopeIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "The IDs of the scopes you want information on.
", + "smithy.api#xmlName": "IpamScopeId" + } + } + } + }, + "com.amazonaws.ec2#DescribeIpamScopesResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The scopes you want information on.
", + "smithy.api#xmlName": "ipamScopeSet" + } + } + } + }, + "com.amazonaws.ec2#DescribeIpams": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeIpamsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeIpamsResult" + }, + "traits": { + "smithy.api#documentation": "Get information about your IPAM pools.
\nFor more information, see What is IPAM? in the Amazon VPC IPAM User Guide.\n
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Ipams", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeIpamsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
One or more filters for the request. For more information about filtering, see Filtering CLI output.
", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the request.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
" + } + }, + "IpamIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "The IDs of the IPAMs you want information on.
", + "smithy.api#xmlName": "IpamId" + } + } + } + }, + "com.amazonaws.ec2#DescribeIpamsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the IPAMs.
", + "smithy.api#xmlName": "ipamSet" + } + } + } + }, "com.amazonaws.ec2#DescribeIpv6Pools": { "type": "operation", "input": { @@ -23102,6 +24519,176 @@ } } }, + "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopeAnalyses": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopeAnalysesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopeAnalysesResult" + }, + "traits": { + "smithy.api#documentation": "Describes the specified Network Access Scope analyses.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NetworkInsightsAccessScopeAnalyses", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopeAnalysesRequest": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeAnalysisIds": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisIdList", + "traits": { + "smithy.api#documentation": "The IDs of the Network Access Scope analyses.
", + "smithy.api#xmlName": "NetworkInsightsAccessScopeAnalysisId" + } + }, + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "smithy.api#documentation": "The ID of the Network Access Scope.
" + } + }, + "AnalysisStartTimeBegin": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "Filters the results based on the start time. The analysis must have started on or after this time.
" + } + }, + "AnalysisStartTimeEnd": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "Filters the results based on the start time. The analysis must have started on or before this time.
" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "There are no supported filters.
", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#NetworkInsightsMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.
Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The token for the next page of results.
" + } + } + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopeAnalysesResult": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeAnalyses": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysisSet", + "smithy.api#documentation": "The Network Access Scope analyses.
", + "smithy.api#xmlName": "networkInsightsAccessScopeAnalysisSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes the specified Network Access Scopes.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NetworkInsightsAccessScopes", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopesRequest": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeIds": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeIdList", + "traits": { + "smithy.api#documentation": "The IDs of the Network Access Scopes.
", + "smithy.api#xmlName": "NetworkInsightsAccessScopeId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "There are no supported filters.
", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#NetworkInsightsMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.
Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The token for the next page of results.
" + } + } + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopesResult": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopes": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeSet", + "smithy.api#documentation": "The Network Access Scopes.
", + "smithy.api#xmlName": "networkInsightsAccessScopeSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes the storage tier status of one or more Amazon EBS snapshots.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SnapshotTierStatuses", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeSnapshotTierStatusMaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.ec2#DescribeSnapshotTierStatusRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "The filters.
\n\n snapshot-id - The snapshot ID.
\n volume-id - The ID of the volume the snapshot is for.
\n last-tiering-operation - The state of the last archive or restore action. (archiving | archival_error |\n archival_complete | restoring | restore_error | restore_complete)
Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The token for the next page of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeSnapshotTierStatusMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.
Information about the snapshot's storage tier.
", + "smithy.api#xmlName": "snapshotTierStatusSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The filters.
\n\n description - A description of the snapshot.
\n encrypted - Indicates whether the snapshot is encrypted\n (true | false)
\n owner-alias - The owner alias, from an Amazon-maintained list \n (amazon). \n This is not the user-configured Amazon Web Services account alias set using the IAM console.\n We recommend that you use the related parameter instead of this filter.
\n owner-id - The Amazon Web Services account ID of the owner. We recommend that \n you use the related parameter instead of this filter.
\n progress - The progress of the snapshot, as a percentage (for example,\n 80%).
\n snapshot-id - The snapshot ID.
\n start-time - The time stamp when the snapshot was initiated.
\n status - The status of the snapshot (pending |\n completed | error).
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n volume-id - The ID of the volume the snapshot is for.
\n volume-size - The size of the volume, in GiB.
The filters.
\n\n description - A description of the snapshot.
\n encrypted - Indicates whether the snapshot is encrypted\n (true | false)
\n owner-alias - The owner alias, from an Amazon-maintained list \n (amazon). \n This is not the user-configured Amazon Web Services account alias set using the IAM console.\n We recommend that you use the related parameter instead of this filter.
\n owner-id - The Amazon Web Services account ID of the owner. We recommend that \n you use the related parameter instead of this filter.
\n progress - The progress of the snapshot, as a percentage (for example,\n 80%).
\n snapshot-id - The snapshot ID.
\n start-time - The time stamp when the snapshot was initiated.
\n status - The status of the snapshot (pending |\n completed | error).
\n storage-tier - The storage tier of the snapshot (archive |\n standard).
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n volume-id - The ID of the volume the snapshot is for.
\n volume-size - The size of the volume, in GiB.
One or more filters.
\n\n availability-zone - The Availability Zone for the subnet. You can also use\n availabilityZone as the filter name.
\n availability-zone-id - The ID of the Availability Zone for the subnet.\n You can also use availabilityZoneId as the filter name.
\n available-ip-address-count - The number of IPv4 addresses in the\n subnet that are available.
\n cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you\n specify must exactly match the subnet's CIDR block for information to be\n returned for the subnet. You can also use cidr or\n cidrBlock as the filter names.
\n default-for-az - Indicates whether this is the default subnet for the\n Availability Zone. You can also use defaultForAz as the filter name.
\n ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR\n block associated with the subnet.
\n ipv6-cidr-block-association.association-id - An association ID\n for an IPv6 CIDR block associated with the subnet.
\n ipv6-cidr-block-association.state - The state of an IPv6 CIDR\n block associated with the subnet.
\n outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
\n owner-id - The ID of the Amazon Web Services account that owns the subnet.
\n state - The state of the subnet (pending | available).
\n subnet-arn - The Amazon Resource Name (ARN) of the subnet.
\n subnet-id - The ID of the subnet.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC for the subnet.
One or more filters.
\n\n availability-zone - The Availability Zone for the subnet. You can also use\n availabilityZone as the filter name.
\n availability-zone-id - The ID of the Availability Zone for the subnet.\n You can also use availabilityZoneId as the filter name.
\n available-ip-address-count - The number of IPv4 addresses in the\n subnet that are available.
\n cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you\n specify must exactly match the subnet's CIDR block for information to be\n returned for the subnet. You can also use cidr or\n cidrBlock as the filter names.
\n default-for-az - Indicates whether this is the default subnet for the\n Availability Zone (true | false). You can also use \n defaultForAz as the filter name.
\n ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR\n block associated with the subnet.
\n ipv6-cidr-block-association.association-id - An association ID\n for an IPv6 CIDR block associated with the subnet.
\n ipv6-cidr-block-association.state - The state of an IPv6 CIDR\n block associated with the subnet.
\n ipv6-native - Indicates whether this is an IPv6 only subnet (true | false).
\n outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
\n owner-id - The ID of the Amazon Web Services account that owns the subnet.
\n state - The state of the subnet (pending | available).
\n subnet-arn - The Amazon Resource Name (ARN) of the subnet.
\n subnet-id - The ID of the subnet.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC for the subnet.
Disable the IPAM account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide.\n
" + } + }, + "com.amazonaws.ec2#DisableIpamOrganizationAdminAccountRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The Organizations member account ID that you want to disable as IPAM account.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ec2#DisableIpamOrganizationAdminAccountResult": { + "type": "structure", + "members": { + "Success": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Success", + "smithy.api#documentation": "The result of disabling the IPAM account.
", + "smithy.api#xmlName": "success" + } + } + } + }, "com.amazonaws.ec2#DisableSerialConsoleAccess": { "type": "operation", "input": { @@ -31338,6 +33043,49 @@ } } }, + "com.amazonaws.ec2#EnableIpamOrganizationAdminAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableIpamOrganizationAdminAccountRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableIpamOrganizationAdminAccountResult" + }, + "traits": { + "smithy.api#documentation": "Enable an Organizations member account as the IPAM admin account. You cannot select the Organizations management account as the IPAM admin account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide.\n
" + } + }, + "com.amazonaws.ec2#EnableIpamOrganizationAdminAccountRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The Organizations member account ID that you want to enable as the IPAM account.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ec2#EnableIpamOrganizationAdminAccountResult": { + "type": "structure", + "members": { + "Success": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Success", + "smithy.api#documentation": "The result of enabling the IPAM account.
", + "smithy.api#xmlName": "success" + } + } + } + }, "com.amazonaws.ec2#EnableSerialConsoleAccess": { "type": "operation", "input": { @@ -32993,6 +34741,25 @@ } } }, + "com.amazonaws.ec2#FindingsFound": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "true", + "name": "true" + }, + { + "value": "false", + "name": "false" + }, + { + "value": "unknown", + "name": "unknown" + } + ] + } + }, "com.amazonaws.ec2#FleetActivityStatus": { "type": "string", "traits": { @@ -33699,7 +35466,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "TerminationDelay", - "smithy.api#documentation": "The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.
", + "smithy.api#documentation": "The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.
\nValid only when replacementStrategy is set to launch-before-terminate.
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.
" + "smithy.api#documentation": "The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.
\nValid only when ReplacementStrategy is set to launch-before-terminate.
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
Retrieve historical information about a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "HistoryRecords", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetIpamAddressHistoryRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. \n If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR.
", + "smithy.api#required": {} + } + }, + "IpamScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "smithy.api#documentation": "The ID of the IPAM scope that the CIDR is in.
", + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "The ID of the VPC you want your history records filtered by.
" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "The start of the time period for which you are looking for history. If you omit this option, it will default to the value of EndTime.
" + } + }, + "EndTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "The end of the time period for which you are looking for history. If you omit this option, it will default to the current time.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamAddressHistoryMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of historical results you would like returned per page. Defaults to 100.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
" + } + } + } + }, + "com.amazonaws.ec2#GetIpamAddressHistoryResult": { + "type": "structure", + "members": { + "HistoryRecords": { + "target": "com.amazonaws.ec2#IpamAddressHistoryRecordSet", + "traits": { + "aws.protocols#ec2QueryName": "HistoryRecordSet", + "smithy.api#documentation": "A historical record for a CIDR within an IPAM scope. If the CIDR is associated with an EC2 instance, you will see an object in the response for the instance and one for the network interface.
", + "smithy.api#xmlName": "historyRecordSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Get a list of all the CIDR allocations in an IPAM pool.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpamPoolAllocations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetIpamPoolAllocationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1000, + "max": 100000 + } + } + }, + "com.amazonaws.ec2#GetIpamPoolAllocationsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the IPAM pool you want to see the allocations for.
", + "smithy.api#required": {} + } + }, + "IpamPoolAllocationId": { + "target": "com.amazonaws.ec2#IpamPoolAllocationId", + "traits": { + "smithy.api#documentation": "The ID of the allocation.
" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "One or more filters for the request. For more information about filtering, see Filtering CLI output.
", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#GetIpamPoolAllocationsMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results you would like returned per page.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
" + } + } + } + }, + "com.amazonaws.ec2#GetIpamPoolAllocationsResult": { + "type": "structure", + "members": { + "IpamPoolAllocations": { + "target": "com.amazonaws.ec2#IpamPoolAllocationSet", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolAllocationSet", + "smithy.api#documentation": "The IPAM pool allocations you want information on.
", + "smithy.api#xmlName": "ipamPoolAllocationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Get the CIDRs provisioned to an IPAM pool.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpamPoolCidrs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetIpamPoolCidrsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the IPAM pool you want the CIDR for.
", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "One or more filters for the request. For more information about filtering, see Filtering CLI output.
", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the request.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
" + } + } + } + }, + "com.amazonaws.ec2#GetIpamPoolCidrsResult": { + "type": "structure", + "members": { + "IpamPoolCidrs": { + "target": "com.amazonaws.ec2#IpamPoolCidrSet", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolCidrSet", + "smithy.api#documentation": "Information about the CIDRs provisioned to an IPAM pool.
", + "smithy.api#xmlName": "ipamPoolCidrSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Get information about the resources in a scope.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpamResourceCidrs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetIpamResourceCidrsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
One or more filters for the request. For more information about filtering, see Filtering CLI output.
", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the request.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
" + } + }, + "IpamScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "smithy.api#documentation": "The ID of the scope that the resource is in.
", + "smithy.api#required": {} + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "The ID of the IPAM pool that the resource is in.
" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "The ID of the resource.
" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#IpamResourceType", + "traits": { + "smithy.api#documentation": "The resource type.
" + } + }, + "ResourceTag": { + "target": "com.amazonaws.ec2#RequestIpamResourceTag" + }, + "ResourceOwner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the resource.
" + } + } + } + }, + "com.amazonaws.ec2#GetIpamResourceCidrsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The resource CIDRs.
", + "smithy.api#xmlName": "ipamResourceCidrSet" + } + } + } + }, "com.amazonaws.ec2#GetLaunchTemplateData": { "type": "operation", "input": { @@ -35441,6 +37572,128 @@ } } }, + "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindingsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindingsResult" + }, + "traits": { + "smithy.api#documentation": "Gets the findings for the specified Network Access Scope analysis.
" + } + }, + "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindingsRequest": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeAnalysisId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", + "traits": { + "smithy.api#documentation": "The ID of the Network Access Scope analysis.
", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#NetworkInsightsMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the Network Access Scope analysis.
", + "smithy.api#xmlName": "networkInsightsAccessScopeAnalysisId" + } + }, + "AnalysisStatus": { + "target": "com.amazonaws.ec2#AnalysisStatus", + "traits": { + "aws.protocols#ec2QueryName": "AnalysisStatus", + "smithy.api#documentation": "The status of Network Access Scope Analysis.
", + "smithy.api#xmlName": "analysisStatus" + } + }, + "AnalysisFindings": { + "target": "com.amazonaws.ec2#AccessScopeAnalysisFindingList", + "traits": { + "aws.protocols#ec2QueryName": "AnalysisFindingSet", + "smithy.api#documentation": "The findings associated with Network Access Scope Analysis.
", + "smithy.api#xmlName": "analysisFindingSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Gets the content for the specified Network Access Scope.
" + } + }, + "com.amazonaws.ec2#GetNetworkInsightsAccessScopeContentRequest": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "smithy.api#documentation": "The ID of the Network Access Scope.
", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The Network Access Scope content.
", + "smithy.api#xmlName": "networkInsightsAccessScopeContent" + } + } + } + }, "com.amazonaws.ec2#GetPasswordData": { "type": "operation", "input": { @@ -37141,6 +39394,21 @@ ] } }, + "com.amazonaws.ec2#HostnameType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ip-name", + "name": "ip_name" + }, + { + "value": "resource-name", + "name": "resource_name" + } + ] + } + }, "com.amazonaws.ec2#Hour": { "type": "integer", "traits": { @@ -39589,6 +41857,22 @@ "smithy.api#documentation": "The time that the usage operation was last updated.
", "smithy.api#xmlName": "usageOperationUpdateTime" } + }, + "PrivateDnsNameOptions": { + "target": "com.amazonaws.ec2#PrivateDnsNameOptionsResponse", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsNameOptions", + "smithy.api#documentation": "The options for the instance hostname.
", + "smithy.api#xmlName": "privateDnsNameOptions" + } + }, + "Ipv6Address": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Address", + "smithy.api#documentation": "The IPv6 address assigned to the instance.
", + "smithy.api#xmlName": "ipv6Address" + } } }, "traits": { @@ -43663,6 +45947,46 @@ "value": "m6gd.16xlarge", "name": "m6gd_16xlarge" }, + { + "value": "m6a.large", + "name": "m6a_large" + }, + { + "value": "m6a.xlarge", + "name": "m6a_xlarge" + }, + { + "value": "m6a.2xlarge", + "name": "m6a_2xlarge" + }, + { + "value": "m6a.4xlarge", + "name": "m6a_4xlarge" + }, + { + "value": "m6a.8xlarge", + "name": "m6a_8xlarge" + }, + { + "value": "m6a.12xlarge", + "name": "m6a_12xlarge" + }, + { + "value": "m6a.16xlarge", + "name": "m6a_16xlarge" + }, + { + "value": "m6a.24xlarge", + "name": "m6a_24xlarge" + }, + { + "value": "m6a.32xlarge", + "name": "m6a_32xlarge" + }, + { + "value": "m6a.48xlarge", + "name": "m6a_48xlarge" + }, { "value": "m6i.large", "name": "m6i_large" @@ -43751,6 +46075,78 @@ "value": "vt1.24xlarge", "name": "vt1_24xlarge" }, + { + "value": "im4gn.16xlarge", + "name": "im4gn_16xlarge" + }, + { + "value": "im4gn.2xlarge", + "name": "im4gn_2xlarge" + }, + { + "value": "im4gn.4xlarge", + "name": "im4gn_4xlarge" + }, + { + "value": "im4gn.8xlarge", + "name": "im4gn_8xlarge" + }, + { + "value": "im4gn.large", + "name": "im4gn_large" + }, + { + "value": "im4gn.xlarge", + "name": "im4gn_xlarge" + }, + { + "value": "is4gen.2xlarge", + "name": "is4gen_2xlarge" + }, + { + "value": "is4gen.4xlarge", + "name": "is4gen_4xlarge" + }, + { + "value": "is4gen.8xlarge", + "name": "is4gen_8xlarge" + }, + { + "value": "is4gen.large", + "name": "is4gen_large" + }, + { + "value": "is4gen.medium", + "name": "is4gen_medium" + }, + { + "value": "is4gen.xlarge", + "name": "is4gen_xlarge" + }, + { + "value": "g5g.xlarge", + "name": "g5g_xlarge" + }, + { + "value": "g5g.2xlarge", + "name": "g5g_2xlarge" + }, + { + "value": "g5g.4xlarge", + "name": "g5g_4xlarge" + }, + { + "value": "g5g.8xlarge", + "name": "g5g_8xlarge" + }, + { + "value": "g5g.16xlarge", + "name": "g5g_16xlarge" + }, + { + "value": "g5g.metal", + "name": "g5g_metal" + }, { "value": "g5.xlarge", "name": "g5_xlarge" @@ -44421,6 +46817,1258 @@ } } }, + "com.amazonaws.ec2#Ipam": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "The Amazon Web Services account ID of the owner of the IPAM.
", + "smithy.api#xmlName": "ownerId" + } + }, + "IpamId": { + "target": "com.amazonaws.ec2#IpamId", + "traits": { + "aws.protocols#ec2QueryName": "IpamId", + "smithy.api#documentation": "The ID of the IPAM.
", + "smithy.api#xmlName": "ipamId" + } + }, + "IpamArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "IpamArn", + "smithy.api#documentation": "The ARN of the IPAM.
", + "smithy.api#xmlName": "ipamArn" + } + }, + "IpamRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpamRegion", + "smithy.api#documentation": "The Amazon Web Services Region of the IPAM.
", + "smithy.api#xmlName": "ipamRegion" + } + }, + "PublicDefaultScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "aws.protocols#ec2QueryName": "PublicDefaultScopeId", + "smithy.api#documentation": "The ID of the IPAM's default public scope.
", + "smithy.api#xmlName": "publicDefaultScopeId" + } + }, + "PrivateDefaultScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDefaultScopeId", + "smithy.api#documentation": "The ID of the IPAM's default private scope.
", + "smithy.api#xmlName": "privateDefaultScopeId" + } + }, + "ScopeCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ScopeCount", + "smithy.api#documentation": "The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.\n
", + "smithy.api#xmlName": "scopeCount" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "The description for the IPAM.
", + "smithy.api#xmlName": "description" + } + }, + "OperatingRegions": { + "target": "com.amazonaws.ec2#IpamOperatingRegionSet", + "traits": { + "aws.protocols#ec2QueryName": "OperatingRegionSet", + "smithy.api#documentation": "The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only\n discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
\nFor more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
", + "smithy.api#xmlName": "operatingRegionSet" + } + }, + "State": { + "target": "com.amazonaws.ec2#IpamState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "The state of the IPAM.
", + "smithy.api#xmlName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
" + } + }, + "com.amazonaws.ec2#IpamAddressHistoryMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#IpamAddressHistoryRecord": { + "type": "structure", + "members": { + "ResourceOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOwnerId", + "smithy.api#documentation": "The ID of the resource owner.
", + "smithy.api#xmlName": "resourceOwnerId" + } + }, + "ResourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceRegion", + "smithy.api#documentation": "The Amazon Web Services Region of the resource.
", + "smithy.api#xmlName": "resourceRegion" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#IpamAddressHistoryResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "The type of the resource.
", + "smithy.api#xmlName": "resourceType" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "The ID of the resource.
", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceCidr", + "smithy.api#documentation": "The CIDR of the resource.
", + "smithy.api#xmlName": "resourceCidr" + } + }, + "ResourceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceName", + "smithy.api#documentation": "The name of the resource.
", + "smithy.api#xmlName": "resourceName" + } + }, + "ResourceComplianceStatus": { + "target": "com.amazonaws.ec2#IpamComplianceStatus", + "traits": { + "aws.protocols#ec2QueryName": "ResourceComplianceStatus", + "smithy.api#documentation": "The compliance status of a resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
", + "smithy.api#xmlName": "resourceComplianceStatus" + } + }, + "ResourceOverlapStatus": { + "target": "com.amazonaws.ec2#IpamOverlapStatus", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOverlapStatus", + "smithy.api#documentation": "The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
", + "smithy.api#xmlName": "resourceOverlapStatus" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "The VPC ID of the resource.
", + "smithy.api#xmlName": "vpcId" + } + }, + "SampledStartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "SampledStartTime", + "smithy.api#documentation": "Sampled start time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the start time may have occurred before this specific time.
", + "smithy.api#xmlName": "sampledStartTime" + } + }, + "SampledEndTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "SampledEndTime", + "smithy.api#documentation": "Sampled end time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the end time may have occurred before this specific time.
", + "smithy.api#xmlName": "sampledEndTime" + } + } + }, + "traits": { + "smithy.api#documentation": "The historical record of a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.\n
" + } + }, + "com.amazonaws.ec2#IpamAddressHistoryRecordSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamAddressHistoryRecord", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamAddressHistoryResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "eip", + "name": "eip" + }, + { + "value": "vpc", + "name": "vpc" + }, + { + "value": "subnet", + "name": "subnet" + }, + { + "value": "network-interface", + "name": "network_interface" + }, + { + "value": "instance", + "name": "instance" + } + ] + } + }, + "com.amazonaws.ec2#IpamCidrAuthorizationContext": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "The plain-text authorization message for the prefix and account.
" + } + }, + "Signature": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "The signed authorization message for the prefix and account.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
" + } + }, + "com.amazonaws.ec2#IpamComplianceStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "compliant", + "name": "compliant" + }, + { + "value": "noncompliant", + "name": "noncompliant" + }, + { + "value": "unmanaged", + "name": "unmanaged" + }, + { + "value": "ignored", + "name": "ignored" + } + ] + } + }, + "com.amazonaws.ec2#IpamId": { + "type": "string" + }, + "com.amazonaws.ec2#IpamManagementState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "managed", + "name": "managed" + }, + { + "value": "unmanaged", + "name": "unmanaged" + }, + { + "value": "ignored", + "name": "ignored" + } + ] + } + }, + "com.amazonaws.ec2#IpamMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#IpamNetmaskLength": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.ec2#IpamOperatingRegion": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RegionName", + "smithy.api#documentation": "The name of the operating Region.
", + "smithy.api#xmlName": "regionName" + } + } + }, + "traits": { + "smithy.api#documentation": "The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only\n discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
\nFor more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
" + } + }, + "com.amazonaws.ec2#IpamOperatingRegionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamOperatingRegion", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamOverlapStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "overlapping", + "name": "overlapping" + }, + { + "value": "nonoverlapping", + "name": "nonoverlapping" + }, + { + "value": "ignored", + "name": "ignored" + } + ] + } + }, + "com.amazonaws.ec2#IpamPool": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "The Amazon Web Services account ID of the owner of the IPAM pool.
", + "smithy.api#xmlName": "ownerId" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolId", + "smithy.api#documentation": "The ID of the IPAM pool.
", + "smithy.api#xmlName": "ipamPoolId" + } + }, + "SourceIpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "aws.protocols#ec2QueryName": "SourceIpamPoolId", + "smithy.api#documentation": "The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.
", + "smithy.api#xmlName": "sourceIpamPoolId" + } + }, + "IpamPoolArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolArn", + "smithy.api#documentation": "The ARN of the IPAM pool.
", + "smithy.api#xmlName": "ipamPoolArn" + } + }, + "IpamScopeArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "IpamScopeArn", + "smithy.api#documentation": "The ARN of the scope of the IPAM pool.
", + "smithy.api#xmlName": "ipamScopeArn" + } + }, + "IpamScopeType": { + "target": "com.amazonaws.ec2#IpamScopeType", + "traits": { + "aws.protocols#ec2QueryName": "IpamScopeType", + "smithy.api#documentation": "In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
", + "smithy.api#xmlName": "ipamScopeType" + } + }, + "IpamArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "IpamArn", + "smithy.api#documentation": "The ARN of the IPAM.
", + "smithy.api#xmlName": "ipamArn" + } + }, + "IpamRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpamRegion", + "smithy.api#documentation": "The Amazon Web Services Region of the IPAM pool.
", + "smithy.api#xmlName": "ipamRegion" + } + }, + "Locale": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Locale", + "smithy.api#documentation": "The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.
", + "smithy.api#xmlName": "locale" + } + }, + "PoolDepth": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "PoolDepth", + "smithy.api#documentation": "The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide.\n
", + "smithy.api#xmlName": "poolDepth" + } + }, + "State": { + "target": "com.amazonaws.ec2#IpamPoolState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "The state of the IPAM pool.
", + "smithy.api#xmlName": "state" + } + }, + "StateMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateMessage", + "smithy.api#documentation": "A message related to the failed creation of an IPAM pool.
", + "smithy.api#xmlName": "stateMessage" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "The description of the IPAM pool.
", + "smithy.api#xmlName": "description" + } + }, + "AutoImport": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AutoImport", + "smithy.api#documentation": "If selected, IPAM will continuously look for resources within the CIDR range of this pool \n and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for\n these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import \n a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently \n marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM \n discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.\n
\nA locale must be set on the pool for this feature to work.
", + "smithy.api#xmlName": "autoImport" + } + }, + "PubliclyAdvertisable": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "PubliclyAdvertisable", + "smithy.api#documentation": "Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.
The address family of the pool.
", + "smithy.api#xmlName": "addressFamily" + } + }, + "AllocationMinNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "aws.protocols#ec2QueryName": "AllocationMinNetmaskLength", + "smithy.api#documentation": "The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
", + "smithy.api#xmlName": "allocationMinNetmaskLength" + } + }, + "AllocationMaxNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "aws.protocols#ec2QueryName": "AllocationMaxNetmaskLength", + "smithy.api#documentation": "The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
", + "smithy.api#xmlName": "allocationMaxNetmaskLength" + } + }, + "AllocationDefaultNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "aws.protocols#ec2QueryName": "AllocationDefaultNetmaskLength", + "smithy.api#documentation": "The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and \n you enter 16 here, new allocations will default to 10.0.0.0/16.
", + "smithy.api#xmlName": "allocationDefaultNetmaskLength" + } + }, + "AllocationResourceTags": { + "target": "com.amazonaws.ec2#IpamResourceTagList", + "traits": { + "aws.protocols#ec2QueryName": "AllocationResourceTagSet", + "smithy.api#documentation": "Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
", + "smithy.api#xmlName": "allocationResourceTagSet" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
Limits which service in Amazon Web Services that the pool can be used in. \"ec2\", for example, allows users to use space for Elastic IP addresses and VPCs.
", + "smithy.api#xmlName": "awsService" + } + } + }, + "traits": { + "smithy.api#documentation": "In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.
" + } + }, + "com.amazonaws.ec2#IpamPoolAllocation": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Cidr", + "smithy.api#documentation": "The CIDR for the allocation. A CIDR is a representation of an IP address and its associated network mask (or netmask) and \n refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.
The ID of an allocation.
", + "smithy.api#xmlName": "ipamPoolAllocationId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "A description of the pool allocation.
", + "smithy.api#xmlName": "description" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "The ID of the resource.
", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#IpamPoolAllocationResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "The type of the resource.
", + "smithy.api#xmlName": "resourceType" + } + }, + "ResourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceRegion", + "smithy.api#documentation": "The Amazon Web Services Region of the resource.
", + "smithy.api#xmlName": "resourceRegion" + } + }, + "ResourceOwner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOwner", + "smithy.api#documentation": "The owner of the resource.
", + "smithy.api#xmlName": "resourceOwner" + } + } + }, + "traits": { + "smithy.api#documentation": "In IPAM, an allocation is a CIDR assignment from an IPAM pool to another resource or IPAM pool.
" + } + }, + "com.amazonaws.ec2#IpamPoolAllocationDisallowedCidrs": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamPoolAllocationId": { + "type": "string" + }, + "com.amazonaws.ec2#IpamPoolAllocationResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ipam-pool", + "name": "ipam_pool" + }, + { + "value": "vpc", + "name": "vpc" + }, + { + "value": "ec2-public-ipv4-pool", + "name": "ec2_public_ipv4_pool" + }, + { + "value": "custom", + "name": "custom" + } + ] + } + }, + "com.amazonaws.ec2#IpamPoolAllocationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamPoolAllocation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamPoolAwsService": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ec2", + "name": "ec2" + } + ] + } + }, + "com.amazonaws.ec2#IpamPoolCidr": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Cidr", + "smithy.api#documentation": "The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) \n and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.
The state of the CIDR.
", + "smithy.api#xmlName": "state" + } + }, + "FailureReason": { + "target": "com.amazonaws.ec2#IpamPoolCidrFailureReason", + "traits": { + "aws.protocols#ec2QueryName": "FailureReason", + "smithy.api#documentation": "Details related to why an IPAM pool CIDR failed to be provisioned.
", + "smithy.api#xmlName": "failureReason" + } + } + }, + "traits": { + "smithy.api#documentation": "A CIDR provisioned to an IPAM pool.
" + } + }, + "com.amazonaws.ec2#IpamPoolCidrFailureCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "cidr-not-available", + "name": "cidr_not_available" + } + ] + } + }, + "com.amazonaws.ec2#IpamPoolCidrFailureReason": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#IpamPoolCidrFailureCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "An error code related to why an IPAM pool CIDR failed to be provisioned.
", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "A message related to why an IPAM pool CIDR failed to be provisioned.
", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "Details related to why an IPAM pool CIDR failed to be provisioned.
" + } + }, + "com.amazonaws.ec2#IpamPoolCidrSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamPoolCidr", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamPoolCidrState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "pending-provision", + "name": "pending_provision" + }, + { + "value": "provisioned", + "name": "provisioned" + }, + { + "value": "failed-provision", + "name": "failed_provision" + }, + { + "value": "pending-deprovision", + "name": "pending_deprovision" + }, + { + "value": "deprovisioned", + "name": "deprovisioned" + }, + { + "value": "failed-deprovision", + "name": "failed_deprovision" + }, + { + "value": "pending-import", + "name": "pending_import" + }, + { + "value": "failed-import", + "name": "failed_import" + } + ] + } + }, + "com.amazonaws.ec2#IpamPoolId": { + "type": "string" + }, + "com.amazonaws.ec2#IpamPoolSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamPool", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamPoolState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "create-in-progress", + "name": "create_in_progress" + }, + { + "value": "create-complete", + "name": "create_complete" + }, + { + "value": "create-failed", + "name": "create_failed" + }, + { + "value": "modify-in-progress", + "name": "modify_in_progress" + }, + { + "value": "modify-complete", + "name": "modify_complete" + }, + { + "value": "modify-failed", + "name": "modify_failed" + }, + { + "value": "delete-in-progress", + "name": "delete_in_progress" + }, + { + "value": "delete-complete", + "name": "delete_complete" + }, + { + "value": "delete-failed", + "name": "delete_failed" + } + ] + } + }, + "com.amazonaws.ec2#IpamResourceCidr": { + "type": "structure", + "members": { + "IpamId": { + "target": "com.amazonaws.ec2#IpamId", + "traits": { + "aws.protocols#ec2QueryName": "IpamId", + "smithy.api#documentation": "The IPAM ID for an IPAM resource.
", + "smithy.api#xmlName": "ipamId" + } + }, + "IpamScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "aws.protocols#ec2QueryName": "IpamScopeId", + "smithy.api#documentation": "The scope ID for an IPAM resource.
", + "smithy.api#xmlName": "ipamScopeId" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolId", + "smithy.api#documentation": "The pool ID for an IPAM resource.
", + "smithy.api#xmlName": "ipamPoolId" + } + }, + "ResourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceRegion", + "smithy.api#documentation": "The Amazon Web Services Region for an IPAM resource.
", + "smithy.api#xmlName": "resourceRegion" + } + }, + "ResourceOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOwnerId", + "smithy.api#documentation": "The Amazon Web Services account number of the owner of an IPAM resource.
", + "smithy.api#xmlName": "resourceOwnerId" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "The ID of an IPAM resource.
", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceName", + "smithy.api#documentation": "The name of an IPAM resource.
", + "smithy.api#xmlName": "resourceName" + } + }, + "ResourceCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceCidr", + "smithy.api#documentation": "The CIDR for an IPAM resource.
", + "smithy.api#xmlName": "resourceCidr" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#IpamResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "The type of IPAM resource.
", + "smithy.api#xmlName": "resourceType" + } + }, + "ResourceTags": { + "target": "com.amazonaws.ec2#IpamResourceTagList", + "traits": { + "aws.protocols#ec2QueryName": "ResourceTagSet", + "smithy.api#documentation": "The tags for an IPAM resource.
", + "smithy.api#xmlName": "resourceTagSet" + } + }, + "IpUsage": { + "target": "com.amazonaws.ec2#BoxedDouble", + "traits": { + "aws.protocols#ec2QueryName": "IpUsage", + "smithy.api#documentation": "The IP address space in the IPAM pool that is allocated to this resource. To convert the decimal to a percentage, multiply the decimal by 100.
", + "smithy.api#xmlName": "ipUsage" + } + }, + "ComplianceStatus": { + "target": "com.amazonaws.ec2#IpamComplianceStatus", + "traits": { + "aws.protocols#ec2QueryName": "ComplianceStatus", + "smithy.api#documentation": "The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
", + "smithy.api#xmlName": "complianceStatus" + } + }, + "ManagementState": { + "target": "com.amazonaws.ec2#IpamManagementState", + "traits": { + "aws.protocols#ec2QueryName": "ManagementState", + "smithy.api#documentation": "The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
", + "smithy.api#xmlName": "managementState" + } + }, + "OverlapStatus": { + "target": "com.amazonaws.ec2#IpamOverlapStatus", + "traits": { + "aws.protocols#ec2QueryName": "OverlapStatus", + "smithy.api#documentation": "The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
", + "smithy.api#xmlName": "overlapStatus" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "The ID of a VPC.
", + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#documentation": "The CIDR for an IPAM resource.
" + } + }, + "com.amazonaws.ec2#IpamResourceCidrSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamResourceCidr", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamResourceTag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Key", + "smithy.api#documentation": "The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
", + "smithy.api#xmlName": "key" + } + }, + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "The value of the tag.
", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
The Amazon Web Services account ID of the owner of the scope.
", + "smithy.api#xmlName": "ownerId" + } + }, + "IpamScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "aws.protocols#ec2QueryName": "IpamScopeId", + "smithy.api#documentation": "The ID of the scope.
", + "smithy.api#xmlName": "ipamScopeId" + } + }, + "IpamScopeArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "IpamScopeArn", + "smithy.api#documentation": "The ARN of the scope.
", + "smithy.api#xmlName": "ipamScopeArn" + } + }, + "IpamArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "IpamArn", + "smithy.api#documentation": "The ARN of the IPAM.
", + "smithy.api#xmlName": "ipamArn" + } + }, + "IpamRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpamRegion", + "smithy.api#documentation": "The Amazon Web Services Region of the IPAM scope.
", + "smithy.api#xmlName": "ipamRegion" + } + }, + "IpamScopeType": { + "target": "com.amazonaws.ec2#IpamScopeType", + "traits": { + "aws.protocols#ec2QueryName": "IpamScopeType", + "smithy.api#documentation": "The type of the scope.
", + "smithy.api#xmlName": "ipamScopeType" + } + }, + "IsDefault": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsDefault", + "smithy.api#documentation": "Defines if the scope is the default scope or not.
", + "smithy.api#xmlName": "isDefault" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "The description of the scope.
", + "smithy.api#xmlName": "description" + } + }, + "PoolCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "PoolCount", + "smithy.api#documentation": "The number of pools in the scope.
", + "smithy.api#xmlName": "poolCount" + } + }, + "State": { + "target": "com.amazonaws.ec2#IpamScopeState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "The state of the IPAM scope.
", + "smithy.api#xmlName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
\nFor more information, see How IPAM works in the Amazon VPC IPAM User Guide\n
" + } + }, + "com.amazonaws.ec2#IpamScopeId": { + "type": "string" + }, + "com.amazonaws.ec2#IpamScopeSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamScope", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamScopeState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "create-in-progress", + "name": "create_in_progress" + }, + { + "value": "create-complete", + "name": "create_complete" + }, + { + "value": "create-failed", + "name": "create_failed" + }, + { + "value": "modify-in-progress", + "name": "modify_in_progress" + }, + { + "value": "modify-complete", + "name": "modify_complete" + }, + { + "value": "modify-failed", + "name": "modify_failed" + }, + { + "value": "delete-in-progress", + "name": "delete_in_progress" + }, + { + "value": "delete-complete", + "name": "delete_complete" + }, + { + "value": "delete-failed", + "name": "delete_failed" + } + ] + } + }, + "com.amazonaws.ec2#IpamScopeType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "public", + "name": "public" + }, + { + "value": "private", + "name": "private" + } + ] + } + }, + "com.amazonaws.ec2#IpamSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipam", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "create-in-progress", + "name": "create_in_progress" + }, + { + "value": "create-complete", + "name": "create_complete" + }, + { + "value": "create-failed", + "name": "create_failed" + }, + { + "value": "modify-in-progress", + "name": "modify_in_progress" + }, + { + "value": "modify-complete", + "name": "modify_complete" + }, + { + "value": "modify-failed", + "name": "modify_failed" + }, + { + "value": "delete-in-progress", + "name": "delete_in_progress" + }, + { + "value": "delete-complete", + "name": "delete_complete" + }, + { + "value": "delete-failed", + "name": "delete_failed" + } + ] + } + }, "com.amazonaws.ec2#Ipv4PoolEc2Id": { "type": "string" }, @@ -46543,6 +50191,64 @@ "smithy.api#documentation": "Describes the placement of an instance.
" } }, + "com.amazonaws.ec2#LaunchTemplatePrivateDnsNameOptions": { + "type": "structure", + "members": { + "HostnameType": { + "target": "com.amazonaws.ec2#HostnameType", + "traits": { + "aws.protocols#ec2QueryName": "HostnameType", + "smithy.api#documentation": "The type of hostname to assign to an instance.
", + "smithy.api#xmlName": "hostnameType" + } + }, + "EnableResourceNameDnsARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableResourceNameDnsARecord", + "smithy.api#documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
", + "smithy.api#xmlName": "enableResourceNameDnsARecord" + } + }, + "EnableResourceNameDnsAAAARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableResourceNameDnsAAAARecord", + "smithy.api#documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
", + "smithy.api#xmlName": "enableResourceNameDnsAAAARecord" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the options for instance hostnames.
" + } + }, + "com.amazonaws.ec2#LaunchTemplatePrivateDnsNameOptionsRequest": { + "type": "structure", + "members": { + "HostnameType": { + "target": "com.amazonaws.ec2#HostnameType", + "traits": { + "smithy.api#documentation": "The type of hostname for Amazon EC2 instances. For IPv4 only subnets, an instance DNS name must \n be based on the instance IPv4 address. For IPv6 native subnets, an instance DNS name must \n be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use \n the instance IPv4 address or the instance ID.
" + } + }, + "EnableResourceNameDnsARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
" + } + }, + "EnableResourceNameDnsAAAARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the options for instance hostnames.
" + } + }, "com.amazonaws.ec2#LaunchTemplateSet": { "type": "list", "member": { @@ -46886,6 +50592,85 @@ } } }, + "com.amazonaws.ec2#ListSnapshotsInRecycleBin": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ListSnapshotsInRecycleBinRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ListSnapshotsInRecycleBinResult" + }, + "traits": { + "smithy.api#documentation": "Lists one or more snapshots that are currently in the Recycle Bin.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Snapshots", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#ListSnapshotsInRecycleBinMaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#ListSnapshotsInRecycleBinRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.ec2#ListSnapshotsInRecycleBinMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" + } + }, + "SnapshotIds": { + "target": "com.amazonaws.ec2#SnapshotIdStringList", + "traits": { + "smithy.api#documentation": "The IDs of the snapshots to list. Omit this parameter to list all of the \n snapshots that are in the Recycle Bin.
", + "smithy.api#xmlName": "SnapshotId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Information about the snapshots.
", + "smithy.api#xmlName": "snapshotSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Modifies the specified attribute of the specified instance. You can specify only one\n attribute at a time.
\n\n Note: Using this action to change the security groups\n associated with an elastic network interface (ENI) attached to an instance in a VPC can\n result in an error if the instance has more than one ENI. To change the security groups\n associated with an ENI attached to an instance that has multiple ENIs, we recommend that\n you use the ModifyNetworkInterfaceAttribute action.
\nTo modify some attributes, the instance must be stopped. For more information, see\n Modifying attributes of a stopped instance in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Modifies the specified attribute of the specified instance. You can specify only one\n attribute at a time.
\n\n Note: Using this action to change the security groups\n associated with an elastic network interface (ENI) attached to an instance in a VPC can\n result in an error if the instance has more than one ENI. To change the security groups\n associated with an ENI attached to an instance that has multiple ENIs, we recommend that\n you use the ModifyNetworkInterfaceAttribute action.
\nTo modify some attributes, the instance must be stopped. For more information, see\n Modify a stopped instance in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#ModifyInstanceAttributeRequest": { @@ -48922,7 +52707,7 @@ "target": "com.amazonaws.ec2#InstanceBlockDeviceMappingSpecificationList", "traits": { "aws.protocols#ec2QueryName": "BlockDeviceMapping", - "smithy.api#documentation": "Modifies the DeleteOnTermination attribute for volumes that are currently\n attached. The volume must be owned by the caller. If no value is specified for\n DeleteOnTermination, the default is true and the volume is\n deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when\n you launch the instance. For more information, see Updating the block device mapping when launching an instance in the\n Amazon EC2 User Guide.
", + "smithy.api#documentation": "Modifies the DeleteOnTermination attribute for volumes that are currently\n attached. The volume must be owned by the caller. If no value is specified for\n DeleteOnTermination, the default is true and the volume is\n deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when\n you launch the instance. For more information, see Update the block device mapping when launching an instance in the\n Amazon EC2 User Guide.
", "smithy.api#xmlName": "blockDeviceMapping" } }, @@ -49295,19 +53080,19 @@ "HttpEndpoint": { "target": "com.amazonaws.ec2#InstanceMetadataEndpointState", "traits": { - "smithy.api#documentation": "This parameter enables or disables the HTTP metadata endpoint on your instances. If\n the parameter is not specified, the existing state is maintained.
\nIf you specify a value of disabled, you will not be able to access your\n instance metadata.
Enables or disables the HTTP metadata endpoint on your instances. If\n the parameter is not specified, the existing state is maintained.
\nIf you specify a value of disabled, you cannot access your\n instance metadata.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.
Enables or disables the IPv6 endpoint for the instance metadata service.
" + "smithy.api#documentation": "Enables or disables the IPv6 endpoint for the instance metadata service. This setting \n applies only if you have enabled the HTTP metadata endpoint.
" } } } @@ -49390,7 +53175,7 @@ "PartitionNumber": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "Reserved for future use.
" + "smithy.api#documentation": "The number of the partition in which to place the instance. Valid only if the\n placement group strategy is set to partition.
Modify the configurations of an IPAM.\n
" + } + }, + "com.amazonaws.ec2#ModifyIpamPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyIpamPoolRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyIpamPoolResult" + }, + "traits": { + "smithy.api#documentation": "Modify the configurations of an IPAM pool.
\nFor more information, see Modify a pool in the Amazon VPC IPAM User Guide.\n
" + } + }, + "com.amazonaws.ec2#ModifyIpamPoolRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the IPAM pool you want to modify.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "The description of the IPAM pool you want to modify.
" + } + }, + "AutoImport": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "If true, IPAM will continuously look for resources within the CIDR range of this pool \n and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for\n these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import \n a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently \n marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM \n discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.\n
\nA locale must be set on the pool for this feature to work.
" + } + }, + "AllocationMinNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "smithy.api#documentation": "The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible \n netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask \n length must be less than the maximum netmask length.
" + } + }, + "AllocationMaxNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "smithy.api#documentation": "The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible \n netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask \n length must be greater than the minimum netmask length.
" + } + }, + "AllocationDefaultNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "smithy.api#documentation": "The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
" + } + }, + "ClearAllocationDefaultNetmaskLength": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Clear the default netmask length allocation rule for this pool.
" + } + }, + "AddAllocationResourceTags": { + "target": "com.amazonaws.ec2#RequestIpamResourceTagList", + "traits": { + "smithy.api#documentation": "Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.
", + "smithy.api#xmlName": "AddAllocationResourceTag" + } + }, + "RemoveAllocationResourceTags": { + "target": "com.amazonaws.ec2#RequestIpamResourceTagList", + "traits": { + "smithy.api#documentation": "Remove tag allocation rules from a pool.
", + "smithy.api#xmlName": "RemoveAllocationResourceTag" + } + } + } + }, + "com.amazonaws.ec2#ModifyIpamPoolResult": { + "type": "structure", + "members": { + "IpamPool": { + "target": "com.amazonaws.ec2#IpamPool", + "traits": { + "aws.protocols#ec2QueryName": "IpamPool", + "smithy.api#documentation": "The results of the modification.
", + "smithy.api#xmlName": "ipamPool" + } + } + } + }, + "com.amazonaws.ec2#ModifyIpamRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the IPAM you want to modify.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "The description of the IPAM you want to modify.
" + } + }, + "AddOperatingRegions": { + "target": "com.amazonaws.ec2#AddIpamOperatingRegionSet", + "traits": { + "smithy.api#documentation": "Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only\n discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
\nFor more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
", + "smithy.api#xmlName": "AddOperatingRegion" + } + }, + "RemoveOperatingRegions": { + "target": "com.amazonaws.ec2#RemoveIpamOperatingRegionSet", + "traits": { + "smithy.api#documentation": "The operating Regions to remove.
", + "smithy.api#xmlName": "RemoveOperatingRegion" + } + } + } + }, + "com.amazonaws.ec2#ModifyIpamResourceCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyIpamResourceCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyIpamResourceCidrResult" + }, + "traits": { + "smithy.api#documentation": "Modify a resource CIDR. You can use this action to transfer resource CIDRs between scopes and ignore resource CIDRs that you do not want to manage. If set to false, the resource will not be tracked for overlap, it cannot be auto-imported into a pool, and it will be removed from any pool it has an allocation in.
\nFor more information, see Move resource CIDRs between scopes and Change the monitoring state of resource CIDRs in the Amazon VPC IPAM User Guide.
" + } + }, + "com.amazonaws.ec2#ModifyIpamResourceCidrRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the resource you want to modify.
", + "smithy.api#required": {} + } + }, + "ResourceCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "The CIDR of the resource you want to modify.
", + "smithy.api#required": {} + } + }, + "ResourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region of the resource you want to modify.
", + "smithy.api#required": {} + } + }, + "CurrentIpamScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "smithy.api#documentation": "The ID of the current scope that the resource CIDR is in.
", + "smithy.api#required": {} + } + }, + "DestinationIpamScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "smithy.api#documentation": "The ID of the scope you want to transfer the resource CIDR to.
" + } + }, + "Monitored": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Determines if the resource is monitored by IPAM. If a resource is monitored, the resource is discovered by IPAM and you can view details about the resource’s CIDR.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ec2#ModifyIpamResourceCidrResult": { + "type": "structure", + "members": { + "IpamResourceCidr": { + "target": "com.amazonaws.ec2#IpamResourceCidr", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceCidr", + "smithy.api#xmlName": "ipamResourceCidr" + } + } + } + }, + "com.amazonaws.ec2#ModifyIpamResult": { + "type": "structure", + "members": { + "Ipam": { + "target": "com.amazonaws.ec2#Ipam", + "traits": { + "aws.protocols#ec2QueryName": "Ipam", + "smithy.api#documentation": "The results of the modification.
", + "smithy.api#xmlName": "ipam" + } + } + } + }, + "com.amazonaws.ec2#ModifyIpamScope": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyIpamScopeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyIpamScopeResult" + }, + "traits": { + "smithy.api#documentation": "Modify an IPAM scope.
" + } + }, + "com.amazonaws.ec2#ModifyIpamScopeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the scope you want to modify.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "The description of the scope you want to modify.
" + } + } + } + }, + "com.amazonaws.ec2#ModifyIpamScopeResult": { + "type": "structure", + "members": { + "IpamScope": { + "target": "com.amazonaws.ec2#IpamScope", + "traits": { + "aws.protocols#ec2QueryName": "IpamScope", + "smithy.api#documentation": "The results of the modification.
", + "smithy.api#xmlName": "ipamScope" + } + } + } + }, "com.amazonaws.ec2#ModifyLaunchTemplate": { "type": "operation", "input": { @@ -49615,6 +53681,66 @@ "smithy.api#documentation": "Contains the parameters for ModifyNetworkInterfaceAttribute.
" } }, + "com.amazonaws.ec2#ModifyPrivateDnsNameOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyPrivateDnsNameOptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyPrivateDnsNameOptionsResult" + }, + "traits": { + "smithy.api#documentation": "Modifies the options for instance hostnames for the specified instance.
" + } + }, + "com.amazonaws.ec2#ModifyPrivateDnsNameOptionsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the instance.
" + } + }, + "PrivateDnsHostnameType": { + "target": "com.amazonaws.ec2#HostnameType", + "traits": { + "smithy.api#documentation": "The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be \n based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based \n on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance\n IPv4 address or the instance ID.
" + } + }, + "EnableResourceNameDnsARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
" + } + }, + "EnableResourceNameDnsAAAARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
" + } + } + } + }, + "com.amazonaws.ec2#ModifyPrivateDnsNameOptionsResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "Returns true if the request succeeds; otherwise, it returns an error.
Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted to a full \n snapshot that includes all of the blocks of data that were written to the volume at the \n time the snapshot was created, and moved from the standard tier to the archive \n tier. For more information, see Archive Amazon EBS snapshots \n in the Amazon Elastic Compute Cloud User Guide.
" + } + }, + "com.amazonaws.ec2#ModifySnapshotTierRequest": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#documentation": "The ID of the snapshot.
", + "smithy.api#required": {} + } + }, + "StorageTier": { + "target": "com.amazonaws.ec2#TargetStorageTier", + "traits": { + "smithy.api#documentation": "The name of the storage tier. You must specify archive.
Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the snapshot.
", + "smithy.api#xmlName": "snapshotId" + } + }, + "TieringStartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "TieringStartTime", + "smithy.api#documentation": "The date and time when the archive process was started.
", + "smithy.api#xmlName": "tieringStartTime" + } + } + } + }, "com.amazonaws.ec2#ModifySpotFleetRequest": { "type": "operation", "input": { @@ -49873,7 +54056,7 @@ "target": "com.amazonaws.ec2#ModifySubnetAttributeRequest" }, "traits": { - "smithy.api#documentation": "Modifies a subnet attribute. You can only modify one attribute at a time.
" + "smithy.api#documentation": "Modifies a subnet attribute. You can only modify one attribute at a time.
\n\t \n\tUse this action to modify subnets on Amazon Web Services Outposts.
\nTo modify a subnet on an Outpost rack, set both\n MapCustomerOwnedIpOnLaunch and\n CustomerOwnedIpv4Pool. These two parameters act as a single\n attribute.
To modify a subnet on an Outpost server, set either\n EnableLniAtDeviceIndex or\n DisableLniAtDeviceIndex.
For more information about Amazon Web Services Outposts, see the following:
\n\t \n\t\n Outpost servers\n
\n\n Outpost racks\n
\nIndicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet \n should return synthetic IPv6 addresses for IPv4-only destinations.
" } + }, + "PrivateDnsHostnameTypeOnLaunch": { + "target": "com.amazonaws.ec2#HostnameType", + "traits": { + "smithy.api#documentation": "The type of hostnames to assign to instances in the subnet at launch. For IPv4 only subnets, an\n instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance\n DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS\n names use the instance IPv4 address or the instance ID.
" + } + }, + "EnableResourceNameDnsARecordOnLaunch": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
" + } + }, + "EnableResourceNameDnsAAAARecordOnLaunch": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
" + } + }, + "EnableLniAtDeviceIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "\n Indicates the device position for local network interfaces in this subnet. For example, \n 1 indicates local network interfaces in this subnet are the secondary \n network interface (eth1). A local network interface cannot be the primary network\n interface (eth0).\n
\n Specify true to indicate that local network interfaces at the current \n position should be disabled. \n
Enables detailed monitoring for a running instance. Otherwise, basic monitoring is\n enabled. For more information, see Monitoring your instances and\n volumes in the Amazon EC2 User Guide.
\nTo disable detailed monitoring, see .
" + "smithy.api#documentation": "Enables detailed monitoring for a running instance. Otherwise, basic monitoring is\n enabled. For more information, see Monitor your instances using \n CloudWatch in the Amazon EC2 User Guide.
\nTo disable detailed monitoring, see .
" } }, "com.amazonaws.ec2#MonitorInstancesRequest": { @@ -51487,6 +55700,59 @@ } } }, + "com.amazonaws.ec2#MoveByoipCidrToIpam": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#MoveByoipCidrToIpamRequest" + }, + "output": { + "target": "com.amazonaws.ec2#MoveByoipCidrToIpamResult" + }, + "traits": { + "smithy.api#documentation": "Move an BYOIP IPv4 CIDR to IPAM from a public IPv4 pool.
" + } + }, + "com.amazonaws.ec2#MoveByoipCidrToIpamRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The BYOIP CIDR.
" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "The IPAM pool ID.
" + } + }, + "IpamPoolOwner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the owner of the IPAM pool.
" + } + } + } + }, + "com.amazonaws.ec2#MoveByoipCidrToIpamResult": { + "type": "structure", + "members": { + "ByoipCidr": { + "target": "com.amazonaws.ec2#ByoipCidr", + "traits": { + "aws.protocols#ec2QueryName": "ByoipCidr", + "smithy.api#xmlName": "byoipCidr" + } + } + } + }, "com.amazonaws.ec2#MoveStatus": { "type": "string", "traits": { @@ -51751,6 +56017,12 @@ ] } }, + "com.amazonaws.ec2#NetmaskLength": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.ec2#NetworkAcl": { "type": "structure", "members": { @@ -52112,6 +56384,224 @@ "smithy.api#documentation": "Describes the networking features of the instance type.
" } }, + "com.amazonaws.ec2#NetworkInsightsAccessScope": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeId", + "smithy.api#documentation": "The ID of the Network Access Scope.
", + "smithy.api#xmlName": "networkInsightsAccessScopeId" + } + }, + "NetworkInsightsAccessScopeArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeArn", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Network Access Scope.
", + "smithy.api#xmlName": "networkInsightsAccessScopeArn" + } + }, + "CreatedDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreatedDate", + "smithy.api#documentation": "The creation date.
", + "smithy.api#xmlName": "createdDate" + } + }, + "UpdatedDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "UpdatedDate", + "smithy.api#documentation": "The last updated date.
", + "smithy.api#xmlName": "updatedDate" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "The tags.
", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a Network Access Scope.
" + } + }, + "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysis": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeAnalysisId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysisId", + "smithy.api#documentation": "The ID of the Network Access Scope analysis.
", + "smithy.api#xmlName": "networkInsightsAccessScopeAnalysisId" + } + }, + "NetworkInsightsAccessScopeAnalysisArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysisArn", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Network Access Scope analysis.
", + "smithy.api#xmlName": "networkInsightsAccessScopeAnalysisArn" + } + }, + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeId", + "smithy.api#documentation": "The ID of the Network Access Scope.
", + "smithy.api#xmlName": "networkInsightsAccessScopeId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#AnalysisStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "The status.
", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "The status message.
", + "smithy.api#xmlName": "statusMessage" + } + }, + "WarningMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "WarningMessage", + "smithy.api#documentation": "The warning message.
", + "smithy.api#xmlName": "warningMessage" + } + }, + "StartDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartDate", + "smithy.api#documentation": "The analysis start date.
", + "smithy.api#xmlName": "startDate" + } + }, + "EndDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EndDate", + "smithy.api#documentation": "The analysis end date.
", + "smithy.api#xmlName": "endDate" + } + }, + "FindingsFound": { + "target": "com.amazonaws.ec2#FindingsFound", + "traits": { + "aws.protocols#ec2QueryName": "FindingsFound", + "smithy.api#documentation": "Indicates whether there are findings.
", + "smithy.api#xmlName": "findingsFound" + } + }, + "AnalyzedEniCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AnalyzedEniCount", + "smithy.api#documentation": "The number of network interfaces analyzed.
", + "smithy.api#xmlName": "analyzedEniCount" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "The tags.
", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a Network Access Scope analysis.
" + } + }, + "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId": { + "type": "string" + }, + "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysis", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInsightsAccessScopeContent": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeId", + "smithy.api#documentation": "The ID of the Network Access Scope.
", + "smithy.api#xmlName": "networkInsightsAccessScopeId" + } + }, + "MatchPaths": { + "target": "com.amazonaws.ec2#AccessScopePathList", + "traits": { + "aws.protocols#ec2QueryName": "MatchPathSet", + "smithy.api#documentation": "The paths to match.
", + "smithy.api#xmlName": "matchPathSet" + } + }, + "ExcludePaths": { + "target": "com.amazonaws.ec2#AccessScopePathList", + "traits": { + "aws.protocols#ec2QueryName": "ExcludePathSet", + "smithy.api#documentation": "The paths to exclude.
", + "smithy.api#xmlName": "excludePathSet" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the Network Access Scope content.
" + } + }, + "com.amazonaws.ec2#NetworkInsightsAccessScopeId": { + "type": "string" + }, + "com.amazonaws.ec2#NetworkInsightsAccessScopeIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInsightsAccessScopeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScope", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#NetworkInsightsAnalysis": { "type": "structure", "members": { @@ -52171,6 +56661,14 @@ "smithy.api#xmlName": "statusMessage" } }, + "WarningMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "WarningMessage", + "smithy.api#documentation": "The warning message.
", + "smithy.api#xmlName": "warningMessage" + } + }, "NetworkPathFound": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -52557,6 +57055,22 @@ "smithy.api#documentation": "Indicates whether a network interface with an IPv6 address is unreachable from the \n public internet. If the value is true, inbound traffic from the internet \n is dropped and you cannot assign an elastic IP address to the network interface. The \n network interface is reachable from peered VPCs and resources connected through a \n transit gateway, including on-premises networks.
Indicates whether this is an IPv6 only network interface.
", + "smithy.api#xmlName": "ipv6Native" + } + }, + "Ipv6Address": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Address", + "smithy.api#documentation": "The IPv6 globally unique address associated with the network interface.
", + "smithy.api#xmlName": "ipv6Address" + } } }, "traits": { @@ -53205,7 +57719,7 @@ "target": "com.amazonaws.ec2#FleetOnDemandAllocationStrategy", "traits": { "aws.protocols#ec2QueryName": "AllocationStrategy", - "smithy.api#documentation": "The order of the launch template overrides to use in fulfilling On-Demand capacity. If\n you specify lowest-price, EC2 Fleet uses price to determine the order, launching\n the lowest price first. If you specify prioritized, EC2 Fleet uses the priority\n that you assigned to each launch template override, launching the highest priority first.\n If you do not specify a value, EC2 Fleet defaults to lowest-price.
The strategy that determines the order of the launch template overrides to use in\n fulfilling On-Demand capacity.
\n\n lowest-price - EC2 Fleet uses price to determine the order, launching the lowest\n price first.
\n prioritized - EC2 Fleet uses the priority that you assigned to each launch\n template override, launching the highest priority first.
Default: lowest-price\n
The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.\n Supported only for fleets of type instant.
The strategy for using unused Capacity Reservations for fulfilling On-Demand\n capacity.
\nSupported only for fleets of type instant.
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.\n Supported only for fleets of type instant.
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the\n fleet.
\nSupported only for fleets of type instant.
Indicates that the fleet launches all On-Demand Instances into a single Availability Zone. Supported\n only for fleets of type instant.
Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.
\nSupported only for fleets of type instant.
The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.
", + "smithy.api#documentation": "The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.
\nSupported only for fleets of type instant.
At least one of the following must be specified: SingleAvailabilityZone |\n SingleInstanceType\n
The order of the launch template overrides to use in fulfilling On-Demand capacity. If\n you specify lowest-price, EC2 Fleet uses price to determine the order, launching\n the lowest price first. If you specify prioritized, EC2 Fleet uses the priority\n that you assigned to each launch template override, launching the highest priority first.\n If you do not specify a value, EC2 Fleet defaults to lowest-price.
The strategy that determines the order of the launch template overrides to use in\n fulfilling On-Demand capacity.
\n\n lowest-price - EC2 Fleet uses price to determine the order, launching the lowest\n price first.
\n prioritized - EC2 Fleet uses the priority that you assigned to each launch\n template override, launching the highest priority first.
Default: lowest-price\n
The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.\n Supported only for fleets of type instant.
The strategy for using unused Capacity Reservations for fulfilling On-Demand\n capacity.
\nSupported only for fleets of type instant.
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.\n Supported only for fleets of type instant.
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the\n fleet.
\nSupported only for fleets of type instant.
Indicates that the fleet launches all On-Demand Instances into a single Availability Zone. Supported\n only for fleets of type instant.
Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.
\nSupported only for fleets of type instant.
The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.
" + "smithy.api#documentation": "The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.
\nSupported only for fleets of type instant.
At least one of the following must be specified: SingleAvailabilityZone |\n SingleInstanceType\n
The source addresses.
", + "smithy.api#xmlName": "sourceAddressSet" + } + }, + "DestinationAddresses": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "DestinationAddressSet", + "smithy.api#documentation": "The destination addresses.
", + "smithy.api#xmlName": "destinationAddressSet" + } + }, + "SourcePorts": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SourcePortSet", + "smithy.api#documentation": "The source ports.
", + "smithy.api#xmlName": "sourcePortSet" + } + }, + "DestinationPorts": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPortSet", + "smithy.api#documentation": "The destination ports.
", + "smithy.api#xmlName": "destinationPortSet" + } + }, + "SourcePrefixLists": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SourcePrefixListSet", + "smithy.api#documentation": "The source prefix lists.
", + "smithy.api#xmlName": "sourcePrefixListSet" + } + }, + "DestinationPrefixLists": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPrefixListSet", + "smithy.api#documentation": "The destination prefix lists.
", + "smithy.api#xmlName": "destinationPrefixListSet" + } + }, + "Protocols": { + "target": "com.amazonaws.ec2#ProtocolList", + "traits": { + "aws.protocols#ec2QueryName": "ProtocolSet", + "smithy.api#documentation": "The protocols.
", + "smithy.api#xmlName": "protocolSet" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a packet header statement.
" + } + }, + "com.amazonaws.ec2#PacketHeaderStatementRequest": { + "type": "structure", + "members": { + "SourceAddresses": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "The source addresses.
", + "smithy.api#xmlName": "SourceAddress" + } + }, + "DestinationAddresses": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "The destination addresses.
", + "smithy.api#xmlName": "DestinationAddress" + } + }, + "SourcePorts": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "The source ports.
", + "smithy.api#xmlName": "SourcePort" + } + }, + "DestinationPorts": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "The destination ports.
", + "smithy.api#xmlName": "DestinationPort" + } + }, + "SourcePrefixLists": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "The source prefix lists.
", + "smithy.api#xmlName": "SourcePrefixList" + } + }, + "DestinationPrefixLists": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "The destination prefix lists.
", + "smithy.api#xmlName": "DestinationPrefixList" + } + }, + "Protocols": { + "target": "com.amazonaws.ec2#ProtocolList", + "traits": { + "smithy.api#documentation": "The protocols.
", + "smithy.api#xmlName": "Protocol" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a packet header statement.
" + } + }, "com.amazonaws.ec2#PartitionLoadFrequency": { "type": "string", "traits": { @@ -53388,6 +58023,14 @@ "smithy.api#xmlName": "aclRule" } }, + "AttachedTo": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "AttachedTo", + "smithy.api#documentation": "The resource to which the path component is attached.
", + "smithy.api#xmlName": "attachedTo" + } + }, "Component": { "target": "com.amazonaws.ec2#AnalysisComponent", "traits": { @@ -53474,6 +58117,50 @@ } } }, + "com.amazonaws.ec2#PathStatement": { + "type": "structure", + "members": { + "PacketHeaderStatement": { + "target": "com.amazonaws.ec2#PacketHeaderStatement", + "traits": { + "aws.protocols#ec2QueryName": "PacketHeaderStatement", + "smithy.api#documentation": "The packet header statement.
", + "smithy.api#xmlName": "packetHeaderStatement" + } + }, + "ResourceStatement": { + "target": "com.amazonaws.ec2#ResourceStatement", + "traits": { + "aws.protocols#ec2QueryName": "ResourceStatement", + "smithy.api#documentation": "The resource statement.
", + "smithy.api#xmlName": "resourceStatement" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a path statement.
" + } + }, + "com.amazonaws.ec2#PathStatementRequest": { + "type": "structure", + "members": { + "PacketHeaderStatement": { + "target": "com.amazonaws.ec2#PacketHeaderStatementRequest", + "traits": { + "smithy.api#documentation": "The packet header statement.
" + } + }, + "ResourceStatement": { + "target": "com.amazonaws.ec2#ResourceStatementRequest", + "traits": { + "smithy.api#documentation": "The resource statement.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a path statement.
" + } + }, "com.amazonaws.ec2#PaymentOption": { "type": "string", "traits": { @@ -53969,7 +58656,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "PartitionNumber", - "smithy.api#documentation": "The number of the partition the instance is in. Valid only if the placement group\n strategy is set to partition.
This parameter is not supported by CreateFleet.
", + "smithy.api#documentation": "The number of the partition that the instance is in. Valid only if the placement group\n strategy is set to partition.
This parameter is not supported by CreateFleet.
", "smithy.api#xmlName": "partitionNumber" } }, @@ -54762,6 +59449,96 @@ "smithy.api#documentation": "Information about the private DNS name for the service endpoint. For more information\n about these parameters, see VPC Endpoint Service\n Private DNS Name Verification in the\n Amazon Virtual Private Cloud User Guide.
" } }, + "com.amazonaws.ec2#PrivateDnsNameOptionsOnLaunch": { + "type": "structure", + "members": { + "HostnameType": { + "target": "com.amazonaws.ec2#HostnameType", + "traits": { + "aws.protocols#ec2QueryName": "HostnameType", + "smithy.api#documentation": "The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be \n based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based \n on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance\n IPv4 address or the instance ID.
", + "smithy.api#xmlName": "hostnameType" + } + }, + "EnableResourceNameDnsARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableResourceNameDnsARecord", + "smithy.api#documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
", + "smithy.api#xmlName": "enableResourceNameDnsARecord" + } + }, + "EnableResourceNameDnsAAAARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableResourceNameDnsAAAARecord", + "smithy.api#documentation": "Indicates whether to respond to DNS queries for instance hostname with DNS AAAA records.
", + "smithy.api#xmlName": "enableResourceNameDnsAAAARecord" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the options for instance hostnames.
" + } + }, + "com.amazonaws.ec2#PrivateDnsNameOptionsRequest": { + "type": "structure", + "members": { + "HostnameType": { + "target": "com.amazonaws.ec2#HostnameType", + "traits": { + "smithy.api#documentation": "The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be \n based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based \n on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance\n IPv4 address or the instance ID.
" + } + }, + "EnableResourceNameDnsARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
" + } + }, + "EnableResourceNameDnsAAAARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the options for instance hostnames.
" + } + }, + "com.amazonaws.ec2#PrivateDnsNameOptionsResponse": { + "type": "structure", + "members": { + "HostnameType": { + "target": "com.amazonaws.ec2#HostnameType", + "traits": { + "aws.protocols#ec2QueryName": "HostnameType", + "smithy.api#documentation": "The type of hostname to assign to an instance.
", + "smithy.api#xmlName": "hostnameType" + } + }, + "EnableResourceNameDnsARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableResourceNameDnsARecord", + "smithy.api#documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
", + "smithy.api#xmlName": "enableResourceNameDnsARecord" + } + }, + "EnableResourceNameDnsAAAARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableResourceNameDnsAAAARecord", + "smithy.api#documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
", + "smithy.api#xmlName": "enableResourceNameDnsAAAARecord" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the options for instance hostnames.
" + } + }, "com.amazonaws.ec2#PrivateIpAddressConfigSet": { "type": "list", "member": { @@ -54946,6 +59723,15 @@ ] } }, + "com.amazonaws.ec2#ProtocolList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Protocol", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#ProtocolValue": { "type": "string", "traits": { @@ -55031,6 +59817,125 @@ } } }, + "com.amazonaws.ec2#ProvisionIpamPoolCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ProvisionIpamPoolCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ProvisionIpamPoolCidrResult" + }, + "traits": { + "smithy.api#documentation": "Provision a CIDR to an IPAM pool. You can use thsi action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.
\nFor more information, see Provision CIDRs to pools in the Amazon VPC IPAM User Guide.\n
" + } + }, + "com.amazonaws.ec2#ProvisionIpamPoolCidrRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the IPAM pool to which you want to assign a CIDR.
", + "smithy.api#required": {} + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "The CIDR you want to assign to the IPAM pool.
" + } + }, + "CidrAuthorizationContext": { + "target": "com.amazonaws.ec2#IpamCidrAuthorizationContext", + "traits": { + "smithy.api#documentation": "A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option applies to public pools only.
" + } + } + } + }, + "com.amazonaws.ec2#ProvisionIpamPoolCidrResult": { + "type": "structure", + "members": { + "IpamPoolCidr": { + "target": "com.amazonaws.ec2#IpamPoolCidr", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolCidr", + "smithy.api#documentation": "Information about the provisioned CIDR.
", + "smithy.api#xmlName": "ipamPoolCidr" + } + } + } + }, + "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidrResult" + }, + "traits": { + "smithy.api#documentation": "Provision a CIDR to a public IPv4 pool.
\nFor more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.\n
" + } + }, + "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidrRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the IPAM pool you would like to use to allocate this CIDR.
", + "smithy.api#required": {} + } + }, + "PoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", + "traits": { + "smithy.api#documentation": "The ID of the public IPv4 pool you would like to use for this CIDR.
", + "smithy.api#required": {} + } + }, + "NetmaskLength": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "The netmask length of the CIDR you would like to allocate to the public IPv4 pool.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidrResult": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", + "traits": { + "aws.protocols#ec2QueryName": "PoolId", + "smithy.api#documentation": "The ID of the pool that you want to provision the CIDR to.
", + "smithy.api#xmlName": "poolId" + } + }, + "PoolAddressRange": { + "target": "com.amazonaws.ec2#PublicIpv4PoolRange", + "traits": { + "aws.protocols#ec2QueryName": "PoolAddressRange", + "smithy.api#xmlName": "poolAddressRange" + } + } + } + }, "com.amazonaws.ec2#ProvisionedBandwidth": { "type": "structure", "members": { @@ -55647,7 +60552,7 @@ "target": "com.amazonaws.ec2#RebootInstancesRequest" }, "traits": { - "smithy.api#documentation": "Requests a reboot of the specified instances. This operation is asynchronous; it only\n queues a request to reboot the specified instances. The operation succeeds if the\n instances are valid and belong to you. Requests to reboot terminated instances are\n ignored.
\nIf an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a\n hard reboot.
\nFor more information about troubleshooting, see Getting console output and\n rebooting instances in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Requests a reboot of the specified instances. This operation is asynchronous; it only\n queues a request to reboot the specified instances. The operation succeeds if the\n instances are valid and belong to you. Requests to reboot terminated instances are\n ignored.
\nIf an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a\n hard reboot.
\nFor more information about troubleshooting, see Troubleshoot an unreachable \n instance in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#RebootInstancesRequest": { @@ -56463,6 +61368,88 @@ } } }, + "com.amazonaws.ec2#ReleaseIpamPoolAllocation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ReleaseIpamPoolAllocationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ReleaseIpamPoolAllocationResult" + }, + "traits": { + "smithy.api#documentation": "Release an allocation within an IPAM pool. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using ModifyIpamResourceCidr. For more information, see Release an allocation in the Amazon VPC IPAM User Guide.\n
" + } + }, + "com.amazonaws.ec2#ReleaseIpamPoolAllocationRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the IPAM pool which contains the allocation you want to release.
", + "smithy.api#required": {} + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "The CIDR of the allocation you want to release.
", + "smithy.api#required": {} + } + }, + "IpamPoolAllocationId": { + "target": "com.amazonaws.ec2#IpamPoolAllocationId", + "traits": { + "smithy.api#documentation": "The ID of the allocation.
" + } + } + } + }, + "com.amazonaws.ec2#ReleaseIpamPoolAllocationResult": { + "type": "structure", + "members": { + "Success": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Success", + "smithy.api#documentation": "Indicates if the release was successful.
", + "smithy.api#xmlName": "success" + } + } + } + }, + "com.amazonaws.ec2#RemoveIpamOperatingRegion": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "The name of the operating Region you want to remove.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Remove an operating Region from an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only\n discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
\nFor more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide\n
" + } + }, + "com.amazonaws.ec2#RemoveIpamOperatingRegionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RemoveIpamOperatingRegion" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, "com.amazonaws.ec2#RemovePrefixListEntries": { "type": "list", "member": { @@ -56926,7 +61913,10 @@ } }, "CoreNetworkArn": { - "target": "com.amazonaws.ec2#CoreNetworkArn" + "target": "com.amazonaws.ec2#CoreNetworkArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the core network.
" + } } } }, @@ -57232,6 +62222,35 @@ } } }, + "com.amazonaws.ec2#RequestIpamResourceTag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
" + } + }, + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "The value for the tag.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A tag on an IPAM resource.
" + } + }, + "com.amazonaws.ec2#RequestIpamResourceTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RequestIpamResourceTag", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#RequestLaunchTemplateData": { "type": "structure", "members": { @@ -57410,6 +62429,12 @@ "traits": { "smithy.api#documentation": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.
\nIf you specify InstanceRequirements, you can't specify\n InstanceTypes.
The options for the instance hostname. The default values are inherited from the subnet.
" + } } }, "traits": { @@ -58993,6 +64018,52 @@ } } }, + "com.amazonaws.ec2#ResourceStatement": { + "type": "structure", + "members": { + "Resources": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "ResourceSet", + "smithy.api#documentation": "The resources.
", + "smithy.api#xmlName": "resourceSet" + } + }, + "ResourceTypes": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "ResourceTypeSet", + "smithy.api#documentation": "The resource types.
", + "smithy.api#xmlName": "resourceTypeSet" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a resource statement.
" + } + }, + "com.amazonaws.ec2#ResourceStatementRequest": { + "type": "structure", + "members": { + "Resources": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "The resources.
", + "smithy.api#xmlName": "Resource" + } + }, + "ResourceTypes": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "The resource types.
", + "smithy.api#xmlName": "ResourceType" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a resource statement.
" + } + }, "com.amazonaws.ec2#ResourceType": { "type": "string", "traits": { @@ -59077,6 +64148,18 @@ "value": "internet-gateway", "name": "internet_gateway" }, + { + "value": "ipam", + "name": "ipam" + }, + { + "value": "ipam-pool", + "name": "ipam_pool" + }, + { + "value": "ipam-scope", + "name": "ipam_scope" + }, { "value": "ipv4pool-ec2", "name": "ipv4pool_ec2" @@ -59137,6 +64220,14 @@ "value": "network-insights-path", "name": "network_insights_path" }, + { + "value": "network-insights-access-scope", + "name": "network_insights_access_scope" + }, + { + "value": "network-insights-access-scope-analysis", + "name": "network_insights_access_scope_analysis" + }, { "value": "placement-group", "name": "placement_group" @@ -59516,6 +64607,14 @@ "smithy.api#documentation": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.
\nIf you specify InstanceRequirements, you can't specify\n InstanceTypes.
The options for the instance hostname.
", + "smithy.api#xmlName": "privateDnsNameOptions" + } } }, "traits": { @@ -59640,6 +64739,206 @@ } } }, + "com.amazonaws.ec2#RestoreSnapshotFromRecycleBin": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RestoreSnapshotFromRecycleBinRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RestoreSnapshotFromRecycleBinResult" + }, + "traits": { + "smithy.api#documentation": "Restores a snapshot from the Recycle Bin. For more information, see Restore \n snapshots from the Recycle Bin in the Amazon Elastic Compute Cloud User Guide.
" + } + }, + "com.amazonaws.ec2#RestoreSnapshotFromRecycleBinRequest": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#documentation": "The ID of the snapshot to restore.
", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the snapshot.
", + "smithy.api#xmlName": "snapshotId" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the \n Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#xmlName": "outpostArn" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "The description for the snapshot.
", + "smithy.api#xmlName": "description" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#documentation": "Indicates whether the snapshot is encrypted.
", + "smithy.api#xmlName": "encrypted" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the EBS snapshot.
", + "smithy.api#xmlName": "ownerId" + } + }, + "Progress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "The progress of the snapshot, as a percentage.
", + "smithy.api#xmlName": "progress" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "The time stamp when the snapshot was initiated.
", + "smithy.api#xmlName": "startTime" + } + }, + "State": { + "target": "com.amazonaws.ec2#SnapshotState", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "The state of the snapshot.
", + "smithy.api#xmlName": "status" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "The ID of the volume that was used to create the snapshot.
", + "smithy.api#xmlName": "volumeId" + } + }, + "VolumeSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "VolumeSize", + "smithy.api#documentation": "The size of the volume, in GiB.
", + "smithy.api#xmlName": "volumeSize" + } + } + } + }, + "com.amazonaws.ec2#RestoreSnapshotTier": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RestoreSnapshotTierRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RestoreSnapshotTierResult" + }, + "traits": { + "smithy.api#documentation": "Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore \n period or restore type for a snapshot that was previously temporarily restored.
\n \nFor more information see \n Restore an archived snapshot and \n modify the restore period or restore type for a temporarily restored snapshot in the Amazon Elastic Compute Cloud User Guide.
" + } + }, + "com.amazonaws.ec2#RestoreSnapshotTierRequest": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#documentation": "The ID of the snapshot to restore.
", + "smithy.api#required": {} + } + }, + "TemporaryRestoreDays": { + "target": "com.amazonaws.ec2#RestoreSnapshotTierRequestTemporaryRestoreDays", + "traits": { + "smithy.api#documentation": "Specifies the number of days for which to temporarily restore an archived snapshot. \n Required for temporary restores only. The snapshot will be automatically re-archived \n after this period.
\nTo temporarily restore an archived snapshot, specify the number of days and omit \n the PermanentRestore parameter or set it to \n false.
Indicates whether to permanently restore an archived snapshot. To permanently restore \n an archived snapshot, specify true and omit the \n RestoreSnapshotTierRequest$TemporaryRestoreDays parameter.
Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the snapshot.
", + "smithy.api#xmlName": "snapshotId" + } + }, + "RestoreStartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "RestoreStartTime", + "smithy.api#documentation": "The date and time when the snapshot restore process started.
", + "smithy.api#xmlName": "restoreStartTime" + } + }, + "RestoreDuration": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "RestoreDuration", + "smithy.api#documentation": "For temporary restores only. The number of days for which the archived snapshot \n is temporarily restored.
", + "smithy.api#xmlName": "restoreDuration" + } + }, + "IsPermanentRestore": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsPermanentRestore", + "smithy.api#documentation": "Indicates whether the snapshot is permanently restored. true indicates a permanent \n restore. false indicates a temporary restore.
The Amazon Resource Name (ARN) of the core network.
", "smithy.api#xmlName": "coreNetworkArn" } } @@ -60491,7 +65791,7 @@ "UserData": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The user data to make available to the instance. For more information, see Running commands\n on your Linux instance at launch (Linux) and Adding User Data (Windows). If you are using a command line tool,\n base64-encoding is performed for you, and you can load the text from a file. Otherwise,\n you must provide base64-encoded text. User data is limited to 16 KB.
" + "smithy.api#documentation": "The user data to make available to the instance. For more information, see Run commands\n on your Linux instance at launch and Run commands on your Windows instance at launch. If you are using a command line tool,\n base64-encoding is performed for you, and you can load the text from a file. Otherwise,\n you must provide base64-encoded text. User data is limited to 16 KB.
" } }, "AdditionalInfo": { @@ -60608,7 +65908,7 @@ "CpuOptions": { "target": "com.amazonaws.ec2#CpuOptionsRequest", "traits": { - "smithy.api#documentation": "The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.
" } }, "CapacityReservationSpecification": { @@ -60641,6 +65941,12 @@ "traits": { "smithy.api#documentation": "Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, \n\t\t\tsee \n\t\t\t What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.
\t\t\n\tYou can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.
" } + }, + "PrivateDnsNameOptions": { + "target": "com.amazonaws.ec2#PrivateDnsNameOptionsRequest", + "traits": { + "smithy.api#documentation": "The options for the instance hostname. The default values are inherited from the subnet.
" + } } } }, @@ -62178,7 +67484,7 @@ "target": "com.amazonaws.ec2#SendDiagnosticInterruptRequest" }, "traits": { - "smithy.api#documentation": "Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a \n\t\t\tkernel panic (on Linux instances), or a \n\t\t\tblue screen/stop error (on Windows \n\t\t\tinstances). For instances based on Intel and AMD processors, the interrupt is \n\t\t\treceived as a non-maskable interrupt (NMI).
\n\t\t\n\t\tIn general, the operating system crashes and reboots when a kernel panic or stop \n\t\t\terror is triggered. The operating system can also be configured to perform diagnostic \n\t\t\ttasks, such as generating a memory dump file, loading a secondary kernel, or \n\t\t\tobtaining a call trace.
\n\t\t\n\t\tBefore sending a diagnostic interrupt to your instance, ensure that its operating \n\t\t\tsystem is configured to perform the required diagnostic tasks.
\n\t\t\n\t\tFor more information about configuring your operating system to generate a crash dump\n\t\t\twhen a kernel panic or stop error occurs, see Send a diagnostic interrupt (Linux instances) or Send a Diagnostic Interrupt (Windows instances).
" + "smithy.api#documentation": "Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a \n\t\t\tkernel panic (on Linux instances), or a \n\t\t\tblue screen/stop error (on Windows \n\t\t\tinstances). For instances based on Intel and AMD processors, the interrupt is \n\t\t\treceived as a non-maskable interrupt (NMI).
\n\t\t\n\t\tIn general, the operating system crashes and reboots when a kernel panic or stop \n\t\t\terror is triggered. The operating system can also be configured to perform diagnostic \n\t\t\ttasks, such as generating a memory dump file, loading a secondary kernel, or \n\t\t\tobtaining a call trace.
\n\t\t\n\t\tBefore sending a diagnostic interrupt to your instance, ensure that its operating \n\t\t\tsystem is configured to perform the required diagnostic tasks.
\n\t\t\n\t\tFor more information about configuring your operating system to generate a crash dump\n\t\t\twhen a kernel panic or stop error occurs, see Send a diagnostic interrupt (for advanced users) (Linux instances) or Send a diagnostic interrupt (for advanced users) (Windows instances).
" } }, "com.amazonaws.ec2#SendDiagnosticInterruptRequest": { @@ -62697,6 +68003,22 @@ "smithy.api#documentation": "Any tags assigned to the snapshot.
", "smithy.api#xmlName": "tagSet" } + }, + "StorageTier": { + "target": "com.amazonaws.ec2#StorageTier", + "traits": { + "aws.protocols#ec2QueryName": "StorageTier", + "smithy.api#documentation": "The storage tier in which the snapshot is stored. standard indicates \n that the snapshot is stored in the standard snapshot storage tier and that it is ready \n for use. archive indicates that the snapshot is currently archived and that \n it must be restored before it can be used.
Only for archived snapshots that are temporarily restored. Indicates the date and \n time when a temporarily restored snapshot will be automatically re-archived.
", + "smithy.api#xmlName": "restoreExpiryTime" + } } }, "traits": { @@ -62964,6 +68286,63 @@ } } }, + "com.amazonaws.ec2#SnapshotRecycleBinInfo": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "The ID of the snapshot.
", + "smithy.api#xmlName": "snapshotId" + } + }, + "RecycleBinEnterTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "RecycleBinEnterTime", + "smithy.api#documentation": "The date and time when the snaphsot entered the Recycle Bin.
", + "smithy.api#xmlName": "recycleBinEnterTime" + } + }, + "RecycleBinExitTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "RecycleBinExitTime", + "smithy.api#documentation": "The date and time when the snapshot is to be permanently deleted from the Recycle Bin.
", + "smithy.api#xmlName": "recycleBinExitTime" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "The description for the snapshot.
", + "smithy.api#xmlName": "description" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "The ID of the volume from which the snapshot was created.
", + "smithy.api#xmlName": "volumeId" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a snapshot that is currently in the Recycle Bin.
" + } + }, + "com.amazonaws.ec2#SnapshotRecycleBinInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SnapshotRecycleBinInfo", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#SnapshotSet": { "type": "list", "member": { @@ -62988,6 +68367,14 @@ { "value": "error", "name": "error" + }, + { + "value": "recoverable", + "name": "recoverable" + }, + { + "value": "recovering", + "name": "recovering" } ] } @@ -63088,6 +68475,110 @@ "smithy.api#documentation": "Details about the import snapshot task.
" } }, + "com.amazonaws.ec2#SnapshotTierStatus": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "The ID of the snapshot.
", + "smithy.api#xmlName": "snapshotId" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeId", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "The ID of the volume from which the snapshot was created.
", + "smithy.api#xmlName": "volumeId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#SnapshotState", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "The state of the snapshot.
", + "smithy.api#xmlName": "status" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the snapshot.
", + "smithy.api#xmlName": "ownerId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "The tags that are assigned to the snapshot.
", + "smithy.api#xmlName": "tagSet" + } + }, + "StorageTier": { + "target": "com.amazonaws.ec2#StorageTier", + "traits": { + "aws.protocols#ec2QueryName": "StorageTier", + "smithy.api#documentation": "The storage tier in which the snapshot is stored. standard indicates \n that the snapshot is stored in the standard snapshot storage tier and that it is ready \n for use. archive indicates that the snapshot is currently archived and that \n it must be restored before it can be used.
The date and time when the last archive or restore process was started.
", + "smithy.api#xmlName": "lastTieringStartTime" + } + }, + "LastTieringProgress": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "LastTieringProgress", + "smithy.api#documentation": "The progress of the last archive or restore process, as a percentage.
", + "smithy.api#xmlName": "lastTieringProgress" + } + }, + "LastTieringOperationStatus": { + "target": "com.amazonaws.ec2#TieringOperationStatus", + "traits": { + "aws.protocols#ec2QueryName": "LastTieringOperationStatus", + "smithy.api#documentation": "The status of the last archive or restore process.
", + "smithy.api#xmlName": "lastTieringOperationStatus" + } + }, + "LastTieringOperationStatusDetail": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LastTieringOperationStatusDetail", + "smithy.api#documentation": "A message describing the status of the last archive or restore process.
", + "smithy.api#xmlName": "lastTieringOperationStatusDetail" + } + }, + "ArchivalCompleteTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "ArchivalCompleteTime", + "smithy.api#documentation": "The date and time when the last archive process was completed.
", + "smithy.api#xmlName": "archivalCompleteTime" + } + }, + "RestoreExpiryTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "RestoreExpiryTime", + "smithy.api#documentation": "Only for archived snapshots that are temporarily restored. Indicates the date and \n time when a temporarily restored snapshot will be automatically re-archived.
", + "smithy.api#xmlName": "restoreExpiryTime" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information about a snapshot's storage tier.
" + } + }, "com.amazonaws.ec2#SpotAllocationStrategy": { "type": "string", "traits": { @@ -63126,7 +68617,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "TerminationDelay", - "smithy.api#documentation": "The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.
", + "smithy.api#documentation": "The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.
\nValid only when ReplacementStrategy is set to launch-before-terminate.
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by\n the EC2 Fleet.
\nIf the allocation strategy is lowest-price, EC2 Fleet launches instances from\n the Spot Instance pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified, EC2 Fleet launches instances from all\n of the Spot Instance pools that you specify.
If the allocation strategy is capacity-optimized (recommended), EC2 Fleet\n launches instances from Spot Instance pools with optimal capacity for the number of instances that\n are launching. To give certain instance types a higher chance of launching first, use\n capacity-optimized-prioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized is supported only if your fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet.
\n\n lowest-price - EC2 Fleet launches instances from the Spot Instance pools with the lowest\n price.
\n diversified - EC2 Fleet launches instances from all of the Spot Instance pools that you\n specify.
\n capacity-optimized (recommended) - EC2 Fleet launches instances from Spot Instance pools\n with optimal capacity for the number of instances that are launching. To give certain\n instance types a higher chance of launching first, use\n capacity-optimized-prioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized is supported only if your fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.
Default: lowest-price\n
The behavior when a Spot Instance is interrupted. The default is terminate.
The behavior when a Spot Instance is interrupted.
\nDefault: terminate\n
The number of Spot pools across which to allocate your target Spot capacity. Valid only\n when AllocationStrategy is set to\n lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates\n your target Spot capacity across the number of Spot pools that you specify.
Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a\n best effort basis. If a pool runs out of Spot capacity before fulfilling your target\n capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest\n pool. To ensure that your target capacity is met, you might receive Spot Instances from more than\n the number of pools that you specified. Similarly, if most of the pools have no Spot\n capacity, you might receive your full target capacity from fewer than the number of pools\n that you specified.
", + "smithy.api#documentation": "The number of Spot pools across which to allocate your target Spot capacity. Supported\n only when AllocationStrategy is set to lowest-price. EC2 Fleet selects\n the cheapest Spot pools and evenly allocates your target Spot capacity across the number of\n Spot pools that you specify.
Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a\n best effort basis. If a pool runs out of Spot capacity before fulfilling your target\n capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest\n pool. To ensure that your target capacity is met, you might receive Spot Instances from more than\n the number of pools that you specified. Similarly, if most of the pools have no Spot\n capacity, you might receive your full target capacity from fewer than the number of pools\n that you specified.
", "smithy.api#xmlName": "instancePoolsToUseCount" } }, @@ -64077,7 +69568,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "SingleInstanceType", - "smithy.api#documentation": "Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.\n Supported only for fleets of type instant.
Indicates that the fleet uses a single instance type to launch all Spot Instances in the\n fleet.
\nSupported only for fleets of type instant.
Indicates that the fleet launches all Spot Instances into a single Availability Zone. Supported\n only for fleets of type instant.
Indicates that the fleet launches all Spot Instances into a single Availability Zone.
\nSupported only for fleets of type instant.
The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.
", + "smithy.api#documentation": "The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.
\nSupported only for fleets of type instant.
At least one of the following must be specified: SingleAvailabilityZone |\n SingleInstanceType\n
Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by\n the EC2 Fleet.
\nIf the allocation strategy is lowest-price, EC2 Fleet launches instances from\n the Spot Instance pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified, EC2 Fleet launches instances from all\n of the Spot Instance pools that you specify.
If the allocation strategy is capacity-optimized (recommended), EC2 Fleet\n launches instances from Spot Instance pools with optimal capacity for the number of instances that\n are launching. To give certain instance types a higher chance of launching first, use\n capacity-optimized-prioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized is supported only if your fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by\n the EC2 Fleet.
\n\n lowest-price - EC2 Fleet launches instances from\n the Spot Instance pools with the lowest price.
\n diversified - EC2 Fleet launches instances from all\n of the Spot Instance pools that you specify.
\n capacity-optimized (recommended) - EC2 Fleet\n launches instances from Spot Instance pools with optimal capacity for the number of instances that\n are launching. To give certain instance types a higher chance of launching first, use\n capacity-optimized-prioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized is supported only if your fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.
Default: lowest-price\n
The behavior when a Spot Instance is interrupted. The default is terminate.
The behavior when a Spot Instance is interrupted.
\nDefault: terminate\n
The number of Spot pools across which to allocate your target Spot capacity. Valid only\n when Spot AllocationStrategy is set to\n lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates\n your target Spot capacity across the number of Spot pools that you specify.
Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a\n best effort basis. If a pool runs out of Spot capacity before fulfilling your target\n capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest\n pool. To ensure that your target capacity is met, you might receive Spot Instances from more than\n the number of pools that you specified. Similarly, if most of the pools have no Spot\n capacity, you might receive your full target capacity from fewer than the number of pools\n that you specified.
" + "smithy.api#documentation": "The number of Spot pools across which to allocate your target Spot capacity. Supported\n only when Spot AllocationStrategy is set to lowest-price. EC2 Fleet\n selects the cheapest Spot pools and evenly allocates your target Spot capacity across the\n number of Spot pools that you specify.
Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a\n best effort basis. If a pool runs out of Spot capacity before fulfilling your target\n capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest\n pool. To ensure that your target capacity is met, you might receive Spot Instances from more than\n the number of pools that you specified. Similarly, if most of the pools have no Spot\n capacity, you might receive your full target capacity from fewer than the number of pools\n that you specified.
" } }, "SingleInstanceType": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.\n Supported only for fleets of type instant.
Indicates that the fleet uses a single instance type to launch all Spot Instances in the\n fleet.
\nSupported only for fleets of type instant.
Indicates that the fleet launches all Spot Instances into a single Availability Zone. Supported\n only for fleets of type instant.
Indicates that the fleet launches all Spot Instances into a single Availability Zone.
\nSupported only for fleets of type instant.
The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.
" + "smithy.api#documentation": "The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.
\nSupported only for fleets of type instant.
At least one of the following must be specified: SingleAvailabilityZone |\n SingleInstanceType\n
Starts an Amazon EBS-backed instance that you've previously stopped.
\nInstances that use Amazon EBS volumes as their root devices can be quickly stopped and\n started. When an instance is stopped, the compute resources are released and you are not\n billed for instance usage. However, your root partition Amazon EBS volume remains and\n continues to persist your data, and you are charged for Amazon EBS volume usage. You can\n restart your instance at any time. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.
\nBefore stopping an instance, make sure it is in a state from which it can be\n restarted. Stopping an instance does not preserve data stored in RAM.
\nPerforming this operation on an instance that uses an instance store as its root\n device returns an error.
\n \nIf you attempt to start a T3 instance with host tenancy and the unlimted \n CPU credit option, the request fails. The unlimited CPU credit option is not \n supported on Dedicated Hosts. Before you start the instance, either change its CPU credit \n option to standard, or change its tenancy to default or dedicated.
For more information, see Stopping instances in the\n Amazon EC2 User Guide.
" + "smithy.api#documentation": "Starts an Amazon EBS-backed instance that you've previously stopped.
\nInstances that use Amazon EBS volumes as their root devices can be quickly stopped and\n started. When an instance is stopped, the compute resources are released and you are not\n billed for instance usage. However, your root partition Amazon EBS volume remains and\n continues to persist your data, and you are charged for Amazon EBS volume usage. You can\n restart your instance at any time. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.
\nBefore stopping an instance, make sure it is in a state from which it can be\n restarted. Stopping an instance does not preserve data stored in RAM.
\nPerforming this operation on an instance that uses an instance store as its root\n device returns an error.
\n \nIf you attempt to start a T3 instance with host tenancy and the unlimted \n CPU credit option, the request fails. The unlimited CPU credit option is not \n supported on Dedicated Hosts. Before you start the instance, either change its CPU credit \n option to standard, or change its tenancy to default or dedicated.
For more information, see Stop and start your instance\n in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#StartInstancesRequest": { @@ -64498,6 +69989,64 @@ } } }, + "com.amazonaws.ec2#StartNetworkInsightsAccessScopeAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#StartNetworkInsightsAccessScopeAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.ec2#StartNetworkInsightsAccessScopeAnalysisResult" + }, + "traits": { + "smithy.api#documentation": "Starts analyzing the specified Network Access Scope.
" + } + }, + "com.amazonaws.ec2#StartNetworkInsightsAccessScopeAnalysisRequest": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "smithy.api#documentation": "The ID of the Network Access Scope.
", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The tags to apply.
", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, \n see How to ensure idempotency.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ec2#StartNetworkInsightsAccessScopeAnalysisResult": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeAnalysis": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysis", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysis", + "smithy.api#documentation": "The Network Access Scope analysis.
", + "smithy.api#xmlName": "networkInsightsAccessScopeAnalysis" + } + } + } + }, "com.amazonaws.ec2#StartNetworkInsightsAnalysis": { "type": "operation", "input": { @@ -64746,7 +70295,7 @@ "target": "com.amazonaws.ec2#StopInstancesResult" }, "traits": { - "smithy.api#documentation": "Stops an Amazon EBS-backed instance.
\nYou can use the Stop action to hibernate an instance if the instance is enabled for\n hibernation and it meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon EC2 User Guide.
\nWe don't charge usage for a stopped instance, or data transfer fees; however, your\n root partition Amazon EBS volume remains and continues to persist your data, and you are\n charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.
\nYou can't stop or hibernate instance store-backed instances. You can't use the Stop\n action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate\n Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide.
\nWhen you stop or hibernate an instance, we shut it down. You can restart your instance\n at any time. Before stopping or hibernating an instance, make sure it is in a state from\n which it can be restarted. Stopping an instance does not preserve data stored in RAM,\n but hibernating an instance does preserve data stored in RAM. If an instance cannot\n hibernate successfully, a normal shutdown occurs.
\nStopping and hibernating an instance is different to rebooting or terminating it. For\n example, when you stop or hibernate an instance, the root device and any other devices\n attached to the instance persist. When you terminate an instance, the root device and\n any other devices attached during the instance launch are automatically deleted. For\n more information about the differences between rebooting, stopping, hibernating, and\n terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.
\nWhen you stop an instance, we attempt to shut it down forcibly after a short while. If\n your instance appears stuck in the stopping state after a period of time, there may be\n an issue with the underlying host computer. For more information, see Troubleshooting\n stopping your instance in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Stops an Amazon EBS-backed instance.
\nYou can use the Stop action to hibernate an instance if the instance is enabled for\n hibernation and it meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon EC2 User Guide.
\nWe don't charge usage for a stopped instance, or data transfer fees; however, your\n root partition Amazon EBS volume remains and continues to persist your data, and you are\n charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.
\nYou can't stop or hibernate instance store-backed instances. You can't use the Stop\n action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate\n Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide.
\nWhen you stop or hibernate an instance, we shut it down. You can restart your instance\n at any time. Before stopping or hibernating an instance, make sure it is in a state from\n which it can be restarted. Stopping an instance does not preserve data stored in RAM,\n but hibernating an instance does preserve data stored in RAM. If an instance cannot\n hibernate successfully, a normal shutdown occurs.
\nStopping and hibernating an instance is different to rebooting or terminating it. For\n example, when you stop or hibernate an instance, the root device and any other devices\n attached to the instance persist. When you terminate an instance, the root device and\n any other devices attached during the instance launch are automatically deleted. For\n more information about the differences between rebooting, stopping, hibernating, and\n terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.
\nWhen you stop an instance, we attempt to shut it down forcibly after a short while. If\n your instance appears stuck in the stopping state after a period of time, there may be\n an issue with the underlying host computer. For more information, see Troubleshoot\n stopping your instance in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#StopInstancesRequest": { @@ -64832,6 +70381,21 @@ "smithy.api#documentation": "Describes a storage location in Amazon S3.
" } }, + "com.amazonaws.ec2#StorageTier": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "archive", + "name": "archive" + }, + { + "value": "standard", + "name": "standard" + } + ] + } + }, "com.amazonaws.ec2#StoreImageTaskResult": { "type": "structure", "members": { @@ -64960,6 +70524,14 @@ "smithy.api#xmlName": "defaultForAz" } }, + "EnableLniAtDeviceIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "EnableLniAtDeviceIndex", + "smithy.api#documentation": "\n Indicates the device position for local network interfaces in this subnet. For example, \n 1 indicates local network interfaces in this subnet are the secondary \n network interface (eth1). \n
Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet \n should return synthetic IPv6 addresses for IPv4-only destinations.
", "smithy.api#xmlName": "enableDns64" } + }, + "Ipv6Native": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Native", + "smithy.api#documentation": "Indicates whether this is an IPv6 only subnet.
", + "smithy.api#xmlName": "ipv6Native" + } + }, + "PrivateDnsNameOptionsOnLaunch": { + "target": "com.amazonaws.ec2#PrivateDnsNameOptionsOnLaunch", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsNameOptionsOnLaunch", + "smithy.api#documentation": "The type of hostnames to assign to instances in the subnet at launch. An instance hostname\n is based on the IPv4 address or ID of the instance.
", + "smithy.api#xmlName": "privateDnsNameOptionsOnLaunch" + } } }, "traits": { @@ -65270,7 +70858,7 @@ "target": "com.amazonaws.ec2#SubnetCidrAssociationId", "traits": { "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#documentation": "The association ID for the CIDR block.
", + "smithy.api#documentation": "The ID of the association.
", "smithy.api#xmlName": "associationId" } }, @@ -65286,13 +70874,13 @@ "target": "com.amazonaws.ec2#SubnetCidrBlockState", "traits": { "aws.protocols#ec2QueryName": "Ipv6CidrBlockState", - "smithy.api#documentation": "Information about the state of the CIDR block.
", + "smithy.api#documentation": "The state of the CIDR block.
", "smithy.api#xmlName": "ipv6CidrBlockState" } } }, "traits": { - "smithy.api#documentation": "Describes an IPv6 CIDR block associated with a subnet.
" + "smithy.api#documentation": "Describes an association between a subnet and an IPv6 CIDR block.
" } }, "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociationSet": { @@ -65827,6 +71415,17 @@ } } }, + "com.amazonaws.ec2#TargetStorageTier": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "archive", + "name": "archive" + } + ] + } + }, "com.amazonaws.ec2#TelemetryStatus": { "type": "string", "traits": { @@ -66034,6 +71633,97 @@ } } }, + "com.amazonaws.ec2#ThroughResourcesStatement": { + "type": "structure", + "members": { + "ResourceStatement": { + "target": "com.amazonaws.ec2#ResourceStatement", + "traits": { + "aws.protocols#ec2QueryName": "ResourceStatement", + "smithy.api#documentation": "The resource statement.
", + "smithy.api#xmlName": "resourceStatement" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a through resource statement.
" + } + }, + "com.amazonaws.ec2#ThroughResourcesStatementList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ThroughResourcesStatement", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ThroughResourcesStatementRequest": { + "type": "structure", + "members": { + "ResourceStatement": { + "target": "com.amazonaws.ec2#ResourceStatementRequest", + "traits": { + "smithy.api#documentation": "The resource statement.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a through resource statement.
" + } + }, + "com.amazonaws.ec2#ThroughResourcesStatementRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ThroughResourcesStatementRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TieringOperationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "archival-in-progress", + "name": "archival_in_progress" + }, + { + "value": "archival-completed", + "name": "archival_completed" + }, + { + "value": "archival-failed", + "name": "archival_failed" + }, + { + "value": "temporary-restore-in-progress", + "name": "temporary_restore_in_progress" + }, + { + "value": "temporary-restore-completed", + "name": "temporary_restore_completed" + }, + { + "value": "temporary-restore-failed", + "name": "temporary_restore_failed" + }, + { + "value": "permanent-restore-in-progress", + "name": "permanent_restore_in_progress" + }, + { + "value": "permanent-restore-completed", + "name": "permanent_restore_completed" + }, + { + "value": "permanent-restore-failed", + "name": "permanent_restore_failed" + } + ] + } + }, "com.amazonaws.ec2#TotalLocalStorageGB": { "type": "structure", "members": { @@ -72555,6 +78245,15 @@ ] } }, + "com.amazonaws.ec2#snapshotTierStatusSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SnapshotTierStatus", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#totalFpgaMemory": { "type": "integer", "traits": { diff --git a/aws/sdk/aws-models/ecr.json b/aws/sdk/aws-models/ecr.json index 63d195a3ad9e1098634d089eb6e295e87bcc28eb..b5860b726f22f36facaee2ecf396cc7c942d9440 100644 --- a/aws/sdk/aws-models/ecr.json +++ b/aws/sdk/aws-models/ecr.json @@ -31,6 +31,24 @@ "shapes": { "com.amazonaws.ecr#AmazonEC2ContainerRegistry_V20150921": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "ECR", + "arnNamespace": "ecr", + "cloudFormationName": "ECR", + "cloudTrailEventSource": "ecr.amazonaws.com", + "endpointPrefix": "api.ecr" + }, + "aws.auth#sigv4": { + "name": "ecr" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service. Customers can use the\n familiar Docker CLI, or their preferred client, to push, pull, and manage images. Amazon ECR\n provides a secure, scalable, and reliable registry for your Docker or Open Container\n Initiative (OCI) images. Amazon ECR supports private repositories with resource-based\n permissions using IAM so that specific users or Amazon EC2 instances can access\n repositories and images.
\nAmazon ECR has service endpoints in each supported Region. For more information, see Amazon ECR endpoints in the\n Amazon Web Services General Reference.
", + "smithy.api#title": "Amazon EC2 Container Registry", + "smithy.api#xmlNamespace": { + "uri": "http://ecr.amazonaws.com/doc/2015-09-21/" + } + }, "version": "2015-09-21", "operations": [ { @@ -42,15 +60,24 @@ { "target": "com.amazonaws.ecr#BatchGetImage" }, + { + "target": "com.amazonaws.ecr#BatchGetRepositoryScanningConfiguration" + }, { "target": "com.amazonaws.ecr#CompleteLayerUpload" }, + { + "target": "com.amazonaws.ecr#CreatePullThroughCacheRule" + }, { "target": "com.amazonaws.ecr#CreateRepository" }, { "target": "com.amazonaws.ecr#DeleteLifecyclePolicy" }, + { + "target": "com.amazonaws.ecr#DeletePullThroughCacheRule" + }, { "target": "com.amazonaws.ecr#DeleteRegistryPolicy" }, @@ -69,6 +96,9 @@ { "target": "com.amazonaws.ecr#DescribeImageScanFindings" }, + { + "target": "com.amazonaws.ecr#DescribePullThroughCacheRules" + }, { "target": "com.amazonaws.ecr#DescribeRegistry" }, @@ -90,6 +120,9 @@ { "target": "com.amazonaws.ecr#GetRegistryPolicy" }, + { + "target": "com.amazonaws.ecr#GetRegistryScanningConfiguration" + }, { "target": "com.amazonaws.ecr#GetRepositoryPolicy" }, @@ -117,6 +150,9 @@ { "target": "com.amazonaws.ecr#PutRegistryPolicy" }, + { + "target": "com.amazonaws.ecr#PutRegistryScanningConfiguration" + }, { "target": "com.amazonaws.ecr#PutReplicationConfiguration" }, @@ -138,25 +174,10 @@ { "target": "com.amazonaws.ecr#UploadLayerPart" } - ], - "traits": { - "aws.api#service": { - "sdkId": "ECR", - "arnNamespace": "ecr", - "cloudFormationName": "ECR", - "cloudTrailEventSource": "ecr.amazonaws.com", - "endpointPrefix": "api.ecr" - }, - "aws.auth#sigv4": { - "name": "ecr" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service. Customers can use the\n familiar Docker CLI, or their preferred client, to push, pull, and manage images. Amazon ECR\n provides a secure, scalable, and reliable registry for your Docker or Open Container\n Initiative (OCI) images. Amazon ECR supports private repositories with resource-based\n permissions using IAM so that specific users or Amazon EC2 instances can access\n repositories and images.
\nAmazon ECR has service endpoints in each supported Region. For more information, see Amazon ECR endpoints in the\n Amazon Web Services General Reference.
", - "smithy.api#title": "Amazon EC2 Container Registry", - "smithy.api#xmlNamespace": { - "uri": "http://ecr.amazonaws.com/doc/2015-09-21/" - } - } + ] + }, + "com.amazonaws.ecr#Arch": { + "type": "string" }, "com.amazonaws.ecr#Arn": { "type": "string" @@ -212,6 +233,9 @@ } } }, + "com.amazonaws.ecr#Author": { + "type": "string" + }, "com.amazonaws.ecr#AuthorizationData": { "type": "structure", "members": { @@ -244,12 +268,71 @@ "target": "com.amazonaws.ecr#AuthorizationData" } }, + "com.amazonaws.ecr#AwsEcrContainerImageDetails": { + "type": "structure", + "members": { + "architecture": { + "target": "com.amazonaws.ecr#Arch", + "traits": { + "smithy.api#documentation": "The architecture of the Amazon ECR container image.
" + } + }, + "author": { + "target": "com.amazonaws.ecr#Author", + "traits": { + "smithy.api#documentation": "The image author of the Amazon ECR container image.
" + } + }, + "imageHash": { + "target": "com.amazonaws.ecr#ImageDigest", + "traits": { + "smithy.api#documentation": "The image hash of the Amazon ECR container image.
" + } + }, + "imageTags": { + "target": "com.amazonaws.ecr#ImageTagsList", + "traits": { + "smithy.api#documentation": "The image tags attached to the Amazon ECR container image.
" + } + }, + "platform": { + "target": "com.amazonaws.ecr#Platform", + "traits": { + "smithy.api#documentation": "The platform of the Amazon ECR container image.
" + } + }, + "pushedAt": { + "target": "com.amazonaws.ecr#Date", + "traits": { + "smithy.api#documentation": "The date and time the Amazon ECR container image was pushed.
" + } + }, + "registry": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "The registry the Amazon ECR container image belongs to.
" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "The name of the repository the Amazon ECR container image resides in.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The image details of the Amazon ECR container image.
" + } + }, "com.amazonaws.ecr#Base64": { "type": "string", "traits": { "smithy.api#pattern": "^\\S+$" } }, + "com.amazonaws.ecr#BaseScore": { + "type": "double" + }, "com.amazonaws.ecr#BatchCheckLayerAvailability": { "type": "operation", "input": { @@ -454,6 +537,61 @@ } } }, + "com.amazonaws.ecr#BatchGetRepositoryScanningConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#BatchGetRepositoryScanningConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ecr#BatchGetRepositoryScanningConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#RepositoryNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the scanning configuration for one or more repositories.
" + } + }, + "com.amazonaws.ecr#BatchGetRepositoryScanningConfigurationRequest": { + "type": "structure", + "members": { + "repositoryNames": { + "target": "com.amazonaws.ecr#ScanningConfigurationRepositoryNameList", + "traits": { + "smithy.api#documentation": "One or more repository names to get the scanning configuration for.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ecr#BatchGetRepositoryScanningConfigurationResponse": { + "type": "structure", + "members": { + "scanningConfigurations": { + "target": "com.amazonaws.ecr#RepositoryScanningConfigurationList", + "traits": { + "smithy.api#documentation": "The scanning configuration for the requested repositories.
" + } + }, + "failures": { + "target": "com.amazonaws.ecr#RepositoryScanningConfigurationFailureList", + "traits": { + "smithy.api#documentation": "Any failures associated with the call.
" + } + } + } + }, "com.amazonaws.ecr#BatchedOperationLayerDigest": { "type": "string", "traits": { @@ -513,7 +651,7 @@ } ], "traits": { - "smithy.api#documentation": "Informs Amazon ECR that the image layer upload has completed for a specified registry,\n repository name, and upload ID. You can optionally provide a sha256 digest\n of the image layer for data validation purposes.
When an image is pushed, the CompleteLayerUpload API is called once per each new image\n layer to verify that the upload has completed.
\nThis operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
Informs Amazon ECR that the image layer upload has completed for a specified registry,\n repository name, and upload ID. You can optionally provide a sha256 digest\n of the image layer for data validation purposes.
When an image is pushed, the CompleteLayerUpload API is called once per each new image\n layer to verify that the upload has completed.
\nThis operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
Creates a pull through cache rule. A pull through cache rule provides a way to cache\n images from an external public registry in your Amazon ECR private registry.
" + } + }, + "com.amazonaws.ecr#CreatePullThroughCacheRuleRequest": { + "type": "structure", + "members": { + "ecrRepositoryPrefix": { + "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", + "traits": { + "smithy.api#documentation": "The repository name prefix to use when caching images from the source registry.
", + "smithy.api#required": {} + } + }, + "upstreamRegistryUrl": { + "target": "com.amazonaws.ecr#Url", + "traits": { + "smithy.api#documentation": "The registry URL of the upstream public registry to use as the source for the pull\n through cache rule.
", + "smithy.api#required": {} + } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry to create the pull through cache\n rule for. If you do not specify a registry, the default registry is assumed.
" + } + } + } + }, + "com.amazonaws.ecr#CreatePullThroughCacheRuleResponse": { + "type": "structure", + "members": { + "ecrRepositoryPrefix": { + "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", + "traits": { + "smithy.api#documentation": "The Amazon ECR repository prefix associated with the pull through cache rule.
" + } + }, + "upstreamRegistryUrl": { + "target": "com.amazonaws.ecr#Url", + "traits": { + "smithy.api#documentation": "The upstream registry URL associated with the pull through cache rule.
" + } + }, + "createdAt": { + "target": "com.amazonaws.ecr#CreationTimestamp", + "traits": { + "smithy.api#documentation": "The date and time, in JavaScript date format, when the pull through cache rule was\n created.
" + } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "The registry ID associated with the request.
" + } + } + } + }, "com.amazonaws.ecr#CreateRepository": { "type": "operation", "input": { @@ -618,7 +842,7 @@ "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { - "smithy.api#documentation": "The AWS account ID associated with the registry to create the repository.\n If you do not specify a registry, the default registry is assumed.
" + "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry to create the repository.\n If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { @@ -668,6 +892,111 @@ "com.amazonaws.ecr#CreationTimestamp": { "type": "timestamp" }, + "com.amazonaws.ecr#CvssScore": { + "type": "structure", + "members": { + "baseScore": { + "target": "com.amazonaws.ecr#BaseScore", + "traits": { + "smithy.api#documentation": "The base CVSS score used for the finding.
" + } + }, + "scoringVector": { + "target": "com.amazonaws.ecr#ScoringVector", + "traits": { + "smithy.api#documentation": "The vector string of the CVSS score.
" + } + }, + "source": { + "target": "com.amazonaws.ecr#Source", + "traits": { + "smithy.api#documentation": "The source of the CVSS score.
" + } + }, + "version": { + "target": "com.amazonaws.ecr#Version", + "traits": { + "smithy.api#documentation": "The version of CVSS used for the score.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The CVSS score for a finding.
" + } + }, + "com.amazonaws.ecr#CvssScoreAdjustment": { + "type": "structure", + "members": { + "metric": { + "target": "com.amazonaws.ecr#Metric", + "traits": { + "smithy.api#documentation": "The metric used to adjust the CVSS score.
" + } + }, + "reason": { + "target": "com.amazonaws.ecr#Reason", + "traits": { + "smithy.api#documentation": "The reason the CVSS score has been adjustment.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details on adjustments Amazon Inspector made to the CVSS score for a finding.
" + } + }, + "com.amazonaws.ecr#CvssScoreAdjustmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#CvssScoreAdjustment" + } + }, + "com.amazonaws.ecr#CvssScoreDetails": { + "type": "structure", + "members": { + "adjustments": { + "target": "com.amazonaws.ecr#CvssScoreAdjustmentList", + "traits": { + "smithy.api#documentation": "An object that contains details about adjustment Amazon Inspector made to the CVSS score.
" + } + }, + "score": { + "target": "com.amazonaws.ecr#Score", + "traits": { + "smithy.api#documentation": "The CVSS score.
" + } + }, + "scoreSource": { + "target": "com.amazonaws.ecr#Source", + "traits": { + "smithy.api#documentation": "The source for the CVSS score.
" + } + }, + "scoringVector": { + "target": "com.amazonaws.ecr#ScoringVector", + "traits": { + "smithy.api#documentation": "The vector for the CVSS score.
" + } + }, + "version": { + "target": "com.amazonaws.ecr#Version", + "traits": { + "smithy.api#documentation": "The CVSS version used in scoring.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the CVSS score.
" + } + }, + "com.amazonaws.ecr#CvssScoreList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#CvssScore" + } + }, + "com.amazonaws.ecr#Date": { + "type": "timestamp" + }, "com.amazonaws.ecr#DeleteLifecyclePolicy": { "type": "operation", "input": { @@ -741,6 +1070,79 @@ } } }, + "com.amazonaws.ecr#DeletePullThroughCacheRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#DeletePullThroughCacheRuleRequest" + }, + "output": { + "target": "com.amazonaws.ecr#DeletePullThroughCacheRuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#PullThroughCacheRuleNotFoundException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a pull through cache rule.
" + } + }, + "com.amazonaws.ecr#DeletePullThroughCacheRuleRequest": { + "type": "structure", + "members": { + "ecrRepositoryPrefix": { + "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", + "traits": { + "smithy.api#documentation": "The Amazon ECR repository prefix associated with the pull through cache rule to\n delete.
", + "smithy.api#required": {} + } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry that contains the pull through cache\n rule. If you do not specify a registry, the default registry is assumed.
" + } + } + } + }, + "com.amazonaws.ecr#DeletePullThroughCacheRuleResponse": { + "type": "structure", + "members": { + "ecrRepositoryPrefix": { + "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", + "traits": { + "smithy.api#documentation": "The Amazon ECR repository prefix associated with the request.
" + } + }, + "upstreamRegistryUrl": { + "target": "com.amazonaws.ecr#Url", + "traits": { + "smithy.api#documentation": "The upstream registry URL associated with the pull through cache rule.
" + } + }, + "createdAt": { + "target": "com.amazonaws.ecr#CreationTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp associated with the pull through cache rule.
" + } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "The registry ID associated with the request.
" + } + } + } + }, "com.amazonaws.ecr#DeleteRegistryPolicy": { "type": "operation", "input": { @@ -1015,6 +1417,9 @@ }, { "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { @@ -1212,24 +1617,101 @@ "filter": { "target": "com.amazonaws.ecr#DescribeImagesFilter", "traits": { - "smithy.api#documentation": "The filter key and value with which to filter your DescribeImages\n results.
The filter key and value with which to filter your DescribeImages\n results.
A list of ImageDetail objects that contain data about the\n image.
" + } + }, + "nextToken": { + "target": "com.amazonaws.ecr#NextToken", + "traits": { + "smithy.api#documentation": "The nextToken value to include in a future DescribeImages\n request. When the results of a DescribeImages request exceed\n maxResults, this value can be used to retrieve the next page of\n results. This value is null when there are no more results to\n return.
Returns the pull through cache rules for a registry.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.ecr#DescribePullThroughCacheRulesRequest": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry to return the pull through cache\n rules for. If you do not specify a registry, the default registry is assumed.
" + } + }, + "ecrRepositoryPrefixes": { + "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefixList", + "traits": { + "smithy.api#documentation": "The Amazon ECR repository prefixes associated with the pull through cache rules to return.\n If no repository prefix value is specified, all pull through cache rules are\n returned.
" + } + }, + "nextToken": { + "target": "com.amazonaws.ecr#NextToken", + "traits": { + "smithy.api#documentation": "The nextToken value returned from a previous paginated\n DescribePullThroughCacheRulesRequest request where\n maxResults was used and the results exceeded the value of that\n parameter. Pagination continues from the end of the previous results that returned the\n nextToken value. This value is null when there are no more results to\n return.
The maximum number of pull through cache rules returned by\n DescribePullThroughCacheRulesRequest in paginated output. When this\n parameter is used, DescribePullThroughCacheRulesRequest only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another DescribePullThroughCacheRulesRequest request with the returned\n nextToken value. This value can be between 1 and 1000. If this\n parameter is not used, then DescribePullThroughCacheRulesRequest returns up\n to 100 results and a nextToken value, if applicable.
A list of ImageDetail objects that contain data about the\n image.
" + "smithy.api#documentation": "The details of the pull through cache rules.
" } }, "nextToken": { "target": "com.amazonaws.ecr#NextToken", "traits": { - "smithy.api#documentation": "The nextToken value to include in a future DescribeImages\n request. When the results of a DescribeImages request exceed\n maxResults, this value can be used to retrieve the next page of\n results. This value is null when there are no more results to\n return.
The nextToken value to include in a future\n DescribePullThroughCacheRulesRequest request. When the results of a\n DescribePullThroughCacheRulesRequest request exceed\n maxResults, this value can be used to retrieve the next page of\n results. This value is null when there are no more results to return.
The encryption type to use.
\nIf you use the KMS encryption type, the contents of the repository will\n be encrypted using server-side encryption with Key Management Service key stored in KMS. When you\n use KMS to encrypt your data, you can either use the default Amazon Web Services managed KMS key\n for Amazon ECR, or specify your own KMS key, which you already created. For more\n information, see Protecting data using server-side\n encryption with an KMS key stored in Key Management Service (SSE-KMS) in the\n Amazon Simple Storage Service Console Developer Guide..
If you use the AES256 encryption type, Amazon ECR uses server-side encryption\n with Amazon S3-managed encryption keys which encrypts the images in the repository using an\n AES-256 encryption algorithm. For more information, see Protecting data using\n server-side encryption with Amazon S3-managed encryption keys (SSE-S3) in the\n Amazon Simple Storage Service Console Developer Guide..
The encryption type to use.
\nIf you use the KMS encryption type, the contents of the repository will\n be encrypted using server-side encryption with Key Management Service key stored in KMS. When you\n use KMS to encrypt your data, you can either use the default Amazon Web Services managed KMS key\n for Amazon ECR, or specify your own KMS key, which you already created. For more\n information, see Protecting data using server-side\n encryption with an KMS key stored in Key Management Service (SSE-KMS) in the\n Amazon Simple Storage Service Console Developer Guide.
If you use the AES256 encryption type, Amazon ECR uses server-side encryption\n with Amazon S3-managed encryption keys which encrypts the images in the repository using an\n AES-256 encryption algorithm. For more information, see Protecting data using\n server-side encryption with Amazon S3-managed encryption keys (SSE-S3) in the\n Amazon Simple Storage Service Console Developer Guide.
The Amazon Web Services account ID associated with the image.
" + } + }, + "description": { + "target": "com.amazonaws.ecr#FindingDescription", + "traits": { + "smithy.api#documentation": "The description of the finding.
" + } + }, + "findingArn": { + "target": "com.amazonaws.ecr#FindingArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the finding.
" + } + }, + "firstObservedAt": { + "target": "com.amazonaws.ecr#Date", + "traits": { + "smithy.api#documentation": "The date and time that the finding was first observed.
" + } + }, + "lastObservedAt": { + "target": "com.amazonaws.ecr#Date", + "traits": { + "smithy.api#documentation": "The date and time that the finding was last observed.
" + } + }, + "packageVulnerabilityDetails": { + "target": "com.amazonaws.ecr#PackageVulnerabilityDetails", + "traits": { + "smithy.api#documentation": "An object that contains the details of a package vulnerability finding.
" + } + }, + "remediation": { + "target": "com.amazonaws.ecr#Remediation", + "traits": { + "smithy.api#documentation": "An object that contains the details about how to remediate a finding.
" + } + }, + "resources": { + "target": "com.amazonaws.ecr#ResourceList", + "traits": { + "smithy.api#documentation": "Contains information on the resources involved in a finding.
" + } + }, + "score": { + "target": "com.amazonaws.ecr#Score", + "traits": { + "smithy.api#documentation": "The Amazon Inspector score given to the finding.
" + } + }, + "scoreDetails": { + "target": "com.amazonaws.ecr#ScoreDetails", + "traits": { + "smithy.api#documentation": "An object that contains details of the Amazon Inspector score.
" + } + }, + "severity": { + "target": "com.amazonaws.ecr#Severity", + "traits": { + "smithy.api#documentation": "The severity of the finding.
" + } + }, + "status": { + "target": "com.amazonaws.ecr#Status", + "traits": { + "smithy.api#documentation": "The status of the finding.
" + } + }, + "title": { + "target": "com.amazonaws.ecr#Title", + "traits": { + "smithy.api#documentation": "The title of the finding.
" + } + }, + "type": { + "target": "com.amazonaws.ecr#Type", + "traits": { + "smithy.api#documentation": "The type of the finding.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.ecr#Date", + "traits": { + "smithy.api#documentation": "The date and time the finding was last updated at.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of an enhanced image scan. This is returned when enhanced scanning is\n enabled for your private registry.
" + } + }, + "com.amazonaws.ecr#EnhancedImageScanFindingList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#EnhancedImageScanFinding" + } + }, + "com.amazonaws.ecr#Epoch": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.ecr#EvaluationTimestamp": { "type": "timestamp" }, @@ -1413,6 +2005,12 @@ "com.amazonaws.ecr#ExpirationTimestamp": { "type": "timestamp" }, + "com.amazonaws.ecr#FilePath": { + "type": "string" + }, + "com.amazonaws.ecr#FindingArn": { + "type": "string" + }, "com.amazonaws.ecr#FindingDescription": { "type": "string" }, @@ -1859,6 +2457,50 @@ } } }, + "com.amazonaws.ecr#GetRegistryScanningConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#GetRegistryScanningConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ecr#GetRegistryScanningConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the scanning configuration for a registry.
" + } + }, + "com.amazonaws.ecr#GetRegistryScanningConfigurationRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.ecr#GetRegistryScanningConfigurationResponse": { + "type": "structure", + "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "The ID of the registry.
" + } + }, + "scanningConfiguration": { + "target": "com.amazonaws.ecr#RegistryScanningConfiguration", + "traits": { + "smithy.api#documentation": "The scanning configuration for the registry.
" + } + } + } + }, "com.amazonaws.ecr#GetRepositoryPolicy": { "type": "operation", "input": { @@ -2229,7 +2871,7 @@ "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { - "smithy.api#documentation": "The AWS account ID associated with the registry to which the image belongs.
" + "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry to which the image belongs.
" } }, "status": { @@ -2314,16 +2956,22 @@ "smithy.api#documentation": "The time when the vulnerability data was last scanned.
" } }, + "findingSeverityCounts": { + "target": "com.amazonaws.ecr#FindingSeverityCounts", + "traits": { + "smithy.api#documentation": "The image vulnerability counts, sorted by severity.
" + } + }, "findings": { "target": "com.amazonaws.ecr#ImageScanFindingList", "traits": { "smithy.api#documentation": "The findings from the image scan.
" } }, - "findingSeverityCounts": { - "target": "com.amazonaws.ecr#FindingSeverityCounts", + "enhancedFindings": { + "target": "com.amazonaws.ecr#EnhancedImageScanFindingList", "traits": { - "smithy.api#documentation": "The image vulnerability counts, sorted by severity.
" + "smithy.api#documentation": "Details about the enhanced scan findings from Amazon Inspector.
" } } }, @@ -2439,6 +3087,12 @@ ] } }, + "com.amazonaws.ecr#ImageTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#ImageTag" + } + }, "com.amazonaws.ecr#InitiateLayerUpload": { "type": "operation", "input": { @@ -2462,7 +3116,7 @@ } ], "traits": { - "smithy.api#documentation": "Notifies Amazon ECR that you intend to upload an image layer.
\nWhen an image is pushed, the InitiateLayerUpload API is called once per image layer\n that has not already been uploaded. Whether or not an image layer has been uploaded is\n determined by the BatchCheckLayerAvailability API action.
\nThis operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
Notifies Amazon ECR that you intend to upload an image layer.
\nWhen an image is pushed, the InitiateLayerUpload API is called once per image layer\n that has not already been uploaded. Whether or not an image layer has been uploaded is\n determined by the BatchCheckLayerAvailability API action.
\nThis operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
List the tags for an Amazon ECR resource.
" } }, - "com.amazonaws.ecr#ListTagsForResourceRequest": { + "com.amazonaws.ecr#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.ecr#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the\n only supported resource is an Amazon ECR repository.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ecr#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.ecr#TagList", + "traits": { + "smithy.api#documentation": "The tags for the resource.
" + } + } + } + }, + "com.amazonaws.ecr#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ecr#MediaType": { + "type": "string" + }, + "com.amazonaws.ecr#MediaTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#MediaType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ecr#Metric": { + "type": "string" + }, + "com.amazonaws.ecr#NextToken": { + "type": "string" + }, + "com.amazonaws.ecr#PackageManager": { + "type": "string" + }, + "com.amazonaws.ecr#PackageVulnerabilityDetails": { + "type": "structure", + "members": { + "cvss": { + "target": "com.amazonaws.ecr#CvssScoreList", + "traits": { + "smithy.api#documentation": "An object that contains details about the CVSS score of a finding.
" + } + }, + "referenceUrls": { + "target": "com.amazonaws.ecr#ReferenceUrlsList", + "traits": { + "smithy.api#documentation": "One or more URLs that contain details about this vulnerability type.
" + } + }, + "relatedVulnerabilities": { + "target": "com.amazonaws.ecr#RelatedVulnerabilitiesList", + "traits": { + "smithy.api#documentation": "One or more vulnerabilities related to the one identified in this finding.
" + } + }, + "source": { + "target": "com.amazonaws.ecr#Source", + "traits": { + "smithy.api#documentation": "The source of the vulnerability information.
" + } + }, + "sourceUrl": { + "target": "com.amazonaws.ecr#Url", + "traits": { + "smithy.api#documentation": "A URL to the source of the vulnerability information.
" + } + }, + "vendorCreatedAt": { + "target": "com.amazonaws.ecr#Date", + "traits": { + "smithy.api#documentation": "The date and time that this vulnerability was first added to the vendor's\n database.
" + } + }, + "vendorSeverity": { + "target": "com.amazonaws.ecr#Severity", + "traits": { + "smithy.api#documentation": "The severity the vendor has given to this vulnerability type.
" + } + }, + "vendorUpdatedAt": { + "target": "com.amazonaws.ecr#Date", + "traits": { + "smithy.api#documentation": "The date and time the vendor last updated this vulnerability in their database.
" + } + }, + "vulnerabilityId": { + "target": "com.amazonaws.ecr#VulnerabilityId", + "traits": { + "smithy.api#documentation": "The ID given to this vulnerability.
" + } + }, + "vulnerablePackages": { + "target": "com.amazonaws.ecr#VulnerablePackagesList", + "traits": { + "smithy.api#documentation": "The packages impacted by this vulnerability.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a package vulnerability finding.
" + } + }, + "com.amazonaws.ecr#PartSize": { + "type": "long", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.ecr#Platform": { + "type": "string" + }, + "com.amazonaws.ecr#ProxyEndpoint": { + "type": "string" + }, + "com.amazonaws.ecr#PullThroughCacheRule": { + "type": "structure", + "members": { + "ecrRepositoryPrefix": { + "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", + "traits": { + "smithy.api#documentation": "The Amazon ECR repository prefix associated with the pull through cache rule.
" + } + }, + "upstreamRegistryUrl": { + "target": "com.amazonaws.ecr#Url", + "traits": { + "smithy.api#documentation": "The upstream registry URL associated with the pull through cache rule.
" + } + }, + "createdAt": { + "target": "com.amazonaws.ecr#CreationTimestamp", + "traits": { + "smithy.api#documentation": "The date and time the pull through cache was created.
" + } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry the pull through cache rule is\n associated with.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a pull through cache rule.
" + } + }, + "com.amazonaws.ecr#PullThroughCacheRuleAlreadyExistsException": { "type": "structure", "members": { - "resourceArn": { - "target": "com.amazonaws.ecr#Arn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the\n only supported resource is an Amazon ECR repository.
", - "smithy.api#required": {} - } + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" } + }, + "traits": { + "smithy.api#documentation": "A pull through cache rule with these settings already exists for the private\n registry.
", + "smithy.api#error": "client" } }, - "com.amazonaws.ecr#ListTagsForResourceResponse": { + "com.amazonaws.ecr#PullThroughCacheRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#PullThroughCacheRule" + } + }, + "com.amazonaws.ecr#PullThroughCacheRuleNotFoundException": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.ecr#TagList", - "traits": { - "smithy.api#documentation": "The tags for the resource.
" - } + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" } + }, + "traits": { + "smithy.api#documentation": "The pull through cache rule was not found. Specify a valid pull through cache rule and\n try again.
", + "smithy.api#error": "client" } }, - "com.amazonaws.ecr#MaxResults": { - "type": "integer", + "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix": { + "type": "string", "traits": { - "smithy.api#box": {}, - "smithy.api#range": { - "min": 1, - "max": 1000 - } + "smithy.api#length": { + "min": 2, + "max": 20 + }, + "smithy.api#pattern": "^[a-z0-9]+(?:[._-][a-z0-9]+)*$" } }, - "com.amazonaws.ecr#MediaType": { - "type": "string" - }, - "com.amazonaws.ecr#MediaTypeList": { + "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefixList": { "type": "list", "member": { - "target": "com.amazonaws.ecr#MediaType" + "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix" }, "traits": { "smithy.api#length": { @@ -3162,21 +3992,6 @@ } } }, - "com.amazonaws.ecr#NextToken": { - "type": "string" - }, - "com.amazonaws.ecr#PartSize": { - "type": "long", - "traits": { - "smithy.api#box": {}, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.ecr#ProxyEndpoint": { - "type": "string" - }, "com.amazonaws.ecr#PushTimestamp": { "type": "timestamp" }, @@ -3295,6 +4110,9 @@ }, { "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { @@ -3543,6 +4361,57 @@ } } }, + "com.amazonaws.ecr#PutRegistryScanningConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecr#PutRegistryScanningConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ecr#PutRegistryScanningConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecr#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecr#ServerException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates or updates the scanning configuration for your private registry.
" + } + }, + "com.amazonaws.ecr#PutRegistryScanningConfigurationRequest": { + "type": "structure", + "members": { + "scanType": { + "target": "com.amazonaws.ecr#ScanType", + "traits": { + "smithy.api#documentation": "The scanning type to set for the registry.
\nBy default, the BASIC scan type is used. When basic scanning is set, you\n may specify filters to determine which individual repositories, or all repositories, are\n scanned when new images are pushed. Alternatively, you can do manual scans of images\n with basic scanning.
When the ENHANCED scan type is set, Amazon Inspector provides automated, continuous\n scanning of all repositories in your registry.
The scanning rules to use for the registry. A scanning rule is used to determine which\n repository filters are used and at what frequency scanning will occur.
" + } + } + } + }, + "com.amazonaws.ecr#PutRegistryScanningConfigurationResponse": { + "type": "structure", + "members": { + "registryScanningConfiguration": { + "target": "com.amazonaws.ecr#RegistryScanningConfiguration", + "traits": { + "smithy.api#documentation": "The scanning configuration for your registry.
" + } + } + } + }, "com.amazonaws.ecr#PutReplicationConfiguration": { "type": "operation", "input": { @@ -3589,6 +4458,38 @@ } } }, + "com.amazonaws.ecr#Reason": { + "type": "string" + }, + "com.amazonaws.ecr#Recommendation": { + "type": "structure", + "members": { + "url": { + "target": "com.amazonaws.ecr#Url", + "traits": { + "smithy.api#documentation": "The URL address to the CVE remediation recommendations.
" + } + }, + "text": { + "target": "com.amazonaws.ecr#RecommendationText", + "traits": { + "smithy.api#documentation": "The recommended course of action to remediate the finding.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the recommended course of action to remediate the finding.
" + } + }, + "com.amazonaws.ecr#RecommendationText": { + "type": "string" + }, + "com.amazonaws.ecr#ReferenceUrlsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#Url" + } + }, "com.amazonaws.ecr#ReferencedImagesNotFoundException": { "type": "structure", "members": { @@ -3638,6 +4539,86 @@ } } }, + "com.amazonaws.ecr#RegistryScanningConfiguration": { + "type": "structure", + "members": { + "scanType": { + "target": "com.amazonaws.ecr#ScanType", + "traits": { + "smithy.api#documentation": "The type of scanning configured for the registry.
" + } + }, + "rules": { + "target": "com.amazonaws.ecr#RegistryScanningRuleList", + "traits": { + "smithy.api#documentation": "The scanning rules associated with the registry.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The scanning configuration for a private registry.
" + } + }, + "com.amazonaws.ecr#RegistryScanningRule": { + "type": "structure", + "members": { + "scanFrequency": { + "target": "com.amazonaws.ecr#ScanFrequency", + "traits": { + "smithy.api#documentation": "The frequency that scans are performed at for a private registry.
", + "smithy.api#required": {} + } + }, + "repositoryFilters": { + "target": "com.amazonaws.ecr#ScanningRepositoryFilterList", + "traits": { + "smithy.api#documentation": "The repository filters associated with the scanning configuration for a private\n registry.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a scanning rule for a private registry.
" + } + }, + "com.amazonaws.ecr#RegistryScanningRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#RegistryScanningRule" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.ecr#RelatedVulnerabilitiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#RelatedVulnerability" + } + }, + "com.amazonaws.ecr#RelatedVulnerability": { + "type": "string" + }, + "com.amazonaws.ecr#Release": { + "type": "string" + }, + "com.amazonaws.ecr#Remediation": { + "type": "structure", + "members": { + "recommendation": { + "target": "com.amazonaws.ecr#Recommendation", + "traits": { + "smithy.api#documentation": "An object that contains information about the recommended course of action to\n remediate the finding.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information on how to remediate a finding.
" + } + }, "com.amazonaws.ecr#ReplicationConfiguration": { "type": "structure", "members": { @@ -3878,73 +4859,223 @@ "min": 2, "max": 256 }, - "smithy.api#pattern": "^(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*$" - } - }, - "com.amazonaws.ecr#RepositoryNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.ecr#RepositoryName" + "smithy.api#pattern": "^(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*$" + } + }, + "com.amazonaws.ecr#RepositoryNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#RepositoryName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ecr#RepositoryNotEmptyException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage", + "traits": { + "smithy.api#documentation": "The error message associated with the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified repository contains images. To delete a repository that contains images,\n you must force the deletion with the force parameter.
The error message associated with the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified repository could not be found. Check the spelling of the specified\n repository and ensure that you are performing operations on the correct registry.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#RepositoryPolicyNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage", + "traits": { + "smithy.api#documentation": "The error message associated with the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified repository and registry combination does not have an associated\n repository policy.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ecr#RepositoryPolicyText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10240 + } + } + }, + "com.amazonaws.ecr#RepositoryScanningConfiguration": { + "type": "structure", + "members": { + "repositoryArn": { + "target": "com.amazonaws.ecr#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the repository.
" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "The name of the repository.
" + } + }, + "scanOnPush": { + "target": "com.amazonaws.ecr#ScanOnPushFlag", + "traits": { + "smithy.api#documentation": "Whether or not scan on push is configured for the repository.
" + } + }, + "scanFrequency": { + "target": "com.amazonaws.ecr#ScanFrequency", + "traits": { + "smithy.api#documentation": "The scan frequency for the repository.
" + } + }, + "appliedScanFilters": { + "target": "com.amazonaws.ecr#ScanningRepositoryFilterList", + "traits": { + "smithy.api#documentation": "The scan filters applied to the repository.
" + } + } }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } + "smithy.api#documentation": "The details of the scanning configuration for a repository.
" } }, - "com.amazonaws.ecr#RepositoryNotEmptyException": { + "com.amazonaws.ecr#RepositoryScanningConfigurationFailure": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.ecr#ExceptionMessage", + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", "traits": { - "smithy.api#documentation": "The error message associated with the exception.
" + "smithy.api#documentation": "The name of the repository.
" + } + }, + "failureCode": { + "target": "com.amazonaws.ecr#ScanningConfigurationFailureCode", + "traits": { + "smithy.api#documentation": "The failure code.
" + } + }, + "failureReason": { + "target": "com.amazonaws.ecr#ScanningConfigurationFailureReason", + "traits": { + "smithy.api#documentation": "The reason for the failure.
" } } }, "traits": { - "smithy.api#documentation": "The specified repository contains images. To delete a repository that contains images,\n you must force the deletion with the force parameter.
The details about any failures associated with the scanning configuration of a\n repository.
" } }, - "com.amazonaws.ecr#RepositoryNotFoundException": { + "com.amazonaws.ecr#RepositoryScanningConfigurationFailureList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#RepositoryScanningConfigurationFailure" + } + }, + "com.amazonaws.ecr#RepositoryScanningConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#RepositoryScanningConfiguration" + } + }, + "com.amazonaws.ecr#Resource": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.ecr#ExceptionMessage", + "details": { + "target": "com.amazonaws.ecr#ResourceDetails", "traits": { - "smithy.api#documentation": "The error message associated with the exception.
" + "smithy.api#documentation": "An object that contains details about the resource involved in a finding.
" + } + }, + "id": { + "target": "com.amazonaws.ecr#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the resource.
" + } + }, + "tags": { + "target": "com.amazonaws.ecr#Tags", + "traits": { + "smithy.api#documentation": "The tags attached to the resource.
" + } + }, + "type": { + "target": "com.amazonaws.ecr#Type", + "traits": { + "smithy.api#documentation": "The type of resource.
" } } }, "traits": { - "smithy.api#documentation": "The specified repository could not be found. Check the spelling of the specified\n repository and ensure that you are performing operations on the correct registry.
", - "smithy.api#error": "client" + "smithy.api#documentation": "Details about the resource involved in a finding.
" } }, - "com.amazonaws.ecr#RepositoryPolicyNotFoundException": { + "com.amazonaws.ecr#ResourceDetails": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.ecr#ExceptionMessage", + "awsEcrContainerImage": { + "target": "com.amazonaws.ecr#AwsEcrContainerImageDetails", "traits": { - "smithy.api#documentation": "The error message associated with the exception.
" + "smithy.api#documentation": "An object that contains details about the Amazon ECR container image involved in the\n finding.
" } } }, "traits": { - "smithy.api#documentation": "The specified repository and registry combination does not have an associated\n repository policy.
", - "smithy.api#error": "client" + "smithy.api#documentation": "Contains details about the resource involved in the finding.
" } }, - "com.amazonaws.ecr#RepositoryPolicyText": { + "com.amazonaws.ecr#ResourceId": { + "type": "string" + }, + "com.amazonaws.ecr#ResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#Resource" + } + }, + "com.amazonaws.ecr#ScanFrequency": { "type": "string", "traits": { - "smithy.api#length": { - "min": 0, - "max": 10240 - } + "smithy.api#enum": [ + { + "value": "SCAN_ON_PUSH", + "name": "SCAN_ON_PUSH" + }, + { + "value": "CONTINUOUS_SCAN", + "name": "CONTINUOUS_SCAN" + }, + { + "value": "MANUAL", + "name": "MANUAL" + } + ] } }, "com.amazonaws.ecr#ScanNotFoundException": { @@ -3977,6 +5108,26 @@ { "value": "FAILED", "name": "FAILED" + }, + { + "value": "UNSUPPORTED_IMAGE", + "name": "UNSUPPORTED_IMAGE" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "SCAN_ELIGIBILITY_EXPIRED", + "name": "SCAN_ELIGIBILITY_EXPIRED" + }, + { + "value": "FINDINGS_UNAVAILABLE", + "name": "FINDINGS_UNAVAILABLE" } ] } @@ -3987,6 +5138,122 @@ "com.amazonaws.ecr#ScanTimestamp": { "type": "timestamp" }, + "com.amazonaws.ecr#ScanType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "BASIC", + "name": "BASIC" + }, + { + "value": "ENHANCED", + "name": "ENHANCED" + } + ] + } + }, + "com.amazonaws.ecr#ScanningConfigurationFailureCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "REPOSITORY_NOT_FOUND", + "name": "REPOSITORY_NOT_FOUND" + } + ] + } + }, + "com.amazonaws.ecr#ScanningConfigurationFailureReason": { + "type": "string" + }, + "com.amazonaws.ecr#ScanningConfigurationRepositoryNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#RepositoryName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.ecr#ScanningRepositoryFilter": { + "type": "structure", + "members": { + "filter": { + "target": "com.amazonaws.ecr#ScanningRepositoryFilterValue", + "traits": { + "smithy.api#documentation": "The filter to use when scanning.
", + "smithy.api#required": {} + } + }, + "filterType": { + "target": "com.amazonaws.ecr#ScanningRepositoryFilterType", + "traits": { + "smithy.api#documentation": "The type associated with the filter.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a scanning repository filter.
" + } + }, + "com.amazonaws.ecr#ScanningRepositoryFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#ScanningRepositoryFilter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.ecr#ScanningRepositoryFilterType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "WILDCARD", + "name": "WILDCARD" + } + ] + } + }, + "com.amazonaws.ecr#ScanningRepositoryFilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-z0-9*](?:[._\\-/a-z0-9*]?[a-z0-9*]+)*$" + } + }, + "com.amazonaws.ecr#Score": { + "type": "double" + }, + "com.amazonaws.ecr#ScoreDetails": { + "type": "structure", + "members": { + "cvss": { + "target": "com.amazonaws.ecr#CvssScoreDetails", + "traits": { + "smithy.api#documentation": "An object that contains details about the CVSS score given to a finding.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the Amazon Inspector score given to a finding.
" + } + }, + "com.amazonaws.ecr#ScoringVector": { + "type": "string" + }, "com.amazonaws.ecr#ServerException": { "type": "structure", "members": { @@ -4079,6 +5346,9 @@ } } }, + "com.amazonaws.ecr#Severity": { + "type": "string" + }, "com.amazonaws.ecr#SeverityCount": { "type": "integer", "traits": { @@ -4088,6 +5358,12 @@ } } }, + "com.amazonaws.ecr#Source": { + "type": "string" + }, + "com.amazonaws.ecr#SourceLayerHash": { + "type": "string" + }, "com.amazonaws.ecr#StartImageScan": { "type": "operation", "input": { @@ -4114,6 +5390,9 @@ }, { "target": "com.amazonaws.ecr#UnsupportedImageTypeException" + }, + { + "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { @@ -4252,6 +5531,9 @@ } } }, + "com.amazonaws.ecr#Status": { + "type": "string" + }, "com.amazonaws.ecr#Tag": { "type": "structure", "members": { @@ -4361,6 +5643,18 @@ "com.amazonaws.ecr#TagValue": { "type": "string" }, + "com.amazonaws.ecr#Tags": { + "type": "map", + "key": { + "target": "com.amazonaws.ecr#TagKey" + }, + "value": { + "target": "com.amazonaws.ecr#TagValue" + } + }, + "com.amazonaws.ecr#Title": { + "type": "string" + }, "com.amazonaws.ecr#TooManyTagsException": { "type": "structure", "members": { @@ -4373,6 +5667,9 @@ "smithy.api#error": "client" } }, + "com.amazonaws.ecr#Type": { + "type": "string" + }, "com.amazonaws.ecr#UnsupportedImageTypeException": { "type": "structure", "members": { @@ -4385,6 +5682,18 @@ "smithy.api#error": "client" } }, + "com.amazonaws.ecr#UnsupportedUpstreamRegistryException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "The specified upstream registry isn't supported.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.ecr#UntagResource": { "type": "operation", "input": { @@ -4475,7 +5784,7 @@ } ], "traits": { - "smithy.api#documentation": "Uploads an image layer part to Amazon ECR.
\nWhen an image is pushed, each new image layer is uploaded in parts. The maximum size\n of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API\n is called once per each new image layer part.
\nThis operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
Uploads an image layer part to Amazon ECR.
\nWhen an image is pushed, each new image layer is uploaded in parts. The maximum size\n of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API\n is called once per each new image layer part.
\nThis operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
The architecture of the vulnerable package.
" + } + }, + "epoch": { + "target": "com.amazonaws.ecr#Epoch", + "traits": { + "smithy.api#documentation": "The epoch of the vulnerable package.
" + } + }, + "filePath": { + "target": "com.amazonaws.ecr#FilePath", + "traits": { + "smithy.api#documentation": "The file path of the vulnerable package.
" + } + }, + "name": { + "target": "com.amazonaws.ecr#VulnerablePackageName", + "traits": { + "smithy.api#documentation": "The name of the vulnerable package.
" + } + }, + "packageManager": { + "target": "com.amazonaws.ecr#PackageManager", + "traits": { + "smithy.api#documentation": "The package manager of the vulnerable package.
" + } + }, + "release": { + "target": "com.amazonaws.ecr#Release", + "traits": { + "smithy.api#documentation": "The release of the vulnerable package.
" + } + }, + "sourceLayerHash": { + "target": "com.amazonaws.ecr#SourceLayerHash", + "traits": { + "smithy.api#documentation": "The source layer hash of the vulnerable package.
" + } + }, + "version": { + "target": "com.amazonaws.ecr#Version", + "traits": { + "smithy.api#documentation": "The version of the vulnerable package.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information on the vulnerable package identified by a finding.
" + } + }, + "com.amazonaws.ecr#VulnerablePackageName": { + "type": "string" + }, + "com.amazonaws.ecr#VulnerablePackagesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#VulnerablePackage" + } } } } diff --git a/aws/sdk/aws-models/ecs.json b/aws/sdk/aws-models/ecs.json index d60bd015a923415301f84a9250ca7c26f9c05697..b51b1017888794a43f2943ab56fd321aeb873681 100644 --- a/aws/sdk/aws-models/ecs.json +++ b/aws/sdk/aws-models/ecs.json @@ -1127,7 +1127,7 @@ "memory": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The amount (in MiB) of memory to present to the container. If your container attempts\n\t\t\tto exceed the memory specified here, the container is killed. The total amount of memory\n\t\t\treserved for all containers within a task must be lower than the task\n\t\t\t\tmemory value, if one is specified. This parameter maps to\n\t\t\t\tMemory in the Create a container section of the\n\t\t\tDocker Remote API and the --memory option to docker run.
If using the Fargate launch type, this parameter is optional.
\n\t\tIf using the EC2 launch type, you must specify either a task-level\n\t\t\tmemory value or a container-level memory value. If you specify both a container-level\n\t\t\t\tmemory and memoryReservation value, memory\n\t\t\tmust be greater than memoryReservation. If you specify\n\t\t\t\tmemoryReservation, then that value is subtracted from the available\n\t\t\tmemory resources for the container instance where the container is placed. Otherwise,\n\t\t\tthe value of memory is used.
The Docker daemon reserves a minimum of 4 MiB of memory for a container. Therefore, we\n\t\t\trecommend that you specify fewer than 4 MiB of memory for your containers.
" + "smithy.api#documentation": "The amount (in MiB) of memory to present to the container. If your container attempts\n\t\t\tto exceed the memory specified here, the container is killed. The total amount of memory\n\t\t\treserved for all containers within a task must be lower than the task\n\t\t\t\tmemory value, if one is specified. This parameter maps to\n\t\t\t\tMemory in the Create a container section of the\n\t\t\tDocker Remote API and the --memory option to docker run.
If using the Fargate launch type, this parameter is optional.
\n\t\tIf using the EC2 launch type, you must specify either a task-level\n\t\t\tmemory value or a container-level memory value. If you specify both a container-level\n\t\t\t\tmemory and memoryReservation value, memory\n\t\t\tmust be greater than memoryReservation. If you specify\n\t\t\t\tmemoryReservation, then that value is subtracted from the available\n\t\t\tmemory resources for the container instance where the container is placed. Otherwise,\n\t\t\tthe value of memory is used.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of\n\t\t\tmemory for a container, so you should not specify fewer than 6 MiB of\n\t\t\tmemory for your containers.
\n\t\tThe Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB\n\t\t\tof memory for a container, so you should not specify fewer than 4 MiB of\n\t\t\tmemory for your containers.
" } }, "memoryReservation": { @@ -6695,7 +6695,7 @@ "cpuArchitecture": { "target": "com.amazonaws.ecs#CPUArchitecture", "traits": { - "smithy.api#documentation": "The CPU architecture.
" + "smithy.api#documentation": "The CPU architecture.
\n\t\tYou can run your Linux tasks on an ARM-based platform by setting the value to ARM64. This option is avaiable\n\t\t\tfor tasks that run on Linuc Amazon EC2 instance or Linux containers on Fargate.
Information about the platform for the Amazon ECS service or task.
" + "smithy.api#documentation": "Information about the platform for the Amazon ECS service or task.
\n\t\tFor more informataion about RuntimePlatform, see RuntimePlatform in the Amazon Elastic Container Service Developer Guide.
The metadata that you apply to the add-on to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you\n define. Add-on tags do not propagate to any other resources associated with the cluster.\n
" + "smithy.api#documentation": "The metadata that you apply to the add-on to assist with categorization and\n organization. Each tag consists of a key and an optional value. You define both.\n Add-on tags do not propagate to any other resources associated with the cluster.\n
" } } }, @@ -578,7 +578,7 @@ "tags": { "target": "com.amazonaws.eks#TagMap", "traits": { - "smithy.api#documentation": "The metadata to apply to the configuration to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you\n define.
" + "smithy.api#documentation": "The metadata to apply to the configuration to assist with categorization and\n organization. Each tag consists of a key and an optional value. You define both.
" } }, "clientRequestToken": { @@ -808,7 +808,7 @@ "tags": { "target": "com.amazonaws.eks#TagMap", "traits": { - "smithy.api#documentation": "The metadata that you apply to the cluster to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you\n define. Cluster tags do not propagate to any other resources associated with the\n cluster.
" + "smithy.api#documentation": "The metadata that you apply to the cluster to assist with categorization and\n organization. Each tag consists of a key and an optional value. You define both.\n Cluster tags do not propagate to any other resources associated with the\n cluster.
" } }, "encryptionConfig": { @@ -1087,7 +1087,7 @@ "tags": { "target": "com.amazonaws.eks#TagMap", "traits": { - "smithy.api#documentation": "The metadata to apply to the cluster to assist with categorization and organization.\n Each tag consists of a key and an optional value, both of which you define.
" + "smithy.api#documentation": "The metadata to apply to the cluster to assist with categorization and organization.\n Each tag consists of a key and an optional value. You define both.
" } } } @@ -1132,7 +1132,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Amazon EKS control plane.
\nThe Amazon EKS control plane consists of control plane instances that run the Kubernetes\n software, such as etcd and the API server. The control plane runs in an\n account managed by Amazon Web Services, and the Kubernetes API is exposed via the Amazon EKS API server\n endpoint. Each Amazon EKS cluster control plane is single-tenant and unique and runs on its\n own set of Amazon EC2 instances.
The cluster control plane is provisioned across multiple Availability Zones and\n fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC\n subnets to provide connectivity from the control plane instances to the nodes (for\n example, to support kubectl exec, logs, and proxy\n data flows).
Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane via\n the Kubernetes API server endpoint and a certificate file that is created for your\n cluster.
\n \nCluster creation typically takes several minutes. After you create an Amazon EKS cluster,\n you must configure your Kubernetes tooling to communicate with the API server and launch\n nodes into your cluster. For more information, see Managing Cluster\n Authentication and Launching Amazon EKS nodes in the Amazon EKS User Guide.
", + "smithy.api#documentation": "Creates an Amazon EKS control plane.
\nThe Amazon EKS control plane consists of control plane instances that run the Kubernetes\n software, such as etcd and the API server. The control plane runs in an\n account managed by Amazon Web Services, and the Kubernetes API is exposed by the Amazon EKS API server\n endpoint. Each Amazon EKS cluster control plane is single tenant and unique. It runs on its\n own set of Amazon EC2 instances.
The cluster control plane is provisioned across multiple Availability Zones and\n fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC\n subnets to provide connectivity from the control plane instances to the nodes (for\n example, to support kubectl exec, logs, and proxy\n data flows).
Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane over\n the Kubernetes API server endpoint and a certificate file that is created for your\n cluster.
\n \nIn most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster,\n you must configure your Kubernetes tooling to communicate with the API server and launch\n nodes into your cluster. For more information, see Managing Cluster\n Authentication and Launching Amazon EKS nodes in the Amazon EKS User Guide.
", "smithy.api#http": { "method": "POST", "uri": "/clusters", @@ -1166,7 +1166,7 @@ "resourcesVpcConfig": { "target": "com.amazonaws.eks#VpcConfigRequest", "traits": { - "smithy.api#documentation": "The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have\n specific requirements to work properly with Kubernetes. For more information, see Cluster VPC\n Considerations and Cluster Security Group Considerations in the\n Amazon EKS User Guide. You must specify at least two subnets. You can specify up to five\n security groups, but we recommend that you use a dedicated security group for your\n cluster control plane.
", + "smithy.api#documentation": "The VPC configuration that's used by the cluster control plane. Amazon EKS VPC resources have\n specific requirements to work properly with Kubernetes. For more information, see Cluster VPC\n Considerations and Cluster Security Group Considerations in the\n Amazon EKS User Guide. You must specify at least two subnets. You can specify up to five\n security groups. However, we recommend that you use a dedicated security group for your\n cluster control plane.
", "smithy.api#required": {} } }, @@ -1192,7 +1192,7 @@ "tags": { "target": "com.amazonaws.eks#TagMap", "traits": { - "smithy.api#documentation": "The metadata to apply to the cluster to assist with categorization and organization.\n Each tag consists of a key and an optional value, both of which you define.
" + "smithy.api#documentation": "The metadata to apply to the cluster to assist with categorization and organization.\n Each tag consists of a key and an optional value. You define both.
" } }, "encryptionConfig": { @@ -1298,7 +1298,7 @@ "tags": { "target": "com.amazonaws.eks#TagMap", "traits": { - "smithy.api#documentation": "The metadata to apply to the Fargate profile to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you\n define. Fargate profile tags do not propagate to any other resources associated with the\n Fargate profile, such as the pods that are scheduled with it.
" + "smithy.api#documentation": "The metadata to apply to the Fargate profile to assist with categorization and\n organization. Each tag consists of a key and an optional value. You define both.\n Fargate profile tags do not propagate to any other resources associated with the\n Fargate profile, such as the pods that are scheduled with it.
" } } } @@ -1431,7 +1431,7 @@ "tags": { "target": "com.amazonaws.eks#TagMap", "traits": { - "smithy.api#documentation": "The metadata to apply to the node group to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you\n define. Node group tags do not propagate to any other resources associated with the node\n group, such as the Amazon EC2 instances or subnets.
" + "smithy.api#documentation": "The metadata to apply to the node group to assist with categorization and\n organization. Each tag consists of a key and an optional value. You\n define both. Node group tags do not propagate to any other resources associated with the node\n group, such as the Amazon EC2 instances or subnets.
" } }, "clientRequestToken": { @@ -2782,7 +2782,7 @@ "tags": { "target": "com.amazonaws.eks#TagMap", "traits": { - "smithy.api#documentation": "The metadata applied to the Fargate profile to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you\n define. Fargate profile tags do not propagate to any other resources associated with the\n Fargate profile, such as the pods that are scheduled with it.
" + "smithy.api#documentation": "The metadata applied to the Fargate profile to assist with categorization and\n organization. Each tag consists of a key and an optional value. You define both.\n Fargate profile tags do not propagate to any other resources associated with the\n Fargate profile, such as the pods that are scheduled with it.
" } } }, @@ -3223,7 +3223,7 @@ "include": { "target": "com.amazonaws.eks#IncludeClustersList", "traits": { - "smithy.api#documentation": "Indicates whether connected clusters are included in the returned list. Default value is 'ALL'.
", + "smithy.api#documentation": "Indicates whether external clusters are included in the returned list. Use 'all' to return connected clusters, or blank to return only Amazon EKS clusters. 'all' must be in lowercase otherwise an error occurs.
The metadata applied to the node group to assist with categorization and organization.\n Each tag consists of a key and an optional value, both of which you define. Node group\n tags do not propagate to any other resources associated with the node group, such as the\n Amazon EC2 instances or subnets.
" + "smithy.api#documentation": "The metadata applied to the node group to assist with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Node group\n tags do not propagate to any other resources associated with the node group, such as the\n Amazon EC2 instances or subnets.
" } } }, @@ -4194,7 +4194,7 @@ "tags": { "target": "com.amazonaws.eks#TagMap", "traits": { - "smithy.api#documentation": "The metadata to apply to the provider configuration to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you\n defined.
" + "smithy.api#documentation": "The metadata to apply to the provider configuration to assist with categorization and\n organization. Each tag consists of a key and an optional value. You define both.
" } }, "status": { @@ -4309,9 +4309,15 @@ { "target": "com.amazonaws.eks#InvalidParameterException" }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, { "target": "com.amazonaws.eks#ResourceLimitExceededException" }, + { + "target": "com.amazonaws.eks#ResourcePropagationDelayException" + }, { "target": "com.amazonaws.eks#ServerException" }, @@ -4490,6 +4496,19 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.eks#ResourcePropagationDelayException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eks#String" + } + }, + "traits": { + "smithy.api#documentation": "Required resources (such as Service Linked Roles) were created and are still propagating. Retry later.
", + "smithy.api#error": "client", + "smithy.api#httpError": 428 + } + }, "com.amazonaws.eks#RoleArn": { "type": "string", "traits": { diff --git a/aws/sdk/aws-models/elasticache.json b/aws/sdk/aws-models/elasticache.json index dad0334eeedadf484dcea985938a34ca06c708ae..0fc0988e6d6d2d7969131f505de670572095d852 100644 --- a/aws/sdk/aws-models/elasticache.json +++ b/aws/sdk/aws-models/elasticache.json @@ -171,6 +171,24 @@ }, "com.amazonaws.elasticache#AmazonElastiCacheV9": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "ElastiCache", + "arnNamespace": "elasticache", + "cloudFormationName": "ElastiCache", + "cloudTrailEventSource": "elasticache.amazonaws.com", + "endpointPrefix": "elasticache" + }, + "aws.auth#sigv4": { + "name": "elasticache" + }, + "aws.protocols#awsQuery": {}, + "smithy.api#documentation": "Amazon ElastiCache is a web service that makes it easier to set up, operate, \n and scale a distributed cache in the cloud.
\nWith ElastiCache, customers get all of the benefits of a high-performance, \n in-memory cache with less of the administrative burden involved in launching and managing a distributed cache. \n The service makes setup, scaling, \n and cluster failure handling much simpler than in a self-managed cache deployment.
\nIn addition, through integration with Amazon CloudWatch, \n customers get enhanced visibility into the key performance statistics \n associated with their cache and can receive alarms if a part of their cache runs hot.
", + "smithy.api#title": "Amazon ElastiCache", + "smithy.api#xmlNamespace": { + "uri": "http://elasticache.amazonaws.com/doc/2015-02-02/" + } + }, "version": "2015-02-02", "operations": [ { @@ -368,25 +386,7 @@ { "target": "com.amazonaws.elasticache#TestFailover" } - ], - "traits": { - "aws.api#service": { - "sdkId": "ElastiCache", - "arnNamespace": "elasticache", - "cloudFormationName": "ElastiCache", - "cloudTrailEventSource": "elasticache.amazonaws.com", - "endpointPrefix": "elasticache" - }, - "aws.auth#sigv4": { - "name": "elasticache" - }, - "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "Amazon ElastiCache is a web service that makes it easier to set up, operate, \n and scale a distributed cache in the cloud.
\nWith ElastiCache, customers get all of the benefits of a high-performance, \n in-memory cache with less of the administrative burden involved in launching and managing a distributed cache. \n The service makes setup, scaling, \n and cluster failure handling much simpler than in a self-managed cache deployment.
\nIn addition, through integration with Amazon CloudWatch, \n customers get enhanced visibility into the key performance statistics \n associated with their cache and can receive alarms if a part of their cache runs hot.
", - "smithy.api#title": "Amazon ElastiCache", - "smithy.api#xmlNamespace": { - "uri": "http://elasticache.amazonaws.com/doc/2015-02-02/" - } - } + ] }, "com.amazonaws.elasticache#AuthTokenUpdateStatus": { "type": "string", @@ -727,7 +727,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the compute and memory capacity node type for the cluster.
\n \nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n \t\t\t\t\t\t\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\t\n cache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T3 node types:\n\t\t\t\t\t cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge\n
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t\t\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
The name of the compute and memory capacity node type for the cluster.
\n \nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge,\n\t\t cache.r6gd.2xlarge,\n\t\t cache.r6gd.4xlarge,\n\t\t cache.r6gd.8xlarge,\n\t\t cache.r6gd.12xlarge,\n\t\t cache.r6gd.16xlarge\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\n\t\t \t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
This parameter is currently disabled.
" + "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. \n
" } }, "SecurityGroups": { @@ -981,7 +981,7 @@ "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the cache parameter group family associated with this cache engine.
\nValid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.x | \n
The name of the cache parameter group family associated with this cache engine.
\nValid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.0 | \n redis6.2\n
Represents an individual cache node within a cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.
\n\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n \t\t\t\t\t\t\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\t\n cache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T3 node types:\n\t\t\t\t\t cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge\n
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t\t\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
Represents an individual cache node within a cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.
\n\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge,\n\t\t cache.r6gd.2xlarge,\n\t\t cache.r6gd.4xlarge,\n\t\t cache.r6gd.8xlarge,\n\t\t cache.r6gd.12xlarge,\n\t\t cache.r6gd.16xlarge\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\n\t\t\t \t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
The name of the cache parameter group family that this cache parameter group is compatible with.
\nValid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.x | \n
The name of the cache parameter group family that this cache parameter group is compatible with.
\nValid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.0 | \n
The compute and memory capacity of the nodes in the node group (shard).
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n \t\t\t\t\t\t\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\t\n cache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T3 node types:\n\t\t\t\t\t cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge\n
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t\t\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
The compute and memory capacity of the nodes in the node group (shard).
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n \t\t\t\t\t\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge,\n\t\t cache.r6gd.2xlarge,\n\t\t cache.r6gd.4xlarge,\n\t\t cache.r6gd.8xlarge,\n\t\t cache.r6gd.12xlarge,\n\t\t cache.r6gd.16xlarge\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\t\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t \n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
This parameter is currently disabled.
" + "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. \n
" } }, "SnapshotRetentionLimit": { @@ -2262,7 +2262,7 @@ "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the cache parameter group family that the cache parameter group can be used with.
\nValid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.x | \n
The name of the cache parameter group family that the cache parameter group can be used with.
\nValid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.0 | \n redis6.2\n
The compute and memory capacity of the nodes in the node group (shard).
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n \t\t\t\t\t\t\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\t\n cache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T3 node types:\n\t\t\t\t\t cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge\n
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t\t\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
The compute and memory capacity of the nodes in the node group (shard).
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): \n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge,\n\t\t cache.r6gd.2xlarge,\n\t\t cache.r6gd.4xlarge,\n\t\t cache.r6gd.8xlarge,\n\t\t cache.r6gd.12xlarge,\n\t\t cache.r6gd.16xlarge\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\n\t\t\t\t\t \t\t \t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
This parameter is currently disabled.
" + "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. \n
" } }, "SnapshotRetentionLimit": { @@ -2767,6 +2767,12 @@ "traits": { "smithy.api#documentation": "Specifies the destination, format and type of the logs.
" } + }, + "DataTieringEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes.\n For more information, see Data tiering.
" + } } }, "traits": { @@ -2890,6 +2896,9 @@ { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, + { + "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" + }, { "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" }, @@ -2901,7 +2910,7 @@ } ], "traits": { - "smithy.api#documentation": "For Redis engine version 6.x onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC).
" + "smithy.api#documentation": "For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC).
" } }, "com.amazonaws.elasticache#CreateUserGroup": { @@ -2922,6 +2931,9 @@ { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, + { + "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" + }, { "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" }, @@ -2936,7 +2948,7 @@ } ], "traits": { - "smithy.api#documentation": "For Redis engine version 6.x onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC) \n
" + "smithy.api#documentation": "For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC) \n
" } }, "com.amazonaws.elasticache#CreateUserGroupMessage": { @@ -3047,6 +3059,21 @@ "target": "com.amazonaws.elasticache#CustomerNodeEndpoint" } }, + "com.amazonaws.elasticache#DataTieringStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "enabled", + "name": "ENABLED" + }, + { + "value": "disabled", + "name": "DISABLED" + } + ] + } + }, "com.amazonaws.elasticache#DecreaseNodeGroupsInGlobalReplicationGroup": { "type": "operation", "input": { @@ -3607,12 +3634,15 @@ { "target": "com.amazonaws.elasticache#InvalidUserStateFault" }, + { + "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" + }, { "target": "com.amazonaws.elasticache#UserNotFoundFault" } ], "traits": { - "smithy.api#documentation": "For Redis engine version 6.x onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC).
" + "smithy.api#documentation": "For Redis engine version 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC).
" } }, "com.amazonaws.elasticache#DeleteUserGroup": { @@ -3630,12 +3660,15 @@ { "target": "com.amazonaws.elasticache#InvalidUserGroupStateFault" }, + { + "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" + }, { "target": "com.amazonaws.elasticache#UserGroupNotFoundFault" } ], "traits": { - "smithy.api#documentation": "For Redis engine version 6.x onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC).
" + "smithy.api#documentation": "For Redis engine version 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC).
" } }, "com.amazonaws.elasticache#DeleteUserGroupMessage": { @@ -3908,7 +3941,7 @@ "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of a specific cache parameter group family to return details for.
\nValid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.x | \n
Constraints:
\nMust be 1 to 255 alphanumeric characters
\nFirst character must be a letter
\nCannot end with a hyphen or contain two consecutive hyphens
\nThe name of a specific cache parameter group family to return details for.
\nValid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.x | \n redis6.2\n
Constraints:
\nMust be 1 to 255 alphanumeric characters
\nFirst character must be a letter
\nCannot end with a hyphen or contain two consecutive hyphens
\nThe name of the cache parameter group family.
\nValid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.x | \n
The name of the cache parameter group family.
\nValid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.x | \n redis6.2\n
The cache node type filter value. \n Use this parameter to show only those reservations matching the specified cache node type.
\n \nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n \t\t\t\t\t\t\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\t\n cache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T3 node types:\n\t\t\t\t\t cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge\n
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t\t\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
The cache node type filter value. \n Use this parameter to show only those reservations matching the specified cache node type.
\n \nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge,\n\t\t cache.r6gd.2xlarge,\n\t\t cache.r6gd.4xlarge,\n\t\t cache.r6gd.8xlarge,\n\t\t cache.r6gd.12xlarge,\n\t\t cache.r6gd.16xlarge\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\t\n\t\t\t\t\t\t\t\t \t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
The cache node type filter value. \n Use this parameter to show only the available offerings matching the specified cache node type.
\n\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n \t\t\t\t\t\t\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\t\n cache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T3 node types:\n\t\t\t\t\t cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge\n
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t\t\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
The cache node type filter value. \n Use this parameter to show only the available offerings matching the specified cache node type.
\n\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward)\tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge,\n\t\t cache.r6gd.2xlarge,\n\t\t cache.r6gd.4xlarge,\n\t\t cache.r6gd.8xlarge,\n\t\t cache.r6gd.12xlarge,\n\t\t cache.r6gd.16xlarge\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\n\n\t\t\t\t\t \t\t\t \t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
Specifies the name of the cache parameter group family to which the engine default parameters apply.
\nValid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.x | \n
Specifies the name of the cache parameter group family to which the engine default parameters apply.
\nValid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.0 | \n redis6.2\n
This parameter is currently disabled.
" + "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. \n
" } }, "SnapshotRetentionLimit": { @@ -6900,7 +6939,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "This parameter is currently disabled.
" + "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. \n
" } }, "SnapshotRetentionLimit": { @@ -7087,6 +7126,9 @@ { "target": "com.amazonaws.elasticache#InvalidUserStateFault" }, + { + "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" + }, { "target": "com.amazonaws.elasticache#UserNotFoundFault" } @@ -7119,6 +7161,9 @@ { "target": "com.amazonaws.elasticache#InvalidUserGroupStateFault" }, + { + "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" + }, { "target": "com.amazonaws.elasticache#UserGroupNotFoundFault" }, @@ -8474,6 +8519,12 @@ "traits": { "smithy.api#documentation": "The date and time when the cluster was created.
" } + }, + "DataTiering": { + "target": "com.amazonaws.elasticache#DataTieringStatus", + "traits": { + "smithy.api#documentation": "Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes.\n For more information, see Data tiering.
" + } } }, "traits": { @@ -8660,7 +8711,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The cache node type for the reserved cache nodes.
\n \nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n \t\t\t\t\t\t\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\t\n cache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T3 node types:\n\t\t\t\t\t cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge\n
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t\t\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
The cache node type for the reserved cache nodes.
\n \nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge,\n\t\t cache.r6gd.2xlarge,\n\t\t cache.r6gd.4xlarge,\n\t\t cache.r6gd.8xlarge,\n\t\t cache.r6gd.12xlarge,\n\t\t cache.r6gd.16xlarge\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\n\t\n\t\t\t\t\t \n\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
The cache node type for the reserved cache node.
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n \t\t\t\t\t\t\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\t\n cache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T3 node types:\n\t\t\t\t\t cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge\n
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t\t\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
The cache node type for the reserved cache node.
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge,\n\t\t cache.r6gd.2xlarge,\n\t\t cache.r6gd.4xlarge,\n\t\t cache.r6gd.8xlarge,\n\t\t cache.r6gd.12xlarge,\n\t\t cache.r6gd.16xlarge\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\n\t\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
The name of the compute and memory capacity node type for the source cluster.
\n \nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n \t\t\t\t\t\t\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\t\n cache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T3 node types:\n\t\t\t\t\t cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge\n
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t\t\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
The name of the compute and memory capacity node type for the source cluster.
\n \nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\t\n cache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n\t\t\t\t\t\t\t\n\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge,\n\t\t cache.r6gd.2xlarge,\n\t\t cache.r6gd.4xlarge,\n\t\t cache.r6gd.8xlarge,\n\t\t cache.r6gd.12xlarge,\n\t\t cache.r6gd.16xlarge\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t \n\t\t \n\t\tCurrent generation:
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t cache.r6g.large,\n\t\t cache.r6g.xlarge,\n\t\t cache.r6g.2xlarge,\n\t\t cache.r6g.4xlarge,\n\t\t cache.r6g.8xlarge,\n\t\t cache.r6g.12xlarge,\n\t\t cache.r6g.16xlarge\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
For region availability, see Supported Node Types\n
\nFor region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
This parameter is currently disabled.
" + "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. \n
" } }, "SnapshotRetentionLimit": { @@ -9512,6 +9563,12 @@ "traits": { "smithy.api#documentation": "The ARN (Amazon Resource Name) of the snapshot.
" } + }, + "DataTiering": { + "target": "com.amazonaws.elasticache#DataTieringStatus", + "traits": { + "smithy.api#documentation": "Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes.\n For more information, see Data tiering.
" + } } }, "traits": { @@ -9905,7 +9962,7 @@ } ], "traits": { - "smithy.api#documentation": "Represents the input of a TestFailover operation which test automatic failover on\n a specified node group (called shard in the console) in a replication group (called cluster in the console).
\n Note the following\n
\nA customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and Amazon CLI) \n in any rolling 24-hour period.
\nIf calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.
\n\n
If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, \n the first node replacement must complete before a subsequent call can be made.
\nTo determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console,\n the Amazon CLI, or the ElastiCache API.\n Look for the following automatic failover related events, listed here in order of occurrance:
\nReplication group message: Test Failover API called for node group \n
Cache cluster message: Failover from primary node \n
Replication group message: Failover from primary node \n
Cache cluster message: Recovering cache nodes \n
Cache cluster message: Finished recovery for cache nodes \n
For more information see:
\n\n Viewing ElastiCache Events\n in the ElastiCache User Guide\n
\n\n DescribeEvents in the ElastiCache API Reference
\nAlso see, Testing Multi-AZ in the ElastiCache User Guide.
" + "smithy.api#documentation": "Represents the input of a TestFailover operation which test automatic failover on\n a specified node group (called shard in the console) in a replication group (called cluster in the console).
This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool \n for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API.
\n\n Note the following\n
\nA customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and Amazon CLI) \n in any rolling 24-hour period.
\nIf calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.
\n\n
If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, \n the first node replacement must complete before a subsequent call can be made.
\nTo determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console,\n the Amazon CLI, or the ElastiCache API.\n Look for the following automatic failover related events, listed here in order of occurrance:
\nReplication group message: Test Failover API called for node group \n
Cache cluster message: Failover from primary node \n
Replication group message: Failover from primary node \n
Cache cluster message: Recovering cache nodes \n
Cache cluster message: Finished recovery for cache nodes \n
For more information see:
\n\n Viewing ElastiCache Events\n in the ElastiCache User Guide\n
\n\n DescribeEvents in the ElastiCache API Reference
\nAlso see, Testing Multi-AZ in the ElastiCache User Guide.
" } }, "com.amazonaws.elasticache#TestFailoverMessage": { @@ -10260,6 +10317,12 @@ "smithy.api#documentation": "The current supported value is Redis.
" } }, + "MinimumEngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "The minimum engine version required, which is Redis 6.0
" + } + }, "AccessString": { "target": "com.amazonaws.elasticache#String", "traits": { @@ -10330,6 +10393,12 @@ "smithy.api#documentation": "The list of user IDs that belong to the user group.
" } }, + "MinimumEngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "The minimum engine version required, which is Redis 6.0
" + } + }, "PendingChanges": { "target": "com.amazonaws.elasticache#UserGroupPendingChanges", "traits": { diff --git a/aws/sdk/aws-models/elasticloadbalancingv2.json b/aws/sdk/aws-models/elasticloadbalancingv2.json index d49ea2b74952feb0a1566cf32292d16497759e50..708e20098399be7598cb4d659b57d45d789d0674 100644 --- a/aws/sdk/aws-models/elasticloadbalancingv2.json +++ b/aws/sdk/aws-models/elasticloadbalancingv2.json @@ -933,7 +933,7 @@ "IpAddressType": { "target": "com.amazonaws.elasticloadbalancingv2#IpAddressType", "traits": { - "smithy.api#documentation": "The type of IP addresses used by the subnets for your load balancer. The possible values\n are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6\n addresses). Internal load balancers must use ipv4.
The type of IP addresses used by the subnets for your load balancer. The possible values\n are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6\n addresses).
A load balancer distributes incoming traffic across targets, such as your EC2 instances.\n This enables you to increase the availability of your application. The load balancer also\n monitors the health of its registered targets and ensures that it routes traffic only to\n healthy targets. You configure your load balancer to accept incoming traffic by specifying one\n or more listeners, which are configured with a protocol and port number for connections from\n clients to the load balancer. You configure a target group with a protocol and port number for\n connections from the load balancer to the targets, and with health check settings to be used\n when checking the health status of the targets.
\n\nElastic Load Balancing supports the following types of load balancers: Application Load\n Balancers, Network Load Balancers, Gateway Load Balancers, and Classic Load Balancers. This\n reference covers the following load balancer types:
\nApplication Load Balancer - Operates at the application layer (layer 7) and supports\n HTTP and HTTPS.
\nNetwork Load Balancer - Operates at the transport layer (layer 4) and supports TCP,\n TLS, and UDP.
\nGateway Load Balancer - Operates at the network layer (layer 3).
\nFor more information, see the Elastic Load Balancing User\n Guide.
\n\n \n \n\n \n \n\nAll Elastic Load Balancing operations are idempotent, which means that they complete at\n most one time. If you repeat an operation, it succeeds.
", + "smithy.api#title": "Elastic Load Balancing", + "smithy.api#xmlNamespace": { + "uri": "http://elasticloadbalancing.amazonaws.com/doc/2015-12-01/" + } + }, "version": "2015-12-01", "operations": [ { @@ -2352,25 +2370,7 @@ { "target": "com.amazonaws.elasticloadbalancingv2#SetSubnets" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Elastic Load Balancing v2", - "arnNamespace": "elasticloadbalancing", - "cloudFormationName": "ElasticLoadBalancingV2", - "cloudTrailEventSource": "elasticloadbalancingv2.amazonaws.com", - "endpointPrefix": "elasticloadbalancing" - }, - "aws.auth#sigv4": { - "name": "elasticloadbalancing" - }, - "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "A load balancer distributes incoming traffic across targets, such as your EC2 instances.\n This enables you to increase the availability of your application. The load balancer also\n monitors the health of its registered targets and ensures that it routes traffic only to\n healthy targets. You configure your load balancer to accept incoming traffic by specifying one\n or more listeners, which are configured with a protocol and port number for connections from\n clients to the load balancer. You configure a target group with a protocol and port number for\n connections from the load balancer to the targets, and with health check settings to be used\n when checking the health status of the targets.
\n\nElastic Load Balancing supports the following types of load balancers: Application Load\n Balancers, Network Load Balancers, Gateway Load Balancers, and Classic Load Balancers. This\n reference covers the following load balancer types:
\nApplication Load Balancer - Operates at the application layer (layer 7) and supports\n HTTP and HTTPS.
\nNetwork Load Balancer - Operates at the transport layer (layer 4) and supports TCP,\n TLS, and UDP.
\nGateway Load Balancer - Operates at the network layer (layer 3).
\nFor more information, see the Elastic Load Balancing User\n Guide.
\n\n \n \n\n \n \n\nAll Elastic Load Balancing operations are idempotent, which means that they complete at\n most one time. If you repeat an operation, it succeeds.
", - "smithy.api#title": "Elastic Load Balancing", - "smithy.api#xmlNamespace": { - "uri": "http://elasticloadbalancing.amazonaws.com/doc/2015-12-01/" - } - } + ] }, "com.amazonaws.elasticloadbalancingv2#ErrorDescription": { "type": "string" @@ -2961,7 +2961,7 @@ "Key": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerAttributeKey", "traits": { - "smithy.api#documentation": "The name of the attribute.
\n\nThe following attribute is supported by all load balancers:
\n\n deletion_protection.enabled - Indicates whether deletion protection is\n enabled. The value is true or false. The default is\n false.
The following attributes are supported by both Application Load Balancers and Network Load\n Balancers:
\n\n access_logs.s3.enabled - Indicates whether access logs are enabled. The\n value is true or false. The default is\n false.
\n access_logs.s3.bucket - The name of the S3 bucket for the access logs.\n This attribute is required if access logs are enabled. The bucket must exist in the same\n region as the load balancer and have a bucket policy that grants Elastic Load Balancing\n permissions to write to the bucket.
\n access_logs.s3.prefix - The prefix for the location in the S3 bucket for the\n access logs.
The following attributes are supported by only Application Load Balancers:
\n\n idle_timeout.timeout_seconds - The idle timeout value, in seconds. The\n valid range is 1-4000 seconds. The default is 60 seconds.
\n routing.http.desync_mitigation_mode - Determines how the load balancer\n handles requests that might pose a security risk to your application. The possible values\n are monitor, defensive, and strictest. The default\n is defensive.
\n routing.http.drop_invalid_header_fields.enabled - Indicates whether HTTP\n headers with invalid header fields are removed by the load balancer (true) or\n routed to targets (false). The default is false.
\n routing.http.x_amzn_tls_version_and_cipher_suite.enabled - Indicates\n whether the two headers (x-amzn-tls-version and\n x-amzn-tls-cipher-suite), which contain information about the negotiated\n TLS version and cipher suite, are added to the client request before sending it to the\n target. The x-amzn-tls-version header has information about the TLS protocol\n version negotiated with the client, and the x-amzn-tls-cipher-suite header\n has information about the cipher suite negotiated with the client. Both headers are in\n OpenSSL format. The possible values for the attribute are true and\n false. The default is false.
\n routing.http.xff_client_port.enabled - Indicates whether the\n X-Forwarded-For header should preserve the source port that the client used\n to connect to the load balancer. The possible values are true and\n false. The default is false.
\n routing.http2.enabled - Indicates whether HTTP/2 is enabled. The possible\n values are true and false. The default is true.\n Elastic Load Balancing requires that message header names contain only alphanumeric\n characters and hyphens.
\n waf.fail_open.enabled - Indicates whether to allow a WAF-enabled load\n balancer to route requests to targets if it is unable to forward the request to Amazon Web Services WAF. The possible values are true and false. The\n default is false.
The following attribute is supported by Network Load Balancers and Gateway Load\n Balancers:
\n\n load_balancing.cross_zone.enabled - Indicates whether cross-zone load\n balancing is enabled. The possible values are true and false.\n The default is false.
The name of the attribute.
\n\nThe following attribute is supported by all load balancers:
\n\n deletion_protection.enabled - Indicates whether deletion protection is\n enabled. The value is true or false. The default is\n false.
The following attributes are supported by both Application Load Balancers and Network Load\n Balancers:
\n\n access_logs.s3.enabled - Indicates whether access logs are enabled. The\n value is true or false. The default is\n false.
\n access_logs.s3.bucket - The name of the S3 bucket for the access logs.\n This attribute is required if access logs are enabled. The bucket must exist in the same\n region as the load balancer and have a bucket policy that grants Elastic Load Balancing\n permissions to write to the bucket.
\n access_logs.s3.prefix - The prefix for the location in the S3 bucket for the\n access logs.
\n ipv6.deny-all-igw-traffic - Blocks internet gateway (IGW) access to the\n load balancer. It is set to false for internet-facing load balancers and\n true for internal load balancers, preventing unintended access to your\n internal load balancer through an internet gateway.
The following attributes are supported by only Application Load Balancers:
\n\n idle_timeout.timeout_seconds - The idle timeout value, in seconds. The\n valid range is 1-4000 seconds. The default is 60 seconds.
\n routing.http.desync_mitigation_mode - Determines how the load balancer\n handles requests that might pose a security risk to your application. The possible values\n are monitor, defensive, and strictest. The default\n is defensive.
\n routing.http.drop_invalid_header_fields.enabled - Indicates whether HTTP\n headers with invalid header fields are removed by the load balancer (true) or\n routed to targets (false). The default is false.
\n routing.http.x_amzn_tls_version_and_cipher_suite.enabled - Indicates\n whether the two headers (x-amzn-tls-version and\n x-amzn-tls-cipher-suite), which contain information about the negotiated\n TLS version and cipher suite, are added to the client request before sending it to the\n target. The x-amzn-tls-version header has information about the TLS protocol\n version negotiated with the client, and the x-amzn-tls-cipher-suite header\n has information about the cipher suite negotiated with the client. Both headers are in\n OpenSSL format. The possible values for the attribute are true and\n false. The default is false.
\n routing.http.xff_client_port.enabled - Indicates whether the\n X-Forwarded-For header should preserve the source port that the client used\n to connect to the load balancer. The possible values are true and\n false. The default is false.
\n routing.http2.enabled - Indicates whether HTTP/2 is enabled. The possible\n values are true and false. The default is true.\n Elastic Load Balancing requires that message header names contain only alphanumeric\n characters and hyphens.
\n waf.fail_open.enabled - Indicates whether to allow a WAF-enabled load\n balancer to route requests to targets if it is unable to forward the request to Amazon Web Services WAF. The possible values are true and false. The\n default is false.
The following attribute is supported by Network Load Balancers and Gateway Load\n Balancers:
\n\n load_balancing.cross_zone.enabled - Indicates whether cross-zone load\n balancing is enabled. The possible values are true and false.\n The default is false.
The IP address type. The possible values are ipv4 (for IPv4 addresses) and\n dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use\n ipv4. You can’t specify dualstack for a load balancer with a UDP\n or TCP_UDP listener.
The IP address type. The possible values are ipv4 (for IPv4 addresses) and\n dualstack (for IPv4 and IPv6 addresses).\n You can’t specify\n dualstack for a load balancer with a UDP or TCP_UDP listener.
[Network Load Balancers] The type of IP addresses used by the subnets for your load\n balancer. The possible values are ipv4 (for IPv4 addresses) and\n dualstack (for IPv4 and IPv6 addresses). You can’t specify\n dualstack for a load balancer with a UDP or TCP_UDP listener. Internal load\n balancers must use ipv4.
[Network Load Balancers] The type of IP addresses used by the subnets for your load\n balancer. The possible values are ipv4 (for IPv4 addresses) and\n dualstack (for IPv4 and IPv6 addresses). You can’t specify\n dualstack for a load balancer with a UDP or TCP_UDP listener.\n .
\n The supported load balancers.\n
" + "smithy.api#documentation": "The supported load balancers.
" } } }, @@ -4645,7 +4645,7 @@ "AvailabilityZone": { "target": "com.amazonaws.elasticloadbalancingv2#ZoneName", "traits": { - "smithy.api#documentation": "An Availability Zone or all. This determines whether the target receives\n traffic from the load balancer nodes in the specified Availability Zone or from all enabled\n Availability Zones for the load balancer.
This parameter is not supported if the target type of the target group is\n instance or alb.
If the target type is ip and the IP address is in a subnet of the VPC for the\n target group, the Availability Zone is automatically detected and this parameter is optional.\n If the IP address is outside the VPC, this parameter is required.
With an Application Load Balancer, if the target type is ip and the IP\n address is outside the VPC for the target group, the only supported value is\n all.
If the target type is lambda, this parameter is optional and the only\n supported value is all.
An Availability Zone or all. This determines whether the target receives\n traffic from the load balancer nodes in the specified Availability Zone or from all enabled\n Availability Zones for the load balancer.
This parameter is not supported if the target type of the target group is\n instance or alb.
If the target type is ip and the IP address is in a subnet of the VPC for the\n target group, the Availability Zone is automatically detected and this parameter is optional.\n If the IP address is outside the VPC, this parameter is required.
With an Application Load Balancer, if the target type is ip and the IP\n address is outside the VPC for the target group, the only supported value is\n all.
If the target type is lambda, this parameter is optional and the only\n supported value is all.
\n Specifies the deployment mechanism through which the update shall be applied on the domain.\n Possible responses are\n Blue/Green (The update will require a blue/green deployment.)\n DynamicUpdate (The update can be applied in-place without a Blue/Green deployment required.)\n Undetermined (The domain is undergoing an update which needs to complete before the deployment type can be predicted.)\n None (The configuration change matches the current configuration and will not result in any update.)\n
Contains an optional message associated with the DryRunResults.
" + } + } + } + }, "com.amazonaws.elasticsearchservice#Duration": { "type": "structure", "members": { @@ -4834,6 +4866,15 @@ "smithy.api#documentation": "\n Maximum number of Instances that can be instantiated for given InstanceType.\n
" } }, + "com.amazonaws.elasticsearchservice#Message": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, "com.amazonaws.elasticsearchservice#MinimumInstanceCount": { "type": "integer", "traits": { @@ -6393,6 +6434,12 @@ "traits": { "smithy.api#documentation": "Specifies Auto-Tune options.
" } + }, + "DryRun": { + "target": "com.amazonaws.elasticsearchservice#DryRun", + "traits": { + "smithy.api#documentation": "\n This flag, when set to True, specifies whether the UpdateElasticsearchDomain request should return the results of validation checks without actually applying the change.\n This flag, when set to True, specifies the deployment mechanism through which the update shall be applied on the domain.\n This will not actually perform the Update.\n
The status of the updated Elasticsearch domain.
", "smithy.api#required": {} } + }, + "DryRunResults": { + "target": "com.amazonaws.elasticsearchservice#DryRunResults", + "traits": { + "smithy.api#documentation": "Contains result of DryRun.
" + } } }, "traits": { diff --git a/aws/sdk/aws-models/evidently.json b/aws/sdk/aws-models/evidently.json new file mode 100644 index 0000000000000000000000000000000000000000..86aa121fe26c26fde72984b800b9a1f3b493d4bc --- /dev/null +++ b/aws/sdk/aws-models/evidently.json @@ -0,0 +1,5315 @@ +{ + "smithy": "1.0", + "shapes": { + "com.amazonaws.evidently#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "You do not have sufficient permissions to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.evidently#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:.*" + } + }, + "com.amazonaws.evidently#BatchEvaluateFeature": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#BatchEvaluateFeatureRequest" + }, + "output": { + "target": "com.amazonaws.evidently#BatchEvaluateFeatureResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ThrottlingException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "This operation assigns feature variation to user sessions. For each user session, you pass\n in an entityID that represents the user. Evidently then checks the evaluation\n rules and assigns the variation.
The first rules that are evaluated are the override rules. If the user's\n entityID matches an override rule, the user is served the variation specified\n by that rule.
Next, if there is a launch of the feature, the user might be assigned to a variation in\n the launch. The chance of this depends on the percentage of users that are allocated to that\n launch. If the user is enrolled in the launch, the variation they are served depends on the\n allocation of the various feature variations used for the launch.
\nIf the user is not assigned to a launch, and there is an ongoing experiment for this feature, the user might \n be assigned to a variation in the experiment. The chance of this\n depends on the percentage of users that are allocated to that experiment. If the user is enrolled in the experiment, \n the variation they are served depends on the allocation of the various feature variations used for the experiment.
\nIf the user is not assigned to a launch or experiment, they are served the default variation.
", + "smithy.api#endpoint": { + "hostPrefix": "dataplane." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/projects/{project}/evaluations", + "code": 200 + }, + "smithy.api#tags": [ + "dataplane" + ] + } + }, + "com.amazonaws.evidently#BatchEvaluateFeatureRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that contains the feature being evaluated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "requests": { + "target": "com.amazonaws.evidently#EvaluationRequestsList", + "traits": { + "smithy.api#documentation": "An array of structures, where each structure assigns a feature variation to one user session.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#BatchEvaluateFeatureResponse": { + "type": "structure", + "members": { + "results": { + "target": "com.amazonaws.evidently#EvaluationResultsList", + "traits": { + "smithy.api#documentation": "An array of structures, where each structure displays the results of one feature evaluation\n assignment to one user session.
" + } + } + } + }, + "com.amazonaws.evidently#ChangeDirectionEnum": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INCREASE", + "name": "INCREASE" + }, + { + "value": "DECREASE", + "name": "DECREASE" + } + ] + } + }, + "com.amazonaws.evidently#CloudWatchLogsDestination": { + "type": "structure", + "members": { + "logGroup": { + "target": "com.amazonaws.evidently#CwLogGroupSafeName", + "traits": { + "smithy.api#documentation": "The name of the log group where the project stores evaluation\n events.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure containing the CloudWatch Logs log group where the project stores evaluation\n events.
" + } + }, + "com.amazonaws.evidently#CloudWatchLogsDestinationConfig": { + "type": "structure", + "members": { + "logGroup": { + "target": "com.amazonaws.evidently#CwLogGroupSafeName", + "traits": { + "smithy.api#documentation": "The name of the log group where the project stores evaluation\n events.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure containing the CloudWatch Logs log group where the project stores evaluation\n events.
" + } + }, + "com.amazonaws.evidently#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the resource that caused the exception.
" + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of the resource that is associated with the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A resource was in an inconsistent state during an update or a deletion.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.evidently#CreateExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#CreateExperimentRequest" + }, + "output": { + "target": "com.amazonaws.evidently#CreateExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ConflictException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Evidently experiment. Before you create an experiment,\n you must create the feature to use for the experiment.
\nAn experiment helps you make feature design \n decisions based on evidence and data. An experiment can test as\n many as five variations at once. Evidently collects experiment data and analyzes it by statistical methods, and provides\n clear recommendations about which variations perform better.
\nDon't use this operation to update an existing experiment. Instead, use \n UpdateExperiment.
", + "smithy.api#http": { + "method": "POST", + "uri": "/projects/{project}/experiments", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.evidently#CreateExperimentRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that you want to create the new experiment in.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.evidently#ExperimentName", + "traits": { + "smithy.api#documentation": "A name for the new experiment.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.evidently#Description", + "traits": { + "smithy.api#documentation": "An optional description of the experiment.
" + } + }, + "treatments": { + "target": "com.amazonaws.evidently#TreatmentConfigList", + "traits": { + "smithy.api#documentation": "An array of structures that describe the configuration of each feature variation used in the experiment.
", + "smithy.api#required": {} + } + }, + "metricGoals": { + "target": "com.amazonaws.evidently#MetricGoalConfigList", + "traits": { + "smithy.api#documentation": "An array of structures that defines the metrics used for the experiment, and whether a higher\n or lower value for each metric is the goal.
", + "smithy.api#required": {} + } + }, + "randomizationSalt": { + "target": "com.amazonaws.evidently#RandomizationSalt", + "traits": { + "smithy.api#documentation": "When Evidently assigns a particular user session to an experiment, it must use a randomization ID\n to determine which variation the user session is served. This randomization ID is a combination of the entity ID\n and randomizationSalt. If you omit randomizationSalt, Evidently uses\n the experiment name as the randomizationSalt.
The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience\n is the total audience minus the audience that you have allocated to overrides or current launches of\n this feature.
\nThis is represented in thousandths of a percent. For example, specify 10,000 to allocate 10% of the available audience.
" + } + }, + "onlineAbConfig": { + "target": "com.amazonaws.evidently#OnlineAbConfig", + "traits": { + "smithy.api#documentation": "A structure that contains the configuration of which variation to use as the \"control\"\n version. tThe \"control\" version is used for comparison with other variations. This structure\n also specifies how much experiment traffic is allocated to each variation.
" + } + }, + "tags": { + "target": "com.amazonaws.evidently#TagMap", + "traits": { + "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the experiment.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.
\nTags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
\n \nYou can associate as many as 50 tags with an experiment.
\nFor more information, see Tagging Amazon Web Services resources.
" + } + } + } + }, + "com.amazonaws.evidently#CreateExperimentResponse": { + "type": "structure", + "members": { + "experiment": { + "target": "com.amazonaws.evidently#Experiment", + "traits": { + "smithy.api#documentation": "A structure containing the configuration details of the experiment\n that you created.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#CreateFeature": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#CreateFeatureRequest" + }, + "output": { + "target": "com.amazonaws.evidently#CreateFeatureResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ConflictException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Evidently feature that you want to launch or test. You can define up to \n five variations of a feature, and use these variations in your launches and experiments. A feature must be created in\n a project. For information about creating a project, see CreateProject.
\nDon't use this operation to update an existing feature. Instead, use \n UpdateFeature.
", + "smithy.api#http": { + "method": "POST", + "uri": "/projects/{project}/features", + "code": 200 + } + } + }, + "com.amazonaws.evidently#CreateFeatureRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that is to contain the new feature.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.evidently#FeatureName", + "traits": { + "smithy.api#documentation": "The name for the new feature.
", + "smithy.api#required": {} + } + }, + "evaluationStrategy": { + "target": "com.amazonaws.evidently#FeatureEvaluationStrategy", + "traits": { + "smithy.api#documentation": "Specify ALL_RULES to activate the traffic allocation specified by any\n ongoing launches or experiments. Specify DEFAULT_VARIATION to serve the default\n variation to all users instead.
An optional description of the feature.
" + } + }, + "variations": { + "target": "com.amazonaws.evidently#VariationConfigsList", + "traits": { + "smithy.api#documentation": "An array of structures that contain the configuration of the feature's different variations.
", + "smithy.api#required": {} + } + }, + "defaultVariation": { + "target": "com.amazonaws.evidently#VariationName", + "traits": { + "smithy.api#documentation": "The name of the variation to use as the default variation. The default\n variation is served to users who are not allocated to any ongoing launches\n or experiments of this feature.
\nThis variation must also be listed in the variations structure.
If you omit defaultVariation, the first variation listed in\n the variations structure is used as the default variation.
Assigns one or more tags (key-value pairs) to the feature.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.
\nTags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
\n \nYou can associate as many as 50 tags with a feature.
\nFor more information, see Tagging Amazon Web Services resources.
" + } + }, + "entityOverrides": { + "target": "com.amazonaws.evidently#EntityOverrideMap", + "traits": { + "smithy.api#documentation": "Specify users that should always be served a specific variation of a feature. Each user\n is specified by a key-value pair . For each key, specify a user by entering their user ID,\n account ID, or some other identifier. For the value, specify the name of the variation that\n they are to be served.
" + } + } + } + }, + "com.amazonaws.evidently#CreateFeatureResponse": { + "type": "structure", + "members": { + "feature": { + "target": "com.amazonaws.evidently#Feature", + "traits": { + "smithy.api#documentation": "A structure that contains information about the new feature.
" + } + } + } + }, + "com.amazonaws.evidently#CreateLaunch": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#CreateLaunchRequest" + }, + "output": { + "target": "com.amazonaws.evidently#CreateLaunchResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ConflictException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a launch of a given feature. Before you create a launch, you\n must create the feature to use for the launch.
\nYou can use a launch to safely validate new features by serving them to a specified\n percentage of your users while you roll out the feature. You can monitor the performance of\n the new feature to help you decide when to ramp up traffic to more users. This helps you\n reduce risk and identify unintended consequences before you fully launch the feature.
\nDon't use this operation to update an existing launch. Instead, use \n UpdateLaunch.
", + "smithy.api#http": { + "method": "POST", + "uri": "/projects/{project}/launches", + "code": 200 + } + } + }, + "com.amazonaws.evidently#CreateLaunchRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that you want to create the launch in.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.evidently#LaunchName", + "traits": { + "smithy.api#documentation": "The name for the new launch.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.evidently#Description", + "traits": { + "smithy.api#documentation": "An optional description for the launch.
" + } + }, + "scheduledSplitsConfig": { + "target": "com.amazonaws.evidently#ScheduledSplitsLaunchConfig", + "traits": { + "smithy.api#documentation": "An array of structures that define the traffic allocation percentages among the feature\n variations during each step of the launch.
" + } + }, + "metricMonitors": { + "target": "com.amazonaws.evidently#MetricMonitorConfigList", + "traits": { + "smithy.api#documentation": "An array of structures that define the metrics that will be used to monitor \n the launch performance.
" + } + }, + "groups": { + "target": "com.amazonaws.evidently#LaunchGroupConfigList", + "traits": { + "smithy.api#documentation": "An array of structures that contains the feature and variations that are to be used for the launch.
", + "smithy.api#required": {} + } + }, + "randomizationSalt": { + "target": "com.amazonaws.evidently#RandomizationSalt", + "traits": { + "smithy.api#documentation": "When Evidently assigns a particular user session to a launch, it must use a randomization ID\n to determine which variation the user session is served. This randomization ID is a combination of the entity ID\n and randomizationSalt. If you omit randomizationSalt, Evidently uses\n the launch name as the randomizationsSalt.
Assigns one or more tags (key-value pairs) to the launch.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.
\nTags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
\n \nYou can associate as many as 50 tags with a launch.
\nFor more information, see Tagging Amazon Web Services resources.
" + } + } + } + }, + "com.amazonaws.evidently#CreateLaunchResponse": { + "type": "structure", + "members": { + "launch": { + "target": "com.amazonaws.evidently#Launch", + "traits": { + "smithy.api#documentation": "A structure that contains the configuration of the launch that was created.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#CreateProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#CreateProjectRequest" + }, + "output": { + "target": "com.amazonaws.evidently#CreateProjectResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ConflictException" + }, + { + "target": "com.amazonaws.evidently#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a project, which is the logical object in Evidently that can contain features, launches, and \n experiments. Use projects to group similar features together.
\nTo update an existing project, use UpdateProject.
", + "smithy.api#http": { + "method": "POST", + "uri": "/projects", + "code": 200 + } + } + }, + "com.amazonaws.evidently#CreateProjectRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.evidently#ProjectName", + "traits": { + "smithy.api#documentation": "The name for the project.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.evidently#Description", + "traits": { + "smithy.api#documentation": "An optional description of the project.
" + } + }, + "dataDelivery": { + "target": "com.amazonaws.evidently#ProjectDataDeliveryConfig", + "traits": { + "smithy.api#documentation": "A structure that contains information about where Evidently is to store\n evaluation events for longer term storage, if you choose to do so. If you choose\n not to store these events, Evidently deletes them after using them to produce metrics and other experiment\n results that you can view.
" + } + }, + "tags": { + "target": "com.amazonaws.evidently#TagMap", + "traits": { + "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the project.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.
\nTags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
\n \nYou can associate as many as 50 tags with a project.
\nFor more information, see Tagging Amazon Web Services resources.
" + } + } + } + }, + "com.amazonaws.evidently#CreateProjectResponse": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#Project", + "traits": { + "smithy.api#documentation": "A structure that contains information about the created project.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#CwDimensionSafeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.evidently#CwLogGroupSafeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9._/]+$" + } + }, + "com.amazonaws.evidently#DeleteExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#DeleteExperimentRequest" + }, + "output": { + "target": "com.amazonaws.evidently#DeleteExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ConflictException" + }, + { + "target": "com.amazonaws.evidently#InternalServerException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an Evidently experiment. The feature used for the experiment is not deleted.
\nTo stop an experiment without deleting it, use StopExperiment.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/projects/{project}/experiments/{experiment}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.evidently#DeleteExperimentRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that contains the experiment to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "experiment": { + "target": "com.amazonaws.evidently#ExperimentName", + "traits": { + "smithy.api#documentation": "The name of the experiment to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#DeleteExperimentResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.evidently#DeleteFeature": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#DeleteFeatureRequest" + }, + "output": { + "target": "com.amazonaws.evidently#DeleteFeatureResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ConflictException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ThrottlingException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an Evidently feature.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/projects/{project}/features/{feature}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.evidently#DeleteFeatureRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that contains the feature to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "feature": { + "target": "com.amazonaws.evidently#FeatureName", + "traits": { + "smithy.api#documentation": "The name of the feature to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#DeleteFeatureResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.evidently#DeleteLaunch": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#DeleteLaunchRequest" + }, + "output": { + "target": "com.amazonaws.evidently#DeleteLaunchResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ConflictException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ThrottlingException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an Evidently launch. The feature used for the launch is not deleted.
\nTo stop a launch without deleting it, use StopLaunch.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/projects/{project}/launches/{launch}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.evidently#DeleteLaunchRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that contains the launch to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "launch": { + "target": "com.amazonaws.evidently#LaunchName", + "traits": { + "smithy.api#documentation": "The name of the launch to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#DeleteLaunchResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.evidently#DeleteProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#DeleteProjectRequest" + }, + "output": { + "target": "com.amazonaws.evidently#DeleteProjectResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ConflictException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ThrottlingException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an Evidently project. Before you can delete a project, you must delete all the\n features that the project contains. To delete a feature, use DeleteFeature.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/projects/{project}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.evidently#DeleteProjectRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#DeleteProjectResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.evidently#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 160 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.evidently#DoubleValueList": { + "type": "list", + "member": { + "target": "smithy.api#Double" + }, + "traits": { + "smithy.api#length": { + "max": 100800 + } + } + }, + "com.amazonaws.evidently#EntityId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.evidently#EntityOverrideMap": { + "type": "map", + "key": { + "target": "com.amazonaws.evidently#EntityId" + }, + "value": { + "target": "com.amazonaws.evidently#VariationName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.evidently#ErrorCodeEnum": { + "type": "string", + "traits": { + "smithy.api#documentation": "Recommended errors from AWS API standards: https://w.amazon.com/bin/view/AWS/API_Standards/Exceptions\nErrorCode = \"ValidationException\"|\"ServiceQuotaExceededException\"|\"AccessDeniedException\"|\"ResourceNotFoundException\"|\"ConflictException\"|\"ThrottlingException\"|\"InternalServerException\"|string;", + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.evidently#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.evidently#EvaluateFeature": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#EvaluateFeatureRequest" + }, + "output": { + "target": "com.amazonaws.evidently#EvaluateFeatureResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ThrottlingException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "This operation assigns a feature variation to one given user session. You pass in an\n entityID that represents the user. Evidently then checks the evaluation rules\n and assigns the variation.
The first rules that are evaluated are the override rules. If the user's\n entityID matches an override rule, the user is served the variation specified\n by that rule.
Next, if there is a launch of the feature, the user might be assigned to a variation in\n the launch. The chance of this depends on the percentage of users that are allocated to that\n launch. If the user is enrolled in the launch, the variation they are served depends on the\n allocation of the various feature variations used for the launch.
\nIf the user is not assigned to a launch, and there is an ongoing experiment for this feature, the user might \n be assigned to a variation in the experiment. The chance of this\n depends on the percentage of users that are allocated to that experiment. If the user is enrolled in the experiment, \n the variation they are served depends on the allocation of the various feature variations used for the experiment.
\nIf the user is not assigned to a launch or experiment, they are served the default variation.
", + "smithy.api#endpoint": { + "hostPrefix": "dataplane." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/projects/{project}/evaluations/{feature}", + "code": 200 + }, + "smithy.api#tags": [ + "dataplane" + ] + } + }, + "com.amazonaws.evidently#EvaluateFeatureRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that contains this feature.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "feature": { + "target": "com.amazonaws.evidently#FeatureName", + "traits": { + "smithy.api#documentation": "The name of the feature being evaluated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityId": { + "target": "com.amazonaws.evidently#EntityId", + "traits": { + "smithy.api#documentation": "An internal ID that represents a unique user of the application. This\n entityID is checked against any override rules assigned for this\n feature.
A JSON block of attributes that you can optionally pass in. This JSON block is included\n in the evaluation events sent to Evidently from the user session.
" + } + } + } + }, + "com.amazonaws.evidently#EvaluateFeatureResponse": { + "type": "structure", + "members": { + "variation": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the variation that was served to the user session.
" + } + }, + "value": { + "target": "com.amazonaws.evidently#VariableValue", + "traits": { + "smithy.api#documentation": "The value assigned to this variation to differentiate it from the other variations of this feature.
" + } + }, + "reason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Specifies the reason that the user session was assigned this variation. Possible values\n include DEFAULT, meaning the user was served the default variation;\n LAUNCH_RULE_MATCH, if the user session was enrolled in a launch;\n EXPERIMENT_RULE_MATCH, if the user session was enrolled in an experiment; or\n ENTITY_OVERRIDES_MATCH, if the user's entityId matches an override\n rule.
If this user was assigned to a launch or experiment, this field lists the launch or experiment name.
" + } + } + } + }, + "com.amazonaws.evidently#EvaluationRequest": { + "type": "structure", + "members": { + "feature": { + "target": "com.amazonaws.evidently#FeatureName", + "traits": { + "smithy.api#documentation": "The name of the feature being evaluated.
", + "smithy.api#required": {} + } + }, + "entityId": { + "target": "com.amazonaws.evidently#EntityId", + "traits": { + "smithy.api#documentation": "An internal ID that represents a unique user session of the application. This\n entityID is checked against any override rules assigned for this\n feature.
A JSON block of attributes that you can optionally pass in. This JSON block is included\n in the evaluation events sent to Evidently from the user session.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure assigns a feature variation to one user session.
" + } + }, + "com.amazonaws.evidently#EvaluationRequestsList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#EvaluationRequest" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.evidently#EvaluationResult": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#Arn", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that contains the feature being evaluated.
" + } + }, + "feature": { + "target": "com.amazonaws.evidently#FeatureName", + "traits": { + "smithy.api#documentation": "The name of the feature being evaluated.
", + "smithy.api#required": {} + } + }, + "variation": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the variation that was served to the user session.
" + } + }, + "value": { + "target": "com.amazonaws.evidently#VariableValue", + "traits": { + "smithy.api#documentation": "The value assigned to this variation to differentiate it from the other variations of this feature.
" + } + }, + "entityId": { + "target": "com.amazonaws.evidently#EntityId", + "traits": { + "smithy.api#documentation": "An internal ID that represents a unique user session of the application.
", + "smithy.api#required": {} + } + }, + "reason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Specifies the reason that the user session was assigned this variation. Possible values\n include DEFAULT, meaning the user was served the default variation;\n LAUNCH_RULE_MATCH, if the user session was enrolled in a launch; or\n EXPERIMENT_RULE_MATCH, if the user session was enrolled in an\n experiment.
If this user was assigned to a launch or experiment, this field lists the launch or experiment name.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure displays the results of one feature evaluation assignment to one user\n session.
" + } + }, + "com.amazonaws.evidently#EvaluationResultsList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#EvaluationResult" + } + }, + "com.amazonaws.evidently#EvaluationRule": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.evidently#RuleName", + "traits": { + "smithy.api#documentation": "The name of the experiment or launch.
" + } + }, + "type": { + "target": "com.amazonaws.evidently#RuleType", + "traits": { + "smithy.api#documentation": "This value is aws.evidently.splits if this is an evaluation rule for a launch, and it is\n aws.evidently.onlineab if this is an evaluation rule for an experiment.
A structure that contains the information about an evaluation rule for this feature, \n if it is used in a launch or experiment.
" + } + }, + "com.amazonaws.evidently#EvaluationRulesList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#EvaluationRule" + } + }, + "com.amazonaws.evidently#Event": { + "type": "structure", + "members": { + "timestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of the event.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.evidently#EventType", + "traits": { + "smithy.api#documentation": "\n aws.evidently.evaluation specifies an evaluation event, which determines\n which feature variation that a user sees. aws.evidently.custom specifies a custom\n event, which generates metrics from user actions such as clicks and checkouts.
The event data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains the information about one evaluation event or custom event sent to Evidently.\n This is a JSON payload. If this event specifies a pre-defined event type, the payload must follow the \n defined event schema.
" + } + }, + "com.amazonaws.evidently#EventList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#Event" + }, + "traits": { + "smithy.api#length": { + "max": 50 + } + } + }, + "com.amazonaws.evidently#EventType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "aws.evidently.evaluation", + "name": "EVALUATION" + }, + { + "value": "aws.evidently.custom", + "name": "CUSTOM" + } + ] + } + }, + "com.amazonaws.evidently#Evidently": { + "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Evidently", + "arnNamespace": "evidently", + "cloudFormationName": "Evidently", + "cloudTrailEventSource": "evidently.amazonaws.com", + "endpointPrefix": "evidently" + }, + "aws.auth#sigv4": { + "name": "evidently" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "Authorization", + "x-amz-content-sha256", + "X-Amz-Date", + "X-Amz-Security-Token", + "X-Api-Key", + "Content-Type", + "X-Amz-User-Agent" + ] + }, + "smithy.api#documentation": "You can use Amazon CloudWatch Evidently to safely validate new features by serving them to a specified percentage\n of your users while you roll out the feature. You can monitor the performance of the new feature\n to help you decide when to ramp up traffic to your users. This helps you \n reduce risk and identify unintended consequences before you fully launch the feature.
\nYou can also conduct A/B experiments to make feature design decisions based on evidence\n and data. An experiment can test as many as five variations at once. Evidently collects\n experiment data and analyzes it using statistical methods. It also provides clear\n recommendations about which variations perform better. You can test both user-facing features\n and backend features.
", + "smithy.api#title": "Amazon CloudWatch Evidently" + }, + "version": "2021-02-01", + "operations": [ + { + "target": "com.amazonaws.evidently#ListTagsForResource" + }, + { + "target": "com.amazonaws.evidently#TagResource" + }, + { + "target": "com.amazonaws.evidently#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.evidently#ProjectResource" + } + ] + }, + "com.amazonaws.evidently#Experiment": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.evidently#ExperimentArn", + "traits": { + "smithy.api#documentation": "The ARN of the experiment.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.evidently#ExperimentName", + "traits": { + "smithy.api#documentation": "The name of the experiment.
", + "smithy.api#required": {} + } + }, + "project": { + "target": "com.amazonaws.evidently#ProjectArn", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that contains this experiment.
" + } + }, + "status": { + "target": "com.amazonaws.evidently#ExperimentStatus", + "traits": { + "smithy.api#documentation": "The current state of the experiment.
", + "smithy.api#required": {} + } + }, + "statusReason": { + "target": "com.amazonaws.evidently#Description", + "traits": { + "smithy.api#documentation": "If the experiment was stopped, this is the string that was entered by the person who \n stopped the experiment, to explain why it was stopped.
" + } + }, + "description": { + "target": "com.amazonaws.evidently#Description", + "traits": { + "smithy.api#documentation": "A description of the experiment.
" + } + }, + "createdTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the experiment is first created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the experiment was most recently updated.
", + "smithy.api#required": {} + } + }, + "schedule": { + "target": "com.amazonaws.evidently#ExperimentSchedule", + "traits": { + "smithy.api#documentation": "A structure that contains the time and date that Evidently completed the analysis of the experiment.
" + } + }, + "execution": { + "target": "com.amazonaws.evidently#ExperimentExecution", + "traits": { + "smithy.api#documentation": "A structure that contains the date and time that the experiment started and ended.
" + } + }, + "treatments": { + "target": "com.amazonaws.evidently#TreatmentList", + "traits": { + "smithy.api#documentation": "An array of structures that describe the configuration of each feature variation used in the experiment.
" + } + }, + "metricGoals": { + "target": "com.amazonaws.evidently#MetricGoalsList", + "traits": { + "smithy.api#documentation": "An array of structures that defines the metrics used for the experiment, and whether a higher\n or lower value for each metric is the goal.
" + } + }, + "randomizationSalt": { + "target": "com.amazonaws.evidently#RandomizationSalt", + "traits": { + "smithy.api#documentation": "This value is used when Evidently assigns a particular user session to the experiment. It\n helps create a randomization ID to determine which variation the user session is served. This\n randomization ID is a combination of the entity ID and randomizationSalt.
In thousandths of a percent, the amount of the available audience that is allocated to this experiment. \n The available audience\n is the total audience minus the audience that you have allocated to overrides or current launches of\n this feature.
\nThis is represented in thousandths of a percent, so a value of 10,000 is 10% of the available audience.
" + } + }, + "type": { + "target": "com.amazonaws.evidently#ExperimentType", + "traits": { + "smithy.api#documentation": "The type of this experiment. Currently, this value must be aws.experiment.onlineab.
A structure that contains the configuration of which variation to use as the \"control\"\n version. The \"control\" version is used for comparison with other variations. This structure\n also specifies how much experiment traffic is allocated to each variation.
" + } + }, + "tags": { + "target": "com.amazonaws.evidently#TagMap", + "traits": { + "smithy.api#documentation": "The list of tag keys and values associated with this experiment.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure containing the configuration details of an experiment.
" + } + }, + "com.amazonaws.evidently#ExperimentArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*/experiment/[-a-zA-Z0-9._]*" + } + }, + "com.amazonaws.evidently#ExperimentBaseStat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Mean", + "name": "MEAN" + } + ] + } + }, + "com.amazonaws.evidently#ExperimentExecution": { + "type": "structure", + "members": { + "startedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the experiment started.
" + } + }, + "endedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the experiment ended.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains the date and time that the experiment started and ended.
" + } + }, + "com.amazonaws.evidently#ExperimentList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#Experiment" + } + }, + "com.amazonaws.evidently#ExperimentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + }, + "smithy.api#pattern": "[-a-zA-Z0-9._]*" + } + }, + "com.amazonaws.evidently#ExperimentReport": { + "type": "structure", + "members": { + "metricName": { + "target": "com.amazonaws.evidently#CwDimensionSafeName", + "traits": { + "smithy.api#documentation": "The name of the metric that is analyzed in this experiment report.
" + } + }, + "treatmentName": { + "target": "com.amazonaws.evidently#TreatmentName", + "traits": { + "smithy.api#documentation": "The name of the variation that this report pertains to.
" + } + }, + "reportName": { + "target": "com.amazonaws.evidently#ExperimentReportName", + "traits": { + "smithy.api#documentation": "The type of analysis used for this report.
" + } + }, + "content": { + "target": "com.amazonaws.evidently#JsonValue", + "traits": { + "smithy.api#documentation": "The content of the report.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains results of an experiment.
" + } + }, + "com.amazonaws.evidently#ExperimentReportList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#ExperimentReport" + }, + "traits": { + "smithy.api#length": { + "max": 1000 + } + } + }, + "com.amazonaws.evidently#ExperimentReportName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "BayesianInference", + "name": "BAYESIAN_INFERENCE" + } + ] + } + }, + "com.amazonaws.evidently#ExperimentReportNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#ExperimentReportName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.evidently#ExperimentResource": { + "type": "resource", + "identifiers": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef" + }, + "experiment": { + "target": "com.amazonaws.evidently#ExperimentName" + } + }, + "create": { + "target": "com.amazonaws.evidently#CreateExperiment" + }, + "read": { + "target": "com.amazonaws.evidently#GetExperiment" + }, + "update": { + "target": "com.amazonaws.evidently#UpdateExperiment" + }, + "delete": { + "target": "com.amazonaws.evidently#DeleteExperiment" + }, + "list": { + "target": "com.amazonaws.evidently#ListExperiments" + }, + "operations": [ + { + "target": "com.amazonaws.evidently#GetExperimentResults" + }, + { + "target": "com.amazonaws.evidently#StartExperiment" + }, + { + "target": "com.amazonaws.evidently#StopExperiment" + } + ] + }, + "com.amazonaws.evidently#ExperimentResultRequestType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "BaseStat", + "name": "BASE_STAT" + }, + { + "value": "TreatmentEffect", + "name": "TREATMENT_EFFECT" + }, + { + "value": "ConfidenceInterval", + "name": "CONFIDENCE_INTERVAL" + }, + { + "value": "PValue", + "name": "P_VALUE" + } + ] + } + }, + "com.amazonaws.evidently#ExperimentResultRequestTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#ExperimentResultRequestType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.evidently#ExperimentResultResponseType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Mean", + "name": "MEAN" + }, + { + "value": "TreatmentEffect", + "name": "TREATMENT_EFFECT" + }, + { + "value": "ConfidenceIntervalUpperBound", + "name": "CONFIDENCE_INTERVAL_UPPERBOUND" + }, + { + "value": "ConfidenceIntervalLowerBound", + "name": "CONFIDENCE_INTERVAL_LOWERBOUND" + }, + { + "value": "PValue", + "name": "P_VALUE" + } + ] + } + }, + "com.amazonaws.evidently#ExperimentResultsData": { + "type": "structure", + "members": { + "metricName": { + "target": "com.amazonaws.evidently#CwDimensionSafeName", + "traits": { + "smithy.api#documentation": "The name of the metric.
" + } + }, + "treatmentName": { + "target": "com.amazonaws.evidently#TreatmentName", + "traits": { + "smithy.api#documentation": "The treatment, or variation, that returned the values in this structure.
The experiment statistic that these results pertain to.
" + } + }, + "values": { + "target": "com.amazonaws.evidently#DoubleValueList", + "traits": { + "smithy.api#documentation": "The values for the metricName that were recorded in the experiment.
A structure that contains experiment results for one metric that is monitored in\n the experiment.
" + } + }, + "com.amazonaws.evidently#ExperimentResultsDataList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#ExperimentResultsData" + }, + "traits": { + "smithy.api#length": { + "max": 1000 + } + } + }, + "com.amazonaws.evidently#ExperimentSchedule": { + "type": "structure", + "members": { + "analysisCompleteTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time and date that Evidently completed the analysis of the experiment.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains the time and date that Evidently completed the analysis of the experiment.
" + } + }, + "com.amazonaws.evidently#ExperimentStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATED", + "name": "CREATED" + }, + { + "value": "UPDATING", + "name": "UPDATING" + }, + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "CANCELLED", + "name": "CANCELLED" + } + ] + } + }, + "com.amazonaws.evidently#ExperimentStopDesiredState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "CANCELLED", + "name": "CANCELLED" + } + ] + } + }, + "com.amazonaws.evidently#ExperimentType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "aws.evidently.onlineab", + "name": "ONLINE_AB_EXPERIMENT" + } + ] + } + }, + "com.amazonaws.evidently#Feature": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.evidently#FeatureArn", + "traits": { + "smithy.api#documentation": "The ARN of the feature.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.evidently#FeatureName", + "traits": { + "smithy.api#documentation": "The name of the feature.
", + "smithy.api#required": {} + } + }, + "project": { + "target": "com.amazonaws.evidently#ProjectArn", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that contains the feature.
" + } + }, + "status": { + "target": "com.amazonaws.evidently#FeatureStatus", + "traits": { + "smithy.api#documentation": "The current state of the feature.
", + "smithy.api#required": {} + } + }, + "createdTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the feature is created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the feature was most recently updated.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.evidently#Description", + "traits": { + "smithy.api#documentation": "The description of the feature.
" + } + }, + "evaluationStrategy": { + "target": "com.amazonaws.evidently#FeatureEvaluationStrategy", + "traits": { + "smithy.api#documentation": "If this value is ALL_RULES, the traffic allocation specified by\n any ongoing launches or experiments is being used. If this is DEFAULT_VARIATION,\n the default variation is being served to all users.
Defines the type of value used to define the different feature variations. \n For more information, see Variation types\n
", + "smithy.api#required": {} + } + }, + "variations": { + "target": "com.amazonaws.evidently#VariationsList", + "traits": { + "smithy.api#documentation": "An array of structures that contain the configuration of the feature's different variations.
", + "smithy.api#required": {} + } + }, + "defaultVariation": { + "target": "com.amazonaws.evidently#VariationName", + "traits": { + "smithy.api#documentation": "The name of the variation that is used as the default variation. The default\n variation is served to users who are not allocated to any ongoing launches\n or experiments of this feature.
\nThis variation must also be listed in the variations structure.
If you omit defaultVariation, the first variation listed in\n the variations structure is used as the default variation.
An array of structures that define the evaluation rules for the feature.
" + } + }, + "tags": { + "target": "com.amazonaws.evidently#TagMap", + "traits": { + "smithy.api#documentation": "The list of tag keys and values associated with this feature.
" + } + }, + "entityOverrides": { + "target": "com.amazonaws.evidently#EntityOverrideMap", + "traits": { + "smithy.api#documentation": "A set of key-value pairs that specify users who should always be served a specific\n variation of a feature. Each key specifies a user using their user ID, account ID, or some\n other identifier. The value specifies the name of the variation that the user is to be\n served.
\nFor the override to be successful, the value of the key must match the entityId used \n in the EvaluateFeature operation.
This structure contains information about one Evidently feature in your account.
" + } + }, + "com.amazonaws.evidently#FeatureArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*/feature/[-a-zA-Z0-9._]*" + } + }, + "com.amazonaws.evidently#FeatureEvaluationStrategy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALL_RULES", + "name": "ALL_RULES" + }, + { + "value": "DEFAULT_VARIATION", + "name": "DEFAULT_VARIATION" + } + ] + } + }, + "com.amazonaws.evidently#FeatureName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + }, + "smithy.api#pattern": "[-a-zA-Z0-9._]*" + } + }, + "com.amazonaws.evidently#FeatureResource": { + "type": "resource", + "identifiers": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef" + }, + "feature": { + "target": "com.amazonaws.evidently#FeatureName" + } + }, + "create": { + "target": "com.amazonaws.evidently#CreateFeature" + }, + "read": { + "target": "com.amazonaws.evidently#GetFeature" + }, + "update": { + "target": "com.amazonaws.evidently#UpdateFeature" + }, + "delete": { + "target": "com.amazonaws.evidently#DeleteFeature" + }, + "list": { + "target": "com.amazonaws.evidently#ListFeatures" + } + }, + "com.amazonaws.evidently#FeatureStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AVAILABLE", + "name": "AVAILABLE" + }, + { + "value": "UPDATING", + "name": "UPDATING" + } + ] + } + }, + "com.amazonaws.evidently#FeatureSummariesList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#FeatureSummary" + } + }, + "com.amazonaws.evidently#FeatureSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.evidently#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the feature.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.evidently#FeatureName", + "traits": { + "smithy.api#documentation": "The name of the feature.
", + "smithy.api#required": {} + } + }, + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that contains the feature.
" + } + }, + "status": { + "target": "com.amazonaws.evidently#FeatureStatus", + "traits": { + "smithy.api#documentation": "The current state of the feature.
", + "smithy.api#required": {} + } + }, + "createdTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the feature is created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the feature was most recently updated.
", + "smithy.api#required": {} + } + }, + "evaluationStrategy": { + "target": "com.amazonaws.evidently#FeatureEvaluationStrategy", + "traits": { + "smithy.api#documentation": "If this value is ALL_RULES, the traffic allocation specified by\n any ongoing launches or experiments is being used. If this is DEFAULT_VARIATION,\n the default variation is being served to all users.
An array of structures that define
" + } + }, + "defaultVariation": { + "target": "com.amazonaws.evidently#VariationName", + "traits": { + "smithy.api#documentation": "The name of the variation that is used as the default variation. The default\n variation is served to users who are not allocated to any ongoing launches\n or experiments of this feature.
" + } + }, + "tags": { + "target": "com.amazonaws.evidently#TagMap", + "traits": { + "smithy.api#documentation": "The list of tag keys and values associated with this feature.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains information about one Evidently feature in your account.
" + } + }, + "com.amazonaws.evidently#FeatureToVariationMap": { + "type": "map", + "key": { + "target": "com.amazonaws.evidently#FeatureName" + }, + "value": { + "target": "com.amazonaws.evidently#VariationName" + } + }, + "com.amazonaws.evidently#GetExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#GetExperimentRequest" + }, + "output": { + "target": "com.amazonaws.evidently#GetExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the details about one experiment. You must already know the \n experiment name. To retrieve a list of experiments in your account, use ListExperiments.
", + "smithy.api#http": { + "method": "GET", + "uri": "/projects/{project}/experiments/{experiment}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.evidently#GetExperimentRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that contains the experiment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "experiment": { + "target": "com.amazonaws.evidently#ExperimentName", + "traits": { + "smithy.api#documentation": "The name of the experiment that you want to see the details of.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#GetExperimentResponse": { + "type": "structure", + "members": { + "experiment": { + "target": "com.amazonaws.evidently#Experiment", + "traits": { + "smithy.api#documentation": "A structure containing the configuration details of the experiment.
" + } + } + } + }, + "com.amazonaws.evidently#GetExperimentResults": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#GetExperimentResultsRequest" + }, + "output": { + "target": "com.amazonaws.evidently#GetExperimentResultsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ConflictException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ThrottlingException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the results of a running or completed experiment.
", + "smithy.api#http": { + "method": "POST", + "uri": "/projects/{project}/experiments/{experiment}/results", + "code": 200 + } + } + }, + "com.amazonaws.evidently#GetExperimentResultsRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that contains the experiment that you want to see the results of.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "experiment": { + "target": "com.amazonaws.evidently#ExperimentName", + "traits": { + "smithy.api#documentation": "The name of the experiment to retrieve the results of.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "startTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the experiment started.
" + } + }, + "endTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the experiment ended, if it is completed.
" + } + }, + "metricNames": { + "target": "com.amazonaws.evidently#MetricNameList", + "traits": { + "smithy.api#documentation": "The names of the experiment metrics that you want to see the results of.
", + "smithy.api#required": {} + } + }, + "treatmentNames": { + "target": "com.amazonaws.evidently#TreatmentNameList", + "traits": { + "smithy.api#documentation": "The names of the experiment treatments that you want to see the results for.
", + "smithy.api#required": {} + } + }, + "baseStat": { + "target": "com.amazonaws.evidently#ExperimentBaseStat", + "traits": { + "smithy.api#documentation": "The statistic used to calculate experiment results. Currently the only valid value is mean, \n which uses the mean of the collected values as the statistic.
The statistics that you want to see in the returned results.
\n\n PValue specifies to use p-values for the results. A p-value is used in hypothesis\n testing to measure how often you are willing to make a mistake in rejecting the null\n hypothesis. A general practice is to reject the null hypothesis and declare that the\n results are statistically significant when the p-value is less than 0.05.
\n ConfidenceInterval specifies a confidence interval for the results. The\n confidence interval represents the range of values for the chosen metric that is likely to\n contain the true difference between the baseStat of a variation and the\n baseline. Evidently returns the 95% confidence interval.
\n TreatmentEffect is the difference in the statistic specified by the\n baseStat parameter between each variation and the default variation.
\n BaseStat returns the statistical values collected for the metric for each\n variation. The statistic uses the same statistic specified in the baseStat\n parameter. Therefore, if baseStat is mean, this returns the mean\n of the values collected for each variation.
The names of the report types that you want to see. Currently, BayesianInference\n is the only valid value.
In seconds, the amount of time to aggregate results together.
" + } + } + } + }, + "com.amazonaws.evidently#GetExperimentResultsResponse": { + "type": "structure", + "members": { + "resultsData": { + "target": "com.amazonaws.evidently#ExperimentResultsDataList", + "traits": { + "smithy.api#documentation": "An array of structures that include experiment results including metric names and values.
" + } + }, + "reports": { + "target": "com.amazonaws.evidently#ExperimentReportList", + "traits": { + "smithy.api#documentation": "An array of structures that include the reports that you requested.
" + } + }, + "timestamps": { + "target": "com.amazonaws.evidently#TimestampList", + "traits": { + "smithy.api#documentation": "The timestamps of each result returned.
" + } + } + } + }, + "com.amazonaws.evidently#GetFeature": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#GetFeatureRequest" + }, + "output": { + "target": "com.amazonaws.evidently#GetFeatureResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ThrottlingException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the details about one feature. You must already know the feature name. To\n retrieve a list of features in your account, use ListFeatures.
", + "smithy.api#http": { + "method": "GET", + "uri": "/projects/{project}/features/{feature}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.evidently#GetFeatureRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that contains the feature.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "feature": { + "target": "com.amazonaws.evidently#FeatureName", + "traits": { + "smithy.api#documentation": "The name of the feature that you want to retrieve information for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#GetFeatureResponse": { + "type": "structure", + "members": { + "feature": { + "target": "com.amazonaws.evidently#Feature", + "traits": { + "smithy.api#documentation": "A structure containing the configuration details of the feature.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#GetLaunch": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#GetLaunchRequest" + }, + "output": { + "target": "com.amazonaws.evidently#GetLaunchResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the details about one launch. You must already know the \n launch name. To retrieve a list of launches in your account, use ListLaunches.
", + "smithy.api#http": { + "method": "GET", + "uri": "/projects/{project}/launches/{launch}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.evidently#GetLaunchRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that contains the launch.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "launch": { + "target": "com.amazonaws.evidently#LaunchName", + "traits": { + "smithy.api#documentation": "The name of the launch that you want to see the details of.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#GetLaunchResponse": { + "type": "structure", + "members": { + "launch": { + "target": "com.amazonaws.evidently#Launch", + "traits": { + "smithy.api#documentation": "A structure containing the configuration details of the launch.
" + } + } + } + }, + "com.amazonaws.evidently#GetProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#GetProjectRequest" + }, + "output": { + "target": "com.amazonaws.evidently#GetProjectResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ThrottlingException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the details about one launch. You must already know the \n project name. To retrieve a list of projects in your account, use ListProjects.
", + "smithy.api#http": { + "method": "GET", + "uri": "/projects/{project}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.evidently#GetProjectRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that you want to see the details of.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#GetProjectResponse": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#Project", + "traits": { + "smithy.api#documentation": "A structure containing the configuration details of the project.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#GroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + }, + "smithy.api#pattern": "[-a-zA-Z0-9._]*" + } + }, + "com.amazonaws.evidently#GroupToWeightMap": { + "type": "map", + "key": { + "target": "com.amazonaws.evidently#GroupName" + }, + "value": { + "target": "com.amazonaws.evidently#SplitWeight" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.evidently#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "Unexpected error while processing the request. Retry the request.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.evidently#JsonPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.evidently#JsonValue": { + "type": "string", + "traits": { + "smithy.api#mediaType": "application/json" + } + }, + "com.amazonaws.evidently#Launch": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.evidently#LaunchArn", + "traits": { + "smithy.api#documentation": "The ARN of the launch.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.evidently#LaunchName", + "traits": { + "smithy.api#documentation": "The name of the launch.
", + "smithy.api#required": {} + } + }, + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that contains the launch.
" + } + }, + "status": { + "target": "com.amazonaws.evidently#LaunchStatus", + "traits": { + "smithy.api#documentation": "The current state of the launch.
", + "smithy.api#required": {} + } + }, + "statusReason": { + "target": "com.amazonaws.evidently#Description", + "traits": { + "smithy.api#documentation": "If the launch was stopped, this is the string that was entered by the person who \n stopped the launch, to explain why it was stopped.
" + } + }, + "description": { + "target": "com.amazonaws.evidently#Description", + "traits": { + "smithy.api#documentation": "The description of the launch.
" + } + }, + "createdTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the launch is created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the launch was most recently updated.
", + "smithy.api#required": {} + } + }, + "execution": { + "target": "com.amazonaws.evidently#LaunchExecution", + "traits": { + "smithy.api#documentation": "A structure that contains information about the start and end times of the launch.
" + } + }, + "groups": { + "target": "com.amazonaws.evidently#LaunchGroupList", + "traits": { + "smithy.api#documentation": "An array of structures that define the feature variations that are being used in the launch.
" + } + }, + "metricMonitors": { + "target": "com.amazonaws.evidently#MetricMonitorList", + "traits": { + "smithy.api#documentation": "An array of structures that define the metrics that are being used to monitor the launch performance.
" + } + }, + "randomizationSalt": { + "target": "com.amazonaws.evidently#RandomizationSalt", + "traits": { + "smithy.api#documentation": "This value is used when Evidently assigns a particular user session to the launch, to help create a randomization ID\n to determine which variation the user session is served. This randomization ID is a combination of the entity ID\n and randomizationSalt.
The type of launch.
", + "smithy.api#required": {} + } + }, + "scheduledSplitsDefinition": { + "target": "com.amazonaws.evidently#ScheduledSplitsLaunchDefinition", + "traits": { + "smithy.api#documentation": "An array of structures that define the traffic allocation percentages among the feature\n variations during each step of the launch.
" + } + }, + "tags": { + "target": "com.amazonaws.evidently#TagMap", + "traits": { + "smithy.api#documentation": "The list of tag keys and values associated with this launch.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains the configuration details of one Evidently launch.
" + } + }, + "com.amazonaws.evidently#LaunchArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*/launch/[-a-zA-Z0-9._]*" + } + }, + "com.amazonaws.evidently#LaunchExecution": { + "type": "structure", + "members": { + "startedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the launch started.
" + } + }, + "endedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the launch ended.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains information about the start and end times of the launch.
" + } + }, + "com.amazonaws.evidently#LaunchGroup": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.evidently#GroupName", + "traits": { + "smithy.api#documentation": "The name of the launch group.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.evidently#Description", + "traits": { + "smithy.api#documentation": "A description of the launch group.
" + } + }, + "featureVariations": { + "target": "com.amazonaws.evidently#FeatureToVariationMap", + "traits": { + "smithy.api#documentation": "The feature variation for this launch group. This is a key-value pair.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that defines one launch group in a launch. A launch group is a variation of the feature\n that you are including in the launch.
" + } + }, + "com.amazonaws.evidently#LaunchGroupConfig": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.evidently#GroupName", + "traits": { + "smithy.api#documentation": "A name for this launch group.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.evidently#Description", + "traits": { + "smithy.api#documentation": "A description of the launch group.
" + } + }, + "feature": { + "target": "com.amazonaws.evidently#FeatureName", + "traits": { + "smithy.api#documentation": "The feature that this launch is using.
", + "smithy.api#required": {} + } + }, + "variation": { + "target": "com.amazonaws.evidently#VariationName", + "traits": { + "smithy.api#documentation": "The feature variation to use for this launch group.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that defines one launch group in a launch. A launch group is a variation of\n the feature that you are including in the launch.
" + } + }, + "com.amazonaws.evidently#LaunchGroupConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#LaunchGroupConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.evidently#LaunchGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#LaunchGroup" + } + }, + "com.amazonaws.evidently#LaunchName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + }, + "smithy.api#pattern": "[-a-zA-Z0-9._]*" + } + }, + "com.amazonaws.evidently#LaunchResource": { + "type": "resource", + "identifiers": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef" + }, + "launch": { + "target": "com.amazonaws.evidently#LaunchName" + } + }, + "create": { + "target": "com.amazonaws.evidently#CreateLaunch" + }, + "read": { + "target": "com.amazonaws.evidently#GetLaunch" + }, + "update": { + "target": "com.amazonaws.evidently#UpdateLaunch" + }, + "delete": { + "target": "com.amazonaws.evidently#DeleteLaunch" + }, + "list": { + "target": "com.amazonaws.evidently#ListLaunches" + }, + "operations": [ + { + "target": "com.amazonaws.evidently#StartLaunch" + }, + { + "target": "com.amazonaws.evidently#StopLaunch" + } + ] + }, + "com.amazonaws.evidently#LaunchStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATED", + "name": "CREATED" + }, + { + "value": "UPDATING", + "name": "UPDATING" + }, + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "CANCELLED", + "name": "CANCELLED" + } + ] + } + }, + "com.amazonaws.evidently#LaunchStopDesiredState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "CANCELLED", + "name": "CANCELLED" + } + ] + } + }, + "com.amazonaws.evidently#LaunchType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "aws.evidently.splits", + "name": "SCHEDULED_SPLITS_LAUNCH" + } + ] + } + }, + "com.amazonaws.evidently#LaunchesList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#Launch" + } + }, + "com.amazonaws.evidently#ListExperiments": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#ListExperimentsRequest" + }, + "output": { + "target": "com.amazonaws.evidently#ListExperimentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns configuration details about all the experiments in the specified project.
", + "smithy.api#http": { + "method": "GET", + "uri": "/projects/{project}/experiments", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "experiments", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.evidently#ListExperimentsRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project to return the experiment list from.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.evidently#MaxExperiments", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.evidently#NextToken", + "traits": { + "smithy.api#documentation": "The token to use when requesting the next set of results. You received this token from a previous \n ListExperiments operation.
An array of structures that contain the configuration details of the experiments in the\n specified project.
" + } + }, + "nextToken": { + "target": "com.amazonaws.evidently#NextToken", + "traits": { + "smithy.api#documentation": "The token to use in a subsequent ListExperiments operation to return\n the next set of results.
Returns configuration details about all the features in the specified project.
", + "smithy.api#http": { + "method": "GET", + "uri": "/projects/{project}/features", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "features", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.evidently#ListFeaturesRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project to return the feature list from.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.evidently#MaxFeatures", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.evidently#NextToken", + "traits": { + "smithy.api#documentation": "The token to use when requesting the next set of results. You received this token from a previous \n ListFeatures operation.
An array of structures that contain the configuration details of the features in the\n specified project.
" + } + }, + "nextToken": { + "target": "com.amazonaws.evidently#NextToken", + "traits": { + "smithy.api#documentation": "The token to use in a subsequent ListFeatures operation to return\n the next set of results.
Returns configuration details about all the launches in the specified project.
", + "smithy.api#http": { + "method": "GET", + "uri": "/projects/{project}/launches", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "launches", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.evidently#ListLaunchesRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project to return the launch list from.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.evidently#MaxLaunches", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.evidently#NextToken", + "traits": { + "smithy.api#documentation": "The token to use when requesting the next set of results. You received this token from a previous \n ListLaunches operation.
An array of structures that contain the configuration details of the launches in the\n specified project.
" + } + }, + "nextToken": { + "target": "com.amazonaws.evidently#NextToken", + "traits": { + "smithy.api#documentation": "The token to use in a subsequent ListLaunches operation to return\n the next set of results.
Returns configuration details about all the projects in the current Region in your\n account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/projects", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "projects", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.evidently#ListProjectsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.evidently#MaxProjects", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.evidently#NextToken", + "traits": { + "smithy.api#documentation": "The token to use when requesting the next set of results. You received this token from a previous \n ListProjects operation.
An array of structures that contain the configuration details of the projects in the Region.
" + } + }, + "nextToken": { + "target": "com.amazonaws.evidently#NextToken", + "traits": { + "smithy.api#documentation": "The token to use in a subsequent ListProjects operation to return\n the next set of results.
Displays the tags associated with an Evidently resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.evidently#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.evidently#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the resource that you want to see the tags of.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.evidently#TagMap", + "traits": { + "smithy.api#documentation": "The list of tag keys and values associated with the resource you specified.
" + } + } + } + }, + "com.amazonaws.evidently#MaxExperiments": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.evidently#MaxFeatures": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.evidently#MaxLaunches": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.evidently#MaxProjects": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.evidently#MetricDefinition": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.evidently#CwDimensionSafeName", + "traits": { + "smithy.api#documentation": "The name of the metric.
" + } + }, + "entityIdKey": { + "target": "com.amazonaws.evidently#JsonPath", + "traits": { + "smithy.api#documentation": "The entity, such as a user or session, that does an action that causes a metric\n value to be recorded.
" + } + }, + "valueKey": { + "target": "com.amazonaws.evidently#JsonPath", + "traits": { + "smithy.api#documentation": "The value that is tracked to produce the metric.
" + } + }, + "eventPattern": { + "target": "com.amazonaws.evidently#JsonValue", + "traits": { + "smithy.api#documentation": "The EventBridge event pattern that defines how the metric is recorded.
\nFor more information about EventBridge event patterns, see \n Amazon EventBridge event patterns.
" + } + }, + "unitLabel": { + "target": "com.amazonaws.evidently#MetricUnitLabel", + "traits": { + "smithy.api#documentation": "The label for the units that the metric is measuring.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure defines a metric that is being used to evaluate the variations\n during a launch or experiment.
" + } + }, + "com.amazonaws.evidently#MetricDefinitionConfig": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.evidently#CwDimensionSafeName", + "traits": { + "smithy.api#documentation": "A name for the metric.
" + } + }, + "entityIdKey": { + "target": "com.amazonaws.evidently#JsonPath", + "traits": { + "smithy.api#documentation": "The entity, such as a user or session, that does an action that causes a metric\n value to be recorded. An example is userDetails.userID.
The value that is tracked to produce the metric.
" + } + }, + "eventPattern": { + "target": "com.amazonaws.evidently#JsonValue", + "traits": { + "smithy.api#documentation": "The EventBridge event pattern that defines how the metric is recorded.
\nFor more information about EventBridge event patterns, see \n Amazon EventBridge event patterns.
", + "smithy.api#length": { + "max": 1024 + } + } + }, + "unitLabel": { + "target": "com.amazonaws.evidently#MetricUnitLabel", + "traits": { + "smithy.api#documentation": "A label for the units that the metric is measuring.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure defines a metric that you want to use to evaluate the variations\n during a launch or experiment.
" + } + }, + "com.amazonaws.evidently#MetricGoal": { + "type": "structure", + "members": { + "metricDefinition": { + "target": "com.amazonaws.evidently#MetricDefinition", + "traits": { + "smithy.api#documentation": "A structure that contains details about the metric.
", + "smithy.api#required": {} + } + }, + "desiredChange": { + "target": "com.amazonaws.evidently#ChangeDirectionEnum", + "traits": { + "smithy.api#documentation": "\n INCREASE means that a variation with a higher number for this metric is performing \n better.
\n DECREASE means that a variation with a lower number for this metric is performing \n better.
A structure that tells Evidently whether higher or lower values are desired for a metric that is \n used in an experiment.
" + } + }, + "com.amazonaws.evidently#MetricGoalConfig": { + "type": "structure", + "members": { + "metricDefinition": { + "target": "com.amazonaws.evidently#MetricDefinitionConfig", + "traits": { + "smithy.api#documentation": "A structure that contains details about the metric.
", + "smithy.api#required": {} + } + }, + "desiredChange": { + "target": "com.amazonaws.evidently#ChangeDirectionEnum", + "traits": { + "smithy.api#documentation": "\n INCREASE means that a variation with a higher number for this metric is performing \n better.
\n DECREASE means that a variation with a lower number for this metric is performing \n better.
Use this structure to tell Evidently whether higher or lower values are desired for a metric that is \n used in an experiment.
" + } + }, + "com.amazonaws.evidently#MetricGoalConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#MetricGoalConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } + } + }, + "com.amazonaws.evidently#MetricGoalsList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#MetricGoal" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } + } + }, + "com.amazonaws.evidently#MetricMonitor": { + "type": "structure", + "members": { + "metricDefinition": { + "target": "com.amazonaws.evidently#MetricDefinition", + "traits": { + "smithy.api#documentation": "A structure that defines the metric.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that defines a metric to be used to monitor performance of the variations during a launch.
" + } + }, + "com.amazonaws.evidently#MetricMonitorConfig": { + "type": "structure", + "members": { + "metricDefinition": { + "target": "com.amazonaws.evidently#MetricDefinitionConfig", + "traits": { + "smithy.api#documentation": "A structure that defines the metric.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that defines a metric to be used to monitor performance of the variations during a launch.
" + } + }, + "com.amazonaws.evidently#MetricMonitorConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#MetricMonitorConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.evidently#MetricMonitorList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#MetricMonitor" + }, + "traits": { + "smithy.api#length": { + "max": 3 + } + } + }, + "com.amazonaws.evidently#MetricNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#CwDimensionSafeName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.evidently#MetricUnitLabel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.evidently#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8192 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.evidently#OnlineAbConfig": { + "type": "structure", + "members": { + "controlTreatmentName": { + "target": "com.amazonaws.evidently#TreatmentName", + "traits": { + "smithy.api#documentation": "The name of the variation that is to be the default variation that the other variations are compared to.
" + } + }, + "treatmentWeights": { + "target": "com.amazonaws.evidently#TreatmentToWeightMap", + "traits": { + "smithy.api#documentation": "A set of key-value pairs. The keys are variation names, and the values are the portion\n of experiment traffic to be assigned to that variation. Specify the traffic portion in\n thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment\n traffic to that variation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains the configuration of which variation to use as the \"control\"\n version. The \"control\" version is used for comparison with other variations. This structure\n also specifies how much experiment traffic is allocated to each variation.
" + } + }, + "com.amazonaws.evidently#OnlineAbDefinition": { + "type": "structure", + "members": { + "controlTreatmentName": { + "target": "com.amazonaws.evidently#TreatmentName", + "traits": { + "smithy.api#documentation": "The name of the variation that is the default variation that the other variations are compared to.
" + } + }, + "treatmentWeights": { + "target": "com.amazonaws.evidently#TreatmentToWeightMap", + "traits": { + "smithy.api#documentation": "A set of key-value pairs. The keys are variation names, and the values are the portion\n of experiment traffic to be assigned to that variation. The traffic portion is specified in\n thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment\n traffic to that variation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains the configuration of which variation to use as the \"control\"\n version. The \"control\" version is used for comparison with other variations. This structure\n also specifies how much experiment traffic is allocated to each variation.
" + } + }, + "com.amazonaws.evidently#Project": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.evidently#ProjectArn", + "traits": { + "smithy.api#documentation": "The name or ARN of the project.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.evidently#ProjectName", + "traits": { + "smithy.api#documentation": "The name of the project.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.evidently#ProjectStatus", + "traits": { + "smithy.api#documentation": "The current state of the project.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.evidently#Description", + "traits": { + "smithy.api#documentation": "The user-entered description of the project.
" + } + }, + "createdTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the project is created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the project was most recently updated.
", + "smithy.api#required": {} + } + }, + "featureCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of features currently in the project.
" + } + }, + "launchCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of launches currently in the project. This includes all launches that have been created\n and not deleted, whether they are ongoing or not.
" + } + }, + "activeLaunchCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of ongoing launches currently in the project.
" + } + }, + "experimentCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of experiments currently in the project. This includes all experiments that have been created\n and not deleted, whether they are ongoing or not.
" + } + }, + "activeExperimentCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of ongoing experiments currently in the project.
" + } + }, + "dataDelivery": { + "target": "com.amazonaws.evidently#ProjectDataDelivery", + "traits": { + "smithy.api#documentation": "A structure that contains information about where Evidently is to store\n evaluation events for longer term storage.
" + } + }, + "tags": { + "target": "com.amazonaws.evidently#TagMap", + "traits": { + "smithy.api#documentation": "The list of tag keys and values associated with this project.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure defines a project, which is the logical object in Evidently that can contain features, launches, and \n experiments. Use projects to group similar features together.
" + } + }, + "com.amazonaws.evidently#ProjectArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*" + } + }, + "com.amazonaws.evidently#ProjectDataDelivery": { + "type": "structure", + "members": { + "s3Destination": { + "target": "com.amazonaws.evidently#S3Destination", + "traits": { + "smithy.api#documentation": "If the project stores evaluation events in an Amazon S3 bucket, this structure\n stores the bucket name and bucket prefix.
" + } + }, + "cloudWatchLogs": { + "target": "com.amazonaws.evidently#CloudWatchLogsDestination", + "traits": { + "smithy.api#documentation": "If the project stores evaluation events in CloudWatch Logs, this structure\n stores the log group name.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains information about where Evidently is to store\n evaluation events for longer term storage.
" + } + }, + "com.amazonaws.evidently#ProjectDataDeliveryConfig": { + "type": "structure", + "members": { + "s3Destination": { + "target": "com.amazonaws.evidently#S3DestinationConfig", + "traits": { + "smithy.api#documentation": "If the project stores evaluation events in an Amazon S3 bucket, this structure\n stores the bucket name and bucket prefix.
" + } + }, + "cloudWatchLogs": { + "target": "com.amazonaws.evidently#CloudWatchLogsDestinationConfig", + "traits": { + "smithy.api#documentation": "If the project stores evaluation events in CloudWatch Logs, this structure\n stores the log group name.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains information about where Evidently is to store\n evaluation events for longer term storage.
" + } + }, + "com.amazonaws.evidently#ProjectName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + }, + "smithy.api#pattern": "[-a-zA-Z0-9._]*" + } + }, + "com.amazonaws.evidently#ProjectRef": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*)" + } + }, + "com.amazonaws.evidently#ProjectResource": { + "type": "resource", + "identifiers": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef" + } + }, + "create": { + "target": "com.amazonaws.evidently#CreateProject" + }, + "read": { + "target": "com.amazonaws.evidently#GetProject" + }, + "delete": { + "target": "com.amazonaws.evidently#DeleteProject" + }, + "list": { + "target": "com.amazonaws.evidently#ListProjects" + }, + "operations": [ + { + "target": "com.amazonaws.evidently#BatchEvaluateFeature" + }, + { + "target": "com.amazonaws.evidently#EvaluateFeature" + }, + { + "target": "com.amazonaws.evidently#PutProjectEvents" + }, + { + "target": "com.amazonaws.evidently#UpdateProject" + }, + { + "target": "com.amazonaws.evidently#UpdateProjectDataDelivery" + } + ], + "resources": [ + { + "target": "com.amazonaws.evidently#ExperimentResource" + }, + { + "target": "com.amazonaws.evidently#FeatureResource" + }, + { + "target": "com.amazonaws.evidently#LaunchResource" + } + ], + "traits": { + "aws.api#arn": { + "template": "{project}", + "absolute": false, + "noAccount": false, + "noRegion": false + } + } + }, + "com.amazonaws.evidently#ProjectStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AVAILABLE", + "name": "AVAILABLE" + }, + { + "value": "UPDATING", + "name": "UPDATING" + } + ] + } + }, + "com.amazonaws.evidently#ProjectSummariesList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#ProjectSummary" + } + }, + "com.amazonaws.evidently#ProjectSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.evidently#ProjectArn", + "traits": { + "smithy.api#documentation": "The name or ARN of the project.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.evidently#ProjectName", + "traits": { + "smithy.api#documentation": "The name of the project.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.evidently#ProjectStatus", + "traits": { + "smithy.api#documentation": "The current state of the project.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.evidently#Description", + "traits": { + "smithy.api#documentation": "The description of the project.
" + } + }, + "createdTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the project is created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the project was most recently updated.
", + "smithy.api#required": {} + } + }, + "featureCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of features currently in the project.
" + } + }, + "launchCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of launches currently in the project, including launches that are ongoing, completed, and not started yet.
" + } + }, + "activeLaunchCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of ongoing launches currently in the project.
" + } + }, + "experimentCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of experiments currently in the project.
" + } + }, + "activeExperimentCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of experiments currently in the project.
" + } + }, + "tags": { + "target": "com.amazonaws.evidently#TagMap", + "traits": { + "smithy.api#documentation": "The list of tag keys and values associated with this project.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains configuration information about an Evidently project.
" + } + }, + "com.amazonaws.evidently#PutProjectEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#PutProjectEventsRequest" + }, + "output": { + "target": "com.amazonaws.evidently#PutProjectEventsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ThrottlingException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Sends performance events to Evidently. These events can be used to evaluate a launch or\n an experiment.
", + "smithy.api#endpoint": { + "hostPrefix": "dataplane." + }, + "smithy.api#examples": [ + { + "title": "Post evaluation Event for Project", + "documentation": "", + "input": { + "project": "ExampleProject", + "events": [ + { + "timestamp": 1627580583, + "type": "aws.evidently.evaluation", + "data": "{\"feature\":\"ExampleFeature\",\"entityId\":\"username@email.com\",\"entityAttributes\":{\"browser\":{\"s\":\"Chrome\"}},\"variation\":\"variationA\",\"type\":\"EXPERIMENT_RULE_MATCH\",\"details\":{\"experiment\":\"Jan2020_landing_page_banner\",\"treatment\":\"control\",\"salt\":\"ADJNC1237ASDNU\"}}" + } + ] + }, + "output": { + "failedEventCount": 0, + "eventResults": [ + { + "eventId": "e55c1f5f-309b-440e-b0d8-64506987c20f", + "errorCode": "null", + "errorMessage": "null" + } + ] + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/events/projects/{project}", + "code": 200 + }, + "smithy.api#tags": [ + "dataplane" + ] + } + }, + "com.amazonaws.evidently#PutProjectEventsRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project to write the events to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "events": { + "target": "com.amazonaws.evidently#EventList", + "traits": { + "smithy.api#documentation": "An array of event structures that contain the performance data that is being sent to\n Evidently.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#PutProjectEventsResponse": { + "type": "structure", + "members": { + "failedEventCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of events in the operation that could not be used by Evidently.
" + } + }, + "eventResults": { + "target": "com.amazonaws.evidently#PutProjectEventsResultEntryList", + "traits": { + "smithy.api#documentation": "A structure that contains Evidently's response to the sent events, including an event ID and \n error codes, if any.
" + } + } + } + }, + "com.amazonaws.evidently#PutProjectEventsResultEntry": { + "type": "structure", + "members": { + "eventId": { + "target": "com.amazonaws.evidently#Uuid", + "traits": { + "smithy.api#documentation": "A unique ID assigned to this PutProjectEvents operation.
If the PutProjectEvents operation has an error, the error code is returned\n here.
If the PutProjectEvents operation has an error, the error message is\n returned here.
A structure that contains Evidently's response to the sent events, including an event ID and error codes, if any.
" + } + }, + "com.amazonaws.evidently#PutProjectEventsResultEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#PutProjectEventsResultEntry" + } + }, + "com.amazonaws.evidently#RandomizationSalt": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 127 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.evidently#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the resource that caused the exception.
" + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of the resource that is associated with the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request references a resource that does not exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.evidently#ResultsPeriod": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 300, + "max": 90000 + } + } + }, + "com.amazonaws.evidently#RuleName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.evidently#RuleType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.evidently#S3BucketSafeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9][-a-z0-9]*[a-z0-9]$" + } + }, + "com.amazonaws.evidently#S3Destination": { + "type": "structure", + "members": { + "bucket": { + "target": "com.amazonaws.evidently#S3BucketSafeName", + "traits": { + "smithy.api#documentation": "The name of the bucket in which Evidently stores evaluation events.
" + } + }, + "prefix": { + "target": "com.amazonaws.evidently#S3PrefixSafeName", + "traits": { + "smithy.api#documentation": "The bucket prefix in which Evidently stores evaluation events.
" + } + } + }, + "traits": { + "smithy.api#documentation": "If the project stores evaluation events in an Amazon S3 bucket, this structure\n stores the bucket name and bucket prefix.
" + } + }, + "com.amazonaws.evidently#S3DestinationConfig": { + "type": "structure", + "members": { + "bucket": { + "target": "com.amazonaws.evidently#S3BucketSafeName", + "traits": { + "smithy.api#documentation": "The name of the bucket in which Evidently stores evaluation events.
" + } + }, + "prefix": { + "target": "com.amazonaws.evidently#S3PrefixSafeName", + "traits": { + "smithy.api#documentation": "The bucket prefix in which Evidently stores evaluation events.
" + } + } + }, + "traits": { + "smithy.api#documentation": "If the project stores evaluation events in an Amazon S3 bucket, this structure\n stores the bucket name and bucket prefix.
" + } + }, + "com.amazonaws.evidently#S3PrefixSafeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9!_.*'()/]*$" + } + }, + "com.amazonaws.evidently#ScheduledSplit": { + "type": "structure", + "members": { + "startTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that this step of the launch starts.
", + "smithy.api#required": {} + } + }, + "groupWeights": { + "target": "com.amazonaws.evidently#GroupToWeightMap", + "traits": { + "smithy.api#documentation": "The traffic allocation percentages among the feature variations during one step of a\n launch. This is a set of key-value pairs. The keys are variation names. The values represent\n the percentage of traffic to allocate to that variation during this step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure defines the traffic allocation percentages among the feature\n variations during one step of a launch, and the start time of that step.
" + } + }, + "com.amazonaws.evidently#ScheduledSplitConfig": { + "type": "structure", + "members": { + "startTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that this step of the launch starts.
", + "smithy.api#required": {} + } + }, + "groupWeights": { + "target": "com.amazonaws.evidently#GroupToWeightMap", + "traits": { + "smithy.api#documentation": "The traffic allocation percentages among the feature variations during one step of a\n launch. This is a set of key-value pairs. The keys are variation names. The values represent\n the percentage of traffic to allocate to that variation during this step.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "This structure defines the traffic allocation percentages among the feature\n variations during one step of a launch, and the start time of that step.
" + } + }, + "com.amazonaws.evidently#ScheduledSplitConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#ScheduledSplitConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6 + } + } + }, + "com.amazonaws.evidently#ScheduledSplitsLaunchConfig": { + "type": "structure", + "members": { + "steps": { + "target": "com.amazonaws.evidently#ScheduledSplitConfigList", + "traits": { + "smithy.api#documentation": "An array of structures that define the traffic allocation percentages among the feature\n variations during each step of the launch. This also defines the start time of each\n step.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An array of structures that define the traffic allocation percentages among the feature\n variations during each step of a launch. This also defines the start time of each step.
" + } + }, + "com.amazonaws.evidently#ScheduledSplitsLaunchDefinition": { + "type": "structure", + "members": { + "steps": { + "target": "com.amazonaws.evidently#ScheduledStepList", + "traits": { + "smithy.api#documentation": "An array of structures that define the traffic allocation percentages among the feature\n variations during each step of the launch. This also defines the start time of each\n step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An array of structures that define the traffic allocation percentages among the feature\n variations during each step of a launch. This also defines the start time of each step.
" + } + }, + "com.amazonaws.evidently#ScheduledStepList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#ScheduledSplit" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6 + } + } + }, + "com.amazonaws.evidently#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the resource that caused the exception.
" + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of the resource that is associated with the error.
" + } + }, + "serviceCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the service that is associated with the error.
" + } + }, + "quotaCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the service quota that was exceeded.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request would cause a service quota to be exceeded.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.evidently#ServiceUnavailableException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The service was unavailable. Retry the request.
", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, + "com.amazonaws.evidently#SplitWeight": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100000 + } + } + }, + "com.amazonaws.evidently#StartExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#StartExperimentRequest" + }, + "output": { + "target": "com.amazonaws.evidently#StartExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ConflictException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.evidently#ThrottlingException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Starts an existing experiment. To create an experiment, \n use CreateExperiment.
", + "smithy.api#http": { + "method": "POST", + "uri": "/projects/{project}/experiments/{experiment}/start", + "code": 200 + } + } + }, + "com.amazonaws.evidently#StartExperimentRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that contains the experiment to start.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "experiment": { + "target": "com.amazonaws.evidently#ExperimentName", + "traits": { + "smithy.api#documentation": "The name of the experiment to start.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "analysisCompleteTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time to end the experiment.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#StartExperimentResponse": { + "type": "structure", + "members": { + "startedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the experiment started.
" + } + } + } + }, + "com.amazonaws.evidently#StartLaunch": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#StartLaunchRequest" + }, + "output": { + "target": "com.amazonaws.evidently#StartLaunchResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.evidently#ThrottlingException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Starts an existing launch. To create a launch, \n use CreateLaunch.
", + "smithy.api#http": { + "method": "POST", + "uri": "/projects/{project}/launches/{launch}/start", + "code": 200 + } + } + }, + "com.amazonaws.evidently#StartLaunchRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that contains the launch to start.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "launch": { + "target": "com.amazonaws.evidently#LaunchName", + "traits": { + "smithy.api#documentation": "The name of the launch to start.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#StartLaunchResponse": { + "type": "structure", + "members": { + "launch": { + "target": "com.amazonaws.evidently#Launch", + "traits": { + "smithy.api#documentation": "A structure that contains information about the launch that was started.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#StopExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#StopExperimentRequest" + }, + "output": { + "target": "com.amazonaws.evidently#StopExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ConflictException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.evidently#ThrottlingException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Stops an experiment that is currently running. If you stop an experiment, you can't\n resume it or restart it.
", + "smithy.api#http": { + "method": "POST", + "uri": "/projects/{project}/experiments/{experiment}/cancel", + "code": 200 + } + } + }, + "com.amazonaws.evidently#StopExperimentRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that contains the experiment to stop.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "experiment": { + "target": "com.amazonaws.evidently#ExperimentName", + "traits": { + "smithy.api#documentation": "The name of the experiment to stop.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "desiredState": { + "target": "com.amazonaws.evidently#ExperimentStopDesiredState", + "traits": { + "smithy.api#documentation": "Specify whether the experiment is to be considered COMPLETED or \n CANCELLED after it stops.
A string that describes why you are stopping the experiment.
" + } + } + } + }, + "com.amazonaws.evidently#StopExperimentResponse": { + "type": "structure", + "members": { + "endedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the experiment stopped.
" + } + } + } + }, + "com.amazonaws.evidently#StopLaunch": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#StopLaunchRequest" + }, + "output": { + "target": "com.amazonaws.evidently#StopLaunchResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ThrottlingException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Stops a launch that is currently running. After you stop a launch, you will not be able to resume it or restart it. \n Also, it \n will not be evaluated as a rule for traffic allocation, and the traffic that was allocated to the launch\n will instead be available to the feature's experiment, if there is one. Otherwise, all traffic\n will be served the default variation after the launch is stopped.
", + "smithy.api#http": { + "method": "POST", + "uri": "/projects/{project}/launches/{launch}/cancel", + "code": 200 + } + } + }, + "com.amazonaws.evidently#StopLaunchRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that contains the launch that you want to stop.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "launch": { + "target": "com.amazonaws.evidently#LaunchName", + "traits": { + "smithy.api#documentation": "The name of the launch to stop.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "desiredState": { + "target": "com.amazonaws.evidently#LaunchStopDesiredState", + "traits": { + "smithy.api#documentation": "Specify whether to consider the launch as COMPLETED or\n CANCELLED after it stops.
A string that describes why you are stopping the launch.
" + } + } + } + }, + "com.amazonaws.evidently#StopLaunchResponse": { + "type": "structure", + "members": { + "endedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the launch stopped.
" + } + } + } + }, + "com.amazonaws.evidently#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" + } + }, + "com.amazonaws.evidently#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.evidently#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.evidently#TagKey" + }, + "value": { + "target": "com.amazonaws.evidently#TagValue" + } + }, + "com.amazonaws.evidently#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.evidently#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#ConflictException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the specified CloudWatch Evidently resource. Projects,\n features, launches, and experiments can be tagged.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.
\nTags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
\nYou can use the TagResource action with a resource that already has tags. \n If you specify a new tag key for the resource, \n this tag is appended to the list of tags associated\n with the alarm. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces\n the previous value for that tag.
You can associate as many as 50 tags with a resource.
\nFor more information, see Tagging Amazon Web Services resources.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.evidently#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.evidently#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the CloudWatch Evidently resource that you're adding tags to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.evidently#TagMap", + "traits": { + "smithy.api#documentation": "The list of key-value pairs to associate with the resource.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.evidently#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.evidently#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + }, + "serviceCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the service that is associated with the error.
" + } + }, + "quotaCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the service quota that was exceeded.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request was denied because of request throttling. Retry the request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.evidently#TimestampList": { + "type": "list", + "member": { + "target": "smithy.api#Timestamp" + }, + "traits": { + "smithy.api#length": { + "max": 100800 + } + } + }, + "com.amazonaws.evidently#Treatment": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.evidently#TreatmentName", + "traits": { + "smithy.api#documentation": "The name of this treatment.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.evidently#Description", + "traits": { + "smithy.api#documentation": "The description of the treatment.
" + } + }, + "featureVariations": { + "target": "com.amazonaws.evidently#FeatureToVariationMap", + "traits": { + "smithy.api#documentation": "The feature variation used for this treatment. This is a key-value pair. The key is the\n feature name, and the value is the variation name.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that defines one treatment in an experiment. A treatment is a variation of the feature\n that you are including in the experiment.
" + } + }, + "com.amazonaws.evidently#TreatmentConfig": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.evidently#TreatmentName", + "traits": { + "smithy.api#documentation": "A name for this treatment.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.evidently#Description", + "traits": { + "smithy.api#documentation": "A description for this treatment.
" + } + }, + "feature": { + "target": "com.amazonaws.evidently#FeatureName", + "traits": { + "smithy.api#documentation": "The feature that this experiment is testing.
", + "smithy.api#required": {} + } + }, + "variation": { + "target": "com.amazonaws.evidently#VariationName", + "traits": { + "smithy.api#documentation": "The name of the variation to use as this treatment in the experiment.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that defines one treatment in an experiment. A treatment is a variation of the feature\n that you are including in the experiment.
" + } + }, + "com.amazonaws.evidently#TreatmentConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#TreatmentConfig" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.evidently#TreatmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#Treatment" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 5 + } + } + }, + "com.amazonaws.evidently#TreatmentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + }, + "smithy.api#pattern": "[-a-zA-Z0-9._]*" + } + }, + "com.amazonaws.evidently#TreatmentNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#TreatmentName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.evidently#TreatmentToWeightMap": { + "type": "map", + "key": { + "target": "com.amazonaws.evidently#TreatmentName" + }, + "value": { + "target": "com.amazonaws.evidently#SplitWeight" + } + }, + "com.amazonaws.evidently#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.evidently#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#ConflictException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes one or more tags from the specified resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.evidently#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.evidently#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the CloudWatch Evidently resource that you're removing tags from.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.evidently#TagKeyList", + "traits": { + "smithy.api#documentation": "The list of tag keys to remove from the resource.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.evidently#UpdateExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#UpdateExperimentRequest" + }, + "output": { + "target": "com.amazonaws.evidently#UpdateExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ConflictException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an Evidently experiment.
\nDon't use this operation to update an experiment's tag. Instead, use \n TagResource.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/projects/{project}/experiments/{experiment}", + "code": 200 + } + } + }, + "com.amazonaws.evidently#UpdateExperimentRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that contains the experiment that you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "experiment": { + "target": "com.amazonaws.evidently#ExperimentName", + "traits": { + "smithy.api#documentation": "The name of the experiment to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.evidently#Description", + "traits": { + "smithy.api#documentation": "An optional description of the experiment.
" + } + }, + "treatments": { + "target": "com.amazonaws.evidently#TreatmentConfigList", + "traits": { + "smithy.api#documentation": "An array of structures that define the variations being tested in the experiment.
" + } + }, + "metricGoals": { + "target": "com.amazonaws.evidently#MetricGoalConfigList", + "traits": { + "smithy.api#documentation": "An array of structures that defines the metrics used for the experiment, and whether a higher\n or lower value for each metric is the goal.
" + } + }, + "randomizationSalt": { + "target": "com.amazonaws.evidently#RandomizationSalt", + "traits": { + "smithy.api#documentation": "When Evidently assigns a particular user session to an experiment, it must use a randomization ID\n to determine which variation the user session is served. This randomization ID is a combination of the entity ID\n and randomizationSalt. If you omit randomizationSalt, Evidently uses\n the experiment name as the randomizationSalt.
The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience\n is the total audience minus the audience that you have allocated to overrides or current launches of\n this feature.
\nThis is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the available audience.
" + } + }, + "onlineAbConfig": { + "target": "com.amazonaws.evidently#OnlineAbConfig", + "traits": { + "smithy.api#documentation": "A structure that contains the configuration of which variation o use as the \"control\"\n version. The \"control\" version is used for comparison with other variations. This structure\n also specifies how much experiment traffic is allocated to each variation.
" + } + } + } + }, + "com.amazonaws.evidently#UpdateExperimentResponse": { + "type": "structure", + "members": { + "experiment": { + "target": "com.amazonaws.evidently#Experiment", + "traits": { + "smithy.api#documentation": "A structure containing the configuration details of the experiment\n that was updated.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#UpdateFeature": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#UpdateFeatureRequest" + }, + "output": { + "target": "com.amazonaws.evidently#UpdateFeatureResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ConflictException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing feature.
\nYou can't use this operation to update the tags of an existing feature. Instead, use \n TagResource.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/projects/{project}/features/{feature}", + "code": 200 + } + } + }, + "com.amazonaws.evidently#UpdateFeatureRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that contains the feature to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "feature": { + "target": "com.amazonaws.evidently#FeatureName", + "traits": { + "smithy.api#documentation": "The name of the feature to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "evaluationStrategy": { + "target": "com.amazonaws.evidently#FeatureEvaluationStrategy", + "traits": { + "smithy.api#documentation": "Specify ALL_RULES to activate the traffic allocation specified by any ongoing\n launches or experiments. Specify DEFAULT_VARIATION to serve the default variation\n to all users instead.
An optional description of the feature.
" + } + }, + "addOrUpdateVariations": { + "target": "com.amazonaws.evidently#VariationConfigsList", + "traits": { + "smithy.api#documentation": "To update variation configurations for this feature, or add new ones, specify this structure.\n In this array, include any variations that you want to add or update. If the array includes a variation name that\n already exists for this feature, it is updated. If it includes a new variation name, it is added\n as a new variation.
" + } + }, + "removeVariations": { + "target": "com.amazonaws.evidently#VariationNameList", + "traits": { + "smithy.api#documentation": "Removes a variation from the feature. If the variation you specify doesn't exist, then this \n makes no change and does not report an error.
\nThis operation fails if you try to remove a variation that is part of an \n ongoing launch or experiment.
" + } + }, + "defaultVariation": { + "target": "com.amazonaws.evidently#VariationName", + "traits": { + "smithy.api#documentation": "The name of the variation to use as the default variation. The default\n variation is served to users who are not allocated to any ongoing launches\n or experiments of this feature.
" + } + }, + "entityOverrides": { + "target": "com.amazonaws.evidently#EntityOverrideMap", + "traits": { + "smithy.api#documentation": "Specified users that should always be served a specific variation of a feature. Each user\n is specified by a key-value pair . For each key, specify a user by entering their user ID,\n account ID, or some other identifier. For the value, specify the name of the variation that\n they are to be served.
" + } + } + } + }, + "com.amazonaws.evidently#UpdateFeatureResponse": { + "type": "structure", + "members": { + "feature": { + "target": "com.amazonaws.evidently#Feature", + "traits": { + "smithy.api#documentation": "A structure that contains information about the updated feature.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#UpdateLaunch": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#UpdateLaunchRequest" + }, + "output": { + "target": "com.amazonaws.evidently#UpdateLaunchResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ConflictException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a launch of a given feature.
\nDon't use this operation to update the tags of an existing launch. Instead, use \n TagResource.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/projects/{project}/launches/{launch}", + "code": 200 + } + } + }, + "com.amazonaws.evidently#UpdateLaunchRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project that contains the launch that you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "launch": { + "target": "com.amazonaws.evidently#LaunchName", + "traits": { + "smithy.api#documentation": "The name of the launch that is to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.evidently#Description", + "traits": { + "smithy.api#documentation": "An optional description for the launch.
" + } + }, + "groups": { + "target": "com.amazonaws.evidently#LaunchGroupConfigList", + "traits": { + "smithy.api#documentation": "An array of structures that contains the feature and variations that are to be used for\n the launch.
" + } + }, + "metricMonitors": { + "target": "com.amazonaws.evidently#MetricMonitorConfigList", + "traits": { + "smithy.api#documentation": "An array of structures that define the metrics that will be used to monitor \n the launch performance.
" + } + }, + "randomizationSalt": { + "target": "com.amazonaws.evidently#RandomizationSalt", + "traits": { + "smithy.api#documentation": "When Evidently assigns a particular user session to a launch, it must use a randomization ID\n to determine which variation the user session is served. This randomization ID is a combination of the entity ID\n and randomizationSalt. If you omit randomizationSalt, Evidently uses\n the launch name as the randomizationSalt.
An array of structures that define the traffic allocation percentages among the feature\n variations during each step of the launch.
" + } + } + } + }, + "com.amazonaws.evidently#UpdateLaunchResponse": { + "type": "structure", + "members": { + "launch": { + "target": "com.amazonaws.evidently#Launch", + "traits": { + "smithy.api#documentation": "A structure that contains the new configuration of the launch that was updated.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#UpdateProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#UpdateProjectRequest" + }, + "output": { + "target": "com.amazonaws.evidently#UpdateProjectResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the description of an existing project.
\nTo create a new project, use CreateProject.
\nDon't use this operation to update the data storage options of a project. Instead, use \n UpdateProjectDataDelivery.
\nDon't use this operation to update the tags of a project. Instead, use \n TagResource.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/projects/{project}", + "code": 200 + } + } + }, + "com.amazonaws.evidently#UpdateProjectDataDelivery": { + "type": "operation", + "input": { + "target": "com.amazonaws.evidently#UpdateProjectDataDeliveryRequest" + }, + "output": { + "target": "com.amazonaws.evidently#UpdateProjectDataDeliveryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evidently#AccessDeniedException" + }, + { + "target": "com.amazonaws.evidently#ConflictException" + }, + { + "target": "com.amazonaws.evidently#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evidently#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.evidently#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the data storage options for this project. If you store evaluation events, you an\n keep them and analyze them on your own. If you choose not to store evaluation events,\n Evidently deletes them after using them to produce metrics and other experiment results that\n you can view.
\nYou can't specify both cloudWatchLogs and s3Destination in the same operation.
The name or ARN of the project that you want to modify the data storage options for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "s3Destination": { + "target": "com.amazonaws.evidently#S3DestinationConfig", + "traits": { + "smithy.api#documentation": "A structure containing the S3 bucket name and bucket prefix where you want to store evaluation events.
" + } + }, + "cloudWatchLogs": { + "target": "com.amazonaws.evidently#CloudWatchLogsDestinationConfig", + "traits": { + "smithy.api#documentation": "A structure containing the CloudWatch Logs log group where you want to store evaluation\n events.
" + } + } + } + }, + "com.amazonaws.evidently#UpdateProjectDataDeliveryResponse": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#Project", + "traits": { + "smithy.api#documentation": "A structure containing details about the project that you updated.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#UpdateProjectRequest": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#ProjectRef", + "traits": { + "smithy.api#documentation": "The name or ARN of the project to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.evidently#Description", + "traits": { + "smithy.api#documentation": "An optional description of the project.
" + } + } + } + }, + "com.amazonaws.evidently#UpdateProjectResponse": { + "type": "structure", + "members": { + "project": { + "target": "com.amazonaws.evidently#Project", + "traits": { + "smithy.api#documentation": "A structure containing information about the updated project.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.evidently#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.evidently#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + }, + "reason": { + "target": "com.amazonaws.evidently#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "A reason for the error.
" + } + }, + "fieldList": { + "target": "com.amazonaws.evidently#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "The parameter that caused the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The value of a parameter in the request caused an error.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.evidently#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The error name.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The error message.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A structure containing an error name and message.
" + } + }, + "com.amazonaws.evidently#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#ValidationExceptionField" + } + }, + "com.amazonaws.evidently#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "unknownOperation", + "name": "UNKNOWN_OPERATION" + }, + { + "value": "cannotParse", + "name": "CANNOT_PARSE" + }, + { + "value": "fieldValidationFailed", + "name": "FIELD_VALIDATION_FAILED" + }, + { + "value": "other", + "name": "OTHER" + } + ] + } + }, + "com.amazonaws.evidently#VariableValue": { + "type": "union", + "members": { + "boolValue": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "If this feature uses the Boolean variation type, this field contains the Boolean value of\n this variation.
" + } + }, + "stringValue": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "If this feature uses the string variation type, this field contains the string value of\n this variation.
", + "smithy.api#length": { + "max": 512 + } + } + }, + "longValue": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "If this feature uses the long variation type, this field contains the long value of\n this variation.
", + "smithy.api#range": { + "min": -9007199254740991, + "max": 9007199254740991 + } + } + }, + "doubleValue": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "If this feature uses the double integer variation type, this field contains the double integer value of\n this variation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The value assigned to a feature variation. This structure must contain exactly one\n field. It can be boolValue, doubleValue, longValue, or\n stringValue.
The name of the variation.
" + } + }, + "value": { + "target": "com.amazonaws.evidently#VariableValue", + "traits": { + "smithy.api#documentation": "The value assigned to this variation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains the name and variation value of one variation of a feature.
" + } + }, + "com.amazonaws.evidently#VariationConfig": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.evidently#VariationName", + "traits": { + "smithy.api#documentation": "The name of the variation.
", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.evidently#VariableValue", + "traits": { + "smithy.api#documentation": "The value assigned to this variation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains the name and variation value of one variation of a feature.
" + } + }, + "com.amazonaws.evidently#VariationConfigsList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#VariationConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.evidently#VariationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + }, + "smithy.api#pattern": "[-a-zA-Z0-9._]*" + } + }, + "com.amazonaws.evidently#VariationNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#VariationName" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.evidently#VariationValueType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "STRING", + "name": "STRING" + }, + { + "value": "LONG", + "name": "LONG" + }, + { + "value": "DOUBLE", + "name": "DOUBLE" + }, + { + "value": "BOOLEAN", + "name": "BOOLEAN" + } + ] + } + }, + "com.amazonaws.evidently#VariationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.evidently#Variation" + } + } + } +} diff --git a/aws/sdk/aws-models/finspace-data.json b/aws/sdk/aws-models/finspace-data.json index d792439b76f99e3e80f1315b8e9cd07425b42e68..2f28ffa467dcb61398c722c0a4278dac775d64be 100644 --- a/aws/sdk/aws-models/finspace-data.json +++ b/aws/sdk/aws-models/finspace-data.json @@ -31,18 +31,6 @@ "shapes": { "com.amazonaws.finspacedata#AWSHabaneroPublicAPI": { "type": "service", - "version": "2020-07-13", - "operations": [ - { - "target": "com.amazonaws.finspacedata#CreateChangeset" - }, - { - "target": "com.amazonaws.finspacedata#GetProgrammaticAccessCredentials" - }, - { - "target": "com.amazonaws.finspacedata#GetWorkingLocation" - } - ], "traits": { "aws.api#service": { "sdkId": "finspace data", @@ -55,15 +43,60 @@ "name": "finspace-api" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "The FinSpace APIs let you take actions inside the FinSpace environment.
", + "smithy.api#documentation": "The FinSpace APIs let you take actions inside the FinSpace.
", "smithy.api#title": "FinSpace Public API" - } + }, + "version": "2020-07-13", + "operations": [ + { + "target": "com.amazonaws.finspacedata#CreateChangeset" + }, + { + "target": "com.amazonaws.finspacedata#CreateDataset" + }, + { + "target": "com.amazonaws.finspacedata#CreateDataView" + }, + { + "target": "com.amazonaws.finspacedata#DeleteDataset" + }, + { + "target": "com.amazonaws.finspacedata#GetChangeset" + }, + { + "target": "com.amazonaws.finspacedata#GetDataset" + }, + { + "target": "com.amazonaws.finspacedata#GetDataView" + }, + { + "target": "com.amazonaws.finspacedata#GetProgrammaticAccessCredentials" + }, + { + "target": "com.amazonaws.finspacedata#GetWorkingLocation" + }, + { + "target": "com.amazonaws.finspacedata#ListChangesets" + }, + { + "target": "com.amazonaws.finspacedata#ListDatasets" + }, + { + "target": "com.amazonaws.finspacedata#ListDataViews" + }, + { + "target": "com.amazonaws.finspacedata#UpdateChangeset" + }, + { + "target": "com.amazonaws.finspacedata#UpdateDataset" + } + ] }, "com.amazonaws.finspacedata#AccessDeniedException": { "type": "structure", "members": { "message": { - "target": "com.amazonaws.finspacedata#errorMessage" + "target": "com.amazonaws.finspacedata#ErrorMessage2" } }, "traits": { @@ -72,9 +105,26 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.finspacedata#AliasString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^alias\\/\\S+$" + } + }, + "com.amazonaws.finspacedata#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#documentation": "Common Boolean data type" + } + }, "com.amazonaws.finspacedata#ChangeType": { "type": "string", "traits": { + "smithy.api#documentation": "Indicates how the given change will be applied to the dataset.", "smithy.api#enum": [ { "value": "REPLACE", @@ -91,125 +141,278 @@ ] } }, - "com.amazonaws.finspacedata#ChangesetInfo": { + "com.amazonaws.finspacedata#ChangesetArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "Arn for a given Changeset" + } + }, + "com.amazonaws.finspacedata#ChangesetErrorInfo": { "type": "structure", "members": { - "id": { - "target": "com.amazonaws.finspacedata#IdType", + "errorMessage": { + "target": "com.amazonaws.finspacedata#ErrorMessage", "traits": { - "smithy.api#documentation": "Unique identifier for a changeset.
" + "smithy.api#documentation": "The text of the error message.
" } }, - "changesetArn": { - "target": "com.amazonaws.finspacedata#arn", + "errorCategory": { + "target": "com.amazonaws.finspacedata#ErrorCategory", "traits": { - "smithy.api#documentation": "The ARN identifier of the changeset.
" + "smithy.api#documentation": "The category of the error.
\n\n VALIDATION -The inputs to this request are invalid.
\n SERVICE_QUOTA_EXCEEDED - Service quotas have been exceeded. Please\n contact AWS support to increase quotas.
\n ACCESS_DENIED - Missing required permission to perform this\n request.
\n RESOURCE_NOT_FOUND - One or more inputs to this request were not\n found.
\n THROTTLING - The system temporarily lacks sufficient resources to process\n the request.
\n INTERNAL_SERVICE_EXCEPTION - An internal service error has\n occurred.
\n CANCELLED - Cancelled.
\n USER_RECOVERABLE - A user recoverable error has occurred.
The structure with error messages.
" + } + }, + "com.amazonaws.finspacedata#ChangesetId": { + "type": "string", + "traits": { + "smithy.api#documentation": "ID used to identify a Changeset", + "smithy.api#length": { + "min": 1, + "max": 26 + } + } + }, + "com.amazonaws.finspacedata#ChangesetList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspacedata#ChangesetSummary" + }, + "traits": { + "smithy.api#documentation": "List of Changeset Summaries" + } + }, + "com.amazonaws.finspacedata#ChangesetSummary": { + "type": "structure", + "members": { + "changesetId": { + "target": "com.amazonaws.finspacedata#ChangesetId", "traits": { - "smithy.api#documentation": "The unique identifier for the FinSpace dataset in which the changeset is created.
" + "smithy.api#documentation": "The unique identifier for a Changeset.
" } }, - "changeType": { - "target": "com.amazonaws.finspacedata#ChangeType", + "changesetArn": { + "target": "com.amazonaws.finspacedata#ChangesetArn", "traits": { - "smithy.api#documentation": "Change type indicates how a changeset is applied to a dataset.
\n\n REPLACE - Changeset is considered as a replacement to all prior loaded\n changesets.
\n APPEND - Changeset is considered as an addition to the end of all prior\n loaded changesets.
\n MODIFY - Changeset is considered as a replacement to a specific prior\n ingested changeset.
The ARN identifier of the Changeset.
" } }, - "sourceType": { - "target": "com.amazonaws.finspacedata#SourceType", + "datasetId": { + "target": "com.amazonaws.finspacedata#DatasetId", "traits": { - "smithy.api#documentation": "Type of the data source from which the files to create the changeset are sourced.
\n\n S3 - Amazon S3.
The unique identifier for the FinSpace Dataset in which the Changeset is created.
" } }, - "sourceParams": { - "target": "com.amazonaws.finspacedata#stringMap", + "changeType": { + "target": "com.amazonaws.finspacedata#ChangeType", "traits": { - "smithy.api#documentation": "Source path from which the files to create the changeset are sourced.
" + "smithy.api#documentation": "Type that indicates how a Changeset is applied to a Dataset.
\n\n REPLACE - Changeset is considered as a replacement to all prior loaded\n Changesets.
\n APPEND - Changeset is considered as an addition to the end of all prior\n loaded Changesets.
\n MODIFY - Changeset is considered as a replacement to a specific prior\n ingested Changeset.
Format type of the input files loaded into the changeset.
" + "smithy.api#documentation": "Options that define the location of the data being ingested.
" } }, "formatParams": { - "target": "com.amazonaws.finspacedata#stringMap", + "target": "com.amazonaws.finspacedata#FormatParams", "traits": { - "smithy.api#documentation": "Structure of the source file(s).
" + "smithy.api#documentation": "Options that define the structure of the source file(s).
" } }, - "createTimestamp": { - "target": "com.amazonaws.finspacedata#Timestamp", + "createTime": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { - "smithy.api#documentation": "The timestamp at which the changeset was created in FinSpace.
" + "smithy.api#documentation": "The timestamp at which the Changeset was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" } }, "status": { - "target": "com.amazonaws.finspacedata#ChangesetStatus", + "target": "com.amazonaws.finspacedata#IngestionStatus", "traits": { - "smithy.api#documentation": "The status of changeset creation operation.
" + "smithy.api#documentation": "Status of the Changeset ingestion.
\n\n PENDING - Changeset is pending creation.
\n FAILED - Changeset creation has failed.
\n SUCCESS - Changeset creation has succeeded.
\n RUNNING - Changeset creation is running.
\n STOP_REQUESTED - User requested Changeset creation to stop.
The structure with error messages.
" } }, - "changesetLabels": { - "target": "com.amazonaws.finspacedata#stringMap", + "activeUntilTimestamp": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", "traits": { - "smithy.api#documentation": "Tags associated with the changeset.
" + "smithy.api#box": {}, + "smithy.api#documentation": "Time until which the Changeset is active. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" } }, "updatesChangesetId": { - "target": "com.amazonaws.finspacedata#stringValue", + "target": "com.amazonaws.finspacedata#ChangesetId", "traits": { - "smithy.api#documentation": "Unique identifier of the changeset that is updated.
" + "smithy.api#documentation": "The unique identifier of the Changeset that is updated.
" } }, "updatedByChangesetId": { - "target": "com.amazonaws.finspacedata#stringValue", + "target": "com.amazonaws.finspacedata#ChangesetId", "traits": { - "smithy.api#documentation": "Unique identifier of the changeset that is updated a changeset.
" + "smithy.api#documentation": "The unique identifier of the updated Changeset.
" } } }, "traits": { - "smithy.api#documentation": "A changeset is unit of data in a dataset.
" + "smithy.api#documentation": "A Changeset is unit of data in a Dataset.
" + } + }, + "com.amazonaws.finspacedata#ClientToken": { + "type": "string", + "traits": { + "smithy.api#documentation": "Idempotence Token for API operations", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "\\S" } }, - "com.amazonaws.finspacedata#ChangesetStatus": { + "com.amazonaws.finspacedata#ColumnDataType": { "type": "string", "traits": { + "smithy.api#documentation": "Data type of a column.", "smithy.api#enum": [ { - "value": "PENDING", - "name": "PENDING" + "value": "STRING", + "name": "STRING" }, { - "value": "FAILED", - "name": "FAILED" + "value": "CHAR", + "name": "CHAR" }, { - "value": "SUCCESS", - "name": "SUCCESS" + "value": "INTEGER", + "name": "INTEGER" }, { - "value": "RUNNING", - "name": "RUNNING" + "value": "TINYINT", + "name": "TINYINT" }, { - "value": "STOP_REQUESTED", - "name": "STOP_REQUESTED" + "value": "SMALLINT", + "name": "SMALLINT" + }, + { + "value": "BIGINT", + "name": "BIGINT" + }, + { + "value": "FLOAT", + "name": "FLOAT" + }, + { + "value": "DOUBLE", + "name": "DOUBLE" + }, + { + "value": "DATE", + "name": "DATE" + }, + { + "value": "DATETIME", + "name": "DATETIME" + }, + { + "value": "BOOLEAN", + "name": "BOOLEAN" + }, + { + "value": "BINARY", + "name": "BINARY" } ] } }, + "com.amazonaws.finspacedata#ColumnDefinition": { + "type": "structure", + "members": { + "dataType": { + "target": "com.amazonaws.finspacedata#ColumnDataType", + "traits": { + "smithy.api#documentation": "Data type of a column.
\n\n STRING - A String data type.
\n CHAR - A char data type.
\n INTEGER - An integer data type.
\n TINYINT - A tinyint data type.
\n SMALLINT - A smallint data type.
\n BIGINT - A bigint data type.
\n FLOAT - A float data type.
\n DOUBLE - A double data type.
\n DATE - A date data type.
\n DATETIME - A datetime data type.
\n BOOLEAN - A boolean data type.
\n BINARY - A binary data type.
Name for a column.
" + } + }, + "columnDescription": { + "target": "com.amazonaws.finspacedata#ColumnDescription", + "traits": { + "smithy.api#documentation": "Description for a column.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The definition of a column in a tabular Dataset.
" + } + }, + "com.amazonaws.finspacedata#ColumnDescription": { + "type": "string", + "traits": { + "smithy.api#documentation": "Column Description", + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\s\\S]*\\S[\\s\\S]*$" + } + }, + "com.amazonaws.finspacedata#ColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspacedata#ColumnDefinition" + }, + "traits": { + "smithy.api#documentation": "List of Column Definitions" + } + }, + "com.amazonaws.finspacedata#ColumnName": { + "type": "string", + "traits": { + "smithy.api#documentation": "Column Name", + "smithy.api#length": { + "min": 0, + "max": 126 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.finspacedata#ColumnNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspacedata#ColumnName" + }, + "traits": { + "smithy.api#documentation": "List of Column Names" + } + }, + "com.amazonaws.finspacedata#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.finspacedata#ErrorMessage2" + } + }, + "traits": { + "smithy.api#documentation": "The request conflicts with an existing resource.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, "com.amazonaws.finspacedata#CreateChangeset": { "type": "operation", "input": { @@ -222,9 +425,15 @@ { "target": "com.amazonaws.finspacedata#AccessDeniedException" }, + { + "target": "com.amazonaws.finspacedata#ConflictException" + }, { "target": "com.amazonaws.finspacedata#InternalServerException" }, + { + "target": "com.amazonaws.finspacedata#LimitExceededException" + }, { "target": "com.amazonaws.finspacedata#ResourceNotFoundException" }, @@ -236,10 +445,10 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new changeset in a FinSpace dataset.
", + "smithy.api#documentation": "Creates a new Changeset in a FinSpace Dataset.
", "smithy.api#http": { "method": "POST", - "uri": "/datasets/{datasetId}/changesets", + "uri": "/datasets/{datasetId}/changesetsv2", "code": 200 } } @@ -247,10 +456,17 @@ "com.amazonaws.finspacedata#CreateChangesetRequest": { "type": "structure", "members": { + "clientToken": { + "target": "com.amazonaws.finspacedata#ClientToken", + "traits": { + "smithy.api#documentation": "A token used to ensure idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, "datasetId": { - "target": "com.amazonaws.finspacedata#IdType", + "target": "com.amazonaws.finspacedata#DatasetId", "traits": { - "smithy.api#documentation": "The unique identifier for the FinSpace dataset in which the changeset will be\n created.
", + "smithy.api#documentation": "The unique identifier for the FinSpace Dataset where the Changeset will be created.\n
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -258,243 +474,2057 @@ "changeType": { "target": "com.amazonaws.finspacedata#ChangeType", "traits": { - "smithy.api#documentation": "Option to indicate how a changeset will be applied to a dataset.
\n\n REPLACE - Changeset will be considered as a replacement to all prior\n loaded changesets.
\n APPEND - Changeset will be considered as an addition to the end of all\n prior loaded changesets.
Type of the data source from which the files to create the changeset will be\n sourced.
\n\n S3 - Amazon S3.
Option to indicate how a Changeset will be applied to a Dataset.
\n\n REPLACE - Changeset will be considered as a replacement to all prior\n loaded Changesets.
\n APPEND - Changeset will be considered as an addition to the end of all\n prior loaded Changesets.
\n MODIFY - Changeset is considered as a replacement to a specific prior ingested Changeset.
Source path from which the files to create the changeset will be sourced.
", + "smithy.api#documentation": "Options that define the location of the data being ingested.
", "smithy.api#required": {} } }, - "formatType": { - "target": "com.amazonaws.finspacedata#FormatType", - "traits": { - "smithy.api#documentation": "Format type of the input files being loaded into the changeset.
" - } - }, "formatParams": { - "target": "com.amazonaws.finspacedata#stringMap", + "target": "com.amazonaws.finspacedata#FormatParams", "traits": { - "smithy.api#documentation": "Options that define the structure of the source file(s).
" - } - }, - "tags": { - "target": "com.amazonaws.finspacedata#stringMap", - "traits": { - "smithy.api#documentation": "Metadata tags to apply to this changeset.
" + "smithy.api#documentation": "Options that define the structure of the source file(s) including the format type (formatType), header row (withHeader), data separation character (separator) and the type of compression (compression).\n
\n formatType is a required attribute and can have the following values:\n
\n PARQUET - Parquet source file format.
\n CSV - CSV source file format.
\n JSON - JSON source file format.
\n XML - XML source file format.
\n \n For example, you could specify the following for formatParams:\n \n \n \"formatParams\": \n {\n \"formatType\": \"CSV\",\n \"withHeader\": \"true\",\n \"separator\": \",\",\n \"compression\":\"None\"\n } \n \n
Returns the changeset details.
" + "smithy.api#documentation": "The unique identifier for the FinSpace Dataset where the Changeset is created.
" + } + }, + "changesetId": { + "target": "com.amazonaws.finspacedata#ChangesetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the Changeset that is created.
" } } + }, + "traits": { + "smithy.api#documentation": "The response from a CreateChangeset operation." } }, - "com.amazonaws.finspacedata#Credentials": { + "com.amazonaws.finspacedata#CreateDataView": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#CreateDataViewRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#CreateDataViewResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#ConflictException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#LimitExceededException" + }, + { + "target": "com.amazonaws.finspacedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a Dataview for a Dataset.
", + "smithy.api#http": { + "method": "POST", + "uri": "/datasets/{datasetId}/dataviewsv2", + "code": 200 + } + } + }, + "com.amazonaws.finspacedata#CreateDataViewRequest": { "type": "structure", "members": { - "accessKeyId": { - "target": "com.amazonaws.finspacedata#stringValueLength1to255", + "clientToken": { + "target": "com.amazonaws.finspacedata#ClientToken", "traits": { - "smithy.api#documentation": "The access key identifier.
" + "smithy.api#documentation": "A token used to ensure idempotency.
", + "smithy.api#idempotencyToken": {} } }, - "secretAccessKey": { - "target": "com.amazonaws.finspacedata#stringValueMaxLength1000", + "datasetId": { + "target": "com.amazonaws.finspacedata#DatasetId", "traits": { - "smithy.api#documentation": "The access key.
" + "smithy.api#documentation": "The unique Dataset identifier that is used to create a Dataview.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "sessionToken": { - "target": "com.amazonaws.finspacedata#stringValueMaxLength1000", + "autoUpdate": { + "target": "com.amazonaws.finspacedata#Boolean", "traits": { - "smithy.api#documentation": "The session token.
" + "smithy.api#documentation": "Flag to indicate Dataview should be updated automatically.
" } - } - }, - "traits": { - "smithy.api#documentation": "Set short term API credentials.
" - } - }, - "com.amazonaws.finspacedata#ErrorCategory": { - "type": "string", - "traits": { - "smithy.api#enum": [ + }, + "sortColumns": { + "target": "com.amazonaws.finspacedata#SortColumnList", + "traits": { + "smithy.api#documentation": "Columns to be used for sorting the data.
" + } + }, + "partitionColumns": { + "target": "com.amazonaws.finspacedata#PartitionColumnList", + "traits": { + "smithy.api#documentation": "Ordered set of column names used to partition data.
" + } + }, + "asOfTimestamp": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "Beginning time to use for the Dataview. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "destinationTypeParams": { + "target": "com.amazonaws.finspacedata#DataViewDestinationTypeParams", + "traits": { + "smithy.api#documentation": "Options that define the destination type for the Dataview.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request for creating a data view." + } + }, + "com.amazonaws.finspacedata#CreateDataViewResponse": { + "type": "structure", + "members": { + "datasetId": { + "target": "com.amazonaws.finspacedata#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the Dataset used for the Dataview.
" + } + }, + "dataViewId": { + "target": "com.amazonaws.finspacedata#DataViewId", + "traits": { + "smithy.api#documentation": "The unique identifier for the created Dataview.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Response for creating a data view." + } + }, + "com.amazonaws.finspacedata#CreateDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#CreateDatasetRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#CreateDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspacedata#ConflictException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#LimitExceededException" + }, + { + "target": "com.amazonaws.finspacedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new FinSpace Dataset.
", + "smithy.api#http": { + "method": "POST", + "uri": "/datasetsv2", + "code": 200 + } + } + }, + "com.amazonaws.finspacedata#CreateDatasetRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.finspacedata#ClientToken", + "traits": { + "smithy.api#documentation": "A token used to ensure idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "datasetTitle": { + "target": "com.amazonaws.finspacedata#DatasetTitle", + "traits": { + "smithy.api#documentation": "Display title for a FinSpace Dataset.
", + "smithy.api#required": {} + } + }, + "kind": { + "target": "com.amazonaws.finspacedata#DatasetKind", + "traits": { + "smithy.api#documentation": "The format in which Dataset data is structured.
\n\n TABULAR - Data is structured in a tabular format.
\n NON_TABULAR - Data is structured in a non-tabular format.
Description of a Dataset.
", + "smithy.api#required": {} + } + }, + "ownerInfo": { + "target": "com.amazonaws.finspacedata#DatasetOwnerInfo", + "traits": { + "smithy.api#documentation": "Contact information for a Dataset owner.
" + } + }, + "permissionGroupParams": { + "target": "com.amazonaws.finspacedata#PermissionGroupParams", + "traits": { + "smithy.api#documentation": "Permission group parameters for Dataset permissions.
", + "smithy.api#required": {} + } + }, + "alias": { + "target": "com.amazonaws.finspacedata#AliasString", + "traits": { + "smithy.api#documentation": "The unique resource identifier for a Dataset.
", + "smithy.api#required": {} + } + }, + "schemaDefinition": { + "target": "com.amazonaws.finspacedata#SchemaUnion", + "traits": { + "smithy.api#documentation": "Definition for a schema on a tabular Dataset.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request for a CreateDataset operation" + } + }, + "com.amazonaws.finspacedata#CreateDatasetResponse": { + "type": "structure", + "members": { + "datasetId": { + "target": "com.amazonaws.finspacedata#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier for the created Dataset.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The response from a CreateDataset operation" + } + }, + "com.amazonaws.finspacedata#Credentials": { + "type": "structure", + "members": { + "accessKeyId": { + "target": "com.amazonaws.finspacedata#StringValueLength1to2552", + "traits": { + "smithy.api#documentation": "The access key identifier.
" + } + }, + "secretAccessKey": { + "target": "com.amazonaws.finspacedata#stringValueMaxLength1000", + "traits": { + "smithy.api#documentation": "The access key.
" + } + }, + "sessionToken": { + "target": "com.amazonaws.finspacedata#stringValueMaxLength1000", + "traits": { + "smithy.api#documentation": "The session token.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Short term API credentials.
" + } + }, + "com.amazonaws.finspacedata#DataViewArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "Arn of a DataView" + } + }, + "com.amazonaws.finspacedata#DataViewDestinationType": { + "type": "string", + "traits": { + "smithy.api#documentation": "DataView Destination Type" + } + }, + "com.amazonaws.finspacedata#DataViewDestinationTypeParams": { + "type": "structure", + "members": { + "destinationType": { + "target": "com.amazonaws.finspacedata#DataViewDestinationType", + "traits": { + "smithy.api#documentation": "Destination type for a Dataview.
\n\n GLUE_TABLE - Glue table destination type.
Structure for the Dataview destination type parameters.
" + } + }, + "com.amazonaws.finspacedata#DataViewErrorInfo": { + "type": "structure", + "members": { + "errorMessage": { + "target": "com.amazonaws.finspacedata#ErrorMessage", + "traits": { + "smithy.api#documentation": "The text of the error message.
" + } + }, + "errorCategory": { + "target": "com.amazonaws.finspacedata#ErrorCategory", + "traits": { + "smithy.api#documentation": "The category of the error.
\n\n VALIDATION -The inputs to this request are invalid.
\n SERVICE_QUOTA_EXCEEDED - Service quotas have been exceeded. Please\n contact AWS support to increase quotas.
\n ACCESS_DENIED - Missing required permission to perform this\n request.
\n RESOURCE_NOT_FOUND - One or more inputs to this request were not\n found.
\n THROTTLING - The system temporarily lacks sufficient resources to process\n the request.
\n INTERNAL_SERVICE_EXCEPTION - An internal service error has\n occurred.
\n CANCELLED - Cancelled.
\n USER_RECOVERABLE - A user recoverable error has occurred.
The structure with error messages.
" + } + }, + "com.amazonaws.finspacedata#DataViewId": { + "type": "string", + "traits": { + "smithy.api#documentation": "DataView ID", + "smithy.api#length": { + "min": 1, + "max": 26 + } + } + }, + "com.amazonaws.finspacedata#DataViewList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspacedata#DataViewSummary" + }, + "traits": { + "smithy.api#documentation": "List of Data Views" + } + }, + "com.amazonaws.finspacedata#DataViewStatus": { + "type": "string", + "traits": { + "smithy.api#documentation": "Status of a DataView", + "smithy.api#enum": [ { - "value": "The_inputs_to_this_request_are_invalid", - "name": "VALIDATION" + "value": "RUNNING", + "name": "RUNNING" }, { - "value": "Service_limits_have_been_exceeded", - "name": "SERVICE_QUOTA_EXCEEDED" + "value": "STARTING", + "name": "STARTING" }, { - "value": "Missing_required_permission_to_perform_this_request", - "name": "ACCESS_DENIED" + "value": "FAILED", + "name": "FAILED" }, { - "value": "One_or_more_inputs_to_this_request_were_not_found", - "name": "RESOURCE_NOT_FOUND" + "value": "CANCELLED", + "name": "CANCELLED" }, { - "value": "The_system_temporarily_lacks_sufficient_resources_to_process_the_request", - "name": "THROTTLING" + "value": "TIMEOUT", + "name": "TIMEOUT" }, { - "value": "An_internal_error_has_occurred", - "name": "INTERNAL_SERVICE_EXCEPTION" + "value": "SUCCESS", + "name": "SUCCESS" }, { - "value": "Cancelled", - "name": "CANCELLED" + "value": "PENDING", + "name": "PENDING" }, { - "value": "A_user_recoverable_error_has_occurred", - "name": "USER_RECOVERABLE" + "value": "FAILED_CLEANUP_FAILED", + "name": "FAILED_CLEANUP_FAILED" } ] } }, - "com.amazonaws.finspacedata#ErrorInfo": { + "com.amazonaws.finspacedata#DataViewSummary": { "type": "structure", "members": { - "errorMessage": { - "target": "com.amazonaws.finspacedata#stringValueMaxLength1000", + "dataViewId": { + "target": "com.amazonaws.finspacedata#DataViewId", "traits": { - "smithy.api#documentation": "The text of the error message.
" + "smithy.api#documentation": "The unique identifier for the Dataview.
" } }, - "errorCategory": { - "target": "com.amazonaws.finspacedata#ErrorCategory", + "dataViewArn": { + "target": "com.amazonaws.finspacedata#DataViewArn", + "traits": { + "smithy.api#documentation": "The ARN identifier of the Dataview.
" + } + }, + "datasetId": { + "target": "com.amazonaws.finspacedata#DatasetId", + "traits": { + "smithy.api#documentation": "Th unique identifier for the Dataview Dataset.
" + } + }, + "asOfTimestamp": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "Time range to use for the Dataview. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "partitionColumns": { + "target": "com.amazonaws.finspacedata#PartitionColumnList", + "traits": { + "smithy.api#documentation": "Ordered set of column names used to partition data.
" + } + }, + "sortColumns": { + "target": "com.amazonaws.finspacedata#SortColumnList", + "traits": { + "smithy.api#documentation": "Columns to be used for sorting the data.
" + } + }, + "status": { + "target": "com.amazonaws.finspacedata#DataViewStatus", + "traits": { + "smithy.api#documentation": "The status of a Dataview creation.
\n\n RUNNING - Dataview creation is running.
\n STARTING - Dataview creation is starting.
\n FAILED - Dataview creation has failed.
\n CANCELLED - Dataview creation has been cancelled.
\n TIMEOUT - Dataview creation has timed out.
\n SUCCESS - Dataview creation has succeeded.
\n PENDING - Dataview creation is pending.
\n FAILED_CLEANUP_FAILED - Dataview creation failed and resource cleanup failed.
The structure with error messages.
" + } + }, + "destinationTypeProperties": { + "target": "com.amazonaws.finspacedata#DataViewDestinationTypeParams", + "traits": { + "smithy.api#documentation": "Information about the Dataview destination.
" + } + }, + "autoUpdate": { + "target": "com.amazonaws.finspacedata#Boolean", + "traits": { + "smithy.api#documentation": "The flag to indicate Dataview should be updated automatically.
" + } + }, + "createTime": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#documentation": "The timestamp at which the Dataview was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#documentation": "The last time that a Dataview was modified. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Structure for the summary of a Dataview.
" + } + }, + "com.amazonaws.finspacedata#Dataset": { + "type": "structure", + "members": { + "datasetId": { + "target": "com.amazonaws.finspacedata#DatasetId", + "traits": { + "smithy.api#documentation": "An identifier for a Dataset.
" + } + }, + "datasetArn": { + "target": "com.amazonaws.finspacedata#DatasetArn", + "traits": { + "smithy.api#documentation": "The ARN identifier of the Dataset.
" + } + }, + "datasetTitle": { + "target": "com.amazonaws.finspacedata#DatasetTitle", + "traits": { + "smithy.api#documentation": "Display title for a Dataset.
" + } + }, + "kind": { + "target": "com.amazonaws.finspacedata#DatasetKind", + "traits": { + "smithy.api#documentation": "The format in which Dataset data is structured.
\n\n TABULAR - Data is structured in a tabular format.
\n NON_TABULAR - Data is structured in a non-tabular format.
Description for a Dataset.
" + } + }, + "ownerInfo": { + "target": "com.amazonaws.finspacedata#DatasetOwnerInfo", + "traits": { + "smithy.api#documentation": "Contact information for a Dataset owner.
" + } + }, + "createTime": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#documentation": "The timestamp at which the Dataset was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#documentation": "The last time that the Dataset was modified. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "schemaDefinition": { + "target": "com.amazonaws.finspacedata#SchemaUnion", + "traits": { + "smithy.api#documentation": "Definition for a schema on a tabular Dataset.
" + } + }, + "alias": { + "target": "com.amazonaws.finspacedata#AliasString", + "traits": { + "smithy.api#documentation": "The unique resource identifier for a Dataset.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The structure for a Dataset.
" + } + }, + "com.amazonaws.finspacedata#DatasetArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "Arn of a Dataset" + } + }, + "com.amazonaws.finspacedata#DatasetDescription": { + "type": "string", + "traits": { + "smithy.api#documentation": "Description of a dataset", + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\s\\S]*\\S[\\s\\S]*$" + } + }, + "com.amazonaws.finspacedata#DatasetId": { + "type": "string", + "traits": { + "smithy.api#documentation": "ID for a given Dataset", + "smithy.api#length": { + "min": 1, + "max": 26 + } + } + }, + "com.amazonaws.finspacedata#DatasetKind": { + "type": "string", + "traits": { + "smithy.api#documentation": "Dataset Kind", + "smithy.api#enum": [ + { + "value": "TABULAR", + "name": "TABULAR" + }, + { + "value": "NON_TABULAR", + "name": "NON_TABULAR" + } + ] + } + }, + "com.amazonaws.finspacedata#DatasetList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspacedata#Dataset" + }, + "traits": { + "smithy.api#documentation": "List of Dataset structures" + } + }, + "com.amazonaws.finspacedata#DatasetOwnerInfo": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.finspacedata#OwnerName", + "traits": { + "smithy.api#documentation": "Name of the Dataset owner.
" + } + }, + "phoneNumber": { + "target": "com.amazonaws.finspacedata#PhoneNumber", + "traits": { + "smithy.api#documentation": "Phone number for the Dataset owner.
" + } + }, + "email": { + "target": "com.amazonaws.finspacedata#Email", + "traits": { + "smithy.api#documentation": "Email address for the Dataset owner.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure for Dataset owner info.
" + } + }, + "com.amazonaws.finspacedata#DatasetStatus": { + "type": "string", + "traits": { + "smithy.api#documentation": "Status of the dataset process returned from scheduler service.", + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "SUCCESS", + "name": "SUCCESS" + }, + { + "value": "RUNNING", + "name": "RUNNING" + } + ] + } + }, + "com.amazonaws.finspacedata#DatasetTitle": { + "type": "string", + "traits": { + "smithy.api#documentation": "Title for a given Dataset", + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.finspacedata#DeleteDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#DeleteDatasetRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#DeleteDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspacedata#ConflictException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#LimitExceededException" + }, + { + "target": "com.amazonaws.finspacedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a FinSpace Dataset.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/datasetsv2/{datasetId}", + "code": 200 + } + } + }, + "com.amazonaws.finspacedata#DeleteDatasetRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.finspacedata#ClientToken", + "traits": { + "smithy.api#documentation": "A token used to ensure idempotency.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + }, + "datasetId": { + "target": "com.amazonaws.finspacedata#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the Dataset to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request for a DeleteDataset operation." + } + }, + "com.amazonaws.finspacedata#DeleteDatasetResponse": { + "type": "structure", + "members": { + "datasetId": { + "target": "com.amazonaws.finspacedata#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier for the deleted Dataset.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The response from an DeleteDataset operation" + } + }, + "com.amazonaws.finspacedata#Email": { + "type": "string", + "traits": { + "smithy.api#documentation": "Email of Dataset Owner", + "smithy.api#length": { + "min": 4, + "max": 320 + }, + "smithy.api#pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,4}$" + } + }, + "com.amazonaws.finspacedata#ErrorCategory": { + "type": "string", + "traits": { + "smithy.api#documentation": "Changeset Error Category", + "smithy.api#enum": [ + { + "value": "VALIDATION", + "name": "VALIDATION" + }, + { + "value": "SERVICE_QUOTA_EXCEEDED", + "name": "SERVICE_QUOTA_EXCEEDED" + }, + { + "value": "ACCESS_DENIED", + "name": "ACCESS_DENIED" + }, + { + "value": "RESOURCE_NOT_FOUND", + "name": "RESOURCE_NOT_FOUND" + }, + { + "value": "THROTTLING", + "name": "THROTTLING" + }, + { + "value": "INTERNAL_SERVICE_EXCEPTION", + "name": "INTERNAL_SERVICE_EXCEPTION" + }, + { + "value": "CANCELLED", + "name": "CANCELLED" + }, + { + "value": "USER_RECOVERABLE", + "name": "USER_RECOVERABLE" + } + ] + } + }, + "com.amazonaws.finspacedata#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#documentation": "Changeset Error Message", + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.finspacedata#ErrorMessage2": { + "type": "string" + }, + "com.amazonaws.finspacedata#FormatParams": { + "type": "map", + "key": { + "target": "com.amazonaws.finspacedata#StringMapKey" + }, + "value": { + "target": "com.amazonaws.finspacedata#StringMapValue" + }, + "traits": { + "smithy.api#documentation": "Format Parameters of a Changeset" + } + }, + "com.amazonaws.finspacedata#GetChangeset": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#GetChangesetRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#GetChangesetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspacedata#ConflictException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get information about a Changeset.
", + "smithy.api#http": { + "method": "GET", + "uri": "/datasets/{datasetId}/changesetsv2/{changesetId}", + "code": 200 + } + } + }, + "com.amazonaws.finspacedata#GetChangesetRequest": { + "type": "structure", + "members": { + "datasetId": { + "target": "com.amazonaws.finspacedata#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier for the FinSpace Dataset where the Changeset is created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "changesetId": { + "target": "com.amazonaws.finspacedata#ChangesetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the Changeset for which to get data.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request to describe a changeset." + } + }, + "com.amazonaws.finspacedata#GetChangesetResponse": { + "type": "structure", + "members": { + "changesetId": { + "target": "com.amazonaws.finspacedata#ChangesetId", + "traits": { + "smithy.api#documentation": "The unique identifier for a Changeset.
" + } + }, + "changesetArn": { + "target": "com.amazonaws.finspacedata#ChangesetArn", + "traits": { + "smithy.api#documentation": "The ARN identifier of the Changeset.
" + } + }, + "datasetId": { + "target": "com.amazonaws.finspacedata#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier for the FinSpace Dataset where the Changeset is created.
" + } + }, + "changeType": { + "target": "com.amazonaws.finspacedata#ChangeType", + "traits": { + "smithy.api#documentation": "Type that indicates how a Changeset is applied to a Dataset.
\n\n REPLACE - Changeset is considered as a replacement to all prior loaded Changesets.
\n APPEND - Changeset is considered as an addition to the end of all prior loaded Changesets.
\n MODIFY - Changeset is considered as a replacement to a specific prior ingested Changeset.
Options that define the location of the data being ingested.
" + } + }, + "formatParams": { + "target": "com.amazonaws.finspacedata#FormatParams", + "traits": { + "smithy.api#documentation": "Structure of the source file(s).
" + } + }, + "createTime": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#documentation": "The timestamp at which the Changeset was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "status": { + "target": "com.amazonaws.finspacedata#IngestionStatus", + "traits": { + "smithy.api#documentation": "The status of Changeset creation operation.
" + } + }, + "errorInfo": { + "target": "com.amazonaws.finspacedata#ChangesetErrorInfo", + "traits": { + "smithy.api#documentation": "The structure with error messages.
" + } + }, + "activeUntilTimestamp": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "Time until which the Changeset is active. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "updatesChangesetId": { + "target": "com.amazonaws.finspacedata#ChangesetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the Changeset that is being updated.
" + } + }, + "updatedByChangesetId": { + "target": "com.amazonaws.finspacedata#ChangesetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the updated Changeset.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The response from a describe changeset operation" + } + }, + "com.amazonaws.finspacedata#GetDataView": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#GetDataViewRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#GetDataViewResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#ConflictException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a Dataview.
", + "smithy.api#http": { + "method": "GET", + "uri": "/datasets/{datasetId}/dataviewsv2/{dataViewId}", + "code": 200 + } + } + }, + "com.amazonaws.finspacedata#GetDataViewRequest": { + "type": "structure", + "members": { + "dataViewId": { + "target": "com.amazonaws.finspacedata#DataViewId", + "traits": { + "smithy.api#documentation": "The unique identifier for the Dataview.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "datasetId": { + "target": "com.amazonaws.finspacedata#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier for the Dataset used in the Dataview.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request for retrieving a data view detail. Grouped / accessible within a dataset by its dataset id." + } + }, + "com.amazonaws.finspacedata#GetDataViewResponse": { + "type": "structure", + "members": { + "autoUpdate": { + "target": "com.amazonaws.finspacedata#Boolean", + "traits": { + "smithy.api#documentation": "Flag to indicate Dataview should be updated automatically.
" + } + }, + "partitionColumns": { + "target": "com.amazonaws.finspacedata#PartitionColumnList", + "traits": { + "smithy.api#documentation": "Ordered set of column names used to partition data.
" + } + }, + "datasetId": { + "target": "com.amazonaws.finspacedata#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier for the Dataset used in the Dataview.
" + } + }, + "asOfTimestamp": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "Time range to use for the Dataview. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "errorInfo": { + "target": "com.amazonaws.finspacedata#DataViewErrorInfo", + "traits": { + "smithy.api#documentation": "Information about an error that occurred for the Dataview.
" + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#documentation": "The last time that a Dataview was modified. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "createTime": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#documentation": "The timestamp at which the Dataview was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "sortColumns": { + "target": "com.amazonaws.finspacedata#SortColumnList", + "traits": { + "smithy.api#documentation": "Columns to be used for sorting the data.
" + } + }, + "dataViewId": { + "target": "com.amazonaws.finspacedata#DataViewId", + "traits": { + "smithy.api#documentation": "The unique identifier for the Dataview.
" + } + }, + "dataViewArn": { + "target": "com.amazonaws.finspacedata#DataViewArn", + "traits": { + "smithy.api#documentation": "The ARN identifier of the Dataview.
" + } + }, + "destinationTypeParams": { + "target": "com.amazonaws.finspacedata#DataViewDestinationTypeParams", + "traits": { + "smithy.api#documentation": "Options that define the destination type for the Dataview.
" + } + }, + "status": { + "target": "com.amazonaws.finspacedata#DataViewStatus", + "traits": { + "smithy.api#documentation": "The status of a Dataview creation.
\n\n RUNNING - Dataview creation is running.
\n STARTING - Dataview creation is starting.
\n FAILED - Dataview creation has failed.
\n CANCELLED - Dataview creation has been cancelled.
\n TIMEOUT - Dataview creation has timed out.
\n SUCCESS - Dataview creation has succeeded.
\n PENDING - Dataview creation is pending.
\n FAILED_CLEANUP_FAILED - Dataview creation failed and resource cleanup failed.
Returns information about a Dataset.
", + "smithy.api#http": { + "method": "GET", + "uri": "/datasetsv2/{datasetId}", + "code": 200 + } + } + }, + "com.amazonaws.finspacedata#GetDatasetRequest": { + "type": "structure", + "members": { + "datasetId": { + "target": "com.amazonaws.finspacedata#StringValueLength1to255", + "traits": { + "smithy.api#documentation": "The unique identifier for a Dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request for the GetDataset operation." + } + }, + "com.amazonaws.finspacedata#GetDatasetResponse": { + "type": "structure", + "members": { + "datasetId": { + "target": "com.amazonaws.finspacedata#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier for a Dataset.
" + } + }, + "datasetArn": { + "target": "com.amazonaws.finspacedata#DatasetArn", + "traits": { + "smithy.api#documentation": "The ARN identifier of the Dataset.
" + } + }, + "datasetTitle": { + "target": "com.amazonaws.finspacedata#DatasetTitle", + "traits": { + "smithy.api#documentation": "Display title for a Dataset.
" + } + }, + "kind": { + "target": "com.amazonaws.finspacedata#DatasetKind", + "traits": { + "smithy.api#documentation": "The format in which Dataset data is structured.
\n\n TABULAR - Data is structured in a tabular format.
\n NON_TABULAR - Data is structured in a non-tabular format.
A description of the Dataset.
" + } + }, + "createTime": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#documentation": "The timestamp at which the Dataset was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#documentation": "The last time that the Dataset was modified. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "schemaDefinition": { + "target": "com.amazonaws.finspacedata#SchemaUnion", + "traits": { + "smithy.api#documentation": "Definition for a schema on a tabular Dataset.
" + } + }, + "alias": { + "target": "com.amazonaws.finspacedata#AliasString", + "traits": { + "smithy.api#documentation": "The unique resource identifier for a Dataset.
" + } + }, + "status": { + "target": "com.amazonaws.finspacedata#DatasetStatus", + "traits": { + "smithy.api#documentation": "Status of the Dataset creation.
\n\n PENDING - Dataset is pending creation.
\n FAILED - Dataset creation has failed.
\n SUCCESS - Dataset creation has succeeded.
\n RUNNING - Dataset creation is running.
Request programmatic credentials to use with FinSpace SDK.
", + "smithy.api#http": { + "method": "GET", + "uri": "/credentials/programmatic", + "code": 200 + } + } + }, + "com.amazonaws.finspacedata#GetProgrammaticAccessCredentialsRequest": { + "type": "structure", + "members": { + "durationInMinutes": { + "target": "com.amazonaws.finspacedata#SessionDuration", + "traits": { + "smithy.api#documentation": "The time duration in which the credentials remain valid.
", + "smithy.api#httpQuery": "durationInMinutes" + } + }, + "environmentId": { + "target": "com.amazonaws.finspacedata#IdType", + "traits": { + "smithy.api#documentation": "The FinSpace environment identifier.
", + "smithy.api#httpQuery": "environmentId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request for GetProgrammaticAccessCredentials operation" + } + }, + "com.amazonaws.finspacedata#GetProgrammaticAccessCredentialsResponse": { + "type": "structure", + "members": { + "credentials": { + "target": "com.amazonaws.finspacedata#Credentials", + "traits": { + "smithy.api#documentation": "Returns the programmatic credentials.
" + } + }, + "durationInMinutes": { + "target": "com.amazonaws.finspacedata#SessionDuration", + "traits": { + "smithy.api#documentation": "Returns the duration in which the credentials will remain valid.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Response for GetProgrammaticAccessCredentials operation" + } + }, + "com.amazonaws.finspacedata#GetWorkingLocation": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#GetWorkingLocationRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#GetWorkingLocationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "A temporary Amazon S3 location, where you can copy your files from a source location to stage or use\n as a scratch space in FinSpace notebook.
", + "smithy.api#http": { + "method": "POST", + "uri": "/workingLocationV1", + "code": 200 + } + } + }, + "com.amazonaws.finspacedata#GetWorkingLocationRequest": { + "type": "structure", + "members": { + "locationType": { + "target": "com.amazonaws.finspacedata#locationType", + "traits": { + "smithy.api#documentation": "Specify the type of the working location.
\n\n SAGEMAKER - Use the Amazon S3 location as a temporary location to store data content when\n working with FinSpace Notebooks that run on SageMaker studio.
\n INGESTION - Use the Amazon S3 location as a staging location to copy your\n data content and then use the location with the Changeset creation operation.
Returns the Amazon S3 URI for the working location.
" + } + }, + "s3Path": { + "target": "com.amazonaws.finspacedata#stringValueLength1to1024", + "traits": { + "smithy.api#documentation": "Returns the Amazon S3 Path for the working location.
" + } + }, + "s3Bucket": { + "target": "com.amazonaws.finspacedata#stringValueLength1to63", + "traits": { + "smithy.api#documentation": "Returns the Amazon S3 bucket name for the working location.
" + } + } + } + }, + "com.amazonaws.finspacedata#IdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 26 + } + } + }, + "com.amazonaws.finspacedata#IngestionStatus": { + "type": "string", + "traits": { + "smithy.api#documentation": "Status of the ingestion process returned from scheduler service.", + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "SUCCESS", + "name": "SUCCESS" + }, + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "STOP_REQUESTED", + "name": "STOP_REQUESTED" + } + ] + } + }, + "com.amazonaws.finspacedata#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.finspacedata#ErrorMessage2" + } + }, + "traits": { + "smithy.api#documentation": "The request processing has failed because of an unknown error, exception or\n failure.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.finspacedata#LimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.finspacedata#ErrorMessage2" + } + }, + "traits": { + "smithy.api#documentation": "A limit has exceeded.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.finspacedata#ListChangesets": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#ListChangesetsRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#ListChangesetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspacedata#ConflictException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the FinSpace Changesets for a Dataset.
", + "smithy.api#http": { + "method": "GET", + "uri": "/datasets/{datasetId}/changesetsv2", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.finspacedata#ListChangesetsRequest": { + "type": "structure", + "members": { + "datasetId": { + "target": "com.amazonaws.finspacedata#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier for the FinSpace Dataset to which the Changeset belongs.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.finspacedata#ResultLimit", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The maximum number of results per page.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.finspacedata#PaginationToken", + "traits": { + "smithy.api#documentation": "A token indicating where a results page should begin.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#documentation": "Request to ListChangesetsRequest. It exposes minimal query filters." + } + }, + "com.amazonaws.finspacedata#ListChangesetsResponse": { + "type": "structure", + "members": { + "changesets": { + "target": "com.amazonaws.finspacedata#ChangesetList", + "traits": { + "smithy.api#documentation": "List of Changesets found.
" + } + }, + "nextToken": { + "target": "com.amazonaws.finspacedata#PaginationToken", + "traits": { + "smithy.api#documentation": "A token indicating where a results page should begin.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Response to ListChangesetsResponse. This returns a list of dataset changesets that match the query criteria." + } + }, + "com.amazonaws.finspacedata#ListDataViews": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#ListDataViewsRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#ListDataViewsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#ConflictException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all available Dataviews for a Dataset.
", + "smithy.api#http": { + "method": "GET", + "uri": "/datasets/{datasetId}/dataviewsv2", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.finspacedata#ListDataViewsRequest": { + "type": "structure", + "members": { + "datasetId": { + "target": "com.amazonaws.finspacedata#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier of the Dataset for which to retrieve Dataviews.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.finspacedata#PaginationToken", + "traits": { + "smithy.api#documentation": "A token indicating where a results page should begin.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.finspacedata#ResultLimit", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The maximum number of results per page.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#documentation": "Request for a list data views." + } + }, + "com.amazonaws.finspacedata#ListDataViewsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.finspacedata#PaginationToken", + "traits": { + "smithy.api#documentation": "A token indicating where a results page should begin.
" + } + }, + "dataViews": { + "target": "com.amazonaws.finspacedata#DataViewList", + "traits": { + "smithy.api#documentation": "A list of Dataviews.
" + } + } + } + }, + "com.amazonaws.finspacedata#ListDatasets": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#ListDatasetsRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#ListDatasetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#ConflictException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all of the active Datasets that a user has access to.
", + "smithy.api#http": { + "method": "GET", + "uri": "/datasetsv2", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.finspacedata#ListDatasetsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.finspacedata#PaginationToken", + "traits": { + "smithy.api#documentation": "A token indicating where a results page should begin.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.finspacedata#ResultLimit", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The maximum number of results per page.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#documentation": "Request for the ListDatasets operation." + } + }, + "com.amazonaws.finspacedata#ListDatasetsResponse": { + "type": "structure", + "members": { + "datasets": { + "target": "com.amazonaws.finspacedata#DatasetList", + "traits": { + "smithy.api#documentation": "List of Datasets.
" + } + }, + "nextToken": { + "target": "com.amazonaws.finspacedata#PaginationToken", + "traits": { + "smithy.api#documentation": "A token indicating where a results page should begin.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Response for the ListDatasets operation" + } + }, + "com.amazonaws.finspacedata#OwnerName": { + "type": "string", + "traits": { + "smithy.api#documentation": "1 - 250 character String", + "smithy.api#length": { + "min": 1, + "max": 250 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.finspacedata#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#documentation": "Pagination token for list operations" + } + }, + "com.amazonaws.finspacedata#PartitionColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspacedata#StringValueLength1to255" + }, + "traits": { + "smithy.api#documentation": "DataView Partition Column List" + } + }, + "com.amazonaws.finspacedata#PermissionGroupId": { + "type": "string", + "traits": { + "smithy.api#documentation": "Id of the associated PermissionGroup", + "smithy.api#length": { + "min": 1, + "max": 26 + } + } + }, + "com.amazonaws.finspacedata#PermissionGroupParams": { + "type": "structure", + "members": { + "permissionGroupId": { + "target": "com.amazonaws.finspacedata#PermissionGroupId", + "traits": { + "smithy.api#documentation": "The unique identifier of the PermissionGroup.
" + } + }, + "datasetPermissions": { + "target": "com.amazonaws.finspacedata#ResourcePermissionsList", + "traits": { + "smithy.api#documentation": "List of resource permissions.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Permission group parameters for Dataset permissions.
" + } + }, + "com.amazonaws.finspacedata#PhoneNumber": { + "type": "string", + "traits": { + "smithy.api#documentation": "PhoneNumber of Dataset Owner", + "smithy.api#length": { + "min": 10, + "max": 20 + }, + "smithy.api#pattern": "^[\\+0-9\\#\\,\\(][\\+0-9\\-\\.\\/\\(\\)\\,\\#\\s]+$" + } + }, + "com.amazonaws.finspacedata#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.finspacedata#ErrorMessage2" + } + }, + "traits": { + "smithy.api#documentation": "One or more resources can't be found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.finspacedata#ResourcePermission": { + "type": "structure", + "members": { + "permission": { + "target": "com.amazonaws.finspacedata#StringValueLength1to250", + "traits": { + "smithy.api#documentation": "Permission for a resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Resource permission for a Dataset.
" + } + }, + "com.amazonaws.finspacedata#ResourcePermissionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspacedata#ResourcePermission" + }, + "traits": { + "smithy.api#documentation": "List of Resource Permissions" + } + }, + "com.amazonaws.finspacedata#ResultLimit": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Maximum number of results to be returned as part of a list operation", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.finspacedata#SchemaDefinition": { + "type": "structure", + "members": { + "columns": { + "target": "com.amazonaws.finspacedata#ColumnList", + "traits": { + "smithy.api#documentation": "List of column definitions.
" + } + }, + "primaryKeyColumns": { + "target": "com.amazonaws.finspacedata#ColumnNameList", + "traits": { + "smithy.api#documentation": "List of column names used for primary key.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Definition for a schema on a tabular Dataset.
" + } + }, + "com.amazonaws.finspacedata#SchemaUnion": { + "type": "structure", + "members": { + "tabularSchemaConfig": { + "target": "com.amazonaws.finspacedata#SchemaDefinition", "traits": { - "smithy.api#documentation": "The category of the error.
\n\n VALIDATION -The inputs to this request are invalid.
\n SERVICE_QUOTA_EXCEEDED - Service quotas have been exceeded. Please\n contact AWS support to increase quotas.
\n ACCESS_DENIED - Missing required permission to perform this\n request.
\n RESOURCE_NOT_FOUND - One or more inputs to this request were not\n found.
\n THROTTLING - The system temporarily lacks sufficient resources to process\n the request.
\n INTERNAL_SERVICE_EXCEPTION - An internal service error has\n occurred.
\n CANCELLED - A user recoverable error has occurred.
The configuration for a schema on a tabular Dataset.
" } } }, "traits": { - "smithy.api#documentation": "Error message.
" + "smithy.api#documentation": "A union of schema types.
" + } + }, + "com.amazonaws.finspacedata#SessionDuration": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 720 + } + } + }, + "com.amazonaws.finspacedata#SortColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspacedata#StringValueLength1to255" + }, + "traits": { + "smithy.api#documentation": "DataView Sort Column List" + } + }, + "com.amazonaws.finspacedata#SourceParams": { + "type": "map", + "key": { + "target": "com.amazonaws.finspacedata#StringMapKey" + }, + "value": { + "target": "com.amazonaws.finspacedata#StringMapValue" + }, + "traits": { + "smithy.api#documentation": "Source Parameters of a Changeset" } }, - "com.amazonaws.finspacedata#FormatType": { + "com.amazonaws.finspacedata#StringMapKey": { "type": "string", "traits": { - "smithy.api#enum": [ - { - "value": "CSV", - "name": "CSV" - }, - { - "value": "JSON", - "name": "JSON" - }, - { - "value": "PARQUET", - "name": "PARQUET" - }, - { - "value": "XML", - "name": "XML" - } - ] + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[\\s\\S]*\\S[\\s\\S]*$" } }, - "com.amazonaws.finspacedata#GetProgrammaticAccessCredentials": { + "com.amazonaws.finspacedata#StringMapValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + }, + "smithy.api#pattern": "^[\\s\\S]*\\S[\\s\\S]*$" + } + }, + "com.amazonaws.finspacedata#StringValueLength1to250": { + "type": "string", + "traits": { + "smithy.api#documentation": "1 - 250 character String", + "smithy.api#length": { + "min": 1, + "max": 250 + }, + "smithy.api#pattern": "^[\\s\\S]*\\S[\\s\\S]*$" + } + }, + "com.amazonaws.finspacedata#StringValueLength1to255": { + "type": "string", + "traits": { + "smithy.api#documentation": "1 - 255 character String", + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\s\\S]*\\S[\\s\\S]*$" + } + }, + "com.amazonaws.finspacedata#StringValueLength1to2552": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.finspacedata#ThrottlingException": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "The request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.finspacedata#TimestampEpoch": { + "type": "long", + "traits": { + "smithy.api#documentation": "Milliseconds since UTC epoch" + } + }, + "com.amazonaws.finspacedata#UpdateChangeset": { "type": "operation", "input": { - "target": "com.amazonaws.finspacedata#GetProgrammaticAccessCredentialsRequest" + "target": "com.amazonaws.finspacedata#UpdateChangesetRequest" }, "output": { - "target": "com.amazonaws.finspacedata#GetProgrammaticAccessCredentialsResponse" + "target": "com.amazonaws.finspacedata#UpdateChangesetResponse" }, "errors": [ { "target": "com.amazonaws.finspacedata#AccessDeniedException" }, + { + "target": "com.amazonaws.finspacedata#ConflictException" + }, { "target": "com.amazonaws.finspacedata#InternalServerException" }, + { + "target": "com.amazonaws.finspacedata#ResourceNotFoundException" + }, { "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" } ], "traits": { - "smithy.api#documentation": "Request programmatic credentials to use with Habanero SDK.
", + "smithy.api#documentation": "Updates a FinSpace Changeset.
", "smithy.api#http": { - "method": "GET", - "uri": "/credentials/programmatic", + "method": "PUT", + "uri": "/datasets/{datasetId}/changesetsv2/{changesetId}", "code": 200 } } }, - "com.amazonaws.finspacedata#GetProgrammaticAccessCredentialsRequest": { + "com.amazonaws.finspacedata#UpdateChangesetRequest": { "type": "structure", "members": { - "durationInMinutes": { - "target": "com.amazonaws.finspacedata#SessionDuration", + "clientToken": { + "target": "com.amazonaws.finspacedata#ClientToken", "traits": { - "smithy.api#documentation": "The time duration in which the credentials remain valid.
", - "smithy.api#httpQuery": "durationInMinutes" + "smithy.api#documentation": "A token used to ensure idempotency.
", + "smithy.api#idempotencyToken": {} } }, - "environmentId": { - "target": "com.amazonaws.finspacedata#IdType", + "datasetId": { + "target": "com.amazonaws.finspacedata#DatasetId", "traits": { - "smithy.api#documentation": "The habanero environment identifier.
", - "smithy.api#httpQuery": "environmentId", + "smithy.api#documentation": "The unique identifier for the FinSpace Dataset in which the Changeset is created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "changesetId": { + "target": "com.amazonaws.finspacedata#ChangesetId", + "traits": { + "smithy.api#documentation": "The unique identifier for the Changeset to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sourceParams": { + "target": "com.amazonaws.finspacedata#SourceParams", + "traits": { + "smithy.api#documentation": "Options that define the location of the data being ingested.
", + "smithy.api#required": {} + } + }, + "formatParams": { + "target": "com.amazonaws.finspacedata#FormatParams", + "traits": { + "smithy.api#documentation": "Options that define the structure of the source file(s).
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "Request to update an existing changeset." } }, - "com.amazonaws.finspacedata#GetProgrammaticAccessCredentialsResponse": { + "com.amazonaws.finspacedata#UpdateChangesetResponse": { "type": "structure", "members": { - "credentials": { - "target": "com.amazonaws.finspacedata#Credentials", + "changesetId": { + "target": "com.amazonaws.finspacedata#ChangesetId", "traits": { - "smithy.api#documentation": "Returns the programmatic credentials.
" + "smithy.api#documentation": "The unique identifier for the Changeset to update.
" } }, - "durationInMinutes": { - "target": "com.amazonaws.finspacedata#SessionDuration", + "datasetId": { + "target": "com.amazonaws.finspacedata#DatasetId", "traits": { - "smithy.api#documentation": "Returns the duration in which the credentials will remain valid.
" + "smithy.api#documentation": "The unique identifier for the FinSpace Dataset in which the Changeset is created.
" } } + }, + "traits": { + "smithy.api#documentation": "The response from a update changeset operation." } }, - "com.amazonaws.finspacedata#GetWorkingLocation": { + "com.amazonaws.finspacedata#UpdateDataset": { "type": "operation", "input": { - "target": "com.amazonaws.finspacedata#GetWorkingLocationRequest" + "target": "com.amazonaws.finspacedata#UpdateDatasetRequest" }, "output": { - "target": "com.amazonaws.finspacedata#GetWorkingLocationResponse" + "target": "com.amazonaws.finspacedata#UpdateDatasetResponse" }, "errors": [ { "target": "com.amazonaws.finspacedata#AccessDeniedException" }, + { + "target": "com.amazonaws.finspacedata#ConflictException" + }, { "target": "com.amazonaws.finspacedata#InternalServerException" }, + { + "target": "com.amazonaws.finspacedata#ResourceNotFoundException" + }, { "target": "com.amazonaws.finspacedata#ThrottlingException" }, @@ -503,120 +2533,89 @@ } ], "traits": { - "smithy.api#documentation": "A temporary Amazon S3 location to copy your files from a source location to stage or use\n as a scratch space in Habanero notebook.
", + "smithy.api#documentation": "Updates a FinSpace Dataset.
", "smithy.api#http": { - "method": "POST", - "uri": "/workingLocationV1", + "method": "PUT", + "uri": "/datasetsv2/{datasetId}", "code": 200 } } }, - "com.amazonaws.finspacedata#GetWorkingLocationRequest": { + "com.amazonaws.finspacedata#UpdateDatasetRequest": { "type": "structure", "members": { - "locationType": { - "target": "com.amazonaws.finspacedata#locationType", + "clientToken": { + "target": "com.amazonaws.finspacedata#ClientToken", "traits": { - "smithy.api#documentation": "Specify the type of the working location.
\n\n SAGEMAKER - Use the Amazon S3 location as a temporary location to store data content when\n working with FinSpace Notebooks that run on SageMaker studio.
\n INGESTION - Use the Amazon S3 location as a staging location to copy your\n data content and then use the location with the changeset creation operation.
A token used to ensure idempotency.
", + "smithy.api#idempotencyToken": {} } - } - } - }, - "com.amazonaws.finspacedata#GetWorkingLocationResponse": { - "type": "structure", - "members": { - "s3Uri": { - "target": "com.amazonaws.finspacedata#stringValueLength1to1024", + }, + "datasetId": { + "target": "com.amazonaws.finspacedata#DatasetId", "traits": { - "smithy.api#documentation": "Returns the Amazon S3 URI for the working location.
" + "smithy.api#documentation": "The unique identifier for the Dataset to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "s3Path": { - "target": "com.amazonaws.finspacedata#stringValueLength1to1024", + "datasetTitle": { + "target": "com.amazonaws.finspacedata#DatasetTitle", "traits": { - "smithy.api#documentation": "Returns the Amazon S3 Path for the working location.
" + "smithy.api#documentation": "A display title for the Dataset.
", + "smithy.api#required": {} } }, - "s3Bucket": { - "target": "com.amazonaws.finspacedata#stringValueLength1to63", + "kind": { + "target": "com.amazonaws.finspacedata#DatasetKind", "traits": { - "smithy.api#documentation": "Returns the Amazon S3 bucket name for the working location.
" + "smithy.api#documentation": "The format in which the Dataset data is structured.
\n\n TABULAR - Data is structured in a tabular format.
\n NON_TABULAR - Data is structured in a non-tabular format.
A description for the Dataset.
" + } + }, + "alias": { + "target": "com.amazonaws.finspacedata#AliasString", + "traits": { + "smithy.api#documentation": "The unique resource identifier for a Dataset.
", + "smithy.api#required": {} + } + }, + "schemaDefinition": { + "target": "com.amazonaws.finspacedata#SchemaUnion", + "traits": { + "smithy.api#documentation": "Definition for a schema on a tabular Dataset.
" } - } - } - }, - "com.amazonaws.finspacedata#IdType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 26 - } - } - }, - "com.amazonaws.finspacedata#InternalServerException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspacedata#errorMessage" } }, "traits": { - "smithy.api#documentation": "The request processing has failed because of an unknown error, exception or\n failure.
", - "smithy.api#error": "server", - "smithy.api#httpError": 500 + "smithy.api#documentation": "The request for an UpdateDataset operation" } }, - "com.amazonaws.finspacedata#ResourceNotFoundException": { + "com.amazonaws.finspacedata#UpdateDatasetResponse": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.finspacedata#errorMessage" + "datasetId": { + "target": "com.amazonaws.finspacedata#DatasetId", + "traits": { + "smithy.api#documentation": "The unique identifier for updated Dataset.
" + } } }, "traits": { - "smithy.api#documentation": "One or more resources can't be found.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.finspacedata#SessionDuration": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 60, - "max": 720 - } - } - }, - "com.amazonaws.finspacedata#SourceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "S3", - "name": "S3" - } - ] - } - }, - "com.amazonaws.finspacedata#ThrottlingException": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "The request was denied due to request throttling.
", - "smithy.api#error": "client", - "smithy.api#httpError": 429 + "smithy.api#documentation": "The response from an UpdateDataset operation" } }, - "com.amazonaws.finspacedata#Timestamp": { - "type": "timestamp" - }, "com.amazonaws.finspacedata#ValidationException": { "type": "structure", "members": { "message": { - "target": "com.amazonaws.finspacedata#errorMessage" + "target": "com.amazonaws.finspacedata#ErrorMessage2" } }, "traits": { @@ -625,18 +2624,6 @@ "smithy.api#httpError": 400 } }, - "com.amazonaws.finspacedata#arn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - } - } - }, - "com.amazonaws.finspacedata#errorMessage": { - "type": "string" - }, "com.amazonaws.finspacedata#locationType": { "type": "string", "traits": { @@ -652,24 +2639,6 @@ ] } }, - "com.amazonaws.finspacedata#stringMap": { - "type": "map", - "key": { - "target": "com.amazonaws.finspacedata#stringMapKey" - }, - "value": { - "target": "com.amazonaws.finspacedata#stringMapValue" - } - }, - "com.amazonaws.finspacedata#stringMapKey": { - "type": "string" - }, - "com.amazonaws.finspacedata#stringMapValue": { - "type": "string" - }, - "com.amazonaws.finspacedata#stringValue": { - "type": "string" - }, "com.amazonaws.finspacedata#stringValueLength1to1024": { "type": "string", "traits": { @@ -677,16 +2646,7 @@ "min": 1, "max": 1024 }, - "smithy.api#pattern": ".*\\S.*" - } - }, - "com.amazonaws.finspacedata#stringValueLength1to255": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } + "smithy.api#pattern": "\\S" } }, "com.amazonaws.finspacedata#stringValueLength1to63": { @@ -696,7 +2656,7 @@ "min": 1, "max": 63 }, - "smithy.api#pattern": ".*\\S.*" + "smithy.api#pattern": "\\S" } }, "com.amazonaws.finspacedata#stringValueMaxLength1000": { diff --git a/aws/sdk/aws-models/fsx.json b/aws/sdk/aws-models/fsx.json index 664d3f7c956d51aa03ca7bc3b565815244809d71..566abe519b8e0e4733b9677921c2512507915f4e 100644 --- a/aws/sdk/aws-models/fsx.json +++ b/aws/sdk/aws-models/fsx.json @@ -42,6 +42,21 @@ }, "com.amazonaws.fsx#AWSSimbaAPIService_v20180301": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "FSx", + "arnNamespace": "fsx", + "cloudFormationName": "FSx", + "cloudTrailEventSource": "fsx.amazonaws.com", + "endpointPrefix": "fsx" + }, + "aws.auth#sigv4": { + "name": "fsx" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Amazon FSx is a fully managed service that makes it easy for storage and\n application administrators to launch and use shared file storage.
", + "smithy.api#title": "Amazon FSx" + }, "version": "2018-03-01", "operations": [ { @@ -56,6 +71,9 @@ { "target": "com.amazonaws.fsx#CreateBackup" }, + { + "target": "com.amazonaws.fsx#CreateDataRepositoryAssociation" + }, { "target": "com.amazonaws.fsx#CreateDataRepositoryTask" }, @@ -65,6 +83,9 @@ { "target": "com.amazonaws.fsx#CreateFileSystemFromBackup" }, + { + "target": "com.amazonaws.fsx#CreateSnapshot" + }, { "target": "com.amazonaws.fsx#CreateStorageVirtualMachine" }, @@ -77,9 +98,15 @@ { "target": "com.amazonaws.fsx#DeleteBackup" }, + { + "target": "com.amazonaws.fsx#DeleteDataRepositoryAssociation" + }, { "target": "com.amazonaws.fsx#DeleteFileSystem" }, + { + "target": "com.amazonaws.fsx#DeleteSnapshot" + }, { "target": "com.amazonaws.fsx#DeleteStorageVirtualMachine" }, @@ -89,6 +116,9 @@ { "target": "com.amazonaws.fsx#DescribeBackups" }, + { + "target": "com.amazonaws.fsx#DescribeDataRepositoryAssociations" + }, { "target": "com.amazonaws.fsx#DescribeDataRepositoryTasks" }, @@ -98,6 +128,9 @@ { "target": "com.amazonaws.fsx#DescribeFileSystems" }, + { + "target": "com.amazonaws.fsx#DescribeSnapshots" + }, { "target": "com.amazonaws.fsx#DescribeStorageVirtualMachines" }, @@ -110,37 +143,34 @@ { "target": "com.amazonaws.fsx#ListTagsForResource" }, + { + "target": "com.amazonaws.fsx#ReleaseFileSystemNfsV3Locks" + }, + { + "target": "com.amazonaws.fsx#RestoreVolumeFromSnapshot" + }, { "target": "com.amazonaws.fsx#TagResource" }, { "target": "com.amazonaws.fsx#UntagResource" }, + { + "target": "com.amazonaws.fsx#UpdateDataRepositoryAssociation" + }, { "target": "com.amazonaws.fsx#UpdateFileSystem" }, + { + "target": "com.amazonaws.fsx#UpdateSnapshot" + }, { "target": "com.amazonaws.fsx#UpdateStorageVirtualMachine" }, { "target": "com.amazonaws.fsx#UpdateVolume" } - ], - "traits": { - "aws.api#service": { - "sdkId": "FSx", - "arnNamespace": "fsx", - "cloudFormationName": "FSx", - "cloudTrailEventSource": "fsx.amazonaws.com", - "endpointPrefix": "fsx" - }, - "aws.auth#sigv4": { - "name": "fsx" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon FSx is a fully managed service that makes it easy for storage and\n application administrators to launch and use shared file storage.
", - "smithy.api#title": "Amazon FSx" - } + ] }, "com.amazonaws.fsx#ActiveDirectoryBackupAttributes": { "type": "structure", @@ -148,7 +178,7 @@ "DomainName": { "target": "com.amazonaws.fsx#ActiveDirectoryFullyQualifiedName", "traits": { - "smithy.api#documentation": "The fully qualified domain name of the self-managed AD directory.
" + "smithy.api#documentation": "The fully qualified domain name of the self-managed Active Directory directory.
" } }, "ActiveDirectoryId": { @@ -162,7 +192,7 @@ } }, "traits": { - "smithy.api#documentation": "The Microsoft AD attributes of the Amazon FSx for Windows File Server file system.
" + "smithy.api#documentation": "The Microsoft Active Directory attributes of the Amazon FSx for Windows File\n Server file system.
" } }, "com.amazonaws.fsx#ActiveDirectoryError": { @@ -244,19 +274,19 @@ "ProgressPercent": { "target": "com.amazonaws.fsx#ProgressPercent", "traits": { - "smithy.api#documentation": "Provides the percent complete of a STORAGE_OPTIMIZATION administrative action. \n Does not apply to any other administrative action type.
The percentage-complete status of a STORAGE_OPTIMIZATION administrative\n action. Does not apply to any other administrative action type.
Time that the administrative action request was received.
" + "smithy.api#documentation": "The time that the administrative action request was received.
" } }, "Status": { "target": "com.amazonaws.fsx#Status", "traits": { - "smithy.api#documentation": "Describes the status of the administrative action, as follows:
\n\n FAILED - Amazon FSx failed to process the administrative action successfully.
\n IN_PROGRESS - Amazon FSx is processing the administrative action.
\n PENDING - Amazon FSx is waiting to process the administrative action.
\n COMPLETED - Amazon FSx has finished processing the administrative task.
\n UPDATED_OPTIMIZING - For a storage capacity increase update, Amazon FSx has\n updated the file system with the new storage capacity, and is now performing the\n storage optimization process. For more information, see\n Managing\n storage capacity in the Amazon FSx for Windows File Server\n User Guide and Managing storage\n and throughput capacity in the Amazon FSx for Lustre User\n Guide.
Describes the status of the administrative action, as follows:
\n\n FAILED - Amazon FSx failed to process the administrative action\n successfully.
\n IN_PROGRESS - Amazon FSx is processing the administrative action.
\n PENDING - Amazon FSx is waiting to process the administrative\n action.
\n COMPLETED - Amazon FSx has finished processing the administrative\n task.
\n UPDATED_OPTIMIZING - For a storage-capacity increase update, Amazon FSx\n has updated the file system with the new storage capacity, and is now performing\n the storage-optimization process.
Describes a specific Amazon FSx administrative action for the current Windows or\n Lustre file system.
" + "smithy.api#documentation": "Describes a specific Amazon FSx administrative action for the current Windows,\n Lustre, or OpenZFS file system.
" } }, "com.amazonaws.fsx#AdministrativeActionFailureDetails": { @@ -293,7 +326,7 @@ "com.amazonaws.fsx#AdministrativeActionType": { "type": "string", "traits": { - "smithy.api#documentation": "Describes the type of administrative action, as follows:
\n\n FILE_SYSTEM_UPDATE - A file system update administrative action initiated by the user from the \n Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).
\n STORAGE_OPTIMIZATION - Once the FILE_SYSTEM_UPDATE \n task to increase a file system's storage capacity completes successfully, a \n STORAGE_OPTIMIZATION task starts.\n
For Windows, storage optimization is the process of migrating the file system data\n to the new, larger disks.
\nFor Lustre, storage optimization consists of rebalancing the data across the existing and\n newly added file servers.
\nYou can track the storage optimization progress using the\n ProgressPercent property. When\n STORAGE_OPTIMIZATION completes successfully, the parent\n FILE_SYSTEM_UPDATE action status changes to\n COMPLETED. For more information, see Managing\n storage capacity in the Amazon FSx for Windows File Server\n User Guide and Managing storage\n and throughput capacity in the Amazon FSx for Lustre User\n Guide.
\n FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new DNS alias with the file system. \n For more information, see\n .
\n FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system.\n For more information, see .
Describes the type of administrative action, as follows:
\n\n FILE_SYSTEM_UPDATE - A file system update administrative action\n initiated from the Amazon FSx console, API\n (UpdateFileSystem), or CLI\n (update-file-system).
\n STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE\n task to increase a file system's storage capacity has been completed\n successfully, a STORAGE_OPTIMIZATION task starts.
For Windows, storage optimization is the process of migrating the file system data\n to the new, larger disks.
\nFor Lustre, storage optimization consists of rebalancing the data across the existing and\n newly added file servers.
\nFor OpenZFS, storage optimization consists of migrating data from the\n older smaller disks to the newer larger disks.
\nYou can track the storage-optimization progress using the\n ProgressPercent property. When\n STORAGE_OPTIMIZATION has been completed successfully, the\n parent FILE_SYSTEM_UPDATE action status changes to\n COMPLETED. For more information, see Managing\n storage capacity in the Amazon FSx for Windows\n File Server User Guide, Managing storage\n and throughput capacity in the Amazon FSx for\n Lustre User Guide, and Managing storage capacity in the\n Amazon FSx for OpenZFS User Guide.
\n FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new Domain\n Name System (DNS) alias with the file system. For more information, see \n AssociateFileSystemAliases.
\n FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system.\n For more information, see DisassociateFileSystemAliases.
\n VOLUME_UPDATE - A volume update to an Amazon FSx for NetApp ONTAP or\n Amazon FSx for OpenZFS volume initiated from the Amazon FSx\n console, API (UpdateVolume), or CLI\n (update-volume).
\n SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for\n OpenZFS volume initiated from the Amazon FSx console, API\n (UpdateSnapshot), or CLI (update-snapshot).
\n RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System\n (NFS) V3 locks on an Amazon FSx for OpenZFS file system.
The system generated response showing the DNS aliases that \n Amazon FSx is attempting to associate with the file system. \n Use the API \n operation to monitor the status of the aliases Amazon FSx is \n associating with the file system. It can take up to 2.5 minutes for \n the alias status to change from CREATING to AVAILABLE.
The AutoExportPolicy can have the following event values:
\n NEW - Amazon FSx automatically exports new files and\n directories to the data repository as they are added to the file system.
\n CHANGED - Amazon FSx automatically exports changes to\n files and directories on the file system to the data repository.
\n DELETED - Files and directories are automatically deleted\n on the data repository when they are deleted on the file system.
You can define any combination of event types for your AutoExportPolicy.
Describes a data repository association's automatic export policy. The\n AutoExportPolicy defines the types of updated objects on the\n file system that will be automatically exported to the data repository.\n As you create, modify, or delete files, Amazon FSx automatically\n exports the defined changes asynchronously once your application finishes\n modifying the file.
This AutoExportPolicy is supported only for file systems with the\n Persistent_2 deployment type.
The AutoImportPolicy can have the following event values:
\n NEW - Amazon FSx automatically imports metadata of\n files added to the linked S3 bucket that do not currently exist in the FSx\n file system.
\n CHANGED - Amazon FSx automatically updates file\n metadata and invalidates existing file content on the file system as files\n change in the data repository.
\n DELETED - Amazon FSx automatically deletes files\n on the file system as corresponding files are deleted in the data repository.
You can define any combination of event types for your AutoImportPolicy.
Describes the data repository association's automatic import policy.\n The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory\n listings up to date by importing changes to your file system as you modify\n objects in a linked S3 bucket.
\nThis AutoImportPolicy is supported only for file systems\n with the Persistent_2 deployment type.
The number of days to retain automatic backups. Setting this to 0 disables\n automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
", + "smithy.api#documentation": "The number of days to retain automatic backups. Setting this property to\n 0 disables automatic backups. You can retain automatic backups for a\n maximum of 90 days. The default is 0.
The lifecycle status of the backup.
\n\n AVAILABLE - The backup is fully available.
\n PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx has not started creating the backup.
\n CREATING - Amazon FSx is creating the backup.
\n TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to S3.
\n COPYING - Amazon FSx is copying the backup.
\n DELETED - Amazon FSx deleted the backup and it is no longer available.
\n FAILED - Amazon FSx could not complete the backup.
The lifecycle status of the backup.
\n\n AVAILABLE - The backup is fully available.
\n PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup.
\n CREATING - Amazon FSx is creating the backup.
\n TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to Amazon S3.
\n COPYING - Amazon FSx is copying the backup.
\n DELETED - Amazon FSx deleted the backup and it's no longer\n available.
\n FAILED - Amazon FSx couldn't finish the backup.
Details explaining any failures that occur when creating a backup.
" + "smithy.api#documentation": "Details explaining any failures that occurred when creating a backup.
" } }, "Type": { "target": "com.amazonaws.fsx#BackupType", "traits": { - "smithy.api#documentation": "The type of the file system backup.
", + "smithy.api#documentation": "The type of the file-system backup.
", "smithy.api#required": {} } }, @@ -556,7 +633,7 @@ "KmsKeyId": { "target": "com.amazonaws.fsx#KmsKeyId", "traits": { - "smithy.api#documentation": "The ID of the Key Management Service (KMS) key used to encrypt the \n backup of the Amazon FSx file system's data at rest. \n
" + "smithy.api#documentation": "The ID of the Key Management Service (KMS) key used to encrypt the\n backup of the Amazon FSx file system's data at rest.
" } }, "ResourceARN": { @@ -568,20 +645,20 @@ "Tags": { "target": "com.amazonaws.fsx#Tags", "traits": { - "smithy.api#documentation": "Tags associated with a particular file system.
" + "smithy.api#documentation": "The tags associated with a particular file system.
" } }, "FileSystem": { "target": "com.amazonaws.fsx#FileSystem", "traits": { - "smithy.api#documentation": "Metadata of the file system associated with the backup. This metadata is persisted\n even if the file system is deleted.
", + "smithy.api#documentation": "The metadata of the file system associated with the backup. This metadata is persisted\n even if the file system is deleted.
", "smithy.api#required": {} } }, "DirectoryInformation": { "target": "com.amazonaws.fsx#ActiveDirectoryBackupAttributes", "traits": { - "smithy.api#documentation": "The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance is joined.
" + "smithy.api#documentation": "The configuration of the self-managed Microsoft Active Directory directory to which\n the Windows File Server instance is joined.
" } }, "OwnerId": { @@ -599,7 +676,7 @@ "ResourceType": { "target": "com.amazonaws.fsx#ResourceType", "traits": { - "smithy.api#documentation": "Specifies the resource type that is backed up.
" + "smithy.api#documentation": "Specifies the resource type that's backed up.
" } }, "Volume": { @@ -607,7 +684,7 @@ } }, "traits": { - "smithy.api#documentation": "A backup of an Amazon FSx for Windows File Server or Amazon FSx for Lustre file system,\n or of an Amazon FSx for NetApp ONTAP volume.
" + "smithy.api#documentation": "A backup of an Amazon FSx for Windows File Server, Amazon FSx for\n Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx\n for OpenZFS file system.
" } }, "com.amazonaws.fsx#BackupBeingCopied": { @@ -631,7 +708,7 @@ "Message": { "target": "com.amazonaws.fsx#ErrorMessage", "traits": { - "smithy.api#documentation": "A message describing the backup creation failure.
" + "smithy.api#documentation": "A message describing the backup-creation failure.
" } } }, @@ -642,7 +719,7 @@ "com.amazonaws.fsx#BackupId": { "type": "string", "traits": { - "smithy.api#documentation": "The ID of the source backup. Specifies the backup you are copying.
", + "smithy.api#documentation": "The ID of the source backup. Specifies the backup that you are copying.
", "smithy.api#length": { "min": 12, "max": 128 @@ -678,7 +755,7 @@ "com.amazonaws.fsx#BackupLifecycle": { "type": "string", "traits": { - "smithy.api#documentation": "The lifecycle status of the backup.
\n\n AVAILABLE - The backup is fully available.
\n PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx has not started creating the backup.
\n CREATING - Amazon FSx is creating the new user-intiated backup
\n TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is backing up the file system.
\n COPYING - Amazon FSx is copying the backup.
\n DELETED - Amazon FSx deleted the backup and it is no longer available.
\n FAILED - Amazon FSx could not complete the backup.
The lifecycle status of the backup.
\n\n AVAILABLE - The backup is fully available.
\n PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup.
\n CREATING - Amazon FSx is creating the new user-initiated backup.
\n TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is backing up the file\n system.
\n COPYING - Amazon FSx is copying the backup.
\n DELETED - Amazon FSx deleted the backup and it's no longer\n available.
\n FAILED - Amazon FSx couldn't finish the backup.
Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region\n (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five\n backup copy requests in progress to a single destination Region per account.
\nYou can use cross-Region backup copies for cross-region disaster recovery.\n You periodically take backups and copy them to another Region so that in the\n event of a disaster in the primary Region, you can restore from backup and recover\n availability quickly in the other Region. You can make cross-Region copies\n only within your Amazon Web Services partition.
\nYou can also use backup copies to clone your file data set to another Region\n or within the same Region.
\nYou can use the SourceRegion parameter to specify the Amazon Web Services Region\n from which the backup will be copied. For example, if you make the call from the\n us-west-1 Region and want to copy a backup from the us-east-2\n Region, you specify us-east-2 in the SourceRegion parameter\n to make a cross-Region copy. If you don't specify a Region, the backup copy is\n created in the same Region where the request is sent from (in-Region copy).
For more information on creating backup copies, see \n \n Copying backups in the Amazon FSx for Windows User Guide and \n Copying backups \n in the Amazon FSx for Lustre User Guide.
", + "smithy.api#documentation": "Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region\n (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five\n backup copy requests in progress to a single destination Region per account.
\nYou can use cross-Region backup copies for cross-Region disaster recovery. You can\n periodically take backups and copy them to another Region so that in the event of a\n disaster in the primary Region, you can restore from backup and recover availability\n quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition. A partition is a grouping of Regions. Amazon Web Services currently\n has three partitions: aws (Standard Regions), aws-cn (China\n Regions), and aws-us-gov (Amazon Web Services GovCloud [US] Regions).
You can also use backup copies to clone your file dataset to another Region or within\n the same Region.
\nYou can use the SourceRegion parameter to specify the Amazon Web Services Region\n from which the backup will be copied. For example, if you make the call from the\n us-west-1 Region and want to copy a backup from the us-east-2\n Region, you specify us-east-2 in the SourceRegion parameter\n to make a cross-Region copy. If you don't specify a Region, the backup copy is\n created in the same Region where the request is sent from (in-Region copy).
For more information about creating backup copies, see Copying backups\n in the Amazon FSx for Windows User Guide, Copying backups in the Amazon FSx for Lustre User\n Guide, and Copying backups in the Amazon FSx for OpenZFS User\n Guide.
", "smithy.api#idempotent": {} } }, @@ -962,14 +1045,14 @@ "SourceBackupId": { "target": "com.amazonaws.fsx#SourceBackupId", "traits": { - "smithy.api#documentation": "The ID of the source backup. Specifies the ID of the backup that is\n being copied.
", + "smithy.api#documentation": "The ID of the source backup. Specifies the ID of the backup that's being copied.
", "smithy.api#required": {} } }, "SourceRegion": { "target": "com.amazonaws.fsx#Region", "traits": { - "smithy.api#documentation": "The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which\n the backup is being copied. The source and destination Regions must be in\n the same Amazon Web Services partition. If you don't specify a Region, it defaults to\n the Region where the request is sent from (in-Region copy).
" + "smithy.api#documentation": "The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination\n Regions must be in the same Amazon Web Services partition. If you don't specify a\n Region, SourceRegion defaults to the Region where the request is sent from\n (in-Region copy).
A boolean flag indicating whether tags from the source backup\n should be copied to the backup copy. This value defaults to false.
\nIf you set CopyTags to true and the source backup has\n existing tags, you can use the Tags parameter to create new\n tags, provided that the sum of the source backup tags and the new tags\n doesn't exceed 50. Both sets of tags are merged. If there are tag\n conflicts (for example, two tags with the same key but different values),\n the tags created with the Tags parameter take precedence.
A Boolean flag indicating whether tags from the source backup should be copied to the\n backup copy. This value defaults to false.
If you set CopyTags to true and the source backup has existing\n tags, you can use the Tags parameter to create new tags, provided that the sum\n of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are\n merged. If there are tag conflicts (for example, two tags with the same key but different\n values), the tags created with the Tags parameter take precedence.
Creates a backup of an existing Amazon FSx for Windows File Server\n or Amazon FSx for Lustre file system, or of an Amazon FSx for NetApp ONTAP\n volume. Creating regular backups is a best practice, enabling you to restore\n a file system or volume from a backup if an issue arises with the original\n file system or volume.
\nFor Amazon FSx for Lustre file systems, you can create a backup only \n for file systems with the following configuration:
\na Persistent deployment type
\nis not linked to a data repository.
\nFor more information about backups, see the following:
\nFor Amazon FSx for Lustre, \n see Working with FSx for Lustre backups.
\nFor Amazon FSx for Windows, \n see Working with FSx for Windows backups.
\nFor Amazon FSx for NetApp ONTAP, \n see Working with FSx for NetApp ONTAP backups.
\nIf a backup with the specified client request token exists, and the parameters\n match, this operation returns the description of the existing backup. If a backup\n specified client request token exists, and the parameters don't match, this\n operation returns IncompatibleParameterError. If a backup with the\n specified client request token doesn't exist, CreateBackup does the\n following:
Creates a new Amazon FSx backup with an assigned ID, and an initial\n lifecycle state of CREATING.
Returns the description of the backup.
\nBy using the idempotent operation, you can retry a CreateBackup\n operation without the risk of creating an extra backup. This approach can be useful when\n an initial call fails in a way that makes it unclear whether a backup was created. If\n you use the same client request token and the initial call created a backup, the\n operation returns a successful result because all the parameters are the same.
The CreateBackup operation returns while the backup's\n lifecycle state is still CREATING. You can check the backup creation\n status by calling the DescribeBackups operation, which returns the\n backup state along with other information.
Creates a backup of an existing Amazon FSx for Windows File Server file\n system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP\n volume, or Amazon FSx for OpenZFS file system. We recommend creating regular\n backups so that you can restore a file system or volume from a backup if an issue arises\n with the original file system or volume.
\nFor Amazon FSx for Lustre file systems, you can create a backup only for file\n systems that have the following configuration:
\nA Persistent deployment type
\nAre not linked to a data repository
\nFor more information about backups, see the following:
\nFor Amazon FSx for Lustre, see Working with FSx for\n Lustre backups.
\nFor Amazon FSx for Windows, see Working with FSx for\n Windows backups.
\nFor Amazon FSx for NetApp ONTAP, see Working with FSx for NetApp\n ONTAP backups.
\nFor Amazon FSx for OpenZFS, see Working with FSx for OpenZFS backups.
\nIf a backup with the specified client request token exists and the parameters match,\n this operation returns the description of the existing backup. If a backup with the\n specified client request token exists and the parameters don't match, this operation\n returns IncompatibleParameterError. If a backup with the specified client\n request token doesn't exist, CreateBackup does the following:
Creates a new Amazon FSx backup with an assigned ID, and an initial\n lifecycle state of CREATING.
Returns the description of the backup.
\nBy using the idempotent operation, you can retry a CreateBackup\n operation without the risk of creating an extra backup. This approach can be useful when\n an initial call fails in a way that makes it unclear whether a backup was created. If\n you use the same client request token and the initial call created a backup, the\n operation returns a successful result because all the parameters are the same.
The CreateBackup operation returns while the backup's lifecycle state is\n still CREATING. You can check the backup creation status by calling the\n DescribeBackups operation, which returns the backup state along with other\n information.
(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent creation. This string is automatically filled on your behalf when you use the\n Command Line Interface (CLI) or an Amazon Web Services SDK.
", + "smithy.api#documentation": "(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to\n ensure idempotent creation. This string is automatically filled on your behalf when you\n use the Command Line Interface (CLI) or an Amazon Web Services SDK.
", "smithy.api#idempotencyToken": {} } }, "Tags": { "target": "com.amazonaws.fsx#Tags", "traits": { - "smithy.api#documentation": "(Optional) The tags to apply to the backup at backup creation. The key value of the\n Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and \n you specify one or more tags using the CreateBackup action, no existing file system tags are copied from the file system to the backup.
(Optional) The tags to apply to the backup at backup creation. The key value of the\n Name tag appears in the console as the backup name. If you have set\n CopyTagsToBackups to true, and you specify one or more\n tags using the CreateBackup operation, no existing file system tags are\n copied from the file system to the backup.
The ID of he FSx for NetApp ONTAP volume to back up.
" + "smithy.api#documentation": "(Optional) The ID of the FSx for ONTAP volume to back up.
" } } }, @@ -1080,6 +1163,102 @@ "smithy.api#documentation": "The response object for the CreateBackup operation.
Creates an Amazon FSx for Lustre data repository association (DRA). A data\n repository association is a link between a directory on the file system and\n an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository\n associations on a file system. Data repository associations are supported only\n for file systems with the Persistent_2 deployment type.
Each data repository association must have a unique Amazon FSx file\n system directory and a unique S3 bucket or prefix associated with it. You\n can configure a data repository association for automatic import only,\n for automatic export only, or for both. To learn more about linking a\n data repository to your file system, see \n Linking your file system to an S3 bucket.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.fsx#CreateDataRepositoryAssociationRequest": { + "type": "structure", + "members": { + "FileSystemId": { + "target": "com.amazonaws.fsx#FileSystemId", + "traits": { + "smithy.api#required": {} + } + }, + "FileSystemPath": { + "target": "com.amazonaws.fsx#Namespace", + "traits": { + "smithy.api#documentation": "A path on the file system that points to a high-level directory (such\n as /ns1/) or subdirectory (such as /ns1/subdir/)\n that will be mapped 1-1 with DataRepositoryPath.\n The leading forward slash in the name is required. Two data repository\n associations cannot have overlapping file system paths. For example, if\n a data repository is associated with file system path /ns1/,\n then you cannot link another data repository with file system\n path /ns1/ns2.
This path specifies where in your file system files will be exported\n from or imported to. This file system directory can be linked to only one\n Amazon S3 bucket, and no other S3 bucket can be linked to the directory.
", + "smithy.api#required": {} + } + }, + "DataRepositoryPath": { + "target": "com.amazonaws.fsx#ArchivePath", + "traits": { + "smithy.api#documentation": "The path to the Amazon S3 data repository that will be linked to the file\n system. The path can be an S3 bucket or prefix in the format\n s3://myBucket/myPrefix/. This path specifies where in the S3\n data repository files will be imported from or exported to.
Set to true to run an import data repository task to import\n metadata from the data repository to the file system after the data repository\n association is created. Default is false.
For files imported from a data repository, this value determines the stripe count and\n maximum amount of data per file (in MiB) stored on a single physical disk. The maximum\n number of disks that a single file can be striped across is limited by the total number\n of disks that make up the file system.
\n \nThe default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500\n GiB). Amazon S3 objects have a maximum size of 5 TB.
" + } + }, + "S3": { + "target": "com.amazonaws.fsx#S3DataRepositoryConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for an Amazon S3 data repository linked to an\n Amazon FSx Lustre file system with a data repository association.\n The configuration defines which file events (new, changed, or\n deleted files or directories) are automatically imported from\n the linked data repository to the file system or automatically\n exported from the file system to the data repository.
" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.fsx#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {} + } + }, + "Tags": { + "target": "com.amazonaws.fsx#Tags" + } + } + }, + "com.amazonaws.fsx#CreateDataRepositoryAssociationResponse": { + "type": "structure", + "members": { + "Association": { + "target": "com.amazonaws.fsx#DataRepositoryAssociation", + "traits": { + "smithy.api#documentation": "The response object returned after the data repository association is created.
" + } + } + } + }, "com.amazonaws.fsx#CreateDataRepositoryTask": { "type": "operation", "input": { @@ -1112,7 +1291,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Amazon FSx for Lustre data repository task. You use data repository tasks\n to perform bulk operations between your Amazon FSx file system and its linked data\n repository. An example of a data repository task is\n exporting any data and metadata changes, including POSIX metadata, to files, directories, and symbolic links (symlinks) from your FSx file system to its linked data repository. A\n CreateDataRepositoryTask operation will fail if a data repository is not\n linked to the FSx file system. To learn more about data repository tasks, see \n Data Repository Tasks. \n To learn more about linking a data repository to your file system, see \n Linking your file system to an S3 bucket.
Creates an Amazon FSx for Lustre data repository task. You use data repository tasks\n to perform bulk operations between your Amazon FSx file system and its linked data\n repositories. An example of a data repository task is exporting any data and metadata\n changes, including POSIX metadata, to files, directories, and symbolic links (symlinks)\n from your FSx file system to a linked data repository. A CreateDataRepositoryTask\n operation will fail if a data repository is not linked to the FSx file system. To learn\n more about data repository tasks, see \n Data Repository Tasks. \n To learn more about linking a data repository to your file system, see \n Linking your file system to an S3 bucket.
Creates a new, empty Amazon FSx file system.
\n\nIf a file system with the specified client request token exists and the parameters\n match, CreateFileSystem returns the description of the existing file\n system. If a file system specified client request token exists and the parameters\n don't match, this call returns IncompatibleParameterError. If a file\n system with the specified client request token doesn't exist,\n CreateFileSystem does the following:
Creates a new, empty Amazon FSx file system with an assigned ID, and an\n initial lifecycle state of CREATING.
Returns the description of the file system.
\nThis operation requires a client request token in the request that Amazon FSx uses\n to ensure idempotent creation. This means that calling the operation multiple times with\n the same client request token has no effect. By using the idempotent operation, you can\n retry a CreateFileSystem operation without the risk of creating an extra\n file system. This approach can be useful when an initial call fails in a way that makes\n it unclear whether a file system was created. Examples are if a transport level timeout\n occurred, or your connection was reset. If you use the same client request token and the\n initial call created a file system, the client receives success as long as the\n parameters are the same.
The CreateFileSystem call returns while the file system's\n lifecycle state is still CREATING. You can check the file-system\n creation status by calling the DescribeFileSystems operation,\n which returns the file system state along with other information.
Creates a new, empty Amazon FSx file system. You can create the following supported \n Amazon FSx file systems using the CreateFileSystem API operation:
Amazon FSx for Lustre
\nAmazon FSx for NetApp ONTAP
\nAmazon FSx for Windows File Server
\nThis operation requires a client request token in the request that Amazon FSx uses\n to ensure idempotent creation. This means that calling the operation multiple times with\n the same client request token has no effect. By using the idempotent operation, you can\n retry a CreateFileSystem operation without the risk of creating an extra\n file system. This approach can be useful when an initial call fails in a way that makes\n it unclear whether a file system was created. Examples are if a transport level timeout\n occurred, or your connection was reset. If you use the same client request token and the\n initial call created a file system, the client receives success as long as the\n parameters are the same.
If a file system with the specified client request token exists and the parameters\n match, CreateFileSystem returns the description of the existing file\n system. If a file system with the specified client request token exists and the\n parameters don't match, this call returns IncompatibleParameterError. If a\n file system with the specified client request token doesn't exist,\n CreateFileSystem does the following:
Creates a new, empty Amazon FSx file system with an assigned ID, and\n an initial lifecycle state of CREATING.
Returns the description of the file system.
\nThis operation requires a client request token in the request that Amazon FSx\n uses to ensure idempotent creation. This means that calling the operation multiple times\n with the same client request token has no effect. By using the idempotent operation, you\n can retry a CreateFileSystem operation without the risk of creating an\n extra file system. This approach can be useful when an initial call fails in a way that\n makes it unclear whether a file system was created. Examples are if a transport-level\n timeout occurred, or your connection was reset. If you use the same client request token\n and the initial call created a file system, the client receives a success message as\n long as the parameters are the same.
The CreateFileSystem call returns while the file system's lifecycle\n state is still CREATING. You can check the file-system creation status\n by calling the DescribeFileSystems operation, which returns the file system state\n along with other information.
Creates a new Amazon FSx for Lustre or Amazon FSx for Windows File Server file system\n from an existing Amazon FSx backup.
\n \nIf a file system with the specified client request token exists and the parameters\n match, this operation returns the description of the file system. If a client\n request token specified by the file system exists and the parameters don't match,\n this call returns IncompatibleParameterError. If a file system with the\n specified client request token doesn't exist, this operation does the following:
Creates a new Amazon FSx file system from backup with an assigned ID, and\n an initial lifecycle state of CREATING.
Returns the description of the file system.
\nParameters like Active Directory, default share name, automatic backup, and backup\n settings default to the parameters of the file system that was backed up, unless\n overridden. You can explicitly supply other settings.
\n\nBy using the idempotent operation, you can retry a\n CreateFileSystemFromBackup call without the risk of creating an extra\n file system. This approach can be useful when an initial call fails in a way that makes\n it unclear whether a file system was created. Examples are if a transport level timeout\n occurred, or your connection was reset. If you use the same client request token and the\n initial call created a file system, the client receives success as long as the\n parameters are the same.
The CreateFileSystemFromBackup call returns while the file\n system's lifecycle state is still CREATING. You can check the\n file-system creation status by calling the DescribeFileSystems\n operation, which returns the file system state along with other\n information.
Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File\n Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.
\n \nIf a file system with the specified client request token exists and the parameters\n match, this operation returns the description of the file system. If a client request\n token with the specified by the file system exists and the parameters don't match, this\n call returns IncompatibleParameterError. If a file system with the\n specified client request token doesn't exist, this operation does the following:
Creates a new Amazon FSx file system from backup with an assigned ID,\n and an initial lifecycle state of CREATING.
Returns the description of the file system.
\nParameters like the Active Directory, default share name, automatic backup, and backup\n settings default to the parameters of the file system that was backed up, unless\n overridden. You can explicitly supply other settings.
\n\nBy using the idempotent operation, you can retry a\n CreateFileSystemFromBackup call without the risk of creating an extra\n file system. This approach can be useful when an initial call fails in a way that makes\n it unclear whether a file system was created. Examples are if a transport level timeout\n occurred, or your connection was reset. If you use the same client request token and the\n initial call created a file system, the client receives a success message as long as the\n parameters are the same.
The CreateFileSystemFromBackup call returns while the file system's\n lifecycle state is still CREATING. You can check the file-system\n creation status by calling the \n DescribeFileSystems operation, which returns the file system state along\n with other information.
A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent creation. This string is automatically filled on your behalf when you use the\n Command Line Interface (CLI) or an Amazon Web Services SDK.
", + "smithy.api#documentation": "A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent creation. This string is automatically filled on your behalf when you use the\n Command Line Interface (CLI) or an Amazon Web Services SDK.
", "smithy.api#idempotencyToken": {} } }, "SubnetIds": { "target": "com.amazonaws.fsx#SubnetIds", "traits": { - "smithy.api#documentation": "Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 \n file system deployment types, provide exactly two subnet IDs, one for the preferred file server \n and one for the standby file server. You specify one of these subnets as the preferred subnet \n using the WindowsConfiguration > PreferredSubnetID property.
For Windows SINGLE_AZ_1 and SINGLE_AZ_2 deployment \n types and Lustre file systems, provide exactly one subnet ID.\n The file server is launched in that subnet's Availability Zone.
Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 \n file system deployment types, provide exactly two subnet IDs, one for the preferred file server \n and one for the standby file server. You specify one of these subnets as the preferred subnet \n using the WindowsConfiguration > PreferredSubnetID property.
Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment\n types, Lustre file systems, and OpenZFS file systems provide exactly one subnet ID. The\n file server is launched in that subnet's Availability Zone.
A list of IDs for the security groups that apply to the specified network\n interfaces created for file system access. These security groups apply to all network\n interfaces. This value isn't returned in later DescribeFileSystem requests.
" + "smithy.api#documentation": "A list of IDs for the security groups that apply to the specified network interfaces\n created for file system access. These security groups apply to all network interfaces.\n This value isn't returned in later DescribeFileSystem requests.
Sets the storage type for the Windows file system you're creating from a backup. \n Valid values are SSD and HDD.
Set to SSD to use solid state drive storage. \n Supported on all Windows deployment types.
Set to HDD to use hard disk drive storage. \n Supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types. \n
\n Default value is SSD. \n
HDD and SSD storage types have different minimum storage capacity requirements. \n A restored file system's storage capacity is tied to the file system that was backed up. \n You can create a file system that uses HDD storage from a backup of a file system that \n used SSD storage only if the original SSD file system had a storage capacity of at least 2000 GiB. \n
\nSets the storage type for the Windows or OpenZFS file system that you're creating from\n a backup. Valid values are SSD and HDD.
Set to SSD to use solid state drive storage. SSD is supported on all Windows and OpenZFS\n deployment types.
Set to HDD to use hard disk drive storage. \n HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 FSx for Windows File Server file system deployment types.
The default value is SSD.
HDD and SSD storage types have different minimum storage capacity requirements. \n A restored file system's storage capacity is tied to the file system that was backed up. \n You can create a file system that uses HDD storage from a backup of a file system that \n used SSD storage if the original SSD file system had a storage capacity of at least 2000 GiB.
\nSets the version for the Amazon FSx for Lustre file system you're creating from a backup.\n Valid values are 2.10 and 2.12.
You don't need to specify FileSystemTypeVersion because it will\n be applied using the backup's FileSystemTypeVersion setting.\n If you choose to specify FileSystemTypeVersion when creating from backup, the\n value must match the backup's FileSystemTypeVersion setting.
Sets the version for the Amazon FSx for Lustre file system that you're\n creating from a backup. Valid values are 2.10 and 2.12.
You don't need to specify FileSystemTypeVersion because it will\n be applied using the backup's FileSystemTypeVersion setting.\n If you choose to specify FileSystemTypeVersion when creating from backup, the\n value must match the backup's FileSystemTypeVersion setting.
The OpenZFS configuration for the file system that's being created.
" } } }, @@ -1342,37 +1527,37 @@ "ImportPath": { "target": "com.amazonaws.fsx#ArchivePath", "traits": { - "smithy.api#documentation": "(Optional) The path to the Amazon S3 bucket (including the optional prefix) that\n you're using as the data repository for your Amazon FSx for Lustre file system.\n The root of your FSx for Lustre file system will\n be mapped to the root of the Amazon S3 bucket you select. An\n example is s3://import-bucket/optional-prefix. If you specify a prefix\n after the Amazon S3 bucket name, only object keys with that prefix are loaded into the\n file system.
(Optional) The path to the Amazon S3 bucket (including the optional prefix) that\n you're using as the data repository for your Amazon FSx for Lustre file system.\n The root of your FSx for Lustre file system will\n be mapped to the root of the Amazon S3 bucket you select. An\n example is s3://import-bucket/optional-prefix. If you specify a prefix\n after the Amazon S3 bucket name, only object keys with that prefix are loaded into the\n file system.
This parameter is not supported for file systems with the Persistent_2 deployment type.\n Instead, use CreateDataRepositoryAssociation to create\n a data repository association to link your Lustre file system to a data repository.
(Optional) The path in Amazon S3 where the root of your Amazon FSx file system is exported. \n The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which\n new and changed data is to be exported from your Amazon FSx for Lustre file system. If\n an ExportPath value is not provided, Amazon FSx sets a default export path,\n s3://import-bucket/FSxLustre[creation-timestamp]. The timestamp is in\n UTC format, for example\n s3://import-bucket/FSxLustre20181105T222312Z.
The Amazon S3 export bucket must be the same as the import bucket specified by\n ImportPath. If you only specify a bucket name, such as\n s3://import-bucket, you get a 1:1 mapping of file system objects to S3\n bucket objects. This mapping means that the input data in S3 is overwritten on export.\n If you provide a custom prefix in the export path, such as\n s3://import-bucket/[custom-optional-prefix], Amazon FSx exports the contents of your file \n system to that export prefix in the Amazon S3 bucket.
(Optional) Available with Scratch and Persistent_1 deployment types. \n Specifies the path in the Amazon S3 bucket where the root of your Amazon FSx file system is exported. \n The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which\n new and changed data is to be exported from your Amazon FSx for Lustre file system. If\n an ExportPath value is not provided, Amazon FSx sets a default export path,\n s3://import-bucket/FSxLustre[creation-timestamp]. The timestamp is in\n UTC format, for example\n s3://import-bucket/FSxLustre20181105T222312Z.
The Amazon S3 export bucket must be the same as the import bucket specified by\n ImportPath. If you specify only a bucket name, such as\n s3://import-bucket, you get a 1:1 mapping of file system objects to S3\n bucket objects. This mapping means that the input data in S3 is overwritten on export.\n If you provide a custom prefix in the export path, such as\n s3://import-bucket/[custom-optional-prefix], Amazon FSx exports the contents of your file \n system to that export prefix in the Amazon S3 bucket.
This parameter is not supported for file systems with the Persistent_2 deployment type.\n Instead, use CreateDataRepositoryAssociation to create\n a data repository association to link your Lustre file system to a data repository.
(Optional) For files imported from a data repository, this value determines the stripe\n count and maximum amount of data per file (in MiB) stored on a single physical disk. The\n maximum number of disks that a single file can be striped across is limited by the total\n number of disks that make up the file system.
\n \nThe default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500\n GiB). Amazon S3 objects have a maximum size of 5 TB.
" + "smithy.api#documentation": "(Optional) For files imported from a data repository, this value determines the stripe\n count and maximum amount of data per file (in MiB) stored on a single physical disk. The\n maximum number of disks that a single file can be striped across is limited by the total\n number of disks that make up the file system.
\n \nThe default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500\n GiB). Amazon S3 objects have a maximum size of 5 TB.
\nThis parameter is not supported for file systems with the Persistent_2 deployment type.\n Instead, use CreateDataRepositoryAssociation to create\n a data repository association to link your Lustre file system to a data repository.
\n Choose SCRATCH_1 and SCRATCH_2 deployment \n types when you need temporary storage and shorter-term processing of data. \n The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst \n throughput capacity than SCRATCH_1.
Choose PERSISTENT_1 deployment type for longer-term storage \n and workloads and encryption of data in transit. To learn more about deployment types, see \n \n FSx for Lustre Deployment Options.
Encryption of data in-transit is automatically \n enabled when you access a SCRATCH_2 or PERSISTENT_1\n file system from Amazon EC2 instances that support this feature.\n (Default = SCRATCH_1)\n
Encryption of data in-transit for SCRATCH_2 and PERSISTENT_1 \n deployment types is supported when accessed from supported instance types in supported Amazon Web Services Regions. To learn more, \n Encrypting Data in Transit.
(Optional) Choose SCRATCH_1 and SCRATCH_2 deployment \n types when you need temporary storage and shorter-term processing of data. \n The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst \n throughput capacity than SCRATCH_1.
Choose PERSISTENT_1 for longer-term storage and for throughput-focused \n workloads that aren’t latency-sensitive. a. \n PERSISTENT_1 supports encryption of data in transit, and is available in all \n Amazon Web Services Regions in which FSx for Lustre is available.
Choose PERSISTENT_2 for longer-term storage and for latency-sensitive workloads \n that require the highest levels of IOPS/throughput. PERSISTENT_2 supports \n SSD storage, and offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB). PERSISTENT_2 \n is available in a limited number of Amazon Web Services Regions. \n For more information, and an up-to-date list of Amazon Web Services Regions in which \n PERSISTENT_2 is available, see \n File \n system deployment options for FSx for Lustre in the Amazon FSx for Lustre User Guide.
If you choose PERSISTENT_2, and you set FileSystemTypeVersion to\n 2.10, the CreateFileSystem operation fails.
Encryption of data in transit is automatically turned on when you access\n SCRATCH_2, PERSISTENT_1 and PERSISTENT_2 file\n systems from Amazon EC2 instances that support\n automatic encryption in the Amazon Web Services Regions where they are\n available. For more information about encryption in transit for FSx for Lustre\n file systems, see Encrypting data in\n transit in the Amazon FSx for Lustre User Guide.
(Default = SCRATCH_1)
(Optional) When you create your file system, your existing S3 objects appear as file and directory listings. \n Use this property to choose how Amazon FSx keeps your file and directory listings up to date \n as you add or modify objects in your linked S3 bucket. AutoImportPolicy can\n have the following values:
\n NONE - (Default) AutoImport is off. Amazon FSx only updates \n file and directory listings from the linked S3 bucket \n when the file system is created. FSx does not update file and directory \n listings for any new or changed objects after choosing this option.
\n NEW - AutoImport is on. Amazon FSx automatically imports\n directory listings of any new objects added to the linked S3 bucket that \n do not currently exist in the FSx file system.
\n NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports \n file and directory listings of any new objects added to the S3 bucket and any \n existing objects that are changed in the S3 bucket after you choose this option. \n
For more information, see Automatically import updates from your S3 bucket.
" + "smithy.api#documentation": " (Optional) Available with Scratch and Persistent_1 deployment types. When you \n create your file system, your existing S3 objects appear as file and directory listings. \n Use this property to choose how Amazon FSx keeps your file and directory listings up to date \n as you add or modify objects in your linked S3 bucket. AutoImportPolicy can\n have the following values:
\n NONE - (Default) AutoImport is off. Amazon FSx only updates \n file and directory listings from the linked S3 bucket \n when the file system is created. FSx does not update file and directory \n listings for any new or changed objects after choosing this option.
\n NEW - AutoImport is on. Amazon FSx automatically imports\n directory listings of any new objects added to the linked S3 bucket that \n do not currently exist in the FSx file system.
\n NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports \n file and directory listings of any new objects added to the S3 bucket and any \n existing objects that are changed in the S3 bucket after you choose this option.
\n NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically\n imports file and directory listings of any new objects added to the S3 bucket, any \n existing objects that are changed in the S3 bucket, and any objects that were deleted\n in the S3 bucket.
For more information, see \n Automatically import updates from your S3 bucket.
\nThis parameter is not supported for file systems with the Persistent_2 deployment type.\n Instead, use CreateDataRepositoryAssociation\" to create\n a data repository association to link your Lustre file system to a data repository.
\n Required for the PERSISTENT_1 deployment type, describes the amount of read and write \n throughput for each 1 tebibyte of storage, in MB/s/TiB. \n File system throughput capacity is calculated by multiplying file system storage capacity (TiB) by the PerUnitStorageThroughput\n (MB/s/TiB). For a 2.4 TiB file system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput\n yields 120 MB/s of file system throughput. You pay for the amount of throughput that you\n provision.\n
Valid values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40.
" + "smithy.api#documentation": "Required with PERSISTENT_1 and PERSISTENT_2 deployment\n types, provisions the amount of read and write throughput for each 1 tebibyte (TiB) of\n file system storage capacity, in MB/s/TiB. File system throughput capacity is calculated\n by multiplying file system storage capacity (TiB) by the\n PerUnitStorageThroughput (MB/s/TiB). For a 2.4-TiB file system,\n provisioning 50 MB/s/TiB of PerUnitStorageThroughput yields 120 MB/s of file\n system throughput. You pay for the amount of throughput that you provision.
Valid values:
\nFor PERSISTENT_1 SSD storage: 50, 100, 200 MB/s/TiB.
For PERSISTENT_1 HDD storage: 12, 40 MB/s/TiB.
For PERSISTENT_2 SSD storage: 125, 250, 500, 1000 MB/s/TiB.
(Optional) Not available to use with file systems that are linked to a data repository. \n A boolean flag indicating whether tags for the file system should be copied to\n backups. The default value is false. If it's set to true, all file system\n tags are copied to all automatic and user-initiated backups when the user\n doesn't specify any backup-specific tags. If this value is true, and you specify one or more backup tags, only\n the specified tags are copied to backups. If you specify one or more tags when creating a\n user-initiated backup, no tags are copied from the file system, regardless of this value.
\nFor more information, see Working with backups.
" + "smithy.api#documentation": "(Optional) Not available for use with file systems that are linked to a data\n repository. A boolean flag indicating whether tags for the file system should be copied\n to backups. The default value is false. If CopyTagsToBackups is set to\n true, all file system tags are copied to all automatic and user-initiated backups when\n the user doesn't specify any backup-specific tags. If\n CopyTagsToBackups is set to true and you specify one or more backup\n tags, only the specified tags are copied to backups. If you specify one or more tags\n when creating a user-initiated backup, no tags are copied from the file system,\n regardless of this value.
(Default = false)
For more information, see \n Working with backups in the Amazon FSx for Lustre User Guide.
" } }, "DriveCacheType": { "target": "com.amazonaws.fsx#DriveCacheType", "traits": { - "smithy.api#documentation": "The type of drive cache used by PERSISTENT_1 file systems that are provisioned with\n HDD storage devices. This parameter is required when storage type is HDD. Set to\n READ, improve the performance for frequently accessed files and allows 20%\n of the total storage capacity of the file system to be cached.
This parameter is required when StorageType is set to HDD.
The type of drive cache used by PERSISTENT_1 file systems that are provisioned with\n HDD storage devices. This parameter is required when storage type is HDD. Set this property to\n READ to improve the performance for frequently accessed files by caching up to 20%\n of the total storage capacity of the file system.
This parameter is required when StorageType is set to HDD.
Sets the data compression configuration for the file system. DataCompressionType\n can have the following values:
\n NONE - (Default) Data compression is turned off when\n the file system is created.
\n LZ4 - Data compression is turned on with the LZ4\n algorithm.
For more information, see Lustre data compression.
" + "smithy.api#documentation": "Sets the data compression configuration for the file system. DataCompressionType\n can have the following values:
\n NONE - (Default) Data compression is turned off when\n the file system is created.
\n LZ4 - Data compression is turned on with the LZ4\n algorithm.
For more information, see Lustre data compression \n in the Amazon FSx for Lustre User Guide.
" + } + }, + "LogConfiguration": { + "target": "com.amazonaws.fsx#LustreLogCreateConfiguration", + "traits": { + "smithy.api#documentation": "The Lustre logging configuration used when creating an Amazon FSx for Lustre\n file system. When logging is enabled, Lustre logs error and warning events for data repositories\n associated with your file system to Amazon CloudWatch Logs.
" } } }, "traits": { - "smithy.api#documentation": "The Lustre configuration for the file system being created. \n
" + "smithy.api#documentation": "The Lustre configuration for the file system being created.
\nThe following parameters are not supported for file systems with the Persistent_2\n deployment type. Instead, use CreateDataRepositoryAssociation \n to create a data repository association to link your Lustre file system to a data repository.
\n AutoImportPolicy\n
\n ExportPath\n
\n ImportedChunkSize\n
\n ImportPath\n
Specifies the ONTAP file system deployment type to use in creating the file system.
", + "smithy.api#documentation": "Specifies the FSx for ONTAP file system deployment type to use in creating the file system. \n MULTI_AZ_1 is the supported ONTAP deployment type.
The ONTAP administrative password for the fsxadmin user that you can\n use to administer your file system using the ONTAP CLI and REST API.
The ONTAP administrative password for the fsxadmin user with which you\n administer your file system using the NetApp ONTAP CLI and REST API.
The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system.
" + "smithy.api#documentation": "The SSD IOPS configuration for the FSx for ONTAP file system.
" } }, "PreferredSubnetId": { - "target": "com.amazonaws.fsx#SubnetId" + "target": "com.amazonaws.fsx#SubnetId", + "traits": { + "smithy.api#documentation": "Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet \n in which you want the preferred file server to be located.
Specifies the VPC route tables in which your file system's endpoints will be\n created. You should specify all VPC route tables associated with the subnets\n in which your clients are located. By default, Amazon FSx selects your VPC's\n default route table.
" + "smithy.api#documentation": "Specifies the virtual private cloud (VPC) route tables in which your file system's\n endpoints will be created. You should specify all VPC route tables associated with the\n subnets in which your clients are located. By default, Amazon FSx selects your VPC's\n default route table.
" + } + }, + "ThroughputCapacity": { + "target": "com.amazonaws.fsx#MegabytesPerSecond", + "traits": { + "smithy.api#documentation": "Sets the throughput capacity for the file system that you're creating. \n Valid values are 512, 1024, and 2048 MBps.
", + "smithy.api#required": {} + } + }, + "WeeklyMaintenanceStartTime": { + "target": "com.amazonaws.fsx#WeeklyTime" + } + }, + "traits": { + "smithy.api#documentation": "The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
" + } + }, + "com.amazonaws.fsx#CreateFileSystemOpenZFSConfiguration": { + "type": "structure", + "members": { + "AutomaticBackupRetentionDays": { + "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays" + }, + "CopyTagsToBackups": { + "target": "com.amazonaws.fsx#Flag", + "traits": { + "smithy.api#documentation": "A Boolean value indicating whether tags for the file system should be copied to\n backups. This value defaults to false. If it's set to true,\n all tags for the file system are copied to all automatic and user-initiated backups\n where the user doesn't specify tags. If this value is true, and you specify\n one or more tags, only the specified tags are copied to backups. If you specify one or\n more tags when creating a user-initiated backup, no tags are copied from the file\n system, regardless of this value.
A Boolean value indicating whether tags for the volume should be copied to snapshots.\n This value defaults to false. If it's set to true, all tags\n for the volume are copied to snapshots where the user doesn't specify tags. If this\n value is true, and you specify one or more tags, only the specified tags\n are copied to snapshots. If you specify one or more tags when creating the snapshot, no\n tags are copied from the volume, regardless of this value.
Specifies the file system deployment type. Amazon FSx for OpenZFS supports\n SINGLE_AZ_1. SINGLE_AZ_1 is a file system configured for a\n single Availability Zone (AZ) of redundancy.
Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second\n (MB/s). Valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s. \n You pay for additional throughput capacity that you provision.
", "smithy.api#required": {} } }, "WeeklyMaintenanceStartTime": { "target": "com.amazonaws.fsx#WeeklyTime" + }, + "DiskIopsConfiguration": { + "target": "com.amazonaws.fsx#DiskIopsConfiguration" + }, + "RootVolumeConfiguration": { + "target": "com.amazonaws.fsx#OpenZFSCreateRootVolumeConfiguration", + "traits": { + "smithy.api#documentation": "The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS\n file system. All volumes are children of the root volume.
" + } } }, "traits": { - "smithy.api#documentation": "The ONTAP configuration properties of the FSx for NetApp ONTAP file system that you are creating.
" + "smithy.api#documentation": "The OpenZFS configuration properties for the file system that you are creating.
" } }, "com.amazonaws.fsx#CreateFileSystemRequest": { @@ -1467,34 +1714,34 @@ "ClientRequestToken": { "target": "com.amazonaws.fsx#ClientRequestToken", "traits": { - "smithy.api#documentation": "A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent creation. This string is automatically filled on your behalf when you use the\n Command Line Interface (CLI) or an Amazon Web Services SDK.
", + "smithy.api#documentation": "A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent creation. This string is automatically filled on your behalf when you use the\n Command Line Interface (CLI) or an Amazon Web Services SDK.
", "smithy.api#idempotencyToken": {} } }, "FileSystemType": { "target": "com.amazonaws.fsx#FileSystemType", "traits": { - "smithy.api#documentation": "The type of Amazon FSx file system to create. Valid values are WINDOWS,\n LUSTRE, and ONTAP.
The type of Amazon FSx file system to create. Valid values are\n WINDOWS, LUSTRE, ONTAP, and\n OPENZFS.
Sets the storage capacity of the file system that you're creating.
\nFor Lustre file systems:
\nFor SCRATCH_2 and PERSISTENT_1 SSD deployment types, valid values are \n 1200 GiB, 2400 GiB, and increments of 2400 GiB.
For PERSISTENT HDD file systems, valid values are increments of 6000 GiB for \n 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.
For SCRATCH_1 deployment type, valid values are \n 1200 GiB, 2400 GiB, and increments of 3600 GiB.
For Windows file systems:
\nIf StorageType=SSD, valid values are 32 GiB - 65,536 GiB (64 TiB).
If StorageType=HDD, valid values are 2000 GiB - 65,536 GiB (64 TiB).
For ONTAP file systems:
\nValid values are 1024 GiB - 196,608 GiB (192 TiB).
\nSets the storage capacity of the file system that you're creating, in gibibytes (GiB).
\n\n FSx for Lustre file systems - The amount of\n storage capacity that you can configure depends on the value that you set for\n StorageType and the Lustre DeploymentType, as\n follows:
For SCRATCH_2, PERSISTENT_2 and PERSISTENT_1 deployment types \n using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
For PERSISTENT_1 HDD file systems, valid values are increments of 6000 GiB for \n 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.
For SCRATCH_1 deployment type, valid values are \n 1200 GiB, 2400 GiB, and increments of 3600 GiB.
\n FSx for ONTAP file systems - The amount of storage capacity \n that you can configure is from 1024 GiB up to 196,608 GiB (192 TiB).
\n\n FSx for OpenZFS file systems - The amount of storage capacity that \n you can configure is from 64 GiB up to 524,288 GiB (512 TiB).
\n\n FSx for Windows File Server file systems - The amount\n of storage capacity that you can configure depends on the value that you set for\n StorageType as follows:
For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
\nFor HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).
\nSets the storage type for the file system you're creating. \n Valid values are SSD and HDD.
Set to SSD to use solid state drive storage. \n SSD is supported on all Windows, Lustre, and ONTAP deployment types.
Set to HDD to use hard disk drive storage. \n HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types,\n and on PERSISTENT Lustre file system deployment types. \n
\n Default value is SSD. For more information, see \n \n Storage Type Options in the Amazon FSx for Windows User Guide and \n Multiple Storage Options \n in the Amazon FSx for Lustre User Guide.\n
Sets the storage type for the file system that you're creating. Valid values are\n SSD and HDD.
Set to SSD to use solid state drive storage. SSD is supported on all Windows,\n Lustre, ONTAP, and OpenZFS deployment types.
Set to HDD to use hard disk drive storage. \n HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types,\n and on PERSISTENT Lustre file system deployment types. \n
Default value is SSD. For more information, see Storage\n type options in the FSx for Windows File Server User\n Guide and Multiple storage\n options in the FSx for Lustre User\n Guide.
Specifies the IDs of the subnets that the file system will be accessible from. For Windows\n and ONTAP MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs,\n one for the preferred file server and one for the standby file server. You specify one of these\n subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID\n or OntapConfiguration > PreferredSubnetID properties. For more information, \n see \n Availability and durability: Single-AZ and Multi-AZ file systems in the\n Amazon FSx for Windows User Guide and\n \n Availability and durability in the\n Amazon FSx for ONTAP User Guide.
For Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types and Lustre file systems, provide exactly one subnet ID.\n The file server is launched in that subnet's Availability Zone.
Specifies the IDs of the subnets that the file system will be accessible from. For\n Windows and ONTAP MULTI_AZ_1 deployment types,provide exactly two subnet\n IDs, one for the preferred file server and one for the standby file server. You specify\n one of these subnets as the preferred subnet using the WindowsConfiguration >\n PreferredSubnetID or OntapConfiguration > PreferredSubnetID\n properties. For more information about Multi-AZ file system configuration, see \n Availability and durability: Single-AZ and Multi-AZ file systems in the\n Amazon FSx for Windows User Guide and \n Availability and durability in the Amazon FSx for ONTAP User\n Guide.
For Windows SINGLE_AZ_1 and SINGLE_AZ_2 and all Lustre \n deployment types, provide exactly one subnet ID.\n The file server is launched in that subnet's Availability Zone.
The tags to apply to the file system being created. The key value of\n the Name tag appears in the console as the file system name.
The tags to apply to the file system that's being created. The key value of the\n Name tag appears in the console as the file system name.
The Microsoft Windows configuration for the file system being created. \n
" + "smithy.api#documentation": "The Microsoft Windows configuration for the file system that's being created.
" } }, "LustreConfiguration": { @@ -1528,7 +1775,13 @@ "FileSystemTypeVersion": { "target": "com.amazonaws.fsx#FileSystemTypeVersion", "traits": { - "smithy.api#documentation": "Sets the version of the Amazon FSx for Lustre file system you're creating.\n Valid values are 2.10 and 2.12.
Set the value to 2.10 to create a Lustre 2.10\n file system.
Set the value to 2.12 to create a Lustre 2.12\n file system.
Default value is 2.10.
(Optional) For FSx for Lustre file systems, sets the Lustre version for the\n file system that you're creating. Valid values are 2.10 and\n 2.12:
2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.
\n2.12 is supported by all Lustre deployment types. 2.12 is \n required when setting FSx for Lustre DeploymentType to \n PERSISTENT_2.
Default value = 2.10, except when DeploymentType is set to \n PERSISTENT_2, then the default is 2.12.
If you set FileSystemTypeVersion to 2.10 for a \n PERSISTENT_2 Lustre deployment type, the CreateFileSystem \n operation fails.
The OpenZFS configuration for the file system that's being created.
" } } }, @@ -1577,7 +1830,7 @@ "ThroughputCapacity": { "target": "com.amazonaws.fsx#MegabytesPerSecond", "traits": { - "smithy.api#documentation": "The throughput of an Amazon FSx file system, measured in megabytes per second, in 2 to\n the nth increments, between 2^3 (8) and 2^11 (2048).
", + "smithy.api#documentation": "Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second (MB/s), in 2 to\n the nth increments, between 2^3 (8) and 2^11 (2048).
", "smithy.api#required": {} } }, @@ -1667,46 +1920,196 @@ "smithy.api#documentation": "Specifies the configuration of the ONTAP volume that you are creating.
" } }, - "com.amazonaws.fsx#CreateStorageVirtualMachine": { - "type": "operation", - "input": { - "target": "com.amazonaws.fsx#CreateStorageVirtualMachineRequest" - }, - "output": { - "target": "com.amazonaws.fsx#CreateStorageVirtualMachineResponse" - }, - "errors": [ - { - "target": "com.amazonaws.fsx#ActiveDirectoryError" - }, - { - "target": "com.amazonaws.fsx#BadRequest" - }, - { - "target": "com.amazonaws.fsx#FileSystemNotFound" - }, - { - "target": "com.amazonaws.fsx#IncompatibleParameterError" - }, - { - "target": "com.amazonaws.fsx#InternalServerError" - }, - { - "target": "com.amazonaws.fsx#ServiceLimitExceeded" + "com.amazonaws.fsx#CreateOpenZFSOriginSnapshotConfiguration": { + "type": "structure", + "members": { + "SnapshotARN": { + "target": "com.amazonaws.fsx#ResourceARN", + "traits": { + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.fsx#UnsupportedOperation" + "CopyStrategy": { + "target": "com.amazonaws.fsx#OpenZFSCopyStrategy", + "traits": { + "smithy.api#documentation": "The strategy used when copying data from the snapshot to the new volume.
\n\n CLONE - The new volume references the data in the origin\n snapshot. Cloning a snapshot is faster than copying data from the snapshot to a\n new volume and doesn't consume disk throughput. However, the origin snapshot\n can't be deleted if there is a volume using its copied data.
\n FULL_COPY - Copies all data from the snapshot to the new volume.\n
Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
" + "smithy.api#documentation": "The snapshot configuration to use when creating an OpenZFS volume from a snapshot.
" } }, - "com.amazonaws.fsx#CreateStorageVirtualMachineRequest": { + "com.amazonaws.fsx#CreateOpenZFSVolumeConfiguration": { "type": "structure", "members": { - "ActiveDirectoryConfiguration": { - "target": "com.amazonaws.fsx#CreateSvmActiveDirectoryConfiguration", + "ParentVolumeId": { + "target": "com.amazonaws.fsx#VolumeId", + "traits": { + "smithy.api#documentation": "The ID of the volume to use as the parent volume.
", + "smithy.api#required": {} + } + }, + "StorageCapacityReservationGiB": { + "target": "com.amazonaws.fsx#IntegerNoMax", + "traits": { + "smithy.api#documentation": "The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't\n reserve more storage than the parent volume has reserved.
" + } + }, + "StorageCapacityQuotaGiB": { + "target": "com.amazonaws.fsx#IntegerNoMax", + "traits": { + "smithy.api#documentation": "The maximum amount of storage in gibibytes (GiB) that the volume can use from its\n parent. You can specify a quota larger than the storage on the parent volume.
" + } + }, + "DataCompressionType": { + "target": "com.amazonaws.fsx#OpenZFSDataCompressionType", + "traits": { + "smithy.api#documentation": "Specifies the method used to compress the data on the volume. Unless the compression\n type is specified, volumes inherit the DataCompressionType value of their\n parent volume.
\n NONE - Doesn't compress the data on the volume.
\n ZSTD - Compresses the data in the volume using the Zstandard\n (ZSTD) compression algorithm. This algorithm reduces the amount of space used on\n your volume and has very little impact on compute resources.
A Boolean value indicating whether tags for the volume should be copied to snapshots.\n This value defaults to false. If it's set to true, all tags\n for the volume are copied to snapshots where the user doesn't specify tags. If this\n value is true, and you specify one or more tags, only the specified tags\n are copied to snapshots. If you specify one or more tags when creating the snapshot, no\n tags are copied from the volume, regardless of this value.
The configuration object that specifies the snapshot to use as the origin of the data\n for the volume.
" + } + }, + "ReadOnly": { + "target": "com.amazonaws.fsx#ReadOnly", + "traits": { + "smithy.api#documentation": "A Boolean value indicating whether the volume is read-only.
" + } + }, + "NfsExports": { + "target": "com.amazonaws.fsx#OpenZFSNfsExports", + "traits": { + "smithy.api#documentation": "The configuration object for mounting a Network File System (NFS) file system.
" + } + }, + "UserAndGroupQuotas": { + "target": "com.amazonaws.fsx#OpenZFSUserAndGroupQuotas", + "traits": { + "smithy.api#documentation": "An object specifying how much storage users or groups can use on the volume.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the configuration of the OpenZFS volume that you are creating.
" + } + }, + "com.amazonaws.fsx#CreateSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.fsx#CreateSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.fsx#CreateSnapshotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fsx#BadRequest" + }, + { + "target": "com.amazonaws.fsx#InternalServerError" + }, + { + "target": "com.amazonaws.fsx#ServiceLimitExceeded" + }, + { + "target": "com.amazonaws.fsx#VolumeNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Creates a snapshot of an existing Amazon FSx for OpenZFS file system. With\n snapshots, you can easily undo file changes and compare file versions by restoring the\n volume to a previous version.
\nIf a snapshot with the specified client request token exists, and the parameters\n match, this operation returns the description of the existing snapshot. If a snapshot\n with the specified client request token exists, and the parameters don't match, this\n operation returns IncompatibleParameterError. If a snapshot with the\n specified client request token doesn't exist, CreateSnapshot does the\n following:
Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle\n state of CREATING.
Returns the description of the snapshot.
\nBy using the idempotent operation, you can retry a CreateSnapshot\n operation without the risk of creating an extra snapshot. This approach can be useful\n when an initial call fails in a way that makes it unclear whether a snapshot was\n created. If you use the same client request token and the initial call created a\n snapshot, the operation returns a successful result because all the parameters are the\n same.
The CreateSnapshot operation returns while the snapshot's lifecycle state\n is still CREATING. You can check the snapshot creation status by calling\n the DescribeSnapshots operation, which returns the snapshot state along with\n other information.
The name of the snapshot.
", + "smithy.api#required": {} + } + }, + "VolumeId": { + "target": "com.amazonaws.fsx#VolumeId", + "traits": { + "smithy.api#documentation": "The ID of the volume that you are taking a snapshot of.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.fsx#Tags" + } + } + }, + "com.amazonaws.fsx#CreateSnapshotResponse": { + "type": "structure", + "members": { + "Snapshot": { + "target": "com.amazonaws.fsx#Snapshot", + "traits": { + "smithy.api#documentation": "A description of the snapshot.
" + } + } + } + }, + "com.amazonaws.fsx#CreateStorageVirtualMachine": { + "type": "operation", + "input": { + "target": "com.amazonaws.fsx#CreateStorageVirtualMachineRequest" + }, + "output": { + "target": "com.amazonaws.fsx#CreateStorageVirtualMachineResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fsx#ActiveDirectoryError" + }, + { + "target": "com.amazonaws.fsx#BadRequest" + }, + { + "target": "com.amazonaws.fsx#FileSystemNotFound" + }, + { + "target": "com.amazonaws.fsx#IncompatibleParameterError" + }, + { + "target": "com.amazonaws.fsx#InternalServerError" + }, + { + "target": "com.amazonaws.fsx#ServiceLimitExceeded" + }, + { + "target": "com.amazonaws.fsx#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
" + } + }, + "com.amazonaws.fsx#CreateStorageVirtualMachineRequest": { + "type": "structure", + "members": { + "ActiveDirectoryConfiguration": { + "target": "com.amazonaws.fsx#CreateSvmActiveDirectoryConfiguration", "traits": { "smithy.api#documentation": "Describes the self-managed Microsoft Active Directory to which you want to join the SVM. \n Joining an Active Directory provides user authentication and access control for SMB clients, \n including Microsoft Windows and macOS client accessing the file system.
" } @@ -1811,7 +2214,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Amazon FSx for NetApp ONTAP storage volume.
" + "smithy.api#documentation": "Creates an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS storage\n volume.
" } }, "com.amazonaws.fsx#CreateVolumeFromBackup": { @@ -1908,25 +2311,31 @@ "VolumeType": { "target": "com.amazonaws.fsx#VolumeType", "traits": { - "smithy.api#documentation": "Specifies the type of volume to create; ONTAP is the only valid volume type.
Specifies the type of volume to create; ONTAP and OPENZFS are\n the only valid volume types.
Specifies the name of the volume you're creating.
", + "smithy.api#documentation": "Specifies the name of the volume that you're creating.
", "smithy.api#required": {} } }, "OntapConfiguration": { "target": "com.amazonaws.fsx#CreateOntapVolumeConfiguration", "traits": { - "smithy.api#documentation": "Specifies the ONTAP configuration to use in creating the volume.
Specifies the configuration to use when creating the ONTAP volume.
" } }, "Tags": { "target": "com.amazonaws.fsx#Tags" + }, + "OpenZFSConfiguration": { + "target": "com.amazonaws.fsx#CreateOpenZFSVolumeConfiguration", + "traits": { + "smithy.api#documentation": "Specifies the configuration to use when creating the OpenZFS volume.
" + } } } }, @@ -1984,13 +2393,124 @@ ] } }, + "com.amazonaws.fsx#DataRepositoryAssociation": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.fsx#DataRepositoryAssociationId", + "traits": { + "smithy.api#documentation": "The system-generated, unique ID of the data repository association.
" + } + }, + "ResourceARN": { + "target": "com.amazonaws.fsx#ResourceARN" + }, + "FileSystemId": { + "target": "com.amazonaws.fsx#FileSystemId" + }, + "Lifecycle": { + "target": "com.amazonaws.fsx#DataRepositoryLifecycle", + "traits": { + "smithy.api#documentation": "Describes the state of a data repository association. The lifecycle can have\n the following values:
\n\n CREATING - The data repository association between \n the FSx file system and the S3 data repository is being created. \n The data repository is unavailable.
\n AVAILABLE - The data repository association is\n available for use.
\n MISCONFIGURED - Amazon FSx cannot automatically import updates\n from the S3 bucket or automatically export updates to the S3 bucket until the data\n repository association configuration is corrected.
\n UPDATING - The data repository association is undergoing\n a customer initiated update that might affect its availability.
\n DELETING - The data repository association is undergoing\n a customer initiated deletion.
\n FAILED - The data repository association is in a terminal\n state that cannot be recovered.
A path on the file system that points to a high-level directory (such\n as /ns1/) or subdirectory (such as /ns1/subdir/)\n that will be mapped 1-1 with DataRepositoryPath.\n The leading forward slash in the name is required. Two data repository\n associations cannot have overlapping file system paths. For example, if\n a data repository is associated with file system path /ns1/,\n then you cannot link another data repository with file system\n path /ns1/ns2.
This path specifies where in your file system files will be exported\n from or imported to. This file system directory can be linked to only one\n Amazon S3 bucket, and no other S3 bucket can be linked to the directory.
" + } + }, + "DataRepositoryPath": { + "target": "com.amazonaws.fsx#ArchivePath", + "traits": { + "smithy.api#documentation": "The path to the Amazon S3 data repository that will be linked to the file\n system. The path can be an S3 bucket or prefix in the format\n s3://myBucket/myPrefix/. This path specifies where in the S3\n data repository files will be imported from or exported to.
A boolean flag indicating whether an import data repository task to import\n metadata should run after the data repository association is created. The\n task runs if this flag is set to true.
For files imported from a data repository, this value determines the stripe count and\n maximum amount of data per file (in MiB) stored on a single physical disk. The maximum\n number of disks that a single file can be striped across is limited by the total number\n of disks that make up the file system.
\n \nThe default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500\n GiB). Amazon S3 objects have a maximum size of 5 TB.
" + } + }, + "S3": { + "target": "com.amazonaws.fsx#S3DataRepositoryConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for an Amazon S3 data repository linked to an\n Amazon FSx Lustre file system with a data repository association.\n The configuration defines which file events (new, changed, or\n deleted files or directories) are automatically imported from\n the linked data repository to the file system or automatically\n exported from the file system to the data repository.
" + } + }, + "Tags": { + "target": "com.amazonaws.fsx#Tags" + }, + "CreationTime": { + "target": "com.amazonaws.fsx#CreationTime" + } + }, + "traits": { + "smithy.api#documentation": "The configuration of a data repository association that links\n an Amazon FSx for Lustre file system to an Amazon S3 bucket.\n The data repository association configuration object is returned \n in the response of the following operations:
\n\n CreateDataRepositoryAssociation\n
\n UpdateDataRepositoryAssociation\n
\n DescribeDataRepositoryAssociations\n
Data repository associations are supported only for file systems\n with the Persistent_2 deployment type.
No data repository associations were found based upon the supplied parameters.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.fsx#DataRepositoryAssociations": { + "type": "list", + "member": { + "target": "com.amazonaws.fsx#DataRepositoryAssociation" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.fsx#DataRepositoryConfiguration": { "type": "structure", "members": { "Lifecycle": { "target": "com.amazonaws.fsx#DataRepositoryLifecycle", "traits": { - "smithy.api#documentation": "Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. \n The lifecycle can have the following values:
\n\n CREATING - The data repository configuration between \n the FSx file system and the linked S3 data repository is being created. \n The data repository is unavailable.
\n AVAILABLE - The data repository is available for use.
\n MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket \n until the data repository configuration is corrected. For more information, see \n Troubleshooting a Misconfigured linked S3 bucket.\n
\n UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.
Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. \n The lifecycle can have the following values:
\n\n CREATING - The data repository configuration between \n the FSx file system and the linked S3 data repository is being created. \n The data repository is unavailable.
\n AVAILABLE - The data repository is available for use.
\n MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket \n until the data repository configuration is corrected. For more information, see \n Troubleshooting a Misconfigured linked S3 bucket.\n
\n UPDATING - The data repository is undergoing a customer\n initiated update and availability may be impacted.
\n FAILED - The data repository is in a terminal state that\n cannot be recovered.
Describes the file system's linked S3 data repository's AutoImportPolicy. \n The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date \n as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:
\n NONE - (Default) AutoImport is off. Amazon FSx only updates \n file and directory listings from the linked S3 bucket \n when the file system is created. FSx does not update file and directory \n listings for any new or changed objects after choosing this option.
\n NEW - AutoImport is on. Amazon FSx automatically imports\n directory listings of any new objects added to the linked S3 bucket that \n do not currently exist in the FSx file system.
\n NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports \n file and directory listings of any new objects added to the S3 bucket and any \n existing objects that are changed in the S3 bucket after you choose this option. \n
For more information, see Automatically import updates from your S3 bucket.
" + "smithy.api#documentation": "Describes the file system's linked S3 data repository's AutoImportPolicy. \n The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date \n as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:
\n NONE - (Default) AutoImport is off. Amazon FSx only updates \n file and directory listings from the linked S3 bucket \n when the file system is created. FSx does not update file and directory \n listings for any new or changed objects after choosing this option.
\n NEW - AutoImport is on. Amazon FSx automatically imports\n directory listings of any new objects added to the linked S3 bucket that \n do not currently exist in the FSx file system.
\n NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports \n file and directory listings of any new objects added to the S3 bucket and any \n existing objects that are changed in the S3 bucket after you choose this option.
\n NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically\n imports file and directory listings of any new objects added to the S3 bucket, any \n existing objects that are changed in the S3 bucket, and any objects that were deleted\n in the S3 bucket.
The data repository configuration object for Lustre file systems returned in the response of\n the CreateFileSystem operation.
The data repository configuration object for Lustre file systems returned in the response of\n the CreateFileSystem operation.
This data type is not supported for file systems with the Persistent_2 deployment type.\n Instead, use .
Provides detailed information about the data respository if its Lifecycle is \n set to MISCONFIGURED.
Provides detailed information about the data respository if its Lifecycle is \n set to MISCONFIGURED or FAILED.
The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.
", + "smithy.api#documentation": "The type of data repository task.
\nThe EXPORT_TO_REPOSITORY data repository task exports\n from your Lustre file system from to a linked S3 bucket.
The IMPORT_METADATA_FROM_REPOSITORY data repository task\n imports metadata changes from a linked S3 bucket to your Lustre file system.
A description of the data repository task. You use data repository tasks\n to perform bulk transfer operations between your Amazon FSx file system and its linked data\n repository.
" + "smithy.api#documentation": "A description of the data repository task. You use data repository tasks\n to perform bulk transfer operations between your Amazon FSx file system and a linked data\n repository.
" } }, "com.amazonaws.fsx#DataRepositoryTaskEnded": { @@ -2209,6 +2733,10 @@ { "value": "task-lifecycle", "name": "TASK_LIFECYCLE" + }, + { + "value": "data-repository-association-id", + "name": "DATA_REPO_ASSOCIATION_ID" } ] } @@ -2351,6 +2879,10 @@ { "value": "EXPORT_TO_REPOSITORY", "name": "EXPORT" + }, + { + "value": "IMPORT_METADATA_FROM_REPOSITORY", + "name": "IMPORT" } ] } @@ -2399,7 +2931,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an Amazon FSx backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone.
\n\nThe DeleteBackup call returns instantly. The backup will not show up\n in later DescribeBackups calls.
The data in a deleted backup is also deleted and can't be recovered by any\n means.
\nDeletes an Amazon FSx backup. After deletion, the backup no longer exists, and\n its data is gone.
\n\nThe DeleteBackup call returns instantly. The backup won't show up in\n later DescribeBackups calls.
The data in a deleted backup is also deleted and can't be recovered by any\n means.
\nThe ID of the backup you want to delete.
", + "smithy.api#documentation": "The ID of the backup that you want to delete.
", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.fsx#ClientRequestToken", "traits": { - "smithy.api#documentation": "A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent deletion. This is automatically filled on your behalf when using\n the CLI or SDK.
", + "smithy.api#documentation": "A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent deletion. This parameter is automatically filled on your behalf when using\n the CLI or SDK.
", "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "The request object for DeleteBackup operation.
The request object for the DeleteBackup operation.
The ID of the backup deleted.
" + "smithy.api#documentation": "The ID of the backup that was deleted.
" } }, "Lifecycle": { "target": "com.amazonaws.fsx#BackupLifecycle", "traits": { - "smithy.api#documentation": "The lifecycle of the backup. Should be DELETED.
The lifecycle status of the backup. If the DeleteBackup operation is\n successful, the status is DELETED.
The response object for DeleteBackup operation.
The response object for the DeleteBackup operation.
Deletes a file system, deleting its contents. After deletion, the file system no\n longer exists, and its data is gone. Any existing automatic backups will also be\n deleted.
\nTo delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes\n and SVMs on the file system. Then provide a FileSystemId value to the\n DeleFileSystem operation.
By default, when you delete an Amazon FSx for Windows File Server file system, a\n final backup is created upon deletion. This final backup is not subject to the file\n system's retention policy, and must be manually deleted.
\n\nThe DeleteFileSystem action returns while the file system has the\n DELETING status. You can check the file system deletion status by\n calling the DescribeFileSystems action, which returns a list of file\n systems in your account. If you pass the file system ID for a deleted file system, the\n DescribeFileSystems returns a FileSystemNotFound\n error.
Deleting an Amazon FSx for Lustre file system will fail with a 400 BadRequest if \n a data repository task is in a PENDING or EXECUTING\n state.
The data in a deleted file system is also deleted and can't be recovered by\n any means.
\nDeletes a data repository association on an Amazon FSx for Lustre\n file system. Deleting the data repository association unlinks the\n file system from the Amazon S3 bucket. When deleting a data repository\n association, you have the option of deleting the data in the file system\n that corresponds to the data repository association. Data repository\n associations are supported only for file systems with the\n Persistent_2 deployment type.
Set SkipFinalBackup to false if you want to take a final backup of the file \n system you are deleting. By default, Amazon FSx will not take a final backup on your behalf when the\n DeleteFileSystem operation is invoked. (Default = true)
The ID of the data repository association that you want to delete.
", + "smithy.api#required": {} } }, - "FinalBackupTags": { - "target": "com.amazonaws.fsx#Tags", + "ClientRequestToken": { + "target": "com.amazonaws.fsx#ClientRequestToken", "traits": { - "smithy.api#documentation": "Use if SkipFinalBackup is set to false, \n and you want to apply an array of tags to the final backup. If you have set the file system property\n CopyTagsToBackups to true, and \n you specify one or more FinalBackupTags when deleting a file system, Amazon FSx will not copy any existing file system tags to the backup.
Set to true to delete the data in the file system that corresponds\n to the data repository association.
The configuration object for the Amazon FSx for Lustre file system being deleted in the\n DeleteFileSystem operation.
The ID of the final backup for this file system.
" + "smithy.api#documentation": "The ID of the data repository association being deleted.
" } }, - "FinalBackupTags": { - "target": "com.amazonaws.fsx#Tags", - "traits": { + "Lifecycle": { + "target": "com.amazonaws.fsx#DataRepositoryLifecycle", + "traits": { + "smithy.api#documentation": "Describes the lifecycle state of the data repository association being deleted.
" + } + }, + "DeleteDataInFileSystem": { + "target": "com.amazonaws.fsx#DeleteDataInFileSystem", + "traits": { + "smithy.api#documentation": "Indicates whether data in the file system that corresponds to the data\n repository association is being deleted. Default is false.
Deletes a file system. After deletion, the file system no longer exists, and its data\n is gone. Any existing automatic backups and snapshots are also deleted.
\nTo delete an Amazon FSx for NetApp ONTAP file system, first delete all the\n volumes and storage virtual machines (SVMs) on the file system. Then provide a\n FileSystemId value to the DeleFileSystem operation.
By default, when you delete an Amazon FSx for Windows File Server file system,\n a final backup is created upon deletion. This final backup isn't subject to the file\n system's retention policy, and must be manually deleted.
\n\nThe DeleteFileSystem operation returns while the file system has the\n DELETING status. You can check the file system deletion status by\n calling the DescribeFileSystems operation, which returns a list of file systems in your\n account. If you pass the file system ID for a deleted file system, the\n DescribeFileSystems operation returns a FileSystemNotFound\n error.
If a data repository task is in a PENDING or EXECUTING state,\n deleting an Amazon FSx for Lustre file system will fail with an HTTP status\n code 400 (Bad Request).
The data in a deleted file system is also deleted and can't be recovered by\n any means.
\nSet SkipFinalBackup to false if you want to take a final backup of the file \n system you are deleting. By default, Amazon FSx will not take a final backup on your behalf when the\n DeleteFileSystem operation is invoked. (Default = true)
The fsx:CreateBackup permission is required if you set SkipFinalBackup to false in order to delete the file system and take a final backup.
Use if SkipFinalBackup is set to false, \n and you want to apply an array of tags to the final backup. If you have set the file system property\n CopyTagsToBackups to true, and \n you specify one or more FinalBackupTags when deleting a file system, Amazon FSx will not copy any existing file system tags to the backup.
The configuration object for the Amazon FSx for Lustre file system being deleted in the\n DeleteFileSystem operation.
The ID of the final backup for this file system.
" + } + }, + "FinalBackupTags": { + "target": "com.amazonaws.fsx#Tags", + "traits": { "smithy.api#documentation": "The set of tags applied to the final backup.
" } } @@ -2515,20 +3131,51 @@ "smithy.api#documentation": "The response object for the Amazon FSx for Lustre file system being deleted in the\n DeleteFileSystem operation.
By default, Amazon FSx for OpenZFS takes a final backup on your behalf when\n the DeleteFileSystem operation is invoked. Doing this helps protect you\n from data loss, and we highly recommend taking the final backup. If you want to skip\n this backup, use this\n value\n to do so.
The configuration object for the OpenZFS file system used in the\n DeleteFileSystem operation.
The response object for the Amazon FSx for OpenZFS file system that's being\n deleted in the DeleteFileSystem operation.
The ID of the file system you want to delete.
", + "smithy.api#documentation": "The ID of the file system that you want to delete.
", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.fsx#ClientRequestToken", "traits": { - "smithy.api#documentation": "A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent deletion. This is automatically filled on your behalf when using the\n Command Line Interface (CLI) or an Amazon Web Services SDK.
", + "smithy.api#documentation": "A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent deletion. This token is automatically filled on your behalf when using the\n Command Line Interface (CLI) or an Amazon Web Services SDK.
", "smithy.api#idempotencyToken": {} } }, @@ -2537,6 +3184,12 @@ }, "LustreConfiguration": { "target": "com.amazonaws.fsx#DeleteFileSystemLustreConfiguration" + }, + "OpenZFSConfiguration": { + "target": "com.amazonaws.fsx#DeleteFileSystemOpenZFSConfiguration", + "traits": { + "smithy.api#documentation": "The configuration object for the OpenZFS file system used in the\n DeleteFileSystem operation.
The ID of the file system being deleted.
" + "smithy.api#documentation": "The ID of the file system that's being deleted.
" } }, "Lifecycle": { "target": "com.amazonaws.fsx#FileSystemLifecycle", "traits": { - "smithy.api#documentation": "The file system lifecycle for the deletion request. Should be\n DELETING.
The file system lifecycle for the deletion request. If the\n DeleteFileSystem operation is successful, this status is\n DELETING.
The response object for the OpenZFS file system that's being deleted in the\n DeleteFileSystem operation.
The response object for the Microsoft Windows file system used in the\n DeleteFileSystem operation.
Deletes the Amazon FSx snapshot. After deletion, the snapshot no longer\n exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a\n file system backup.
\nThe DeleteSnapshot operation returns instantly. The snapshot appears with\n the lifecycle status of DELETING until the deletion is complete.
The ID of the snapshot that you want to delete.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.fsx#DeleteSnapshotResponse": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.fsx#SnapshotId", + "traits": { + "smithy.api#documentation": "The ID of the deleted snapshot.
" + } + }, + "Lifecycle": { + "target": "com.amazonaws.fsx#SnapshotLifecycle", + "traits": { + "smithy.api#documentation": "The lifecycle status of the snapshot. If the DeleteSnapshot operation is\n successful, this status is DELETING.
Deletes an Amazon FSx for NetApp ONTAP volume. When deleting a volume, \n you have the option of creating a final backup. If you create a final backup, you have the option to \n apply Tags to the backup. You need to have fsx:TagResource \n permission in order to apply tags to the backup.
Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS\n volume.
" } }, "com.amazonaws.fsx#DeleteVolumeOntapConfiguration": { @@ -2727,6 +3468,20 @@ "smithy.api#documentation": "The response object for the Amazon FSx for NetApp ONTAP volume being deleted\n in the DeleteVolume operation.
To delete the volume's children and snapshots, use the string\n DELETE_CHILD_VOLUMES_AND_SNAPSHOTS.
A value that specifies whether to delete all child volumes and snapshots.
" + } + }, "com.amazonaws.fsx#DeleteVolumeRequest": { "type": "structure", "members": { @@ -2739,14 +3494,20 @@ "VolumeId": { "target": "com.amazonaws.fsx#VolumeId", "traits": { - "smithy.api#documentation": "The ID of the volume you are deleting.
", + "smithy.api#documentation": "The ID of the volume that you are deleting.
", "smithy.api#required": {} } }, "OntapConfiguration": { "target": "com.amazonaws.fsx#DeleteVolumeOntapConfiguration", "traits": { - "smithy.api#documentation": "For Amazon FSx for ONTAP volumes, specify whether to take \n a final backup of the volume, and apply tags to the backup.
" + "smithy.api#documentation": "For Amazon FSx for ONTAP volumes, specify whether to take a final backup of\n the volume and apply tags to the backup. To apply tags to the backup, you must have the\n fsx:TagResource permission.
For Amazon FSx for OpenZFS volumes, specify whether to delete all child\n volumes and snapshots.
" } } } @@ -2757,19 +3518,19 @@ "VolumeId": { "target": "com.amazonaws.fsx#VolumeId", "traits": { - "smithy.api#documentation": "The ID of the volume being deleted.
" + "smithy.api#documentation": "The ID of the volume that's being deleted.
" } }, "Lifecycle": { "target": "com.amazonaws.fsx#VolumeLifecycle", "traits": { - "smithy.api#documentation": "Describes the lifecycle state of the volume being deleted.
" + "smithy.api#documentation": "The lifecycle state of the volume being deleted. If the DeleteVolume\n operation is successful, this value is DELETING.
Returned after a DeleteVolume request, showing the status of the delete request.\n
Returned after a DeleteVolume request, showing the status of the delete\n request.
Returns the description of specific Amazon FSx backups, if\n a BackupIds value is provided for that backup. Otherwise, it returns all\n backups owned by your Amazon Web Services account in the Amazon Web Services Region\n of the endpoint that you're calling.
When retrieving all backups, you can optionally specify the MaxResults\n parameter to limit the number of backups in a response. If more backups remain, Amazon\n FSx returns a NextToken value in the response. In this case, send a later\n request with the NextToken request parameter set to the value of\n NextToken from the last response.
This action is used in an iterative process to retrieve a list of your backups.\n DescribeBackups is called first without a NextTokenvalue.\n Then the action continues to be called with the NextToken parameter set to\n the value of the last NextToken value until a response has no\n NextToken.
When using this action, keep the following in mind:
\nThe implementation might return fewer than MaxResults\n backup descriptions while still including a NextToken\n value.
The order of backups returned in the response of one\n DescribeBackups call and the order of backups returned across\n the responses of a multi-call iteration is unspecified.
Returns the description of a specific Amazon FSx backup, if a\n BackupIds value is provided for that backup. Otherwise, it returns all\n backups owned by your Amazon Web Services account in the Amazon Web Services Region of the\n endpoint that you're calling.
When retrieving all backups, you can optionally specify the MaxResults\n parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case,\n send a later request with the NextToken request parameter set to the value\n of the NextToken value from the last response.
This operation is used in an iterative process to retrieve a list of your backups.\n DescribeBackups is called first without a NextToken value.\n Then the operation continues to be called with the NextToken parameter set\n to the value of the last NextToken value until a response has no\n NextToken value.
When using this operation, keep the following in mind:
\nThe operation might return fewer than the MaxResults value of\n backup descriptions while still including a NextToken\n value.
The order of the backups returned in the response of one\n DescribeBackups call and the order of the backups returned\n across the responses of a multi-call iteration is unspecified.
IDs of the backups you want to retrieve (String). This overrides any\n filters. If any IDs are not found, BackupNotFound will be thrown.
" + "smithy.api#documentation": "The IDs of the backups that you want to retrieve. This parameter value overrides any\n filters. If any IDs aren't found, a BackupNotFound error occurs.
Filters structure. Supported names are file-system-id,\n backup-type, file-system-type, and\n volume-id.
The filters structure. The supported names are file-system-id,\n backup-type, file-system-type, and\n volume-id.
Maximum number of backups to return in the response (integer). This\n parameter value must be greater than 0. The number of items that Amazon FSx returns is\n the minimum of the MaxResults parameter specified in the request and the\n service's internal maximum number of items per page.
Maximum number of backups to return in the response. This parameter value must be\n greater than 0. The number of items that Amazon FSx returns is the minimum of\n the MaxResults parameter specified in the request and the service's\n internal maximum number of items per page.
Opaque pagination token returned from a previous\n DescribeBackups operation (String). If a token present, the action\n continues the list from where the returning call left off.
An opaque pagination token returned from a previous DescribeBackups\n operation. If a token is present, the operation continues the list from where the\n returning call left off.
The request object for DescribeBackups operation.
The request object for the DescribeBackups operation.
This is present if there are more backups than returned in the response (String).\n You can use the NextToken value in the later request to fetch the backups.\n
A NextToken value is present if there are more backups than returned in\n the response. You can use the NextToken value in the subsequent request to\n fetch the backups.
Response object for DescribeBackups operation.
Response object for the DescribeBackups operation.
Returns the description of specific Amazon FSx for Lustre data repository associations, if\n one or more AssociationIds values are provided in the request, or if filters are\n used in the request. Data repository associations are supported only\n for file systems with the Persistent_2 deployment type.
You can use filters to narrow the response to include just data repository\n associations for specific file systems (use the file-system-id filter with\n the ID of the file system) or data repository associations for a specific repository type\n (use the data-repository-type filter with a value of S3).\n If you don't use filters, the response returns all data repository associations\n owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint\n that you're calling.
When retrieving all data repository associations, you can paginate the response by using\n the optional MaxResults parameter to limit the number of data repository associations\n returned in a response. If more data repository associations remain, Amazon FSx returns a\n NextToken value in the response. In this case, send a later\n request with the NextToken request parameter set to the value of\n NextToken from the last response.
IDs of the data repository associations whose descriptions you want to retrieve\n (String).
" + } + }, + "Filters": { + "target": "com.amazonaws.fsx#Filters" + }, + "MaxResults": { + "target": "com.amazonaws.fsx#LimitedMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of resources to return in the response. This value must be\n an integer greater than zero.
" + } + }, + "NextToken": { + "target": "com.amazonaws.fsx#NextToken" + } + } + }, + "com.amazonaws.fsx#DescribeDataRepositoryAssociationsResponse": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.fsx#DataRepositoryAssociations", + "traits": { + "smithy.api#documentation": "An array of one ore more data repository association descriptions.
" + } + }, + "NextToken": { + "target": "com.amazonaws.fsx#NextToken" + } } }, "com.amazonaws.fsx#DescribeDataRepositoryTasks": { @@ -3029,7 +3862,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the description of specific Amazon FSx file systems, if a\n FileSystemIds value is provided for that file system. Otherwise, it\n returns descriptions of all file systems owned by your Amazon Web Services account in\n the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the\n MaxResults parameter to limit the number of descriptions in a response.\n If more file system descriptions remain, Amazon FSx returns a NextToken\n value in the response. In this case, send a later request with the\n NextToken request parameter set to the value of NextToken\n from the last response.
This action is used in an iterative process to retrieve a list of your file system\n descriptions. DescribeFileSystems is called first without a\n NextTokenvalue. Then the action continues to be called with the\n NextToken parameter set to the value of the last NextToken\n value until a response has no NextToken.
When using this action, keep the following in mind:
\nThe implementation might return fewer than MaxResults file\n system descriptions while still including a NextToken\n value.
The order of file systems returned in the response of one\n DescribeFileSystems call and the order of file systems returned\n across the responses of a multicall iteration is unspecified.
Returns the description of specific Amazon FSx file systems, if a\n FileSystemIds value is provided for that file system. Otherwise, it\n returns descriptions of all file systems owned by your Amazon Web Services account in the\n Amazon Web Services Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the\n MaxResults parameter to limit the number of descriptions in a response.\n If more file system descriptions remain, Amazon FSx returns a\n NextToken value in the response. In this case, send a later request\n with the NextToken request parameter set to the value of\n NextToken from the last response.
This operation is used in an iterative process to retrieve a list of your file system\n descriptions. DescribeFileSystems is called first without a\n NextTokenvalue. Then the operation continues to be called with the\n NextToken parameter set to the value of the last NextToken\n value until a response has no NextToken.
When using this operation, keep the following in mind:
\nThe implementation might return fewer than MaxResults file\n system descriptions while still including a NextToken\n value.
The order of file systems returned in the response of one\n DescribeFileSystems call and the order of file systems returned\n across the responses of a multicall iteration is unspecified.
Opaque pagination token returned from a previous\n DescribeFileSystems operation (String). If a token present, the action\n continues the list from where the returning call left off.
Opaque pagination token returned from a previous DescribeFileSystems\n operation (String). If a token present, the operation continues the list from where the\n returning call left off.
The response object for DescribeFileSystems operation.
Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
", + "smithy.api#documentation": "Returns the description of specific Amazon FSx snapshots, if a\n SnapshotIds value is provided. Otherwise, this operation returns all\n snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of\n the endpoint that you're calling.
When retrieving all snapshots, you can optionally specify the MaxResults\n parameter to limit the number of snapshots in a response. If more backups remain,\n Amazon FSx returns a NextToken value in the response. In this\n case, send a later request with the NextToken request parameter set to the\n value of NextToken from the last response.
Use this operation in an iterative process to retrieve a list of your snapshots.\n DescribeSnapshots is called first without a NextToken\n value. Then the operation continues to be called with the NextToken\n parameter set to the value of the last NextToken value until a response has\n no NextToken value.
When using this operation, keep the following in mind:
\nThe operation might return fewer than the MaxResults value of\n snapshot descriptions while still including a NextToken\n value.
The order of snapshots returned in the response of one\n DescribeSnapshots call and the order of backups returned across\n the responses of a multi-call iteration is unspecified.
Enter the ID of one or more SVMs that you want to view.
" + "smithy.api#documentation": "The IDs of the snapshots that you want to retrieve. This parameter value overrides any\n filters. If any IDs aren't found, a SnapshotNotFound error occurs.
Enter a filter name:value pair to view a select set of SVMs.
" + "smithy.api#documentation": "The filters structure. The supported names are file-system-id or\n volume-id.
Returned after a successful DescribeStorageVirtualMachines operation, describing each SVM.
An array of snapshots.
" } }, "NextToken": { @@ -3148,13 +3981,13 @@ } } }, - "com.amazonaws.fsx#DescribeVolumes": { + "com.amazonaws.fsx#DescribeStorageVirtualMachines": { "type": "operation", "input": { - "target": "com.amazonaws.fsx#DescribeVolumesRequest" + "target": "com.amazonaws.fsx#DescribeStorageVirtualMachinesRequest" }, "output": { - "target": "com.amazonaws.fsx#DescribeVolumesResponse" + "target": "com.amazonaws.fsx#DescribeStorageVirtualMachinesResponse" }, "errors": [ { @@ -3164,11 +3997,11 @@ "target": "com.amazonaws.fsx#InternalServerError" }, { - "target": "com.amazonaws.fsx#VolumeNotFound" + "target": "com.amazonaws.fsx#StorageVirtualMachineNotFound" } ], "traits": { - "smithy.api#documentation": "Describes one or more Amazon FSx for NetApp ONTAP volumes.
", + "smithy.api#documentation": "Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3176,19 +4009,84 @@ } } }, - "com.amazonaws.fsx#DescribeVolumesRequest": { + "com.amazonaws.fsx#DescribeStorageVirtualMachinesRequest": { + "type": "structure", + "members": { + "StorageVirtualMachineIds": { + "target": "com.amazonaws.fsx#StorageVirtualMachineIds", + "traits": { + "smithy.api#documentation": "Enter the ID of one or more SVMs that you want to view.
" + } + }, + "Filters": { + "target": "com.amazonaws.fsx#StorageVirtualMachineFilters", + "traits": { + "smithy.api#documentation": "Enter a filter name:value pair to view a select set of SVMs.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.fsx#MaxResults" + }, + "NextToken": { + "target": "com.amazonaws.fsx#NextToken" + } + } + }, + "com.amazonaws.fsx#DescribeStorageVirtualMachinesResponse": { + "type": "structure", + "members": { + "StorageVirtualMachines": { + "target": "com.amazonaws.fsx#StorageVirtualMachines", + "traits": { + "smithy.api#documentation": "Returned after a successful DescribeStorageVirtualMachines operation, describing each SVM.
Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for\n OpenZFS volumes.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.fsx#DescribeVolumesRequest": { "type": "structure", "members": { "VolumeIds": { "target": "com.amazonaws.fsx#VolumeIds", "traits": { - "smithy.api#documentation": "IDs of the volumes whose descriptions you want to retrieve.
" + "smithy.api#documentation": "The IDs of the volumes whose descriptions you want to retrieve.
" } }, "Filters": { "target": "com.amazonaws.fsx#VolumeFilters", "traits": { - "smithy.api#documentation": "Enter a filter name:value pair to view a select set of volumes.
" + "smithy.api#documentation": "Enter a filter Name and Values pair to view a select set of\n volumes.
The SSD IOPS (input/output operations per second) configuration\n for an Amazon FSx for NetApp ONTAP file system. The default is 3 IOPS\n per GB of storage capacity, but you can provision additional IOPS\n per GB of storage. The configuration consists of the total number\n of provisioned SSD IOPS and how the amount was provisioned\n (by the customer or by the system).
" + "smithy.api#documentation": "The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS file system. The\n default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per\n GB of storage. The configuration consists of the total number of provisioned SSD IOPS\n and how the amount was provisioned (by the customer or by the system).
" } }, "com.amazonaws.fsx#DiskIopsConfigurationMode": { @@ -3384,6 +4282,37 @@ } } }, + "com.amazonaws.fsx#EventType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NEW", + "name": "NEW" + }, + { + "value": "CHANGED", + "name": "CHANGED" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] + } + }, + "com.amazonaws.fsx#EventTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.fsx#EventType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, "com.amazonaws.fsx#FailedCount": { "type": "long", "traits": { @@ -3414,13 +4343,13 @@ "FileSystemType": { "target": "com.amazonaws.fsx#FileSystemType", "traits": { - "smithy.api#documentation": "The type of Amazon FSx file system, which can be LUSTRE, WINDOWS,\n or ONTAP.
The type of Amazon FSx file system, which can be LUSTRE,\n WINDOWS, ONTAP, or OPENZFS.
The lifecycle status of the file system, following are the possible values and what they mean:
\n\n AVAILABLE - The file system is in a healthy state, and is reachable and available for use.
\n CREATING - Amazon FSx is creating the new file system.
\n DELETING - Amazon FSx is deleting an existing file system.
\n FAILED - An existing file system has experienced an unrecoverable failure. \n When creating a new file system, Amazon FSx was unable to create the file system.
\n MISCONFIGURED indicates that the file system is in a failed but recoverable state.
\n UPDATING indicates that the file system is undergoing a customer initiated update.
The lifecycle status of the file system. The following are the possible values and\n what they mean:
\n\n AVAILABLE - The file system is in a healthy state, and is reachable and available for use.
\n CREATING - Amazon FSx is creating the new file system.
\n DELETING - Amazon FSx is deleting an existing file system.
\n FAILED - An existing file system has experienced an unrecoverable failure. \n When creating a new file system, Amazon FSx was unable to create the file system.
\n MISCONFIGURED - The file system is in a failed but recoverable state.
\n UPDATING - The file system is undergoing a customer-initiated update.
The storage type of the file system. \n Valid values are SSD and HDD.\n If set to SSD, the file system uses solid state drive storage. \n If set to HDD, the file system uses hard disk drive storage.\n
The type of storage the file system is using. \n If set to SSD, the file system uses solid state drive storage. \n If set to HDD, the file system uses hard disk drive storage.\n
The ID of the primary VPC for the file system.
" + "smithy.api#documentation": "The ID of the primary virtual private cloud (VPC) for the file system.
" } }, "SubnetIds": { "target": "com.amazonaws.fsx#SubnetIds", "traits": { - "smithy.api#documentation": "Specifies the IDs of the subnets that the file system is accessible from. For Windows and\n ONTAP MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for\n the preferred file server and one for the standby file server. The preferred file server subnet\n identified in the PreferredSubnetID property. All other file systems have only one subnet ID.
For Lustre file systems, and Single-AZ Windows file systems, this is the ID of \n the subnet that contains the endpoint for the file system. For MULTI_AZ_1 Windows and\n ONTAP file systems, the endpoint for the file system is available in the PreferredSubnetID.
Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and\n ONTAP MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for\n the preferred file server and one for the standby file server. The preferred file server subnet\n identified in the PreferredSubnetID property. All other file systems have only one subnet ID.
For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of \n the subnet that contains the file system's endpoint. For MULTI_AZ_1 Windows and\n ONTAP file systems, the file system endpoint is available in the PreferredSubnetID.
The IDs of the elastic network interface from which a specific file system is\n accessible. The elastic network interface is automatically created in the same VPC that\n the Amazon FSx file system was created in. For more information, see Elastic Network\n Interfaces in the Amazon EC2 User Guide.\n
\n\nFor an Amazon FSx for Windows File Server file system, you can have one network\n interface ID. For an Amazon FSx for Lustre file system, you can have more than\n one.
" + "smithy.api#documentation": "The IDs of the elastic network interfaces from which a specific file system is\n accessible. The elastic network interface is automatically created in the same virtual\n private cloud (VPC) that the Amazon FSx file system was created in. For more\n information, see Elastic Network Interfaces in\n the Amazon EC2 User Guide.\n
\n\nFor an Amazon FSx for Windows File Server file system, you can have one\n network interface ID. For an Amazon FSx for Lustre file system, you can have\n more than one.
" } }, "DNSName": { "target": "com.amazonaws.fsx#DNSName", "traits": { - "smithy.api#documentation": "The DNS name for the file system.
" + "smithy.api#documentation": "The Domain Name System (DNS) name for the file system.
" } }, "KmsKeyId": { "target": "com.amazonaws.fsx#KmsKeyId", "traits": { - "smithy.api#documentation": "The ID of the Key Management Service (KMS) key used to encrypt the file system's data\n for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and\n persistent Amazon FSx for Lustre file systems at rest. If not specified, the Amazon FSx\n managed key is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using\n Amazon FSx managed keys. For more information, see Encrypt\n in the Key Management Service API Reference.
" + "smithy.api#documentation": "The ID of the Key Management Service (KMS) key used to encrypt the file\n system's data for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and PERSISTENT\n Amazon FSx for Lustre file systems at rest. If this ID isn't specified, the\n Amazon FSx-managed key for your account is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using the Amazon\n FSx-managed key for your account. For more information, see Encrypt in the\n Key Management Service API Reference.
The tags to associate with the file system. For more information, see Tagging Your\n Amazon EC2 Resources in the Amazon EC2 User\n Guide.
" + "smithy.api#documentation": "The tags to associate with the file system. For more information, see Tagging your\n Amazon EC2 resources in the Amazon EC2 User\n Guide.
" } }, "WindowsConfiguration": { "target": "com.amazonaws.fsx#WindowsFileSystemConfiguration", "traits": { - "smithy.api#documentation": "The configuration for this Microsoft Windows file system.
" + "smithy.api#documentation": "The configuration for this FSx for Windows File Server file system.
" } }, "LustreConfiguration": { @@ -3492,19 +4421,25 @@ "AdministrativeActions": { "target": "com.amazonaws.fsx#AdministrativeActions", "traits": { - "smithy.api#documentation": "A list of administrative actions for the file system that are in process or waiting to be processed. \n Administrative actions describe changes to the Amazon FSx file system that you have initiated using\n the UpdateFileSystem action.
A list of administrative actions for the file system that are in process or waiting to\n be processed. Administrative actions describe changes to the Amazon FSx system\n that you have initiated using the UpdateFileSystem operation.
The configuration for this FSx for NetApp ONTAP file system.
" + "smithy.api#documentation": "The configuration for this FSx for ONTAP file system.
" } }, "FileSystemTypeVersion": { "target": "com.amazonaws.fsx#FileSystemTypeVersion", "traits": { - "smithy.api#documentation": "The version of your Amazon FSx for Lustre file system, either\n 2.10 or 2.12.
The Lustre version of the Amazon FSx for Lustrefile system, either\n 2.10 or 2.12.
The configuration for this Amazon FSx for OpenZFS file system.
" } } }, @@ -3570,7 +4505,7 @@ } }, "traits": { - "smithy.api#documentation": "A structure providing details of any failures that occur when creating the file system\n has failed.
" + "smithy.api#documentation": "A structure providing details of any failures that occurred when creating a file\n system.
" } }, "com.amazonaws.fsx#FileSystemId": { @@ -3590,7 +4525,7 @@ "target": "com.amazonaws.fsx#FileSystemId" }, "traits": { - "smithy.api#documentation": "A list of FileSystemIds.
A list of file system IDs.
", "smithy.api#length": { "min": 0, "max": 50 @@ -3686,6 +4621,10 @@ { "value": "ONTAP", "name": "ONTAP" + }, + { + "value": "OPENZFS", + "name": "OPENZFS" } ] } @@ -3697,7 +4636,7 @@ "min": 1, "max": 20 }, - "smithy.api#pattern": "^[0-9](\\.[0-9]*)*$" + "smithy.api#pattern": "^[0-9](.[0-9]*)*$" } }, "com.amazonaws.fsx#FileSystems": { @@ -3753,6 +4692,10 @@ { "value": "volume-id", "name": "VOLUME_ID" + }, + { + "value": "data-repository-type", + "name": "DATA_REPOSITORY_TYPE" } ] } @@ -3856,10 +4799,20 @@ } }, "traits": { - "smithy.api#documentation": "Amazon FSx doesn't support Multi-AZ Windows File Server\n copy backup in the destination Region, so the copied backup\n can't be restored.
", + "smithy.api#documentation": "Amazon FSx doesn't support Multi-AZ Windows File Server copy backup in the\n destination Region, so the copied backup can't be restored.
", "smithy.api#error": "client" } }, + "com.amazonaws.fsx#IntegerNoMax": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 2147483647 + } + } + }, "com.amazonaws.fsx#InternalServerError": { "type": "structure", "members": { @@ -3872,6 +4825,18 @@ "smithy.api#error": "server" } }, + "com.amazonaws.fsx#InvalidDataRepositoryType": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.fsx#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "You have filtered the response to a data repository type that is not supported.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.fsx#InvalidDestinationKmsKey": { "type": "structure", "members": { @@ -3880,7 +4845,7 @@ } }, "traits": { - "smithy.api#documentation": "The Key Management Service (KMS) key of the destination\n backup is invalid.
", + "smithy.api#documentation": "The Key Management Service (KMS) key of the destination backup is not\n valid.
", "smithy.api#error": "client" } }, @@ -3961,7 +4926,7 @@ } }, "traits": { - "smithy.api#documentation": "The Region provided for Source Region is invalid or\n is in a different Amazon Web Services partition.
The Region provided for SourceRegion is not valid or is in a different\n Amazon Web Services partition.
The Key Management Service (KMS) key of the source backup\n is invalid.
", + "smithy.api#documentation": "The Key Management Service (KMS) key of the source backup is not\n valid.
", "smithy.api#error": "client" } }, @@ -3983,7 +4948,7 @@ "smithy.api#box": {}, "smithy.api#range": { "min": 0, - "max": 80000 + "max": 160000 } } }, @@ -4020,7 +4985,7 @@ "com.amazonaws.fsx#KmsKeyId": { "type": "string", "traits": { - "smithy.api#documentation": "The ID of the Key Management Service (KMS) key used to encrypt the file system's data\n for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and\n Amazon FSx for Lustre PERSISTENT_1 file systems at rest. If not specified, the Amazon FSx\n managed key is used. The Amazon FSx for Lustre SCRATCH_1 and SCRATCH_2 file systems\n are always encrypted at rest using Amazon FSx managed keys. For more information, see Encrypt\n in the Key Management Service API Reference.
The ID of the Key Management Service (KMS) key used to encrypt the file\n system's data for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and Amazon FSx for Lustre\n PERSISTENT_1 and PERSISTENT_2 file systems at rest. If this ID\n isn't specified, the key managed by Amazon FSx is used. The Amazon FSx for Lustre\n SCRATCH_1 and SCRATCH_2 file systems are always encrypted at\n rest using Amazon FSx-managed keys. For more information, see Encrypt\n in the Key Management Service API Reference.
Describes why a resource lifecycle state changed.
" } }, + "com.amazonaws.fsx#LimitedMaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 25 + } + } + }, "com.amazonaws.fsx#ListTagsForResource": { "type": "operation", "input": { @@ -4123,6 +5098,29 @@ "smithy.api#documentation": "The response object for ListTagsForResource operation.
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\n time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
" + "smithy.api#documentation": "The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\n time zone. Here, d is the weekday number, from 1 through 7, beginning with Monday and\n ending with Sunday.
" } }, "DataRepositoryConfiguration": { @@ -4157,19 +5159,19 @@ "DeploymentType": { "target": "com.amazonaws.fsx#LustreDeploymentType", "traits": { - "smithy.api#documentation": "The deployment type of the FSX for Lustre file system. Scratch deployment type is designed for temporary storage\n and shorter-term processing of data.
\n\n SCRATCH_1 and SCRATCH_2 deployment \n types are best suited for when you need temporary storage and shorter-term processing of data. \n The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst \n throughput capacity than SCRATCH_1.
The PERSISTENT_1 deployment type is used for longer-term storage \n and workloads and encryption of data in transit. To learn more about deployment types, see \n \n FSx for Lustre Deployment Options. (Default = SCRATCH_1)
The deployment type of the FSx for Lustre file system. \n Scratch deployment type is designed for temporary storage\n and shorter-term processing of data.
\n\n SCRATCH_1 and SCRATCH_2 deployment types are best suited \n for when you need temporary storage and shorter-term processing of data. The \n SCRATCH_2 deployment type provides in-transit encryption of data and higher burst \n throughput capacity than SCRATCH_1.
The PERSISTENT_1 and PERSISTENT_2 deployment type is used\n for longer-term storage and workloads and encryption of data in transit.\n PERSISTENT_2 is built on Lustre v2.12 and offers higher\n PerUnitStorageThroughput (up to 1000 MB/s/TiB) along with a lower\n minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see \n FSx for Lustre deployment options.
The default is SCRATCH_1.
Per unit storage throughput represents the megabytes per second of read or write\n throughput per 1 tebibyte of storage provisioned. File system throughput capacity is\n equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is\n only valid for PERSISTENT_1 deployment types.
Valid values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40.
" + "smithy.api#documentation": "Per unit storage throughput represents the megabytes per second of read or write\n throughput per 1 tebibyte of storage provisioned. File system throughput capacity is\n equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is\n only valid for PERSISTENT_1 and PERSISTENT_2 deployment types.
Valid values:
\nFor PERSISTENT_1 SSD storage: 50, 100, 200.
For PERSISTENT_1 HDD storage: 12, 40.
For PERSISTENT_2 SSD storage: 125, 250, 500, 1000.
You use the MountName value when mounting the file system.
For the SCRATCH_1 deployment type, this value is always \"fsx\". \n For SCRATCH_2 and PERSISTENT_1 deployment types, this \n value is a string that is unique within an Amazon Web Services Region. \n \n
You use the MountName value when mounting the file system.
For the SCRATCH_1 deployment type, this value is always \"fsx\". \n For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 deployment\n types, this value is a string that is unique within an Amazon Web Services Region. \n \n
A boolean flag indicating whether tags on the file system should be copied to backups.\n If it's set to true, all tags on the file system are\n copied to all automatic backups and any user-initiated backups where the user\n doesn't specify any tags. If this value is true, and you specify one or more tags,\n only the specified tags are copied to backups. If you specify one or more tags when \n creating a user-initiated backup, no tags are copied from the file system, \n regardless of this value. (Default = false)
" + "smithy.api#documentation": "A boolean flag indicating whether tags on the file system are copied to backups.\n If it's set to true, all tags on the file system are\n copied to all automatic backups and any user-initiated backups where the user\n doesn't specify any tags. If this value is true, and you specify one or more tags,\n only the specified tags are copied to backups. If you specify one or more tags when \n creating a user-initiated backup, no tags are copied from the file system, \n regardless of this value. (Default = false)
" } }, "DriveCacheType": { "target": "com.amazonaws.fsx#DriveCacheType", "traits": { - "smithy.api#documentation": "The type of drive cache used by PERSISTENT_1 file systems that are provisioned with\n HDD storage devices. This parameter is required when storage type is HDD. Set to\n READ, improve the performance for frequently accessed files and allows 20%\n of the total storage capacity of the file system to be cached.
This parameter is required when StorageType is set to HDD.
The type of drive cache used by PERSISTENT_1 file systems that are provisioned with\n HDD storage devices. This parameter is required when StorageType is HDD. When set to\n READ the file system has an SSD storage cache that is sized to 20% of the file system's\n storage capacity. This improves the performance for frequently accessed files by caching up to 20%\n of the total storage capacity.
This parameter is required when StorageType is set to HDD.
The data compression configuration for the file system. DataCompressionType\n can have the following values:
\n NONE - Data compression is turned off for\n the file system.
\n LZ4 - Data compression is turned on with the LZ4\n algorithm.
For more information, see Lustre data compression.
" } + }, + "LogConfiguration": { + "target": "com.amazonaws.fsx#LustreLogConfiguration", + "traits": { + "smithy.api#documentation": "The Lustre logging configuration. Lustre logging writes the enabled log\n events for your file system to Amazon CloudWatch Logs.
" + } } }, "traits": { @@ -4211,6 +5219,48 @@ "smithy.api#pattern": "^([A-Za-z0-9_-]{1,8})$" } }, + "com.amazonaws.fsx#LustreLogConfiguration": { + "type": "structure", + "members": { + "Level": { + "target": "com.amazonaws.fsx#LustreAccessAuditLogLevel", + "traits": { + "smithy.api#documentation": "The data repository events that are logged by Amazon FSx.
\n\n WARN_ONLY - only warning events are logged.
\n ERROR_ONLY - only error events are logged.
\n WARN_ERROR - both warning events and error events\n are logged.
\n DISABLED - logging of data repository events\n is turned off.
The Amazon Resource Name (ARN) that specifies the destination of the logs.\n The destination can be any Amazon CloudWatch Logs log group ARN. The destination\n ARN must be in the same Amazon Web Services partition, Amazon Web Services Region,\n and Amazon Web Services account as your Amazon FSx file system.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for Lustre logging used to write the enabled\n logging events for your file system to Amazon CloudWatch Logs.
\nWhen logging is enabled, Lustre logs error and warning events\n from data repository operations such as automatic export and data repository tasks.\n To learn more about Lustre logging, see \n Logging with Amazon CloudWatch Logs.\n
" + } + }, + "com.amazonaws.fsx#LustreLogCreateConfiguration": { + "type": "structure", + "members": { + "Level": { + "target": "com.amazonaws.fsx#LustreAccessAuditLogLevel", + "traits": { + "smithy.api#documentation": "Sets which data repository events are logged by Amazon FSx.
\n\n WARN_ONLY - only warning events are logged.
\n ERROR_ONLY - only error events are logged.
\n WARN_ERROR - both warning events and error events\n are logged.
\n DISABLED - logging of data repository events\n is turned off.
The Amazon Resource Name (ARN) that specifies the destination of the logs.
\nThe destination can be any Amazon CloudWatch Logs log group ARN, with the following\n requirements:
\nThe destination ARN that you provide must be in the same Amazon Web Services partition,\n Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
\nThe name of the Amazon CloudWatch Logs log group must begin with\n the /aws/fsx prefix.
If you do not provide a destination, Amazon FSx will create and use a\n log stream in the CloudWatch Logs /aws/fsx/lustre log group.
If Destination is provided and the resource does not\n exist, the request will fail with a BadRequest error.
If Level is set to DISABLED, you cannot specify\n a destination in Destination.
The Lustre logging configuration used when creating or updating an\n Amazon FSx for Lustre file system. Lustre logging writes the enabled\n logging events for your file system to Amazon CloudWatch Logs.
\nError and warning events can be logged from the following data\n repository operations:
\nAutomatic export
\nData repository tasks
\nTo learn more about Lustre logging, see \n Logging to Amazon CloudWatch Logs.
" + } + }, "com.amazonaws.fsx#MaxResults": { "type": "integer", "traits": { @@ -4236,10 +5286,10 @@ "type": "integer", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "Sustained throughput of an Amazon FSx file system in MBps.
", + "smithy.api#documentation": "The sustained throughput of an Amazon FSx file system in MBps.
", "smithy.api#range": { "min": 8, - "max": 2048 + "max": 4096 } } }, @@ -4267,6 +5317,16 @@ "smithy.api#error": "client" } }, + "com.amazonaws.fsx#Namespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#pattern": "^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4096}$" + } + }, "com.amazonaws.fsx#NetBiosAlias": { "type": "string", "traits": { @@ -4419,13 +5479,13 @@ "JunctionPath": { "target": "com.amazonaws.fsx#JunctionPath", "traits": { - "smithy.api#documentation": "Specifies the directory that NAS clients use to mount the volume, along with the SVM DNS name or IP address.\n You can create a JunctionPath directly below a parent volume junction or on a \n directory within a volume. A JunctionPath for a volume named vol3 might \n be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3..
Specifies the directory that network-attached storage (NAS) clients use to mount the\n volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP\n address. You can create a JunctionPath directly below a parent volume\n junction or on a directory within a volume. A JunctionPath for a volume\n named vol3 might be /vol1/vol2/vol3, or\n /vol1/dir2/vol3, or even /dir1/dir2/vol3.
The security style for the volume, which can be UNIX,\n NTFS, or MIXED.
The security style for the volume, which can be UNIX, NTFS,\n or\n MIXED.
A boolean flag indicating whether this volume is the root volume for\n its storage virtual machine (SVM). Only one volume on an SVM can be the\n root volume. This value defaults to false. If this value is true, then\n this is the SVM root volume.
\nThis flag is useful when you're deleting an SVM, because you must\n first delete all non-root volumes. This flag, when set to false, helps\n you identify which volumes to delete before you can delete the SVM.
" + "smithy.api#documentation": "A Boolean flag indicating whether this volume is the root volume for its storage\n virtual machine (SVM). Only one volume on an SVM can be the root volume. This value\n defaults to false. If this value is true, then this is the SVM\n root volume.
This flag is useful when you're deleting an SVM, because you must first delete all\n non-root volumes. This flag, when set to false, helps you identify which\n volumes to delete before you can delete the SVM.
The volume's UUID (universally unique identifier).
" + "smithy.api#documentation": "The volume's universally unique identifier (UUID).
" } }, "OntapVolumeType": { "target": "com.amazonaws.fsx#OntapVolumeType", "traits": { - "smithy.api#documentation": "Specifies the type of volume. Valid values are the following:
\n\n RW specifies a read-write volume.\n RW is the default.
\n DP specifies a data protection volume. You can\n protect data by replicating it to data protection mirror copies and use\n data protection mirror copies to recover data when a disaster occurs.
\n LS specifies a load-sharing mirror volume.\n A load-sharing mirror reduces the network traffic to a FlexVol volume\n by providing additional read-only access to clients.
Specifies the type of volume. Valid values are the following:
\n\n RW specifies a read/write volume. RW is the default.
\n DP specifies a data-protection volume. You can protect data by replicating it to\n data-protection mirror copies. If a disaster occurs, you can use these\n data-protection mirror copies to recover data.
\n LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the\n network traffic to a FlexVol volume by providing additional read-only access to\n clients.
The configuration of an Amazon FSx for NetApp ONTAP volume
" + "smithy.api#documentation": "The configuration of an Amazon FSx for NetApp ONTAP volume.
" } }, "com.amazonaws.fsx#OntapVolumeType": { @@ -4494,143 +5554,666 @@ ] } }, - "com.amazonaws.fsx#OrganizationalUnitDistinguishedName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2000 + "com.amazonaws.fsx#OpenZFSClientConfiguration": { + "type": "structure", + "members": { + "Clients": { + "target": "com.amazonaws.fsx#OpenZFSClients", + "traits": { + "smithy.api#documentation": "A value that specifies who can mount the file system. You can provide a wildcard\n character (*), an IP address (0.0.0.0), or a CIDR address\n (192.0.2.0/24. By default, Amazon FSx uses the wildcard\n character when specifying the client.
The name of a parameter for the request. Parameter names are returned in\n PascalCase.
", - "smithy.api#length": { - "min": 1 + "Options": { + "target": "com.amazonaws.fsx#OpenZFSNfsExportOptions", + "traits": { + "smithy.api#documentation": "The options to use when mounting the file system. For a list of options that you can\n use with Network File System (NFS), see the exports(5) - Linux man page. When\n choosing your options, consider the following:
\n\n crossmount is used by default. If you don't specify\n crossmount when changing the client configuration, you won't be\n able to see or access snapshots in your file system's snapshot directory.
\n sync is used by default. If you instead specify\n async, the system acknowledges writes before writing to disk.\n If the system crashes before the writes are finished, you lose the unwritten\n data.
Specifies who can mount the file system and the options that can be used while\n mounting the file system.
" } }, - "com.amazonaws.fsx#ProgressPercent": { - "type": "integer", + "com.amazonaws.fsx#OpenZFSClientConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.fsx#OpenZFSClientConfiguration" + }, "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "The current percent of progress of an asynchronous task.
", - "smithy.api#range": { + "smithy.api#length": { "min": 0, - "max": 100 + "max": 25 } } }, - "com.amazonaws.fsx#Region": { + "com.amazonaws.fsx#OpenZFSClients": { "type": "string", "traits": { "smithy.api#length": { "min": 1, - "max": 20 + "max": 128 }, - "smithy.api#pattern": "^[a-z0-9-]{1,20}$" + "smithy.api#pattern": "^[ -~]{1,128}$" } }, - "com.amazonaws.fsx#ReportFormat": { + "com.amazonaws.fsx#OpenZFSCopyStrategy": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "REPORT_CSV_20191124", - "name": "REPORT_CSV_20191124" - } - ] - } - }, - "com.amazonaws.fsx#ReportScope": { - "type": "string", - "traits": { - "smithy.api#enum": [ + "value": "CLONE", + "name": "CLONE" + }, { - "value": "FAILED_FILES_ONLY", - "name": "FAILED_FILES_ONLY" + "value": "FULL_COPY", + "name": "FULL_COPY" } ] } }, - "com.amazonaws.fsx#RequestTime": { - "type": "timestamp" - }, - "com.amazonaws.fsx#ResourceARN": { - "type": "string", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services\n resources. We require an ARN when you need to specify a resource unambiguously across\n all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in\n the Amazon Web Services General Reference.
", - "smithy.api#length": { - "min": 8, - "max": 512 - }, + "com.amazonaws.fsx#OpenZFSCreateRootVolumeConfiguration": { + "type": "structure", + "members": { + "DataCompressionType": { + "target": "com.amazonaws.fsx#OpenZFSDataCompressionType", + "traits": { + "smithy.api#documentation": "Specifies the method used to compress the data on the volume. Unless the compression\n type is specified, volumes inherit the DataCompressionType value of their\n parent volume.
\n NONE - Doesn't compress the data on the volume.
\n ZSTD - Compresses the data in the volume using the ZStandard\n (ZSTD) compression algorithm. This algorithm reduces the amount of space used on\n your volume and has very little impact on compute resources.
The configuration object for mounting a file system.
" + } + }, + "UserAndGroupQuotas": { + "target": "com.amazonaws.fsx#OpenZFSUserAndGroupQuotas", + "traits": { + "smithy.api#documentation": "An object specifying how much storage users or groups can use on the volume.
" + } + }, + "CopyTagsToSnapshots": { + "target": "com.amazonaws.fsx#Flag", + "traits": { + "smithy.api#documentation": "A Boolean value indicating whether tags for the volume should be copied to snapshots.\n This value defaults to false. If it's set to true, all tags\n for the volume are copied to snapshots where the user doesn't specify tags. If this\n value is true and you specify one or more tags, only the specified tags are\n copied to snapshots. If you specify one or more tags when creating the snapshot, no tags\n are copied from the volume, regardless of this value.
A Boolean value indicating whether the volume is read-only. Setting this value to\n true can be useful after you have completed changes to a volume and no\n longer want changes to occur.
The configuration of an Amazon FSx for OpenZFS root volume.
" + } + }, + "com.amazonaws.fsx#OpenZFSDataCompressionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "ZSTD", + "name": "ZSTD" + } + ] + } + }, + "com.amazonaws.fsx#OpenZFSDeploymentType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SINGLE_AZ_1", + "name": "SINGLE_AZ_1" + } + ] + } + }, + "com.amazonaws.fsx#OpenZFSFileSystemConfiguration": { + "type": "structure", + "members": { + "AutomaticBackupRetentionDays": { + "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays" + }, + "CopyTagsToBackups": { + "target": "com.amazonaws.fsx#Flag", + "traits": { + "smithy.api#documentation": "A Boolean value indicating whether tags on the file system should be copied to\n backups.\n If it's set to true, all tags on the file system are copied to all\n automatic backups and any user-initiated backups where the user doesn't specify any\n tags. If this value is true and you specify one or more tags, only the\n specified tags are copied to backups. If you specify one or more tags when creating a\n user-initiated backup, no tags are copied from the file system, regardless of this\n value.
A Boolean value indicating whether tags for the volume should be copied to snapshots.\n This value defaults to false. If it's set to true, all tags\n for the volume are copied to snapshots where the user doesn't specify tags. If this\n value is true and you specify one or more tags, only the specified tags are\n copied to snapshots. If you specify one or more tags when creating the snapshot, no tags\n are copied from the volume, regardless of this value.
Specifies the file-system deployment type. Amazon FSx for OpenZFS supports\n SINGLE_AZ_1. SINGLE_AZ_1 is a file system configured for a\n single Availability Zone (AZ) of redundancy.
The throughput of an Amazon FSx file system, measured in megabytes per second\n (MBps), in 2 to the nth increments, between 2^3 (8) and 2^11 (2048).
" + } + }, + "WeeklyMaintenanceStartTime": { + "target": "com.amazonaws.fsx#WeeklyTime" + }, + "DiskIopsConfiguration": { + "target": "com.amazonaws.fsx#DiskIopsConfiguration" + }, + "RootVolumeId": { + "target": "com.amazonaws.fsx#VolumeId", + "traits": { + "smithy.api#documentation": "The ID of the root volume of the OpenZFS file system.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for the Amazon FSx for OpenZFS file system.
" + } + }, + "com.amazonaws.fsx#OpenZFSNfsExport": { + "type": "structure", + "members": { + "ClientConfigurations": { + "target": "com.amazonaws.fsx#OpenZFSClientConfigurations", + "traits": { + "smithy.api#documentation": "A list of configuration objects that contain the client and options for mounting the\n OpenZFS file system.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The Network File System NFS) configurations for mounting an Amazon FSx for\n OpenZFS file system.
" + } + }, + "com.amazonaws.fsx#OpenZFSNfsExportOption": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[ -~]{1,128}$" + } + }, + "com.amazonaws.fsx#OpenZFSNfsExportOptions": { + "type": "list", + "member": { + "target": "com.amazonaws.fsx#OpenZFSNfsExportOption" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.fsx#OpenZFSNfsExports": { + "type": "list", + "member": { + "target": "com.amazonaws.fsx#OpenZFSNfsExport" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.fsx#OpenZFSOriginSnapshotConfiguration": { + "type": "structure", + "members": { + "SnapshotARN": { + "target": "com.amazonaws.fsx#ResourceARN" + }, + "CopyStrategy": { + "target": "com.amazonaws.fsx#OpenZFSCopyStrategy", + "traits": { + "smithy.api#documentation": "The strategy used when copying data from the snapshot to the new volume.
\n\n CLONE - The new volume references the data in the origin\n snapshot. Cloning a snapshot is faster than copying the data from a snapshot to\n a new volume and doesn't consume disk throughput. However, the origin snapshot\n can't be deleted if there is a volume using its copied data.
\n FULL_COPY - Copies all data from the snapshot to the new volume.\n
The snapshot configuration to use when creating an OpenZFS volume from a\n snapshot.
" + } + }, + "com.amazonaws.fsx#OpenZFSQuotaType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "USER", + "name": "USER" + }, + { + "value": "GROUP", + "name": "GROUP" + } + ] + } + }, + "com.amazonaws.fsx#OpenZFSUserAndGroupQuotas": { + "type": "list", + "member": { + "target": "com.amazonaws.fsx#OpenZFSUserOrGroupQuota" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.fsx#OpenZFSUserOrGroupQuota": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.fsx#OpenZFSQuotaType", + "traits": { + "smithy.api#documentation": "A value that specifies whether the quota applies to a user or group.
", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.fsx#IntegerNoMax", + "traits": { + "smithy.api#documentation": "The ID of the user or group.
", + "smithy.api#required": {} + } + }, + "StorageCapacityQuotaGiB": { + "target": "com.amazonaws.fsx#IntegerNoMax", + "traits": { + "smithy.api#documentation": "The amount of storage that the user or group can use in gibibytes (GiB).
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for how much storage a user or group can use on the volume.
" + } + }, + "com.amazonaws.fsx#OpenZFSVolumeConfiguration": { + "type": "structure", + "members": { + "ParentVolumeId": { + "target": "com.amazonaws.fsx#VolumeId", + "traits": { + "smithy.api#documentation": "The ID of the parent volume.
" + } + }, + "VolumePath": { + "target": "com.amazonaws.fsx#VolumePath", + "traits": { + "smithy.api#documentation": "The path to the volume from the root volume. For example,\n fsx/parentVolume/volume1.
The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't\n reserve more storage than the parent volume has reserved.
" + } + }, + "StorageCapacityQuotaGiB": { + "target": "com.amazonaws.fsx#IntegerNoMax", + "traits": { + "smithy.api#documentation": "The maximum amount of storage in gibibtyes (GiB) that the volume can use from its\n parent. You can specify a quota larger than the storage on the parent volume.
" + } + }, + "DataCompressionType": { + "target": "com.amazonaws.fsx#OpenZFSDataCompressionType", + "traits": { + "smithy.api#documentation": "The method used to compress the data on the volume. Unless a compression type is\n specified, volumes inherit the DataCompressionType value of their parent\n volume.
\n NONE - Doesn't compress the data on the volume.
\n ZSTD - Compresses the data in the volume using the Zstandard\n (ZSTD) compression algorithm. This algorithm reduces the amount of space used on\n your volume and has very little impact on compute resources.
A Boolean value indicating whether tags for the volume should be copied to snapshots.\n This value defaults to false. If it's set to true, all tags\n for the volume are copied to snapshots where the user doesn't specify tags. If this\n value is true and you specify one or more tags, only the specified tags are\n copied to snapshots. If you specify one or more tags when creating the snapshot, no tags\n are copied from the volume, regardless of this value.
The configuration object that specifies the snapshot to use as the origin of the data\n for the volume.
" + } + }, + "ReadOnly": { + "target": "com.amazonaws.fsx#ReadOnly", + "traits": { + "smithy.api#documentation": "A Boolean value indicating whether the volume is read-only.
" + } + }, + "NfsExports": { + "target": "com.amazonaws.fsx#OpenZFSNfsExports", + "traits": { + "smithy.api#documentation": "The configuration object for mounting a Network File System (NFS) file\n system.
" + } + }, + "UserAndGroupQuotas": { + "target": "com.amazonaws.fsx#OpenZFSUserAndGroupQuotas", + "traits": { + "smithy.api#documentation": "An object specifying how much storage users or groups can use on the volume.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of an Amazon FSx for OpenZFS volume.
" + } + }, + "com.amazonaws.fsx#OrganizationalUnitDistinguishedName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + }, + "smithy.api#pattern": "^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,2000}$" + } + }, + "com.amazonaws.fsx#Parameter": { + "type": "string", + "traits": { + "smithy.api#documentation": "The name of a parameter for the request. Parameter names are returned in\n PascalCase.
", + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.fsx#PerUnitStorageThroughput": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 12, + "max": 1000 + } + } + }, + "com.amazonaws.fsx#ProgressPercent": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The current percent of progress of an asynchronous task.
", + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.fsx#ReadOnly": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.fsx#Region": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#pattern": "^[a-z0-9-]{1,20}$" + } + }, + "com.amazonaws.fsx#ReleaseFileSystemNfsV3Locks": { + "type": "operation", + "input": { + "target": "com.amazonaws.fsx#ReleaseFileSystemNfsV3LocksRequest" + }, + "output": { + "target": "com.amazonaws.fsx#ReleaseFileSystemNfsV3LocksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fsx#BadRequest" + }, + { + "target": "com.amazonaws.fsx#FileSystemNotFound" + }, + { + "target": "com.amazonaws.fsx#IncompatibleParameterError" + }, + { + "target": "com.amazonaws.fsx#InternalServerError" + }, + { + "target": "com.amazonaws.fsx#ServiceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Releases the file system lock from an Amazon FSx for OpenZFS file\n system.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.fsx#ReleaseFileSystemNfsV3LocksRequest": { + "type": "structure", + "members": { + "FileSystemId": { + "target": "com.amazonaws.fsx#FileSystemId", + "traits": { + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.fsx#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.fsx#ReleaseFileSystemNfsV3LocksResponse": { + "type": "structure", + "members": { + "FileSystem": { + "target": "com.amazonaws.fsx#FileSystem" + } + } + }, + "com.amazonaws.fsx#ReportFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "REPORT_CSV_20191124", + "name": "REPORT_CSV_20191124" + } + ] + } + }, + "com.amazonaws.fsx#ReportScope": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FAILED_FILES_ONLY", + "name": "FAILED_FILES_ONLY" + } + ] + } + }, + "com.amazonaws.fsx#RequestTime": { + "type": "timestamp" + }, + "com.amazonaws.fsx#ResourceARN": { + "type": "string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services\n resources. We require an ARN when you need to specify a resource unambiguously across\n all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in\n the Amazon Web Services General Reference.
", + "smithy.api#length": { + "min": 8, + "max": 512 + }, "smithy.api#pattern": "^arn:(?=[^:]+:fsx:[^:]+:\\d{12}:)((|(?=[a-z0-9-.]{1,63})(?!\\d{1,3}(\\.\\d{1,3}){3})(?![^:]*-{2})(?![^:]*-\\.)(?![^:]*\\.-)[a-z0-9].*(?The Amazon Resource Name (ARN) of the resource that doesn't support\n tagging.", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.fsx#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The resource specified does not support tagging.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.fsx#ResourceNotFound": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.fsx#ResourceARN", + "traits": { + "smithy.api#documentation": "The resource ARN of the resource that can't be found.
", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.fsx#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The resource specified by the Amazon Resource Name (ARN) can't be found.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.fsx#ResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FILE_SYSTEM", + "name": "FILE_SYSTEM" + }, + { + "value": "VOLUME", + "name": "VOLUME" + } + ] + } + }, + "com.amazonaws.fsx#RestoreOpenZFSVolumeOption": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DELETE_INTERMEDIATE_SNAPSHOTS", + "name": "DELETE_INTERMEDIATE_SNAPSHOTS" + }, + { + "value": "DELETE_CLONED_VOLUMES", + "name": "DELETE_CLONED_VOLUMES" + } + ] + } + }, + "com.amazonaws.fsx#RestoreOpenZFSVolumeOptions": { + "type": "list", + "member": { + "target": "com.amazonaws.fsx#RestoreOpenZFSVolumeOption" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.fsx#RestoreVolumeFromSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.fsx#RestoreVolumeFromSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.fsx#RestoreVolumeFromSnapshotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fsx#BadRequest" + }, + { + "target": "com.amazonaws.fsx#InternalServerError" + }, + { + "target": "com.amazonaws.fsx#VolumeNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Returns an Amazon FSx for OpenZFS volume to the state saved by the specified\n snapshot.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.fsx#RestoreVolumeFromSnapshotRequest": { "type": "structure", "members": { - "ResourceARN": { - "target": "com.amazonaws.fsx#ResourceARN", + "ClientRequestToken": { + "target": "com.amazonaws.fsx#ClientRequestToken", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource that doesn't support\n tagging.
", + "smithy.api#idempotencyToken": {} + } + }, + "VolumeId": { + "target": "com.amazonaws.fsx#VolumeId", + "traits": { + "smithy.api#documentation": "The ID of the volume that you are restoring.
", "smithy.api#required": {} } }, - "Message": { - "target": "com.amazonaws.fsx#ErrorMessage" + "SnapshotId": { + "target": "com.amazonaws.fsx#SnapshotId", + "traits": { + "smithy.api#documentation": "The ID of the source snapshot. Specifies the snapshot that you are restoring\n from.
", + "smithy.api#required": {} + } + }, + "Options": { + "target": "com.amazonaws.fsx#RestoreOpenZFSVolumeOptions", + "traits": { + "smithy.api#documentation": "The settings used when restoring the specified volume from snapshot.
\n\n DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots between the\n current state and the specified snapshot. If there are intermediate snapshots\n and this option isn't used, RestoreVolumeFromSnapshot fails.
\n DELETE_CLONED_VOLUMES - Deletes any volumes cloned from this\n volume. If there are any cloned volumes and this option isn't used,\n RestoreVolumeFromSnapshot fails.
The resource specified does not support tagging.
", - "smithy.api#error": "client" } }, - "com.amazonaws.fsx#ResourceNotFound": { + "com.amazonaws.fsx#RestoreVolumeFromSnapshotResponse": { "type": "structure", "members": { - "ResourceARN": { - "target": "com.amazonaws.fsx#ResourceARN", + "VolumeId": { + "target": "com.amazonaws.fsx#VolumeId", "traits": { - "smithy.api#documentation": "The resource ARN of the resource that can't be found.
", - "smithy.api#required": {} + "smithy.api#documentation": "The ID of the volume that you restored.
" } }, - "Message": { - "target": "com.amazonaws.fsx#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The resource specified by the Amazon Resource Name (ARN) can't be found.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.fsx#ResourceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FILE_SYSTEM", - "name": "FILE_SYSTEM" - }, - { - "value": "VOLUME", - "name": "VOLUME" + "Lifecycle": { + "target": "com.amazonaws.fsx#VolumeLifecycle", + "traits": { + "smithy.api#documentation": "The lifecycle state of the volume being restored.
" } - ] + } } }, "com.amazonaws.fsx#RouteTableId": { @@ -4655,10 +6238,30 @@ } } }, + "com.amazonaws.fsx#S3DataRepositoryConfiguration": { + "type": "structure", + "members": { + "AutoImportPolicy": { + "target": "com.amazonaws.fsx#AutoImportPolicy", + "traits": { + "smithy.api#documentation": "Specifies the type of updated objects (new, changed, deleted)\n that will be automatically imported from the linked S3 bucket\n to your file system.
" + } + }, + "AutoExportPolicy": { + "target": "com.amazonaws.fsx#AutoExportPolicy", + "traits": { + "smithy.api#documentation": "Specifies the type of updated objects (new, changed, deleted)\n that will be automatically exported from your file system to\n the linked S3 bucket.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for an Amazon S3 data repository linked to an\n Amazon FSx Lustre file system with a data repository association.\n The configuration consists of an AutoImportPolicy that\n defines file events on the data repository are automatically\n imported to the file system and an AutoExportPolicy\n that defines which file events on the file system are automatically\n exported to the data repository. File events are when files or\n directories are added, changed, or deleted on the file system or\n the data repository.
The ID of your Amazon EC2 security group. This ID is used to control network access\n to the endpoint that Amazon FSx creates on your behalf in each subnet. For more\n information, see Amazon EC2 Security\n Groups for Linux Instances in the Amazon EC2 User\n Guide.
", + "smithy.api#documentation": "The ID of your Amazon EC2 security group. This ID is used to control network access\n to the endpoint that Amazon FSx creates on your behalf in each subnet. For more\n information, see Amazon EC2 Security\n groups for Linux instances in the Amazon EC2 User\n Guide.
", "smithy.api#length": { "min": 11, "max": 20 @@ -4810,69 +6413,264 @@ "smithy.api#documentation": "The configuration that Amazon FSx uses to join the Windows File Server instance to a\n self-managed Microsoft Active Directory (AD) directory.
" } }, - "com.amazonaws.fsx#ServiceLimit": { + "com.amazonaws.fsx#ServiceLimit": { + "type": "string", + "traits": { + "smithy.api#documentation": "The types of limits on your service utilization. Limits include file system count,\n total throughput capacity, total storage, and total user-initiated backups. These limits\n apply for a specific account in a specific Amazon Web Services Region. You can increase some of them by\n contacting Amazon Web Services Support.
", + "smithy.api#enum": [ + { + "value": "FILE_SYSTEM_COUNT", + "name": "FILE_SYSTEM_COUNT" + }, + { + "value": "TOTAL_THROUGHPUT_CAPACITY", + "name": "TOTAL_THROUGHPUT_CAPACITY" + }, + { + "value": "TOTAL_STORAGE", + "name": "TOTAL_STORAGE" + }, + { + "value": "TOTAL_USER_INITIATED_BACKUPS", + "name": "TOTAL_USER_INITIATED_BACKUPS" + }, + { + "value": "TOTAL_USER_TAGS", + "name": "TOTAL_USER_TAGS" + }, + { + "value": "TOTAL_IN_PROGRESS_COPY_BACKUPS", + "name": "TOTAL_IN_PROGRESS_COPY_BACKUPS" + }, + { + "value": "STORAGE_VIRTUAL_MACHINES_PER_FILE_SYSTEM", + "name": "STORAGE_VIRTUAL_MACHINES_PER_FILE_SYSTEM" + }, + { + "value": "VOLUMES_PER_FILE_SYSTEM", + "name": "VOLUMES_PER_FILE_SYSTEM" + }, + { + "value": "TOTAL_SSD_IOPS", + "name": "TOTAL_SSD_IOPS" + } + ] + } + }, + "com.amazonaws.fsx#ServiceLimitExceeded": { + "type": "structure", + "members": { + "Limit": { + "target": "com.amazonaws.fsx#ServiceLimit", + "traits": { + "smithy.api#documentation": "Enumeration of the service limit that was exceeded.
", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.fsx#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "An error indicating that a particular service limit was exceeded. You can increase\n some service limits by contacting Amazon Web Services Support.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.fsx#Snapshot": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.fsx#ResourceARN" + }, + "SnapshotId": { + "target": "com.amazonaws.fsx#SnapshotId", + "traits": { + "smithy.api#documentation": "The ID of the snapshot.
" + } + }, + "Name": { + "target": "com.amazonaws.fsx#SnapshotName", + "traits": { + "smithy.api#documentation": "The name of the snapshot.
" + } + }, + "VolumeId": { + "target": "com.amazonaws.fsx#VolumeId", + "traits": { + "smithy.api#documentation": "The ID of the volume that the snapshot is of.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.fsx#CreationTime" + }, + "Lifecycle": { + "target": "com.amazonaws.fsx#SnapshotLifecycle", + "traits": { + "smithy.api#documentation": "The lifecycle status of the snapshot.
\n\n PENDING - Amazon FSx hasn't started creating the\n snapshot.
\n CREATING - Amazon FSx is creating the snapshot.
\n DELETING - Amazon FSx is deleting the snapshot.
\n AVAILABLE - The snapshot is fully available.
A list of administrative actions for the file system that are in process or waiting to\n be processed. Administrative actions describe changes to the Amazon FSx\n system.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A snapshot of an Amazon FSx for OpenZFS volume.
" + } + }, + "com.amazonaws.fsx#SnapshotFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.fsx#SnapshotFilterName", + "traits": { + "smithy.api#documentation": "The name of the filter to use. You can filter by the file-system-id or by\n volume-id.
The file-system-id or volume-id that you are filtering\n for.
A filter used to restrict the results of DescribeSnapshots calls. You can\n use multiple filters to return results that meet all applied filter requirements.
The types of limits on your service utilization. Limits include file system count,\n total throughput capacity, total storage, and total user-initiated backups. These limits\n apply for a specific account in a specific Amazon Web Services Region. You can increase some of them by\n contacting Amazon Web Services Support.
", "smithy.api#enum": [ { - "value": "FILE_SYSTEM_COUNT", - "name": "FILE_SYSTEM_COUNT" - }, - { - "value": "TOTAL_THROUGHPUT_CAPACITY", - "name": "TOTAL_THROUGHPUT_CAPACITY" - }, - { - "value": "TOTAL_STORAGE", - "name": "TOTAL_STORAGE" - }, - { - "value": "TOTAL_USER_INITIATED_BACKUPS", - "name": "TOTAL_USER_INITIATED_BACKUPS" - }, - { - "value": "TOTAL_USER_TAGS", - "name": "TOTAL_USER_TAGS" - }, - { - "value": "TOTAL_IN_PROGRESS_COPY_BACKUPS", - "name": "TOTAL_IN_PROGRESS_COPY_BACKUPS" + "value": "PENDING", + "name": "PENDING" }, { - "value": "STORAGE_VIRTUAL_MACHINES_PER_FILE_SYSTEM", - "name": "STORAGE_VIRTUAL_MACHINES_PER_FILE_SYSTEM" + "value": "CREATING", + "name": "CREATING" }, { - "value": "VOLUMES_PER_FILE_SYSTEM", - "name": "VOLUMES_PER_FILE_SYSTEM" + "value": "DELETING", + "name": "DELETING" }, { - "value": "TOTAL_SSD_IOPS", - "name": "TOTAL_SSD_IOPS" + "value": "AVAILABLE", + "name": "AVAILABLE" } ] } }, - "com.amazonaws.fsx#ServiceLimitExceeded": { + "com.amazonaws.fsx#SnapshotName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 203 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_:.-]{1,203}$" + } + }, + "com.amazonaws.fsx#SnapshotNotFound": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.fsx#ServiceLimit", - "traits": { - "smithy.api#documentation": "Enumeration of the service limit that was exceeded.
", - "smithy.api#required": {} - } - }, "Message": { "target": "com.amazonaws.fsx#ErrorMessage" } }, "traits": { - "smithy.api#documentation": "An error indicating that a particular service limit was exceeded. You can increase\n some service limits by contacting Amazon Web Services Support.
", + "smithy.api#documentation": "No Amazon FSx snapshots were found based on the supplied parameters.
", "smithy.api#error": "client" } }, + "com.amazonaws.fsx#Snapshots": { + "type": "list", + "member": { + "target": "com.amazonaws.fsx#Snapshot" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, "com.amazonaws.fsx#SourceBackupId": { "type": "string", "traits": { @@ -4894,7 +6692,7 @@ } }, "traits": { - "smithy.api#documentation": "The request was rejected because the lifecycle status of the \n source backup is not AVAILABLE.
The request was rejected because the lifecycle status of the source backup isn't\n AVAILABLE.
The ID for a subnet. A subnet is a range of IP addresses in\n your virtual private cloud (VPC). For more information, see VPC and Subnets in the\n Amazon VPC User Guide.\n
", + "smithy.api#documentation": "The ID for a subnet. A subnet is a range of IP addresses in\n your virtual private cloud (VPC). For more information, see VPC and subnets in the\n Amazon VPC User Guide.\n
", "smithy.api#length": { "min": 15, "max": 24 @@ -5600,6 +7398,77 @@ "smithy.api#documentation": "The response object for UntagResource action.
Updates the configuration of an existing data repository association\n on an Amazon FSx for Lustre file system. Data repository associations are\n supported only for file systems with the Persistent_2 deployment type.
The ID of the data repository association that you are updating.
", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.fsx#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {} + } + }, + "ImportedFileChunkSize": { + "target": "com.amazonaws.fsx#Megabytes", + "traits": { + "smithy.api#documentation": "For files imported from a data repository, this value determines the stripe count and\n maximum amount of data per file (in MiB) stored on a single physical disk. The maximum\n number of disks that a single file can be striped across is limited by the total number\n of disks that make up the file system.
\n \nThe default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500\n GiB). Amazon S3 objects have a maximum size of 5 TB.
" + } + }, + "S3": { + "target": "com.amazonaws.fsx#S3DataRepositoryConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for an Amazon S3 data repository linked to an\n Amazon FSx Lustre file system with a data repository association.\n The configuration defines which file events (new, changed, or\n deleted files or directories) are automatically imported from\n the linked data repository to the file system or automatically\n exported from the file system to the data repository.
" + } + } + } + }, + "com.amazonaws.fsx#UpdateDataRepositoryAssociationResponse": { + "type": "structure", + "members": { + "Association": { + "target": "com.amazonaws.fsx#DataRepositoryAssociation", + "traits": { + "smithy.api#documentation": "The response object returned after the data repository association is updated.
" + } + } + } + }, "com.amazonaws.fsx#UpdateFileSystem": { "type": "operation", "input": { @@ -5632,7 +7501,7 @@ } ], "traits": { - "smithy.api#documentation": "Use this operation to update the configuration of an existing Amazon FSx file system. \n You can update multiple properties in a single request.
\nFor Amazon FSx for Windows File Server file systems, you can update the following \n properties:
\nAuditLogConfiguration
\nAutomaticBackupRetentionDays
\nDailyAutomaticBackupStartTime
\nSelfManagedActiveDirectoryConfiguration
\nStorageCapacity
\nThroughputCapacity
\nWeeklyMaintenanceStartTime
\nFor Amazon FSx for Lustre file systems, you can update the following \n properties:
\nAutoImportPolicy
\nAutomaticBackupRetentionDays
\nDailyAutomaticBackupStartTime
\nDataCompressionType
\nStorageCapacity
\nWeeklyMaintenanceStartTime
\nFor Amazon FSx for NetApp ONTAP file systems, you can update the following\n properties:
\nAutomaticBackupRetentionDays
\nDailyAutomaticBackupStartTime
\nFsxAdminPassword
\nWeeklyMaintenanceStartTime
\nUse this operation to update the configuration of an existing Amazon FSx file\n system. You can update multiple properties in a single request.
\nFor Amazon FSx for Windows File Server file systems, you can update the following\n properties:
\n\n AuditLogConfiguration\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n SelfManagedActiveDirectoryConfiguration\n
\n StorageCapacity\n
\n ThroughputCapacity\n
\n WeeklyMaintenanceStartTime\n
For FSx for Lustre file systems, you can update the following\n properties:
\n\n AutoImportPolicy\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n DataCompressionType\n
\n StorageCapacity\n
\n WeeklyMaintenanceStartTime\n
For FSx for ONTAP file systems, you can update the following\n properties:
\n\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n FsxAdminPassword\n
\n WeeklyMaintenanceStartTime\n
For the Amazon FSx for OpenZFS file systems, you can update the following\n properties:
\n\n AutomaticBackupRetentionDays\n
\n CopyTagsToBackups\n
\n CopyTagsToVolumes\n
\n DailyAutomaticBackupStartTime\n
\n DiskIopsConfiguration\n
\n ThroughputCapacity\n
\n WeeklyMaintenanceStartTime\n
(Optional) When you create your file system, your existing S3 objects appear as file and directory listings. \n Use this property to choose how Amazon FSx keeps your file and directory listing up to date \n as you add or modify objects in your linked S3 bucket. AutoImportPolicy can\n have the following values:
\n NONE - (Default) AutoImport is off. Amazon FSx only updates \n file and directory listings from the linked S3 bucket \n when the file system is created. FSx does not update the file and directory \n listing for any new or changed objects after choosing this option.
\n NEW - AutoImport is on. Amazon FSx automatically imports\n directory listings of any new objects added to the linked S3 bucket that \n do not currently exist in the FSx file system.
\n NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports \n file and directory listings of any new objects added to the S3 bucket and any \n existing objects that are changed in the S3 bucket after you choose this option. \n
For more information, see Automatically import updates from your S3 bucket.
" + "smithy.api#documentation": " (Optional) When you create your file system, your existing S3 objects appear as file and directory listings. \n Use this property to choose how Amazon FSx keeps your file and directory listing up to date \n as you add or modify objects in your linked S3 bucket. AutoImportPolicy can\n have the following values:
\n NONE - (Default) AutoImport is off. Amazon FSx only updates \n file and directory listings from the linked S3 bucket \n when the file system is created. FSx does not update the file and directory \n listing for any new or changed objects after choosing this option.
\n NEW - AutoImport is on. Amazon FSx automatically imports\n directory listings of any new objects added to the linked S3 bucket that \n do not currently exist in the FSx file system.
\n NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports \n file and directory listings of any new objects added to the S3 bucket and any \n existing objects that are changed in the S3 bucket after you choose this option.
\n NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically\n imports file and directory listings of any new objects added to the S3 bucket, any \n existing objects that are changed in the S3 bucket, and any objects that were deleted\n in the S3 bucket.
The AutoImportPolicy parameter is not supported for Lustre file systems with\n the Persistent_2 deployment type. Instead, use \n to update a data repository association on your Persistent_2 file system.
Sets the data compression configuration for the file system. DataCompressionType\n can have the following values:
\n NONE - Data compression is turned off for\n the file system.
\n LZ4 - Data compression is turned on with the LZ4\n algorithm.
If you don't use DataCompressionType, the file system retains\n its current data compression configuration.
For more information, see Lustre data compression.
" } + }, + "LogConfiguration": { + "target": "com.amazonaws.fsx#LustreLogCreateConfiguration", + "traits": { + "smithy.api#documentation": "The Lustre logging configuration used when updating an Amazon FSx for Lustre\n file system. When logging is enabled, Lustre logs error and warning events for\n data repositories associated with your file system to Amazon CloudWatch Logs.
" + } } }, "traits": { @@ -5690,33 +7565,71 @@ "smithy.api#documentation": "The configuration updates for an Amazon FSx for NetApp ONTAP file system.
" } }, + "com.amazonaws.fsx#UpdateFileSystemOpenZFSConfiguration": { + "type": "structure", + "members": { + "AutomaticBackupRetentionDays": { + "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays" + }, + "CopyTagsToBackups": { + "target": "com.amazonaws.fsx#Flag", + "traits": { + "smithy.api#documentation": "A Boolean value indicating whether tags for the file system should be copied to\n backups. This value defaults to false. If it's set to true,\n all tags for the file system are copied to all automatic and user-initiated backups\n where the user doesn't specify tags. If this value is true and you specify\n one or more tags, only the specified tags are copied to backups. If you specify one or\n more tags when creating a user-initiated backup, no tags are copied from the file\n system, regardless of this value.
A Boolean value indicating whether tags for the volume should be copied to snapshots.\n This value defaults to false. If it's set to true, all tags\n for the volume are copied to snapshots where the user doesn't specify tags. If this\n value is true and you specify one or more tags, only the specified tags are\n copied to snapshots. If you specify one or more tags when creating the snapshot, no tags\n are copied from the volume, regardless of this value.
The throughput of an Amazon FSx file system, measured in megabytes per second\n (MBps), in 2 to the nth increments, between 2^3 (8) and 2^11 (2048).
" + } + }, + "WeeklyMaintenanceStartTime": { + "target": "com.amazonaws.fsx#WeeklyTime" + }, + "DiskIopsConfiguration": { + "target": "com.amazonaws.fsx#DiskIopsConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "The configuration updates for an Amazon FSx for OpenZFS file system.
" + } + }, "com.amazonaws.fsx#UpdateFileSystemRequest": { "type": "structure", "members": { "FileSystemId": { "target": "com.amazonaws.fsx#FileSystemId", "traits": { - "smithy.api#documentation": "Identifies the file system that you are updating.
", + "smithy.api#documentation": "The ID of the file system that you are updating.
", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.fsx#ClientRequestToken", "traits": { - "smithy.api#documentation": "A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent updates. This string is automatically filled on your behalf when you use\n the Command Line Interface (CLI) or an Amazon Web Services SDK.
", + "smithy.api#documentation": "A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent updates. This string is automatically filled on your behalf when you use the\n Command Line Interface (CLI) or an Amazon Web Services SDK.
", "smithy.api#idempotencyToken": {} } }, "StorageCapacity": { "target": "com.amazonaws.fsx#StorageCapacity", "traits": { - "smithy.api#documentation": "Use this parameter to increase the storage capacity of an Amazon FSx for Windows File Server\n or Amazon FSx for Lustre file system.\n Specifies the storage capacity target value, GiB, to increase the storage capacity for the\n file system that you're updating. You cannot make a storage capacity increase request if\n there is an existing storage capacity increase request in progress.
\nFor Windows file systems, the storage capacity target value must be at least 10 percent\n (%) greater than the current storage capacity value. In order to increase storage capacity,\n the file system must have at least 16 MB/s of throughput capacity.
\nFor Lustre file systems, the storage capacity target value can be the following:
\nFor SCRATCH_2 and PERSISTENT_1 SSD deployment types, valid values\n are in multiples of 2400 GiB. The value must be greater than the current storage capacity.
For PERSISTENT HDD file systems, valid values are multiples of 6000 GiB for \n 12 MB/s/TiB file systems and multiples of 1800 GiB for 40 MB/s/TiB file systems. The values must be greater\n than the current storage capacity.
For SCRATCH_1 file systems, you cannot increase the storage capacity.
For more information, see Managing storage\n capacity in the Amazon FSx for Windows File Server User Guide\n and Managing storage and throughput capacity in the Amazon FSx for Lustre\n User Guide.
" + "smithy.api#documentation": "Use this parameter to increase the storage capacity of an Amazon FSx for Windows\n File Server or Amazon FSx for Lustre file system. Specifies the storage capacity\n target value, in GiB, to increase the storage capacity for the file system that you're\n updating.
\nYou can't make a storage capacity increase request if there is an existing storage\n capacity increase request in progress.
\nFor Windows file systems, the storage capacity target value must be at least 10 percent\n greater than the current storage capacity value. To increase storage capacity, the file system\n must have at least 16 MBps of throughput capacity.
\nFor Lustre file systems, the storage capacity target value can be the following:
\nFor SCRATCH_2 and PERSISTENT_1 SSD deployment types, valid values\n are in multiples of 2400 GiB. The value must be greater than the current storage capacity.
For PERSISTENT HDD file systems, valid values are multiples of 6000 GiB for\n 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput\n per TiB file systems. The values must be greater than the current storage capacity.
For SCRATCH_1 file systems, you can't increase the storage capacity.
For OpenZFS file systems, the input/output operations per second (IOPS) automatically\n scale with increases to the storage capacity if IOPS is configured for automatic scaling. If\n the storage capacity increase would result in less than 3 IOPS per GiB of storage, this\n operation returns an error.
\nFor more information, see Managing storage\n capacity in the Amazon FSx for Windows File Server User\n Guide, Managing storage and throughput\n capacity in the Amazon FSx for Lustre User Guide, and\n Managing storage capacity in the Amazon FSx for OpenZFS User\n Guide.
" } }, "WindowsConfiguration": { "target": "com.amazonaws.fsx#UpdateFileSystemWindowsConfiguration", "traits": { - "smithy.api#documentation": "The configuration updates for an Amazon FSx for Windows File Server file system.
" + "smithy.api#documentation": "The configuration updates for an Amazon FSx for Windows File Server file\n system.
" } }, "LustreConfiguration": { @@ -5724,6 +7637,12 @@ }, "OntapConfiguration": { "target": "com.amazonaws.fsx#UpdateFileSystemOntapConfiguration" + }, + "OpenZFSConfiguration": { + "target": "com.amazonaws.fsx#UpdateFileSystemOpenZFSConfiguration", + "traits": { + "smithy.api#documentation": "The configuration updates for an Amazon FSx for OpenZFS file system.
" + } } }, "traits": { @@ -5826,6 +7745,110 @@ "smithy.api#documentation": "Used to specify changes to the ONTAP configuration for the volume you are updating.
" } }, + "com.amazonaws.fsx#UpdateOpenZFSVolumeConfiguration": { + "type": "structure", + "members": { + "StorageCapacityReservationGiB": { + "target": "com.amazonaws.fsx#IntegerNoMax", + "traits": { + "smithy.api#documentation": "The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't\n reserve more storage than the parent volume has reserved.
" + } + }, + "StorageCapacityQuotaGiB": { + "target": "com.amazonaws.fsx#IntegerNoMax", + "traits": { + "smithy.api#documentation": "\nThe maximum amount of storage in gibibytes (GiB) that the volume can use from its\n parent. You can specify a quota larger than the storage on the parent volume.
" + } + }, + "DataCompressionType": { + "target": "com.amazonaws.fsx#OpenZFSDataCompressionType", + "traits": { + "smithy.api#documentation": "\nSpecifies the method used to compress the data on the volume. Unless the compression\n type is specified, volumes inherit the DataCompressionType value of their\n parent volume.
\n NONE - Doesn't compress the data on the volume.
\n ZSTD - Compresses the data in the volume using the Zstandard\n (ZSTD) compression algorithm. This algorithm reduces the amount of space used on\n your volume and has very little impact on compute resources.
The configuration object for mounting a Network File System (NFS) file system.
" + } + }, + "UserAndGroupQuotas": { + "target": "com.amazonaws.fsx#OpenZFSUserAndGroupQuotas", + "traits": { + "smithy.api#documentation": "An object specifying how much storage users or groups can use on the volume.
" + } + }, + "ReadOnly": { + "target": "com.amazonaws.fsx#ReadOnly", + "traits": { + "smithy.api#documentation": "A Boolean value indicating whether the volume is read-only.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Used to specify changes to the OpenZFS configuration for the volume that you are\n updating.
" + } + }, + "com.amazonaws.fsx#UpdateSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.fsx#UpdateSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.fsx#UpdateSnapshotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fsx#BadRequest" + }, + { + "target": "com.amazonaws.fsx#InternalServerError" + }, + { + "target": "com.amazonaws.fsx#SnapshotNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates the name of a snapshot.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.fsx#UpdateSnapshotRequest": { + "type": "structure", + "members": { + "ClientRequestToken": { + "target": "com.amazonaws.fsx#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {} + } + }, + "Name": { + "target": "com.amazonaws.fsx#SnapshotName", + "traits": { + "smithy.api#documentation": "The name of the snapshot to update.
", + "smithy.api#required": {} + } + }, + "SnapshotId": { + "target": "com.amazonaws.fsx#SnapshotId", + "traits": { + "smithy.api#documentation": "The ID of the snapshot that you want to update, in the format\n fsvolsnap-0123456789abcdef0.
Returned after a successful UpdateSnapshot operation, describing the\n snapshot that you updated.
Updates the Microsoft Active Directory (AD) configuration of an SVM joined to an AD. \n Pleae note, account credentials are not returned in the response payload.
" + "smithy.api#documentation": "Updates the Microsoft Active Directory (AD) configuration of an SVM joined to an AD. \n Please note, account credentials are not returned in the response payload.
" } }, "com.amazonaws.fsx#UpdateVolume": { @@ -5930,7 +7953,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an Amazon FSx for NetApp ONTAP volume's configuration.
" + "smithy.api#documentation": "Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
" } }, "com.amazonaws.fsx#UpdateVolumeRequest": { @@ -5945,14 +7968,26 @@ "VolumeId": { "target": "com.amazonaws.fsx#VolumeId", "traits": { - "smithy.api#documentation": "Specifies the volume that you want to update, formatted fsvol-0123456789abcdef0.
The ID of the volume that you want to update, in the format\n fsvol-0123456789abcdef0.
The ONTAP configuration of the volume you are updating.
The configuration of the ONTAP volume that you are updating.
" + } + }, + "Name": { + "target": "com.amazonaws.fsx#VolumeName", + "traits": { + "smithy.api#documentation": "The name of the OpenZFS volume. OpenZFS root volumes are automatically named\n FSX. Child volume names must be unique among their parent volume's\n children. The name of the volume is part of the mount string for the OpenZFS volume.
The configuration of the OpenZFS volume that you are updating.
" } } } @@ -5963,7 +7998,7 @@ "Volume": { "target": "com.amazonaws.fsx#Volume", "traits": { - "smithy.api#documentation": "Returned after a successful UpdateVolume API operation, describing the volume just updated.
A description of the volume just updated. Returned after a successful\n UpdateVolume API operation.
The lifecycle status of the volume.
\n\n CREATED - The volume is fully available for use.
\n CREATING - Amazon FSx is creating the new volume.
\n DELETING - Amazon FSx is deleting an existing volume.
\n FAILED - Amazon FSx was unable to create the volume.
\n MISCONFIGURED - The volume is in a failed but recoverable state.
\n PENDING - Amazon FSx has not started creating the volume.
The lifecycle status of the volume.
\n\n AVAILABLE - The volume is fully available for\n use.
\n CREATED - The volume has been created.
\n CREATING - Amazon FSx is creating the new volume.
\n DELETING - Amazon FSx is deleting an existing\n volume.
\n FAILED - Amazon FSx was unable to create the\n volume.
\n MISCONFIGURED - The volume is in a failed but recoverable\n state.
\n PENDING - Amazon FSx hasn't started creating the\n volume.
The type of volume; ONTAP is the only valid volume type.
The type of the volume.
" } }, "LifecycleTransitionReason": { "target": "com.amazonaws.fsx#LifecycleTransitionReason", "traits": { - "smithy.api#documentation": "Describes why the volume lifecycle state changed.
" + "smithy.api#documentation": "The reason why the volume lifecycle status changed.
" + } + }, + "AdministrativeActions": { + "target": "com.amazonaws.fsx#AdministrativeActions", + "traits": { + "smithy.api#documentation": "A list of administrative actions for the file system that are in process or waiting to\n be processed. Administrative actions describe changes to the Amazon FSx system\n that you initiated.
" + } + }, + "OpenZFSConfiguration": { + "target": "com.amazonaws.fsx#OpenZFSVolumeConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of an Amazon FSx for OpenZFS volume.
" } } }, "traits": { - "smithy.api#documentation": "Describes an Amazon FSx for NetApp ONTAP volume.
" + "smithy.api#documentation": "Describes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS\n volume.
" } }, "com.amazonaws.fsx#VolumeCapacity": { @@ -6048,7 +8095,7 @@ } }, "traits": { - "smithy.api#documentation": "A filter used to restrict the results of describe calls for\n Amazon FSx for NetApp ONTAP volumes. You can use multiple\n filters to return results that meet all applied filter requirements.
" + "smithy.api#documentation": "A filter used to restrict the results of describe calls for Amazon FSx for\n NetApp ONTAP or Amazon FSx for OpenZFS volumes. You can use multiple filters to\n return results that meet all applied filter requirements.
" } }, "com.amazonaws.fsx#VolumeFilterName": { @@ -6149,6 +8196,10 @@ { "value": "PENDING", "name": "PENDING" + }, + { + "value": "AVAILABLE", + "name": "AVAILABLE" } ] } @@ -6175,6 +8226,16 @@ "smithy.api#error": "client" } }, + "com.amazonaws.fsx#VolumePath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[A-za-z0-9\\_\\.\\:\\-\\/]*$" + } + }, "com.amazonaws.fsx#VolumeType": { "type": "string", "traits": { @@ -6182,6 +8243,10 @@ { "value": "ONTAP", "name": "ONTAP" + }, + { + "value": "OPENZFS", + "name": "OPENZFS" } ] } @@ -6201,7 +8266,7 @@ "com.amazonaws.fsx#VpcId": { "type": "string", "traits": { - "smithy.api#documentation": "The ID of your virtual private cloud (VPC). For more information, see VPC and\n Subnets in the Amazon VPC User Guide.
", + "smithy.api#documentation": "The ID of your virtual private cloud (VPC). For more information, see VPC and\n subnets in the Amazon VPC User Guide.
", "smithy.api#length": { "min": 12, "max": 21 diff --git a/aws/sdk/aws-models/glue.json b/aws/sdk/aws-models/glue.json index 7813ff1bf12ca31512a6be36047977635987e9b6..43d31192a0ff0195ea54af9cfe138b96ec308573 100644 --- a/aws/sdk/aws-models/glue.json +++ b/aws/sdk/aws-models/glue.json @@ -31,6 +31,21 @@ "shapes": { "com.amazonaws.glue#AWSGlue": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Glue", + "arnNamespace": "glue", + "cloudFormationName": "Glue", + "cloudTrailEventSource": "glue.amazonaws.com", + "endpointPrefix": "glue" + }, + "aws.auth#sigv4": { + "name": "glue" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Defines the public endpoint for the Glue service.
", + "smithy.api#title": "AWS Glue" + }, "version": "2017-03-31", "operations": [ { @@ -531,22 +546,7 @@ { "target": "com.amazonaws.glue#UpdateWorkflow" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Glue", - "arnNamespace": "glue", - "cloudFormationName": "Glue", - "cloudTrailEventSource": "glue.amazonaws.com", - "endpointPrefix": "glue" - }, - "aws.auth#sigv4": { - "name": "glue" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Defines the public endpoint for the Glue service.
", - "smithy.api#title": "AWS Glue" - } + ] }, "com.amazonaws.glue#AccessDeniedException": { "type": "structure", @@ -925,6 +925,9 @@ { "target": "com.amazonaws.glue#EntityNotFoundException" }, + { + "target": "com.amazonaws.glue#GlueEncryptionException" + }, { "target": "com.amazonaws.glue#InternalServiceException" }, @@ -933,6 +936,9 @@ }, { "target": "com.amazonaws.glue#OperationTimeoutException" + }, + { + "target": "com.amazonaws.glue#ResourceNotReadyException" } ], "traits": { @@ -973,6 +979,12 @@ "smithy.api#documentation": "A list of the table to delete.
", "smithy.api#required": {} } + }, + "TransactionId": { + "target": "com.amazonaws.glue#TransactionIdString", + "traits": { + "smithy.api#documentation": "The transaction ID at which to delete the table contents.
" + } } } }, @@ -1321,6 +1333,9 @@ { "target": "com.amazonaws.glue#InvalidInputException" }, + { + "target": "com.amazonaws.glue#InvalidStateException" + }, { "target": "com.amazonaws.glue#OperationTimeoutException" } @@ -5393,6 +5408,9 @@ { "target": "com.amazonaws.glue#OperationTimeoutException" }, + { + "target": "com.amazonaws.glue#ResourceNotReadyException" + }, { "target": "com.amazonaws.glue#ResourceNumberLimitExceededException" } @@ -5429,6 +5447,12 @@ "traits": { "smithy.api#documentation": "A list of partition indexes, PartitionIndex structures, to create in the table.
The ID of the transaction.
" + } } } }, @@ -7090,6 +7114,9 @@ }, { "target": "com.amazonaws.glue#OperationTimeoutException" + }, + { + "target": "com.amazonaws.glue#ResourceNotReadyException" } ], "traits": { @@ -7118,6 +7145,12 @@ "smithy.api#documentation": "The name of the table to be deleted. For Hive\n compatibility, this name is entirely lowercase.
", "smithy.api#required": {} } + }, + "TransactionId": { + "target": "com.amazonaws.glue#TransactionIdString", + "traits": { + "smithy.api#documentation": "The transaction ID at which to delete the table contents.
" + } } } }, @@ -10188,8 +10221,14 @@ { "target": "com.amazonaws.glue#InvalidInputException" }, + { + "target": "com.amazonaws.glue#InvalidStateException" + }, { "target": "com.amazonaws.glue#OperationTimeoutException" + }, + { + "target": "com.amazonaws.glue#ResourceNotReadyException" } ], "traits": { @@ -10253,6 +10292,18 @@ "traits": { "smithy.api#documentation": "When true, specifies not returning the partition column schema. Useful when you are interested only in other partition attributes such as partition values or location. This approach avoids the problem of a large response by not returning duplicate data.
" } + }, + "TransactionId": { + "target": "com.amazonaws.glue#TransactionIdString", + "traits": { + "smithy.api#documentation": "The transaction ID at which to read the partition contents.
" + } + }, + "QueryAsOfTime": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "The time as of when to read the partition contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.
The name of the table for which to retrieve the definition. For Hive\n compatibility, this name is entirely lowercase.
", "smithy.api#required": {} } + }, + "TransactionId": { + "target": "com.amazonaws.glue#TransactionIdString", + "traits": { + "smithy.api#documentation": "The transaction ID at which to read the table contents.
" + } + }, + "QueryAsOfTime": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.
The maximum number of tables to return in a single response.
" } + }, + "TransactionId": { + "target": "com.amazonaws.glue#TransactionIdString", + "traits": { + "smithy.api#documentation": "The transaction ID at which to read the table contents.
" + } + }, + "QueryAsOfTime": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.
A message describing the problem.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An error that indicates your data is in an invalid state.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.glue#IsVersionValid": { "type": "boolean" }, @@ -15927,6 +16020,21 @@ } } }, + "com.amazonaws.glue#ResourceNotReadyException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#MessageString", + "traits": { + "smithy.api#documentation": "A message describing the problem.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A resource was not ready for a transaction.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.glue#ResourceNumberLimitExceededException": { "type": "structure", "members": { @@ -18574,6 +18682,16 @@ } } }, + "com.amazonaws.glue#TransactionIdString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\p{L}\\p{N}\\p{P}]*$" + } + }, "com.amazonaws.glue#TransformEncryption": { "type": "structure", "members": { @@ -20247,6 +20365,9 @@ { "target": "com.amazonaws.glue#OperationTimeoutException" }, + { + "target": "com.amazonaws.glue#ResourceNotReadyException" + }, { "target": "com.amazonaws.glue#ResourceNumberLimitExceededException" } @@ -20283,6 +20404,12 @@ "traits": { "smithy.api#documentation": "By default, UpdateTable always creates an archived version of the table\n before updating it. However, if skipArchive is set to true,\n UpdateTable does not create the archived version.
The transaction ID at which to update the table contents.
" + } } } }, diff --git a/aws/sdk/aws-models/imagebuilder.json b/aws/sdk/aws-models/imagebuilder.json index c68804e36e78897948aff94797cd6a8fb644e73e..f6285fd1f3d6b6de009c6e9321a1c3e8bee02b65 100644 --- a/aws/sdk/aws-models/imagebuilder.json +++ b/aws/sdk/aws-models/imagebuilder.json @@ -120,7 +120,7 @@ "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "The description of the distribution configuration. Minimum and maximum length are in characters.
" + "smithy.api#documentation": "The description of the AMI distribution configuration. Minimum and maximum length are in characters.
" } }, "targetAccountIds": { @@ -558,9 +558,9 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1 + "min": 0 }, - "smithy.api#pattern": "^[^\\x00]+$" + "smithy.api#pattern": "^[^\\x00]*$" } }, "com.amazonaws.imagebuilder#ComponentParameterValueList": { @@ -2317,7 +2317,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an Image Builder image resource. This does not delete any EC2 AMIs or ECR container images\n\t\t\tthat are created during the image build process. You must clean those up separately,\n\t\t\tusing the appropriate Amazon EC2 or Amazon ECR console actions, or API or CLI commands.
\n\t\tTo deregister an EC2 Linux AMI, see Deregister \n\t\t\t\t\t\tyour Linux AMI in the \n Amazon EC2 User Guide\n .
\n\t\t\tTo deregister an EC2 Windows AMI, see Deregister \n\t\t\t\t\t\tyour Windows AMI in the \n Amazon EC2 Windows Guide\n .
\n\t\t\tTo delete a container image from Amazon ECR, see Deleting \n\t\t\t\t\t\tan image in the Amazon ECR User Guide.
\n\t\t\tDeletes an Image Builder image resource. This does not delete any EC2 AMIs or ECR container images\n\t\t\tthat are created during the image build process. You must clean those up separately,\n\t\t\tusing the appropriate Amazon EC2 or Amazon ECR console actions, or API or CLI commands.
\n\t\tTo deregister an EC2 Linux AMI, see Deregister \n\t\t\t\t\t\tyour Linux AMI in the \n Amazon EC2 User Guide\n .
\n\t\t\tTo deregister an EC2 Windows AMI, see Deregister \n\t\t\t\t\t\tyour Windows AMI in the \n Amazon EC2 Windows Guide\n .
\n\t\t\tTo delete a container image from Amazon ECR, see Deleting \n\t\t\t\t\t\tan image in the Amazon ECR User Guide.
\n\t\t\tThe name of the group.
" } + }, + "organizationArns": { + "target": "com.amazonaws.imagebuilder#OrganizationArnList", + "traits": { + "smithy.api#documentation": "The ARN for an Amazon Web Services Organization that you want to share your AMI with. For more information, see \n\t\t\tWhat is Organizations?.
" + } + }, + "organizationalUnitArns": { + "target": "com.amazonaws.imagebuilder#OrganizationalUnitArnList", + "traits": { + "smithy.api#documentation": "The ARN for an Organizations organizational unit (OU) that you want to share your AMI with. For more \n\t\t\tinformation about key concepts for Organizations, see Organizations terminology and concepts.
" + } } }, "traits": { - "smithy.api#documentation": "Describes the configuration for a launch permission. The launch permission modification request is sent to the \n\t\t\tAmazon EC2 ModifyImageAttribute \n\t\t\tAPI on behalf of the user for each Region they have selected to distribute the AMI. To make an AMI public, \n\t\t\tset the launch permission authorized accounts to all. See the examples for making an AMI public at \n\t\t\tAmazon EC2 ModifyImageAttribute.
Describes the configuration for a launch permission. The launch permission modification \n\t\t\trequest is sent to the Amazon EC2 ModifyImageAttribute \n\t\t\tAPI on behalf of the user for each Region they have selected to distribute the AMI. To make an AMI public, \n\t\t\tset the launch permission authorized accounts to all. See the examples for making an AMI \n\t\t\tpublic at Amazon EC2 ModifyImageAttribute.
Applies a policy to a container image. We recommend that you call the RAM API CreateResourceShare (https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html) to share resources. If you call the Image Builder API PutContainerImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy (https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) in order for the resource to be visible to all principals with whom the resource is shared.
Applies a policy to a container image. We recommend that you call the RAM API CreateResourceShare (https://docs.aws.amazon.com//ram/latest/APIReference/API_CreateResourceShare.html) to share resources. If you call the Image Builder API PutContainerImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy (https://docs.aws.amazon.com//ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) in order for the resource to be visible to all principals with whom the resource is shared.
EC2 Image Builder is a fully managed Amazon Web Services service that makes it easier to automate the \n creation, management, and deployment of customized, secure, and up-to-date \"golden\" server \n images that are pre-installed and pre-configured with software and settings to meet specific\n IT standards.
", + "smithy.api#title": "EC2 Image Builder" + }, "version": "2019-12-02", "operations": [ { @@ -7666,22 +7729,7 @@ { "target": "com.amazonaws.imagebuilder#UpdateInfrastructureConfiguration" } - ], - "traits": { - "aws.api#service": { - "sdkId": "imagebuilder", - "arnNamespace": "imagebuilder", - "cloudFormationName": "Imagebuilder", - "cloudTrailEventSource": "imagebuilder.amazonaws.com", - "endpointPrefix": "imagebuilder" - }, - "aws.auth#sigv4": { - "name": "imagebuilder" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "EC2 Image Builder is a fully managed Amazon Web Services service that makes it easier to automate the \n creation, management, and deployment of customized, secure, and up-to-date \"golden\" server \n images that are pre-installed and pre-configured with software and settings to meet specific\n IT standards.
", - "smithy.api#title": "EC2 Image Builder" - } + ] } } } diff --git a/aws/sdk/aws-models/inspector2.json b/aws/sdk/aws-models/inspector2.json new file mode 100644 index 0000000000000000000000000000000000000000..a03b4df23a5df0bad37ed814c3f8bb0cd468484c --- /dev/null +++ b/aws/sdk/aws-models/inspector2.json @@ -0,0 +1,6949 @@ +{ + "smithy": "1.0", + "shapes": { + "com.amazonaws.inspector2#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "You do not have sufficient access to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.inspector2#Account": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.inspector2#Status", + "traits": { + "smithy.api#documentation": "The status of Amazon Inspector for the account.
", + "smithy.api#required": {} + } + }, + "resourceStatus": { + "target": "com.amazonaws.inspector2#ResourceStatus", + "traits": { + "smithy.api#documentation": "Details of the status of Amazon Inspector scans by resource type.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An Amazon Web Services account within your environment that Amazon Inspector has been enabled for.
" + } + }, + "com.amazonaws.inspector2#AccountAggregation": { + "type": "structure", + "members": { + "findingType": { + "target": "com.amazonaws.inspector2#AggregationFindingType", + "traits": { + "smithy.api#documentation": "The type of finding.
" + } + }, + "resourceType": { + "target": "com.amazonaws.inspector2#AggregationResourceType", + "traits": { + "smithy.api#documentation": "The type of resource.
" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#SortOrder", + "traits": { + "smithy.api#documentation": "The sort order (ascending or descending).
" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#AccountSortBy", + "traits": { + "smithy.api#documentation": "The value to sort by.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains details about an aggregation response based on\n Amazon Web Services accounts.
" + } + }, + "com.amazonaws.inspector2#AccountAggregationResponse": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
" + } + }, + "severityCounts": { + "target": "com.amazonaws.inspector2#SeverityCounts", + "traits": { + "smithy.api#documentation": "The number of findings by severity.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An aggregation of findings by Amazon Web Services account ID.
" + } + }, + "com.amazonaws.inspector2#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^\\d{12}$" + } + }, + "com.amazonaws.inspector2#AccountIdSet": { + "type": "set", + "member": { + "target": "com.amazonaws.inspector2#AccountId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.inspector2#AccountList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Account" + } + }, + "com.amazonaws.inspector2#AccountSortBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CRITICAL", + "name": "CRITICAL" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "ALL", + "name": "ALL" + } + ] + } + }, + "com.amazonaws.inspector2#AccountState": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.inspector2#State", + "traits": { + "smithy.api#documentation": "An object detailing the status of Amazon Inspector for the account.
", + "smithy.api#required": {} + } + }, + "resourceState": { + "target": "com.amazonaws.inspector2#ResourceState", + "traits": { + "smithy.api#documentation": "An object detailing which resources Amazon Inspector is enabled to scan for the account.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object with details the status of an Amazon Web Services account within your Amazon Inspector environment
" + } + }, + "com.amazonaws.inspector2#AccountStateList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#AccountState" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.inspector2#AggCounts": { + "type": "long" + }, + "com.amazonaws.inspector2#AggregationFindingType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NETWORK_REACHABILITY", + "name": "NETWORK_REACHABILITY" + }, + { + "value": "PACKAGE_VULNERABILITY", + "name": "PACKAGE_VULNERABILITY" + } + ] + } + }, + "com.amazonaws.inspector2#AggregationRequest": { + "type": "union", + "members": { + "accountAggregation": { + "target": "com.amazonaws.inspector2#AccountAggregation", + "traits": { + "smithy.api#documentation": "An object that contains details about an aggregation request based on Amazon Web Services account\n IDs.
" + } + }, + "amiAggregation": { + "target": "com.amazonaws.inspector2#AmiAggregation", + "traits": { + "smithy.api#documentation": "An object that contains details about an aggregation request based on Amazon Machine\n Images (AMIs).
" + } + }, + "awsEcrContainerAggregation": { + "target": "com.amazonaws.inspector2#AwsEcrContainerAggregation", + "traits": { + "smithy.api#documentation": "An object that contains details about an aggregation request based on Amazon ECR container\n images.
" + } + }, + "ec2InstanceAggregation": { + "target": "com.amazonaws.inspector2#Ec2InstanceAggregation", + "traits": { + "smithy.api#documentation": "An object that contains details about an aggregation request based on Amazon EC2\n instances.
" + } + }, + "findingTypeAggregation": { + "target": "com.amazonaws.inspector2#FindingTypeAggregation", + "traits": { + "smithy.api#documentation": "An object that contains details about an aggregation request based on finding types.
" + } + }, + "imageLayerAggregation": { + "target": "com.amazonaws.inspector2#ImageLayerAggregation", + "traits": { + "smithy.api#documentation": "An object that contains details about an aggregation request based on container image\n layers.
" + } + }, + "packageAggregation": { + "target": "com.amazonaws.inspector2#PackageAggregation", + "traits": { + "smithy.api#documentation": "An object that contains details about an aggregation request based on operating system\n package type.
" + } + }, + "repositoryAggregation": { + "target": "com.amazonaws.inspector2#RepositoryAggregation", + "traits": { + "smithy.api#documentation": "An object that contains details about an aggregation request based on Amazon ECR repositories.
" + } + }, + "titleAggregation": { + "target": "com.amazonaws.inspector2#TitleAggregation", + "traits": { + "smithy.api#documentation": "An object that contains details about an aggregation request based on finding title.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an aggregation request.
" + } + }, + "com.amazonaws.inspector2#AggregationResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWS_EC2_INSTANCE", + "name": "AWS_EC2_INSTANCE" + }, + { + "value": "AWS_ECR_CONTAINER_IMAGE", + "name": "AWS_ECR_CONTAINER_IMAGE" + } + ] + } + }, + "com.amazonaws.inspector2#AggregationResponse": { + "type": "union", + "members": { + "accountAggregation": { + "target": "com.amazonaws.inspector2#AccountAggregationResponse", + "traits": { + "smithy.api#documentation": "An object that contains details about an aggregation response based on Amazon Web Services account\n IDs.
" + } + }, + "amiAggregation": { + "target": "com.amazonaws.inspector2#AmiAggregationResponse", + "traits": { + "smithy.api#documentation": "An object that contains details about an aggregation response based on Amazon Machine\n Images (AMIs).
" + } + }, + "awsEcrContainerAggregation": { + "target": "com.amazonaws.inspector2#AwsEcrContainerAggregationResponse", + "traits": { + "smithy.api#documentation": "An object that contains details about an aggregation response based on Amazon ECR container\n images.
" + } + }, + "ec2InstanceAggregation": { + "target": "com.amazonaws.inspector2#Ec2InstanceAggregationResponse", + "traits": { + "smithy.api#documentation": "An object that contains details about an aggregation response based on Amazon EC2\n instances.
" + } + }, + "findingTypeAggregation": { + "target": "com.amazonaws.inspector2#FindingTypeAggregationResponse", + "traits": { + "smithy.api#documentation": "An object that contains details about an aggregation response based on finding types.
" + } + }, + "imageLayerAggregation": { + "target": "com.amazonaws.inspector2#ImageLayerAggregationResponse", + "traits": { + "smithy.api#documentation": "An object that contains details about an aggregation response based on container image\n layers.
" + } + }, + "packageAggregation": { + "target": "com.amazonaws.inspector2#PackageAggregationResponse", + "traits": { + "smithy.api#documentation": "An object that contains details about an aggregation response based on operating system\n package type.
" + } + }, + "repositoryAggregation": { + "target": "com.amazonaws.inspector2#RepositoryAggregationResponse", + "traits": { + "smithy.api#documentation": "An object that contains details about an aggregation response based on Amazon ECR\n repositories.
" + } + }, + "titleAggregation": { + "target": "com.amazonaws.inspector2#TitleAggregationResponse", + "traits": { + "smithy.api#documentation": "An object that contains details about an aggregation response based on finding title.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains details about the results of an aggregation type.
" + } + }, + "com.amazonaws.inspector2#AggregationResponseList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#AggregationResponse" + } + }, + "com.amazonaws.inspector2#AggregationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FINDING_TYPE", + "name": "FINDING_TYPE" + }, + { + "value": "PACKAGE", + "name": "PACKAGE" + }, + { + "value": "TITLE", + "name": "TITLE" + }, + { + "value": "REPOSITORY", + "name": "REPOSITORY" + }, + { + "value": "AMI", + "name": "AMI" + }, + { + "value": "AWS_EC2_INSTANCE", + "name": "AWS_EC2_INSTANCE" + }, + { + "value": "AWS_ECR_CONTAINER", + "name": "AWS_ECR_CONTAINER" + }, + { + "value": "IMAGE_LAYER", + "name": "IMAGE_LAYER" + }, + { + "value": "ACCOUNT", + "name": "ACCOUNT" + } + ] + } + }, + "com.amazonaws.inspector2#AmiAggregation": { + "type": "structure", + "members": { + "amis": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "The IDs of AMIs to aggregate findings for.
" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#SortOrder", + "traits": { + "smithy.api#documentation": "The order to sort results by.
" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#AmiSortBy", + "traits": { + "smithy.api#documentation": "The value to sort results by.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details that define an aggregation based on Amazon machine images (AMIs).
" + } + }, + "com.amazonaws.inspector2#AmiAggregationResponse": { + "type": "structure", + "members": { + "ami": { + "target": "com.amazonaws.inspector2#AmiId", + "traits": { + "smithy.api#documentation": "The ID of the AMI that findings were aggregated for.
", + "smithy.api#required": {} + } + }, + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID that the AMI belongs.
" + } + }, + "severityCounts": { + "target": "com.amazonaws.inspector2#SeverityCounts", + "traits": { + "smithy.api#documentation": "An object that contains the count of matched findings per severity.
" + } + }, + "affectedInstances": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The IDs of Amazon EC2 instances using this AMI.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A response that contains the results of a finding aggregation by AMI.
" + } + }, + "com.amazonaws.inspector2#AmiId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^ami-([a-z0-9]{8}|[a-z0-9]{17}|\\*)$" + } + }, + "com.amazonaws.inspector2#AmiSortBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CRITICAL", + "name": "CRITICAL" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "ALL", + "name": "ALL" + }, + { + "value": "AFFECTED_INSTANCES", + "name": "AFFECTED_INSTANCES" + } + ] + } + }, + "com.amazonaws.inspector2#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + } + } + }, + "com.amazonaws.inspector2#AssociateMember": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#AssociateMemberRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#AssociateMemberResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Associates an Amazon Web Services account with an Amazon Inspector delegated administrator.
", + "smithy.api#http": { + "method": "POST", + "uri": "/members/associate", + "code": 200 + } + } + }, + "com.amazonaws.inspector2#AssociateMemberRequest": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the member account to be associated.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#AssociateMemberResponse": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the successfully associated member account.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#AutoEnable": { + "type": "structure", + "members": { + "ec2": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Represents whether Amazon EC2 scans are automatically enabled for new members of your Amazon Inspector\n organization.
", + "smithy.api#required": {} + } + }, + "ecr": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Represents whether Amazon ECR scans are automatically enabled for new members of your Amazon Inspector\n organization.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents which scan types are automatically enabled for new members of your Amazon Inspector organization.
" + } + }, + "com.amazonaws.inspector2#AwsEc2InstanceDetails": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The type of the Amazon EC2 instance.
" + } + }, + "imageId": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The image ID of the Amazon EC2 instance.
" + } + }, + "ipV4Addresses": { + "target": "com.amazonaws.inspector2#IpV4AddressList", + "traits": { + "smithy.api#documentation": "The IPv4 addresses of the Amazon EC2 instance.
" + } + }, + "ipV6Addresses": { + "target": "com.amazonaws.inspector2#IpV6AddressList", + "traits": { + "smithy.api#documentation": "The IPv6 addresses of the Amazon EC2 instance.
" + } + }, + "keyName": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The name of the key pair used to launch the Amazon EC2 instance.
" + } + }, + "iamInstanceProfileArn": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The IAM instance profile ARN of the Amazon EC2 instance.
" + } + }, + "vpcId": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The VPC ID of the Amazon EC2 instance.
" + } + }, + "subnetId": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The subnet ID of the Amazon EC2 instance.
" + } + }, + "launchedAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The date and time the Amazon EC2 instance was launched at.
" + } + }, + "platform": { + "target": "com.amazonaws.inspector2#Platform", + "traits": { + "smithy.api#documentation": "The platform of the Amazon EC2 instance.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of the Amazon EC2 instance involved in a finding.
" + } + }, + "com.amazonaws.inspector2#AwsEcrContainerAggregation": { + "type": "structure", + "members": { + "resourceIds": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "The container resource IDs.
" + } + }, + "imageShas": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "The image SHA values.
" + } + }, + "repositories": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "The container repositories.
" + } + }, + "architectures": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "The architecture of the containers.
" + } + }, + "imageTags": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "The image tags.
" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#SortOrder", + "traits": { + "smithy.api#documentation": "The sort order (ascending or descending).
" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#AwsEcrContainerSortBy", + "traits": { + "smithy.api#documentation": "The value to sort by.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An aggregation of information about Amazon ECR containers.
" + } + }, + "com.amazonaws.inspector2#AwsEcrContainerAggregationResponse": { + "type": "structure", + "members": { + "resourceId": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The resource ID of the container.
", + "smithy.api#required": {} + } + }, + "imageSha": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The SHA value of the container image.
" + } + }, + "repository": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The container repository.
" + } + }, + "architecture": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The architecture of the container.
" + } + }, + "imageTags": { + "target": "com.amazonaws.inspector2#StringList", + "traits": { + "smithy.api#documentation": "The container image stags.
" + } + }, + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the account that owns the container.
" + } + }, + "severityCounts": { + "target": "com.amazonaws.inspector2#SeverityCounts", + "traits": { + "smithy.api#documentation": "The number of finding by severity.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An aggregation of information about Amazon ECR containers.
" + } + }, + "com.amazonaws.inspector2#AwsEcrContainerImageDetails": { + "type": "structure", + "members": { + "repositoryName": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The name of the repository the Amazon ECR container image resides in.
", + "smithy.api#required": {} + } + }, + "imageTags": { + "target": "com.amazonaws.inspector2#ImageTagList", + "traits": { + "smithy.api#documentation": "The image tags attached to the Amazon ECR container image.
" + } + }, + "pushedAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The date and time the Amazon ECR container image was pushed.
" + } + }, + "author": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The image author of the Amazon ECR container image.
" + } + }, + "architecture": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The architecture of the Amazon ECR container image.
" + } + }, + "imageHash": { + "target": "com.amazonaws.inspector2#ImageHash", + "traits": { + "smithy.api#documentation": "The image hash of the Amazon ECR container image.
", + "smithy.api#required": {} + } + }, + "registry": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The registry the Amazon ECR container image belongs to.
", + "smithy.api#required": {} + } + }, + "platform": { + "target": "com.amazonaws.inspector2#Platform", + "traits": { + "smithy.api#documentation": "The platform of the Amazon ECR container image.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The image details of the Amazon ECR container image.
" + } + }, + "com.amazonaws.inspector2#AwsEcrContainerSortBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CRITICAL", + "name": "CRITICAL" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "ALL", + "name": "ALL" + } + ] + } + }, + "com.amazonaws.inspector2#BadRequestException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "One or more tags submitted as part of the request is not valid.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.inspector2#BatchGetAccountStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#BatchGetAccountStatusRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#BatchGetAccountStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.
", + "smithy.api#http": { + "method": "POST", + "uri": "/status/batch/get", + "code": 200 + } + } + }, + "com.amazonaws.inspector2#BatchGetAccountStatusRequest": { + "type": "structure", + "members": { + "accountIds": { + "target": "com.amazonaws.inspector2#AccountIdSet", + "traits": { + "smithy.api#documentation": "The 12-digit Amazon Web Services account IDs of the accounts to retrieve Amazon Inspector status for.
" + } + } + } + }, + "com.amazonaws.inspector2#BatchGetAccountStatusResponse": { + "type": "structure", + "members": { + "accounts": { + "target": "com.amazonaws.inspector2#AccountStateList", + "traits": { + "smithy.api#documentation": "An array of objects that provide details on the status of Amazon Inspector for each of the requested accounts.
", + "smithy.api#required": {} + } + }, + "failedAccounts": { + "target": "com.amazonaws.inspector2#FailedAccountList", + "traits": { + "smithy.api#documentation": "An array of objects detailing any accounts that failed to enable Amazon Inspector and why.
" + } + } + } + }, + "com.amazonaws.inspector2#BatchGetFreeTrialInfo": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#BatchGetFreeTrialInfoRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#BatchGetFreeTrialInfoResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets free trial status for multiple Amazon Web Services accounts.
", + "smithy.api#http": { + "method": "POST", + "uri": "/freetrialinfo/batchget", + "code": 200 + } + } + }, + "com.amazonaws.inspector2#BatchGetFreeTrialInfoRequest": { + "type": "structure", + "members": { + "accountIds": { + "target": "com.amazonaws.inspector2#MeteringAccountIdList", + "traits": { + "smithy.api#documentation": "The account IDs to get free trial status for.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#BatchGetFreeTrialInfoResponse": { + "type": "structure", + "members": { + "accounts": { + "target": "com.amazonaws.inspector2#FreeTrialAccountInfoList", + "traits": { + "smithy.api#documentation": "An array of objects that provide Amazon Inspector free trial details for each of the requested accounts.\n
", + "smithy.api#required": {} + } + }, + "failedAccounts": { + "target": "com.amazonaws.inspector2#FreeTrialInfoErrorList", + "traits": { + "smithy.api#documentation": "An array of objects detailing any accounts that free trial data could not be returned for.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#CancelFindingsReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#CancelFindingsReportRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#CancelFindingsReportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Cancels the given findings report.
", + "smithy.api#http": { + "method": "POST", + "uri": "/reporting/cancel", + "code": 200 + } + } + }, + "com.amazonaws.inspector2#CancelFindingsReportRequest": { + "type": "structure", + "members": { + "reportId": { + "target": "com.amazonaws.inspector2#ReportId", + "traits": { + "smithy.api#documentation": "The ID of the report to be canceled.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#CancelFindingsReportResponse": { + "type": "structure", + "members": { + "reportId": { + "target": "com.amazonaws.inspector2#ReportId", + "traits": { + "smithy.api#documentation": "The ID of the canceled report.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.inspector2#Component": { + "type": "string" + }, + "com.amazonaws.inspector2#ComponentType": { + "type": "string" + }, + "com.amazonaws.inspector2#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the conflicting resource.
", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of the conflicting resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A conflict occurred.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.inspector2#Counts": { + "type": "structure", + "members": { + "count": { + "target": "com.amazonaws.inspector2#AggCounts", + "traits": { + "smithy.api#documentation": "The number of resources.
" + } + }, + "groupKey": { + "target": "com.amazonaws.inspector2#GroupKey", + "traits": { + "smithy.api#documentation": "The key associated with this group
" + } + } + }, + "traits": { + "smithy.api#documentation": "a structure that contains information on the count of resources within a group.
" + } + }, + "com.amazonaws.inspector2#CountsList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Counts" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.inspector2#CoverageFilterCriteria": { + "type": "structure", + "members": { + "scanStatusCode": { + "target": "com.amazonaws.inspector2#CoverageStringFilterList", + "traits": { + "smithy.api#documentation": "The scan status code to filter on.
" + } + }, + "scanStatusReason": { + "target": "com.amazonaws.inspector2#CoverageStringFilterList", + "traits": { + "smithy.api#documentation": "The scan status reason to filter on.
" + } + }, + "accountId": { + "target": "com.amazonaws.inspector2#CoverageStringFilterList", + "traits": { + "smithy.api#documentation": "An array of Amazon Web Services account IDs to return coverage statistics for.
" + } + }, + "resourceId": { + "target": "com.amazonaws.inspector2#CoverageStringFilterList", + "traits": { + "smithy.api#documentation": "An array of Amazon Web Services resource IDs to return coverage statistics for.
" + } + }, + "resourceType": { + "target": "com.amazonaws.inspector2#CoverageStringFilterList", + "traits": { + "smithy.api#documentation": "An array of Amazon Web Services resource types to return coverage statistics for.
" + } + }, + "scanType": { + "target": "com.amazonaws.inspector2#CoverageStringFilterList", + "traits": { + "smithy.api#documentation": "An array of Amazon Inspector scan types to return coverage statistics for.
" + } + }, + "ecrRepositoryName": { + "target": "com.amazonaws.inspector2#CoverageStringFilterList", + "traits": { + "smithy.api#documentation": "The Amazon ECR repository name to filter on.
" + } + }, + "ecrImageTags": { + "target": "com.amazonaws.inspector2#CoverageStringFilterList", + "traits": { + "smithy.api#documentation": "The Amazon ECR image tags to filter on.
" + } + }, + "ec2InstanceTags": { + "target": "com.amazonaws.inspector2#CoverageMapFilterList", + "traits": { + "smithy.api#documentation": "The Amazon EC2 instance tags to filter on.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that identifies filter criteria for GetCoverageStatistics.
The operator to compare coverage on.
", + "smithy.api#required": {} + } + }, + "key": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The tag key associated with the coverage map filter.
", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The tag value associated with the coverage map filter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details of a coverage map filter.
" + } + }, + "com.amazonaws.inspector2#CoverageMapFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CoverageMapFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#CoverageResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWS_EC2_INSTANCE", + "name": "AWS_EC2_INSTANCE" + }, + { + "value": "AWS_ECR_CONTAINER_IMAGE", + "name": "AWS_ECR_CONTAINER_IMAGE" + }, + { + "value": "AWS_ECR_REPOSITORY", + "name": "AWS_ECR_REPOSITORY" + } + ] + } + }, + "com.amazonaws.inspector2#CoverageStringComparison": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EQUALS", + "name": "EQUALS" + }, + { + "value": "NOT_EQUALS", + "name": "NOT_EQUALS" + } + ] + } + }, + "com.amazonaws.inspector2#CoverageStringFilter": { + "type": "structure", + "members": { + "comparison": { + "target": "com.amazonaws.inspector2#CoverageStringComparison", + "traits": { + "smithy.api#documentation": "The operator to compare strings on.
", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.inspector2#CoverageStringInput", + "traits": { + "smithy.api#documentation": "The value to compare strings on.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details of a coverage string filter.
" + } + }, + "com.amazonaws.inspector2#CoverageStringFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CoverageStringFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#CoverageStringInput": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#CoveredResource": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.inspector2#CoverageResourceType", + "traits": { + "smithy.api#documentation": "The type of the covered resource.
", + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.inspector2#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the covered resource.
", + "smithy.api#required": {} + } + }, + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the covered resource.
", + "smithy.api#required": {} + } + }, + "scanType": { + "target": "com.amazonaws.inspector2#ScanType", + "traits": { + "smithy.api#documentation": "The Amazon Inspector scan type covering the resource.
", + "smithy.api#required": {} + } + }, + "scanStatus": { + "target": "com.amazonaws.inspector2#ScanStatus", + "traits": { + "smithy.api#documentation": "The status of the scan covering the resource.
" + } + }, + "resourceMetadata": { + "target": "com.amazonaws.inspector2#ResourceScanMetadata", + "traits": { + "smithy.api#documentation": "An object that contains details about the metadata.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains details about a resource covered by Amazon Inspector.
" + } + }, + "com.amazonaws.inspector2#CoveredResources": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CoveredResource" + } + }, + "com.amazonaws.inspector2#CreateFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#CreateFilterRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#CreateFilterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#BadRequestException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a filter resource using specified filter criteria.
", + "smithy.api#http": { + "method": "POST", + "uri": "/filters/create", + "code": 200 + } + } + }, + "com.amazonaws.inspector2#CreateFilterRequest": { + "type": "structure", + "members": { + "action": { + "target": "com.amazonaws.inspector2#FilterAction", + "traits": { + "smithy.api#documentation": "Defines the action that is to be applied to the findings that match the filter.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.inspector2#FilterDescription", + "traits": { + "smithy.api#documentation": "A description of the filter.
" + } + }, + "filterCriteria": { + "target": "com.amazonaws.inspector2#FilterCriteria", + "traits": { + "smithy.api#documentation": "Defines the criteria to be used in the filter for querying findings.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.inspector2#FilterName", + "traits": { + "smithy.api#documentation": "The name of the filter. Minimum length of 3. Maximum length of 64. Valid characters\n include alphanumeric characters, dot (.), underscore (_), and dash (-). Spaces are not\n allowed.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.inspector2#TagMap", + "traits": { + "smithy.api#documentation": "A list of tags for the filter.
" + } + } + } + }, + "com.amazonaws.inspector2#CreateFilterResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.inspector2#FilterArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the successfully created filter.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#CreateFindingsReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#CreateFindingsReportRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#CreateFindingsReportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a finding report.
", + "smithy.api#http": { + "method": "POST", + "uri": "/reporting/create", + "code": 200 + } + } + }, + "com.amazonaws.inspector2#CreateFindingsReportRequest": { + "type": "structure", + "members": { + "filterCriteria": { + "target": "com.amazonaws.inspector2#FilterCriteria", + "traits": { + "smithy.api#documentation": "The filter criteria to apply to the results of the finding report.
" + } + }, + "reportFormat": { + "target": "com.amazonaws.inspector2#ReportFormat", + "traits": { + "smithy.api#documentation": "The format to generate the report in.
", + "smithy.api#required": {} + } + }, + "s3Destination": { + "target": "com.amazonaws.inspector2#Destination", + "traits": { + "smithy.api#documentation": "The Amazon S3 export destination for the report.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#CreateFindingsReportResponse": { + "type": "structure", + "members": { + "reportId": { + "target": "com.amazonaws.inspector2#ReportId", + "traits": { + "smithy.api#documentation": "The ID of the report.
" + } + } + } + }, + "com.amazonaws.inspector2#Currency": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "USD", + "name": "USD" + } + ] + } + }, + "com.amazonaws.inspector2#CvssScore": { + "type": "structure", + "members": { + "baseScore": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The base CVSS score used for the finding.
", + "smithy.api#required": {} + } + }, + "scoringVector": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The vector string of the CVSS score.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The version of CVSS used for the score.
", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The source of the CVSS score.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The CVSS score for a finding.
" + } + }, + "com.amazonaws.inspector2#CvssScoreAdjustment": { + "type": "structure", + "members": { + "metric": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The metric used to adjust the CVSS score.
", + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The reason the CVSS score has been adjustment.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details on adjustments Amazon Inspector made to the CVSS score for a finding.
" + } + }, + "com.amazonaws.inspector2#CvssScoreAdjustmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CvssScoreAdjustment" + } + }, + "com.amazonaws.inspector2#CvssScoreDetails": { + "type": "structure", + "members": { + "scoreSource": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The source for the CVSS score.
", + "smithy.api#required": {} + } + }, + "cvssSource": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The source of the CVSS data.
" + } + }, + "version": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The CVSS version used in scoring.
", + "smithy.api#required": {} + } + }, + "score": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The CVSS score.
", + "smithy.api#required": {} + } + }, + "scoringVector": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The vector for the CVSS score.
", + "smithy.api#required": {} + } + }, + "adjustments": { + "target": "com.amazonaws.inspector2#CvssScoreAdjustmentList", + "traits": { + "smithy.api#documentation": "An object that contains details about adjustment Amazon Inspector made to the CVSS score.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the CVSS score.
" + } + }, + "com.amazonaws.inspector2#CvssScoreList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CvssScore" + } + }, + "com.amazonaws.inspector2#DateFilter": { + "type": "structure", + "members": { + "startInclusive": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp representing the start of the time period filtered on.
" + } + }, + "endInclusive": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp representing the end of the time period filtered on.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details on the time range used to filter findings.
" + } + }, + "com.amazonaws.inspector2#DateFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#DateFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#DateTimeTimestamp": { + "type": "timestamp" + }, + "com.amazonaws.inspector2#DelegatedAdmin": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the Amazon Inspector delegated administrator for your organization.
" + } + }, + "relationshipStatus": { + "target": "com.amazonaws.inspector2#RelationshipStatus", + "traits": { + "smithy.api#documentation": "The status of the Amazon Inspector delegated administrator.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of the Amazon Inspector delegated administrator for your organization.
" + } + }, + "com.amazonaws.inspector2#DelegatedAdminAccount": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the Amazon Inspector delegated administrator for your organization.
" + } + }, + "status": { + "target": "com.amazonaws.inspector2#DelegatedAdminStatus", + "traits": { + "smithy.api#documentation": "The status of the Amazon Inspector delegated administrator.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of the Amazon Inspector delegated administrator for your organization.
" + } + }, + "com.amazonaws.inspector2#DelegatedAdminAccountList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#DelegatedAdminAccount" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.inspector2#DelegatedAdminStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "DISABLE_IN_PROGRESS", + "name": "DISABLE_IN_PROGRESS" + } + ] + } + }, + "com.amazonaws.inspector2#DeleteFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#DeleteFilterRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#DeleteFilterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a filter resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/filters/delete", + "code": 200 + } + } + }, + "com.amazonaws.inspector2#DeleteFilterRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.inspector2#FilterArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the filter to be deleted.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#DeleteFilterResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.inspector2#FilterArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the filter that has been deleted.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#DescribeOrganizationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#DescribeOrganizationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#DescribeOrganizationConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Describe Amazon Inspector configuration settings for an Amazon Web Services organization
", + "smithy.api#http": { + "method": "POST", + "uri": "/organizationconfiguration/describe", + "code": 200 + } + } + }, + "com.amazonaws.inspector2#DescribeOrganizationConfigurationRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.inspector2#DescribeOrganizationConfigurationResponse": { + "type": "structure", + "members": { + "autoEnable": { + "target": "com.amazonaws.inspector2#AutoEnable", + "traits": { + "smithy.api#documentation": "The scan types are automatically enabled for new members of your organization.
" + } + }, + "maxAccountLimitReached": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Represents whether your organization has reached the maximum Amazon Web Services account limit for Amazon Inspector.
" + } + } + } + }, + "com.amazonaws.inspector2#Destination": { + "type": "structure", + "members": { + "bucketName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon S3 bucket to export findings to.
", + "smithy.api#required": {} + } + }, + "keyPrefix": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The prefix of the KMS key used to export findings.
" + } + }, + "kmsKeyArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the KMS key used to encrypt data when exporting findings.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details of the Amazon S3 bucket and KMS key used to export findings.
" + } + }, + "com.amazonaws.inspector2#Disable": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#DisableRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#DisableResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Disables Amazon Inspector scans for one or more Amazon Web Services accounts. Disabling all scan types in an account\n disables the Amazon Inspector service.
", + "smithy.api#http": { + "method": "POST", + "uri": "/disable", + "code": 200 + } + } + }, + "com.amazonaws.inspector2#DisableDelegatedAdminAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#DisableDelegatedAdminAccountRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#DisableDelegatedAdminAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#ConflictException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Disables the Amazon Inspector delegated administrator for your organization.
", + "smithy.api#http": { + "method": "POST", + "uri": "/delegatedadminaccounts/disable", + "code": 200 + } + } + }, + "com.amazonaws.inspector2#DisableDelegatedAdminAccountRequest": { + "type": "structure", + "members": { + "delegatedAdminAccountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the current Amazon Inspector delegated administrator.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#DisableDelegatedAdminAccountResponse": { + "type": "structure", + "members": { + "delegatedAdminAccountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the successfully disabled delegated administrator.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#DisableRequest": { + "type": "structure", + "members": { + "accountIds": { + "target": "com.amazonaws.inspector2#AccountIdSet", + "traits": { + "smithy.api#documentation": "An array of account IDs you want to disable Amazon Inspector scans for.
" + } + }, + "resourceTypes": { + "target": "com.amazonaws.inspector2#DisableResourceTypeList", + "traits": { + "smithy.api#documentation": "The resource scan types you want to disable.
" + } + } + } + }, + "com.amazonaws.inspector2#DisableResourceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#ResourceScanType" + }, + "traits": { + "smithy.api#length": { + "max": 2 + } + } + }, + "com.amazonaws.inspector2#DisableResponse": { + "type": "structure", + "members": { + "accounts": { + "target": "com.amazonaws.inspector2#AccountList", + "traits": { + "smithy.api#documentation": "Information on the accounts that have had Amazon Inspector scans successfully disabled. Details are\n provided for each account.
", + "smithy.api#required": {} + } + }, + "failedAccounts": { + "target": "com.amazonaws.inspector2#FailedAccountList", + "traits": { + "smithy.api#documentation": "Information on any accounts for which Amazon Inspector scans could not be disabled. Details are\n provided for each account.
" + } + } + } + }, + "com.amazonaws.inspector2#DisassociateMember": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#DisassociateMemberRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#DisassociateMemberResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates a member account from an Amazon Inspector delegated administrator.
", + "smithy.api#http": { + "method": "POST", + "uri": "/members/disassociate", + "code": 200 + } + } + }, + "com.amazonaws.inspector2#DisassociateMemberRequest": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the member account to disassociate.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#DisassociateMemberResponse": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the successfully disassociated member.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#Ec2InstanceAggregation": { + "type": "structure", + "members": { + "amis": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "The AMI IDs associated with the Amazon EC2 instances to aggregate findings for.
" + } + }, + "operatingSystems": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "The operating system types to aggregate findings for. Valid values must be uppercase and\n underscore separated, examples are ORACLE_LINUX_7 and\n ALPINE_LINUX_3_8.
The Amazon EC2 instance IDs to aggregate findings for.
" + } + }, + "instanceTags": { + "target": "com.amazonaws.inspector2#MapFilterList", + "traits": { + "smithy.api#documentation": "The Amazon EC2 instance tags to aggregate findings for.
" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#SortOrder", + "traits": { + "smithy.api#documentation": "The order to sort results by.
" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#Ec2InstanceSortBy", + "traits": { + "smithy.api#documentation": "The value to sort results by.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details that define an aggregation based on Amazon EC2 instances.
" + } + }, + "com.amazonaws.inspector2#Ec2InstanceAggregationResponse": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The Amazon EC2 instance ID.
", + "smithy.api#required": {} + } + }, + "ami": { + "target": "com.amazonaws.inspector2#AmiId", + "traits": { + "smithy.api#documentation": "The Amazon Machine Image (AMI) of the Amazon EC2 instance.
" + } + }, + "operatingSystem": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The operating system of the Amazon EC2 instance.
" + } + }, + "instanceTags": { + "target": "com.amazonaws.inspector2#TagMap", + "traits": { + "smithy.api#documentation": "The tags attached to the instance.
" + } + }, + "accountId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account the Amazon EC2 instance belongs to.
" + } + }, + "severityCounts": { + "target": "com.amazonaws.inspector2#SeverityCounts", + "traits": { + "smithy.api#documentation": "An object that contains the count of matched findings per severity.
" + } + }, + "networkFindings": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of network findings for the Amazon EC2 instance.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A response that contains the results of a finding aggregation by Amazon EC2 instance.
" + } + }, + "com.amazonaws.inspector2#Ec2InstanceSortBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NETWORK_FINDINGS", + "name": "NETWORK_FINDINGS" + }, + { + "value": "CRITICAL", + "name": "CRITICAL" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "ALL", + "name": "ALL" + } + ] + } + }, + "com.amazonaws.inspector2#Ec2Metadata": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.inspector2#TagMap", + "traits": { + "smithy.api#documentation": "The tags attached to the instance.
" + } + }, + "amiId": { + "target": "com.amazonaws.inspector2#AmiId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Machine Image (AMI) used to launch the instance.
" + } + }, + "platform": { + "target": "com.amazonaws.inspector2#Ec2Platform", + "traits": { + "smithy.api#documentation": "The platform of the instance.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Meta data details of an Amazon EC2 instance.
" + } + }, + "com.amazonaws.inspector2#Ec2Platform": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "WINDOWS", + "name": "WINDOWS" + }, + { + "value": "LINUX", + "name": "LINUX" + }, + { + "value": "UNKNOWN", + "name": "UNKNOWN" + } + ] + } + }, + "com.amazonaws.inspector2#EcrContainerImageMetadata": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.inspector2#TagList", + "traits": { + "smithy.api#documentation": "Tags associated with the Amazon ECR image metadata.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information on the Amazon ECR image metadata associated with a finding.
" + } + }, + "com.amazonaws.inspector2#EcrRepositoryMetadata": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon ECR repository.
" + } + }, + "scanFrequency": { + "target": "com.amazonaws.inspector2#EcrScanFrequency", + "traits": { + "smithy.api#documentation": "The frequency of scans.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information on the Amazon ECR repository metadata associated with a finding.
" + } + }, + "com.amazonaws.inspector2#EcrScanFrequency": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MANUAL", + "name": "MANUAL" + }, + { + "value": "SCAN_ON_PUSH", + "name": "SCAN_ON_PUSH" + }, + { + "value": "CONTINUOUS_SCAN", + "name": "CONTINUOUS_SCAN" + } + ] + } + }, + "com.amazonaws.inspector2#Enable": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#EnableRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#EnableResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Enables Amazon Inspector scans for one or more Amazon Web Services accounts.
", + "smithy.api#http": { + "method": "POST", + "uri": "/enable", + "code": 200 + } + } + }, + "com.amazonaws.inspector2#EnableDelegatedAdminAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#EnableDelegatedAdminAccountRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#EnableDelegatedAdminAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#ConflictException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Enables the Amazon Inspector delegated administrator for your Organizations organization.
", + "smithy.api#http": { + "method": "POST", + "uri": "/delegatedadminaccounts/enable", + "code": 200 + } + } + }, + "com.amazonaws.inspector2#EnableDelegatedAdminAccountRequest": { + "type": "structure", + "members": { + "delegatedAdminAccountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the Amazon Inspector delegated administrator.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.inspector2#ClientToken", + "traits": { + "smithy.api#documentation": "The idempotency token for the request.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.inspector2#EnableDelegatedAdminAccountResponse": { + "type": "structure", + "members": { + "delegatedAdminAccountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the successfully Amazon Inspector delegated administrator.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#EnableRequest": { + "type": "structure", + "members": { + "accountIds": { + "target": "com.amazonaws.inspector2#AccountIdSet", + "traits": { + "smithy.api#documentation": "A list of account IDs you want to enable Amazon Inspector scans for.
" + } + }, + "resourceTypes": { + "target": "com.amazonaws.inspector2#EnableResourceTypeList", + "traits": { + "smithy.api#documentation": "The resource scan types you want to enable.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.inspector2#ClientToken", + "traits": { + "smithy.api#documentation": "The idempotency token for the request.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.inspector2#EnableResourceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#ResourceScanType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.inspector2#EnableResponse": { + "type": "structure", + "members": { + "accounts": { + "target": "com.amazonaws.inspector2#AccountList", + "traits": { + "smithy.api#documentation": "Information on the accounts that have had Amazon Inspector scans successfully enabled. Details are\n provided for each account.
", + "smithy.api#required": {} + } + }, + "failedAccounts": { + "target": "com.amazonaws.inspector2#FailedAccountList", + "traits": { + "smithy.api#documentation": "Information on any accounts for which Amazon Inspector scans could not be enabled. Details are\n provided for each account.
" + } + } + } + }, + "com.amazonaws.inspector2#ErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALREADY_ENABLED", + "name": "ALREADY_ENABLED" + }, + { + "value": "ENABLE_IN_PROGRESS", + "name": "ENABLE_IN_PROGRESS" + }, + { + "value": "DISABLE_IN_PROGRESS", + "name": "DISABLE_IN_PROGRESS" + }, + { + "value": "SUSPEND_IN_PROGRESS", + "name": "SUSPEND_IN_PROGRESS" + }, + { + "value": "RESOURCE_NOT_FOUND", + "name": "RESOURCE_NOT_FOUND" + }, + { + "value": "ACCESS_DENIED", + "name": "ACCESS_DENIED" + }, + { + "value": "INTERNAL_ERROR", + "name": "INTERNAL_ERROR" + }, + { + "value": "SSM_UNAVAILABLE", + "name": "SSM_UNAVAILABLE" + }, + { + "value": "SSM_THROTTLED", + "name": "SSM_THROTTLED" + }, + { + "value": "EVENTBRIDGE_UNAVAILABLE", + "name": "EVENTBRIDGE_UNAVAILABLE" + }, + { + "value": "EVENTBRIDGE_THROTTLED", + "name": "EVENTBRIDGE_THROTTLED" + }, + { + "value": "RESOURCE_SCAN_NOT_DISABLED", + "name": "RESOURCE_SCAN_NOT_DISABLED" + }, + { + "value": "DISASSOCIATE_ALL_MEMBERS", + "name": "DISASSOCIATE_ALL_MEMBERS" + } + ] + } + }, + "com.amazonaws.inspector2#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.inspector2#ExternalReportStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SUCCEEDED", + "name": "SUCCEEDED" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "CANCELLED", + "name": "CANCELLED" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.inspector2#FailedAccount": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.inspector2#Status", + "traits": { + "smithy.api#documentation": "The status of Amazon Inspector for the account.
" + } + }, + "resourceStatus": { + "target": "com.amazonaws.inspector2#ResourceStatus", + "traits": { + "smithy.api#documentation": "An object detailing which resources Amazon Inspector is enabled to scan for the account.
" + } + }, + "errorCode": { + "target": "com.amazonaws.inspector2#ErrorCode", + "traits": { + "smithy.api#documentation": "The error code explaining why the account failed to enable Amazon Inspector.
", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The error message received when the account failed to enable Amazon Inspector.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object with details on why an account failed to enable Amazon Inspector.
" + } + }, + "com.amazonaws.inspector2#FailedAccountList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#FailedAccount" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.inspector2#FilePath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#Filter": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.inspector2#FilterArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) associated with this filter.
", + "smithy.api#required": {} + } + }, + "ownerId": { + "target": "com.amazonaws.inspector2#OwnerId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the account that created the filter.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.inspector2#FilterName", + "traits": { + "smithy.api#documentation": "The name of the filter.
", + "smithy.api#required": {} + } + }, + "criteria": { + "target": "com.amazonaws.inspector2#FilterCriteria", + "traits": { + "smithy.api#documentation": "Details on the filter criteria associated with this filter.
", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.inspector2#FilterAction", + "traits": { + "smithy.api#documentation": "The action that is to be applied to the findings that match the filter.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The date and time this filter was created at.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The date and time the filter was last updated at.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.inspector2#FilterDescription", + "traits": { + "smithy.api#documentation": "A description of the filter.
" + } + }, + "reason": { + "target": "com.amazonaws.inspector2#FilterReason", + "traits": { + "smithy.api#documentation": "The reason for the filter.
" + } + }, + "tags": { + "target": "com.amazonaws.inspector2#TagMap", + "traits": { + "smithy.api#documentation": "The tags attached to the filter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a filter.
" + } + }, + "com.amazonaws.inspector2#FilterAction": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "SUPPRESS", + "name": "SUPPRESS" + } + ] + } + }, + "com.amazonaws.inspector2#FilterArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.inspector2#FilterArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#FilterArn" + } + }, + "com.amazonaws.inspector2#FilterCriteria": { + "type": "structure", + "members": { + "findingArn": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "Details on the finding ARNs used to filter findings.
" + } + }, + "awsAccountId": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "Details of the Amazon Web Services account IDs used to filter findings.
" + } + }, + "findingType": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "Details on the finding types used to filter findings.
" + } + }, + "severity": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "Details on the severity used to filter findings.
" + } + }, + "firstObservedAt": { + "target": "com.amazonaws.inspector2#DateFilterList", + "traits": { + "smithy.api#documentation": "Details on the date and time a finding was first seen used to filter findings.
" + } + }, + "lastObservedAt": { + "target": "com.amazonaws.inspector2#DateFilterList", + "traits": { + "smithy.api#documentation": "Details on the date and time a finding was last seen used to filter findings.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.inspector2#DateFilterList", + "traits": { + "smithy.api#documentation": "Details on the date and time a finding was last updated at used to filter findings.
" + } + }, + "findingStatus": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "Details on the finding status types used to filter findings.
" + } + }, + "title": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "Details on the finding title used to filter findings.
" + } + }, + "inspectorScore": { + "target": "com.amazonaws.inspector2#NumberFilterList", + "traits": { + "smithy.api#documentation": "The Amazon Inspector score to filter on.
" + } + }, + "resourceType": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "Details on the resource types used to filter findings.
" + } + }, + "resourceId": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "Details on the resource IDs used to filter findings.
" + } + }, + "resourceTags": { + "target": "com.amazonaws.inspector2#MapFilterList", + "traits": { + "smithy.api#documentation": "Details on the resource tags used to filter findings.
" + } + }, + "ec2InstanceImageId": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "Details of the Amazon EC2 instance image IDs used to filter findings.
" + } + }, + "ec2InstanceVpcId": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "Details of the Amazon EC2 instance VPC IDs used to filter findings.
" + } + }, + "ec2InstanceSubnetId": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "Details of the Amazon EC2 instance subnet IDs used to filter findings.
" + } + }, + "ecrImagePushedAt": { + "target": "com.amazonaws.inspector2#DateFilterList", + "traits": { + "smithy.api#documentation": "Details on the Amazon ECR image push date and time used to filter findings.
" + } + }, + "ecrImageArchitecture": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "Details of the Amazon ECR image architecture types used to filter findings.
" + } + }, + "ecrImageRegistry": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "Details on the Amazon ECR registry used to filter findings.
" + } + }, + "ecrImageRepositoryName": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "Details on the name of the Amazon ECR repository used to filter findings.
" + } + }, + "ecrImageTags": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "The tags attached to the Amazon ECR container image.
" + } + }, + "ecrImageHash": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "Details of the Amazon ECR image hashes used to filter findings.
" + } + }, + "portRange": { + "target": "com.amazonaws.inspector2#PortRangeFilterList", + "traits": { + "smithy.api#documentation": "Details on the port ranges used to filter findings.
" + } + }, + "networkProtocol": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "Details on the ingress source addresses used to filter findings.
" + } + }, + "componentId": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "Details of the component IDs used to filter findings.
" + } + }, + "componentType": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "Details of the component types used to filter findings.
" + } + }, + "vulnerabilityId": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "Details on the vulnerability ID used to filter findings.
" + } + }, + "vulnerabilitySource": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "Details on the vulnerability type used to filter findings.
" + } + }, + "vendorSeverity": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "Details on the vendor severity used to filter findings.
" + } + }, + "vulnerablePackages": { + "target": "com.amazonaws.inspector2#PackageFilterList", + "traits": { + "smithy.api#documentation": "Details on the vulnerable packages used to filter findings.
" + } + }, + "relatedVulnerabilities": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "Details on the related vulnerabilities used to filter findings.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details on the criteria used to define the filter.
" + } + }, + "com.amazonaws.inspector2#FilterDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.inspector2#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Filter" + } + }, + "com.amazonaws.inspector2#FilterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.inspector2#FilterReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.inspector2#Finding": { + "type": "structure", + "members": { + "findingArn": { + "target": "com.amazonaws.inspector2#FindingArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the finding.
", + "smithy.api#required": {} + } + }, + "awsAccountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID associated with the finding.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.inspector2#FindingType", + "traits": { + "smithy.api#documentation": "The type of the finding.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.inspector2#FindingDescription", + "traits": { + "smithy.api#documentation": "The description of the finding.
", + "smithy.api#required": {} + } + }, + "title": { + "target": "com.amazonaws.inspector2#FindingTitle", + "traits": { + "smithy.api#documentation": "The title of the finding.
" + } + }, + "remediation": { + "target": "com.amazonaws.inspector2#Remediation", + "traits": { + "smithy.api#documentation": "An object that contains the details about how to remediate a finding.
", + "smithy.api#required": {} + } + }, + "severity": { + "target": "com.amazonaws.inspector2#Severity", + "traits": { + "smithy.api#documentation": "The severity of the finding.
", + "smithy.api#required": {} + } + }, + "firstObservedAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The date and time that the finding was first observed.
", + "smithy.api#required": {} + } + }, + "lastObservedAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The date and time that the finding was last observed.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The date and time the finding was last updated at.
" + } + }, + "status": { + "target": "com.amazonaws.inspector2#FindingStatus", + "traits": { + "smithy.api#documentation": "The status of the finding.
", + "smithy.api#required": {} + } + }, + "resources": { + "target": "com.amazonaws.inspector2#ResourceList", + "traits": { + "smithy.api#documentation": "Contains information on the resources involved in a finding.
", + "smithy.api#required": {} + } + }, + "inspectorScore": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The Amazon Inspector score given to the finding.
" + } + }, + "inspectorScoreDetails": { + "target": "com.amazonaws.inspector2#InspectorScoreDetails", + "traits": { + "smithy.api#documentation": "An object that contains details of the Amazon Inspector score.
" + } + }, + "networkReachabilityDetails": { + "target": "com.amazonaws.inspector2#NetworkReachabilityDetails", + "traits": { + "smithy.api#documentation": "An object that contains the details of a network reachability finding.
" + } + }, + "packageVulnerabilityDetails": { + "target": "com.amazonaws.inspector2#PackageVulnerabilityDetails", + "traits": { + "smithy.api#documentation": "An object that contains the details of a package vulnerability finding.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about an Amazon Inspector finding.
" + } + }, + "com.amazonaws.inspector2#FindingArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#FindingDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#FindingList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Finding" + }, + "traits": { + "smithy.api#length": { + "max": 25 + } + } + }, + "com.amazonaws.inspector2#FindingStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "SUPPRESSED", + "name": "SUPPRESSED" + }, + { + "value": "CLOSED", + "name": "CLOSED" + } + ] + } + }, + "com.amazonaws.inspector2#FindingTitle": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#FindingType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NETWORK_REACHABILITY", + "name": "NETWORK_REACHABILITY" + }, + { + "value": "PACKAGE_VULNERABILITY", + "name": "PACKAGE_VULNERABILITY" + } + ] + } + }, + "com.amazonaws.inspector2#FindingTypeAggregation": { + "type": "structure", + "members": { + "findingType": { + "target": "com.amazonaws.inspector2#AggregationFindingType", + "traits": { + "smithy.api#documentation": "The finding type to aggregate.
" + } + }, + "resourceType": { + "target": "com.amazonaws.inspector2#AggregationResourceType", + "traits": { + "smithy.api#documentation": "The resource type to aggregate.
" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#SortOrder", + "traits": { + "smithy.api#documentation": "The order to sort results by.
" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#FindingTypeSortBy", + "traits": { + "smithy.api#documentation": "The value to sort results by.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details that define an aggregation based on finding type.
" + } + }, + "com.amazonaws.inspector2#FindingTypeAggregationResponse": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account associated with the findings.
" + } + }, + "severityCounts": { + "target": "com.amazonaws.inspector2#SeverityCounts", + "traits": { + "smithy.api#documentation": "The value to sort results by.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A response that contains the results of a finding type aggregation.
" + } + }, + "com.amazonaws.inspector2#FindingTypeSortBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CRITICAL", + "name": "CRITICAL" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "ALL", + "name": "ALL" + } + ] + } + }, + "com.amazonaws.inspector2#FreeTrialAccountInfo": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#MeteringAccountId", + "traits": { + "smithy.api#documentation": "The account associated with the Amazon Inspector free trial information.
", + "smithy.api#required": {} + } + }, + "freeTrialInfo": { + "target": "com.amazonaws.inspector2#FreeTrialInfoList", + "traits": { + "smithy.api#documentation": "Contains information about the Amazon Inspector free trial for an account.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the Amazon Inspector free trial for an account.
" + } + }, + "com.amazonaws.inspector2#FreeTrialAccountInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#FreeTrialAccountInfo" + } + }, + "com.amazonaws.inspector2#FreeTrialInfo": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.inspector2#FreeTrialType", + "traits": { + "smithy.api#documentation": "The type of scan covered by the Amazon Inspector free trail.
", + "smithy.api#required": {} + } + }, + "start": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the Amazon Inspector free trail started for a given account.
", + "smithy.api#required": {} + } + }, + "end": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the Amazon Inspector free trail ends for a given account.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.inspector2#FreeTrialStatus", + "traits": { + "smithy.api#documentation": "The order to sort results by.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information about the Amazon Inspector free trial for an account.
" + } + }, + "com.amazonaws.inspector2#FreeTrialInfoError": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#MeteringAccountId", + "traits": { + "smithy.api#documentation": "The account associated with the Amazon Inspector free trial information.
", + "smithy.api#required": {} + } + }, + "code": { + "target": "com.amazonaws.inspector2#FreeTrialInfoErrorCode", + "traits": { + "smithy.api#documentation": "The error code.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The error message returned.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about an error received while accessing free trail data for an account.
" + } + }, + "com.amazonaws.inspector2#FreeTrialInfoErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACCESS_DENIED", + "name": "ACCESS_DENIED" + }, + { + "value": "INTERNAL_ERROR", + "name": "INTERNAL_ERROR" + } + ] + } + }, + "com.amazonaws.inspector2#FreeTrialInfoErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#FreeTrialInfoError" + } + }, + "com.amazonaws.inspector2#FreeTrialInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#FreeTrialInfo" + } + }, + "com.amazonaws.inspector2#FreeTrialStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "INACTIVE", + "name": "INACTIVE" + } + ] + } + }, + "com.amazonaws.inspector2#FreeTrialType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EC2", + "name": "EC2" + }, + { + "value": "ECR", + "name": "ECR" + } + ] + } + }, + "com.amazonaws.inspector2#GetDelegatedAdminAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#GetDelegatedAdminAccountRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#GetDelegatedAdminAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about the Amazon Inspector delegated administrator for your\n organization.
", + "smithy.api#http": { + "method": "POST", + "uri": "/delegatedadminaccounts/get", + "code": 200 + } + } + }, + "com.amazonaws.inspector2#GetDelegatedAdminAccountRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.inspector2#GetDelegatedAdminAccountResponse": { + "type": "structure", + "members": { + "delegatedAdmin": { + "target": "com.amazonaws.inspector2#DelegatedAdmin", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the Amazon Inspector delegated administrator.
" + } + } + } + }, + "com.amazonaws.inspector2#GetFindingsReportStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#GetFindingsReportStatusRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#GetFindingsReportStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the status of a findings report.
", + "smithy.api#http": { + "method": "POST", + "uri": "/reporting/status/get", + "code": 200 + } + } + }, + "com.amazonaws.inspector2#GetFindingsReportStatusRequest": { + "type": "structure", + "members": { + "reportId": { + "target": "com.amazonaws.inspector2#ReportId", + "traits": { + "smithy.api#documentation": "The ID of the report to retrieve the status of.
" + } + } + } + }, + "com.amazonaws.inspector2#GetFindingsReportStatusResponse": { + "type": "structure", + "members": { + "reportId": { + "target": "com.amazonaws.inspector2#ReportId", + "traits": { + "smithy.api#documentation": "The ID of the report.
" + } + }, + "status": { + "target": "com.amazonaws.inspector2#ExternalReportStatus", + "traits": { + "smithy.api#documentation": "The status of the report.
" + } + }, + "errorCode": { + "target": "com.amazonaws.inspector2#ReportingErrorCode", + "traits": { + "smithy.api#documentation": "The error code of the report.
" + } + }, + "errorMessage": { + "target": "com.amazonaws.inspector2#ErrorMessage", + "traits": { + "smithy.api#documentation": "The error message of the report.
" + } + }, + "destination": { + "target": "com.amazonaws.inspector2#Destination", + "traits": { + "smithy.api#documentation": "The destination of the report.
" + } + }, + "filterCriteria": { + "target": "com.amazonaws.inspector2#FilterCriteria", + "traits": { + "smithy.api#documentation": "The filter criteria associated with the report.
" + } + } + } + }, + "com.amazonaws.inspector2#GetMember": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#GetMemberRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#GetMemberResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets member information for your organization.
", + "smithy.api#http": { + "method": "POST", + "uri": "/members/get", + "code": 200 + } + } + }, + "com.amazonaws.inspector2#GetMemberRequest": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the member account to retrieve information on.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#GetMemberResponse": { + "type": "structure", + "members": { + "member": { + "target": "com.amazonaws.inspector2#Member", + "traits": { + "smithy.api#documentation": "Details of the retrieved member account.
" + } + } + } + }, + "com.amazonaws.inspector2#GroupKey": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SCAN_STATUS_CODE", + "name": "SCAN_STATUS_CODE" + }, + { + "value": "SCAN_STATUS_REASON", + "name": "SCAN_STATUS_REASON" + }, + { + "value": "ACCOUNT_ID", + "name": "ACCOUNT_ID" + }, + { + "value": "RESOURCE_TYPE", + "name": "RESOURCE_TYPE" + }, + { + "value": "ECR_REPOSITORY_NAME", + "name": "ECR_REPOSITORY_NAME" + } + ] + } + }, + "com.amazonaws.inspector2#ImageHash": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 71, + "max": 71 + }, + "smithy.api#pattern": "^sha256:[a-z0-9]{64}$" + } + }, + "com.amazonaws.inspector2#ImageLayerAggregation": { + "type": "structure", + "members": { + "repositories": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "The repository associated with the container image hosting the layers.
" + } + }, + "resourceIds": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "The ID of the container image layer.
" + } + }, + "layerHashes": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "The hashes associated with the layers.
" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#SortOrder", + "traits": { + "smithy.api#documentation": "The order to sort results by.
" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#ImageLayerSortBy", + "traits": { + "smithy.api#documentation": "The value to sort results by.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details that define an aggregation based on container image layers.
" + } + }, + "com.amazonaws.inspector2#ImageLayerAggregationResponse": { + "type": "structure", + "members": { + "repository": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The repository the layer resides in.
", + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The resource ID of the container image layer.
", + "smithy.api#required": {} + } + }, + "layerHash": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The layer hash.
", + "smithy.api#required": {} + } + }, + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the container image hosting the layer image.
", + "smithy.api#required": {} + } + }, + "severityCounts": { + "target": "com.amazonaws.inspector2#SeverityCounts", + "traits": { + "smithy.api#documentation": "An object that represents the count of matched findings per severity.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A response that contains the results of a finding aggregation by image layer.
" + } + }, + "com.amazonaws.inspector2#ImageLayerSortBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CRITICAL", + "name": "CRITICAL" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "ALL", + "name": "ALL" + } + ] + } + }, + "com.amazonaws.inspector2#ImageTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#NonEmptyString" + } + }, + "com.amazonaws.inspector2#Inspector2": { + "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Inspector2", + "arnNamespace": "inspector2", + "cloudFormationName": "Inspector2", + "cloudTrailEventSource": "inspector2.amazon.aws", + "endpointPrefix": "inspector2" + }, + "aws.auth#sigv4": { + "name": "inspector2" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*" + ] + }, + "smithy.api#documentation": "Amazon Inspector is a vulnerability discovery service that automates continuous scanning for\n security vulnerabilities within your Amazon EC2 and Amazon ECR environments.
", + "smithy.api#title": "Inspector2" + }, + "version": "2020-06-08", + "operations": [ + { + "target": "com.amazonaws.inspector2#AssociateMember" + }, + { + "target": "com.amazonaws.inspector2#BatchGetAccountStatus" + }, + { + "target": "com.amazonaws.inspector2#BatchGetFreeTrialInfo" + }, + { + "target": "com.amazonaws.inspector2#CancelFindingsReport" + }, + { + "target": "com.amazonaws.inspector2#CreateFilter" + }, + { + "target": "com.amazonaws.inspector2#CreateFindingsReport" + }, + { + "target": "com.amazonaws.inspector2#DeleteFilter" + }, + { + "target": "com.amazonaws.inspector2#DescribeOrganizationConfiguration" + }, + { + "target": "com.amazonaws.inspector2#Disable" + }, + { + "target": "com.amazonaws.inspector2#DisableDelegatedAdminAccount" + }, + { + "target": "com.amazonaws.inspector2#DisassociateMember" + }, + { + "target": "com.amazonaws.inspector2#Enable" + }, + { + "target": "com.amazonaws.inspector2#EnableDelegatedAdminAccount" + }, + { + "target": "com.amazonaws.inspector2#GetDelegatedAdminAccount" + }, + { + "target": "com.amazonaws.inspector2#GetFindingsReportStatus" + }, + { + "target": "com.amazonaws.inspector2#GetMember" + }, + { + "target": "com.amazonaws.inspector2#ListAccountPermissions" + }, + { + "target": "com.amazonaws.inspector2#ListCoverage" + }, + { + "target": "com.amazonaws.inspector2#ListCoverageStatistics" + }, + { + "target": "com.amazonaws.inspector2#ListDelegatedAdminAccounts" + }, + { + "target": "com.amazonaws.inspector2#ListFilters" + }, + { + "target": "com.amazonaws.inspector2#ListFindingAggregations" + }, + { + "target": "com.amazonaws.inspector2#ListFindings" + }, + { + "target": "com.amazonaws.inspector2#ListMembers" + }, + { + "target": "com.amazonaws.inspector2#ListTagsForResource" + }, + { + "target": "com.amazonaws.inspector2#ListUsageTotals" + }, + { + "target": "com.amazonaws.inspector2#TagResource" + }, + { + "target": "com.amazonaws.inspector2#UntagResource" + }, + { + "target": "com.amazonaws.inspector2#UpdateFilter" + }, + { + "target": "com.amazonaws.inspector2#UpdateOrganizationConfiguration" + } + ] + }, + "com.amazonaws.inspector2#InspectorScoreDetails": { + "type": "structure", + "members": { + "adjustedCvss": { + "target": "com.amazonaws.inspector2#CvssScoreDetails", + "traits": { + "smithy.api#documentation": "An object that contains details about the CVSS score given to a finding.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the Amazon Inspector score given to a finding.
" + } + }, + "com.amazonaws.inspector2#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "retryAfterSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of seconds to wait before retrying the request.
", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "The request has failed due to an internal failure of the Amazon Inspector service.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.inspector2#IpV4Address": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 7, + "max": 15 + }, + "smithy.api#pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$" + } + }, + "com.amazonaws.inspector2#IpV4AddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#IpV4Address" + } + }, + "com.amazonaws.inspector2#IpV6Address": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 47 + } + } + }, + "com.amazonaws.inspector2#IpV6AddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#IpV6Address" + } + }, + "com.amazonaws.inspector2#ListAccountPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#ListAccountPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#ListAccountPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the permissions an account has to configure Amazon Inspector.
", + "smithy.api#http": { + "method": "POST", + "uri": "/accountpermissions/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "permissions", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.inspector2#ListAccountPermissionsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#ListAccountPermissionsRequest": { + "type": "structure", + "members": { + "service": { + "target": "com.amazonaws.inspector2#Service", + "traits": { + "smithy.api#documentation": "The service scan type to check permissions for.
" + } + }, + "maxResults": { + "target": "com.amazonaws.inspector2#ListAccountPermissionsMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response.
" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.
Contains details on the permissions an account has to configure Amazon Inspector.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.
Lists coverage details for you environment.
", + "smithy.api#http": { + "method": "POST", + "uri": "/coverage/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "coveredResources", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.inspector2#ListCoverageMaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.inspector2#ListCoverageRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.inspector2#ListCoverageMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response.
" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.
An object that contains details on the filters to apply to the coverage data for your\n environment.
" + } + } + } + }, + "com.amazonaws.inspector2#ListCoverageResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.
An object that contains details on the covered resources in your environment.
" + } + } + } + }, + "com.amazonaws.inspector2#ListCoverageStatistics": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#ListCoverageStatisticsRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#ListCoverageStatisticsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists Amazon Inspector coverage statistics for your environment.
", + "smithy.api#http": { + "method": "POST", + "uri": "/coverage/statistics/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "countsByGroup" + } + } + }, + "com.amazonaws.inspector2#ListCoverageStatisticsRequest": { + "type": "structure", + "members": { + "filterCriteria": { + "target": "com.amazonaws.inspector2#CoverageFilterCriteria", + "traits": { + "smithy.api#documentation": "An object that contains details on the filters to apply to the coverage data for your\n environment.
" + } + }, + "groupBy": { + "target": "com.amazonaws.inspector2#GroupKey", + "traits": { + "smithy.api#documentation": "The value to group the results by.
" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.
An array with the number for each group.
" + } + }, + "totalCounts": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The total number for all groups.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.
Lists information about the Amazon Inspector delegated administrator of your\n organization.
", + "smithy.api#http": { + "method": "POST", + "uri": "/delegatedadminaccounts/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "delegatedAdminAccounts", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.inspector2#ListDelegatedAdminAccountsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.inspector2#ListDelegatedAdminMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response.
" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.
Details of the Amazon Inspector delegated administrator of your organization.
" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.
Lists the filters associated with your account.
", + "smithy.api#http": { + "method": "POST", + "uri": "/filters/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "filters", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.inspector2#ListFiltersRequest": { + "type": "structure", + "members": { + "arns": { + "target": "com.amazonaws.inspector2#FilterArnList", + "traits": { + "smithy.api#documentation": "The Amazon resource number (ARN) of the filter.
" + } + }, + "action": { + "target": "com.amazonaws.inspector2#FilterAction", + "traits": { + "smithy.api#documentation": "The action the filter applies to matched findings.
" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.
The maximum number of results to return in the response.
" + } + } + } + }, + "com.amazonaws.inspector2#ListFiltersResponse": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.inspector2#FilterList", + "traits": { + "smithy.api#documentation": "Contains details on the filters associated with your account.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.
Lists aggregated finding data for your environment based on specific criteria.
", + "smithy.api#http": { + "method": "POST", + "uri": "/findings/aggregation/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "responses", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.inspector2#ListFindingAggregationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.inspector2#ListFindingAggregationsRequest": { + "type": "structure", + "members": { + "aggregationType": { + "target": "com.amazonaws.inspector2#AggregationType", + "traits": { + "smithy.api#documentation": "The type of the aggregation request.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.
The maximum number of results to return in the response.
" + } + }, + "accountIds": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account IDs to retrieve finding aggregation data for.
" + } + }, + "aggregationRequest": { + "target": "com.amazonaws.inspector2#AggregationRequest", + "traits": { + "smithy.api#documentation": "Details of the aggregation request that is used to filter your aggregation results.
" + } + } + } + }, + "com.amazonaws.inspector2#ListFindingAggregationsResponse": { + "type": "structure", + "members": { + "aggregationType": { + "target": "com.amazonaws.inspector2#AggregationType", + "traits": { + "smithy.api#documentation": "The type of aggregation to perform.
", + "smithy.api#required": {} + } + }, + "responses": { + "target": "com.amazonaws.inspector2#AggregationResponseList", + "traits": { + "smithy.api#documentation": "Objects that contain the results of an aggregation operation.
" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.
Lists findings for your environment.
", + "smithy.api#http": { + "method": "POST", + "uri": "/findings/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "findings", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.inspector2#ListFindingsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.inspector2#ListFindingsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.inspector2#ListFindingsMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response.
" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.
Details on the filters to apply to your finding results.
" + } + }, + "sortCriteria": { + "target": "com.amazonaws.inspector2#SortCriteria", + "traits": { + "smithy.api#documentation": "Details on the sort criteria to apply to your finding results.
" + } + } + } + }, + "com.amazonaws.inspector2#ListFindingsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.
Contains details on the findings in your environment.
" + } + } + } + }, + "com.amazonaws.inspector2#ListMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#ListMembersRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#ListMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List members associated with the Amazon Inspector delegated administrator for your\n organization.
", + "smithy.api#http": { + "method": "POST", + "uri": "/members/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "members", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.inspector2#ListMembersMaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.inspector2#ListMembersRequest": { + "type": "structure", + "members": { + "onlyAssociated": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether to list only currently associated members if True or to\n list all members within the organization if False.
The maximum number of results to return in the response.
" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.
An object that contains details for each member account.
" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more\n items.
" + } + } + } + }, + "com.amazonaws.inspector2#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all tags attached to a given resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.inspector2#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.inspector2#Arn", + "traits": { + "smithy.api#documentation": "The Amazon resource number (ARN) of the resource to list tags of.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.inspector2#TagMap", + "traits": { + "smithy.api#documentation": "The tags associated with the resource.
" + } + } + } + }, + "com.amazonaws.inspector2#ListUsageTotals": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#ListUsageTotalsRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#ListUsageTotalsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the Amazon Inspector usage totals over the last 30 days.
", + "smithy.api#http": { + "method": "POST", + "uri": "/usage/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "totals", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.inspector2#ListUsageTotalsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.inspector2#ListUsageTotalsNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.inspector2#ListUsageTotalsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.inspector2#ListUsageTotalsMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response.
" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#ListUsageTotalsNextToken", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.
The Amazon Web Services account IDs to retrieve usage totals for.
" + } + } + } + }, + "com.amazonaws.inspector2#ListUsageTotalsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.inspector2#ListUsageTotalsNextToken", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more items.
" + } + }, + "totals": { + "target": "com.amazonaws.inspector2#UsageTotalList", + "traits": { + "smithy.api#documentation": "An object with details on the total usage for the requested account.
" + } + } + } + }, + "com.amazonaws.inspector2#MapComparison": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EQUALS", + "name": "EQUALS" + } + ] + } + }, + "com.amazonaws.inspector2#MapFilter": { + "type": "structure", + "members": { + "comparison": { + "target": "com.amazonaws.inspector2#MapComparison", + "traits": { + "smithy.api#documentation": "The operator to use when comparing values in the filter.
", + "smithy.api#required": {} + } + }, + "key": { + "target": "com.amazonaws.inspector2#MapKey", + "traits": { + "smithy.api#documentation": "The tag key used in the filter.
", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.inspector2#MapValue", + "traits": { + "smithy.api#documentation": "The tag value used in the filter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that describes details of a map filter.
" + } + }, + "com.amazonaws.inspector2#MapFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#MapFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#MapKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.inspector2#MapValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 256 + } + } + }, + "com.amazonaws.inspector2#Member": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the member account.
" + } + }, + "relationshipStatus": { + "target": "com.amazonaws.inspector2#RelationshipStatus", + "traits": { + "smithy.api#documentation": "The status of the member account.
" + } + }, + "delegatedAdminAccountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the Amazon Inspector delegated administrator for this member account.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "A timestamp showing when the status of this member was last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details on a member account in your organization.
" + } + }, + "com.amazonaws.inspector2#MemberList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Member" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.inspector2#MeteringAccountId": { + "type": "string", + "traits": { + "smithy.api#pattern": "[0-9]{12}" + } + }, + "com.amazonaws.inspector2#MeteringAccountIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#MeteringAccountId" + } + }, + "com.amazonaws.inspector2#MonthlyCostEstimate": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.inspector2#NetworkPath": { + "type": "structure", + "members": { + "steps": { + "target": "com.amazonaws.inspector2#StepList", + "traits": { + "smithy.api#documentation": "The details on the steps in the network path.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information on the network path associated with a finding.
" + } + }, + "com.amazonaws.inspector2#NetworkProtocol": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TCP", + "name": "TCP" + }, + { + "value": "UDP", + "name": "UDP" + } + ] + } + }, + "com.amazonaws.inspector2#NetworkReachabilityDetails": { + "type": "structure", + "members": { + "openPortRange": { + "target": "com.amazonaws.inspector2#PortRange", + "traits": { + "smithy.api#documentation": "An object that contains details about the open port range associated with a finding.
", + "smithy.api#required": {} + } + }, + "protocol": { + "target": "com.amazonaws.inspector2#NetworkProtocol", + "traits": { + "smithy.api#documentation": "The protocol associated with a finding.
", + "smithy.api#required": {} + } + }, + "networkPath": { + "target": "com.amazonaws.inspector2#NetworkPath", + "traits": { + "smithy.api#documentation": "An object that contains details about a network path associated with a finding.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the details of a network reachability finding.
" + } + }, + "com.amazonaws.inspector2#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1000000 + } + } + }, + "com.amazonaws.inspector2#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.inspector2#NonEmptyStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#NonEmptyString" + } + }, + "com.amazonaws.inspector2#NumberFilter": { + "type": "structure", + "members": { + "upperInclusive": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The highest number to be included in the filter.
" + } + }, + "lowerInclusive": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The lowest number to be included in the filter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that describes the details of a number filter.
" + } + }, + "com.amazonaws.inspector2#NumberFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#NumberFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#Operation": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENABLE_SCANNING", + "name": "ENABLE_SCANNING" + }, + { + "value": "DISABLE_SCANNING", + "name": "DISABLE_SCANNING" + }, + { + "value": "ENABLE_REPOSITORY", + "name": "ENABLE_REPOSITORY" + }, + { + "value": "DISABLE_REPOSITORY", + "name": "DISABLE_REPOSITORY" + } + ] + } + }, + "com.amazonaws.inspector2#OwnerId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 34 + }, + "smithy.api#pattern": "(^\\d{12}$)|(^o-[a-z0-9]{10,32}$)" + } + }, + "com.amazonaws.inspector2#PackageAggregation": { + "type": "structure", + "members": { + "packageNames": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "The names of packages to aggregate findings on.
" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#SortOrder", + "traits": { + "smithy.api#documentation": "The order to sort results by.
" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#PackageSortBy", + "traits": { + "smithy.api#documentation": "The value to sort results by.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details that define an aggregation based on operating system package type.
" + } + }, + "com.amazonaws.inspector2#PackageAggregationResponse": { + "type": "structure", + "members": { + "packageName": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The name of the operating system package.
", + "smithy.api#required": {} + } + }, + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account associated with the findings.
" + } + }, + "severityCounts": { + "target": "com.amazonaws.inspector2#SeverityCounts", + "traits": { + "smithy.api#documentation": "An object that contains the count of matched findings per severity.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A response that contains the results of a finding aggregation by image layer.
" + } + }, + "com.amazonaws.inspector2#PackageArchitecture": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.inspector2#PackageEpoch": { + "type": "integer" + }, + "com.amazonaws.inspector2#PackageFilter": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.inspector2#StringFilter", + "traits": { + "smithy.api#documentation": "An object that contains details on the name of the package to filter on.
" + } + }, + "version": { + "target": "com.amazonaws.inspector2#StringFilter", + "traits": { + "smithy.api#documentation": "The package version to filter on.
" + } + }, + "epoch": { + "target": "com.amazonaws.inspector2#NumberFilter", + "traits": { + "smithy.api#documentation": "An object that contains details on the package epoch to filter on.
" + } + }, + "release": { + "target": "com.amazonaws.inspector2#StringFilter", + "traits": { + "smithy.api#documentation": "An object that contains details on the package release to filter on.
" + } + }, + "architecture": { + "target": "com.amazonaws.inspector2#StringFilter", + "traits": { + "smithy.api#documentation": "An object that contains details on the package architecture type to filter on.
" + } + }, + "sourceLayerHash": { + "target": "com.amazonaws.inspector2#StringFilter", + "traits": { + "smithy.api#documentation": "An object that contains details on the source layer hash to filter on.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the details of a package filter.
" + } + }, + "com.amazonaws.inspector2#PackageFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#PackageFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#PackageManager": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "BUNDLER", + "name": "BUNDLER" + }, + { + "value": "CARGO", + "name": "CARGO" + }, + { + "value": "COMPOSER", + "name": "COMPOSER" + }, + { + "value": "NPM", + "name": "NPM" + }, + { + "value": "NUGET", + "name": "NUGET" + }, + { + "value": "PIPENV", + "name": "PIPENV" + }, + { + "value": "POETRY", + "name": "POETRY" + }, + { + "value": "YARN", + "name": "YARN" + }, + { + "value": "GOBINARY", + "name": "GOBINARY" + }, + { + "value": "GOMOD", + "name": "GOMOD" + }, + { + "value": "JAR", + "name": "JAR" + }, + { + "value": "OS", + "name": "OS" + } + ] + } + }, + "com.amazonaws.inspector2#PackageName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#PackageRelease": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#PackageSortBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CRITICAL", + "name": "CRITICAL" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "ALL", + "name": "ALL" + } + ] + } + }, + "com.amazonaws.inspector2#PackageVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#PackageVulnerabilityDetails": { + "type": "structure", + "members": { + "vulnerabilityId": { + "target": "com.amazonaws.inspector2#VulnerabilityId", + "traits": { + "smithy.api#documentation": "The ID given to this vulnerability.
", + "smithy.api#required": {} + } + }, + "vulnerablePackages": { + "target": "com.amazonaws.inspector2#VulnerablePackageList", + "traits": { + "smithy.api#documentation": "The packages impacted by this vulnerability.
", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The source of the vulnerability information.
", + "smithy.api#required": {} + } + }, + "cvss": { + "target": "com.amazonaws.inspector2#CvssScoreList", + "traits": { + "smithy.api#documentation": "An object that contains details about the CVSS score of a finding.
" + } + }, + "relatedVulnerabilities": { + "target": "com.amazonaws.inspector2#VulnerabilityIdList", + "traits": { + "smithy.api#documentation": "One or more vulnerabilities related to the one identified in this finding.
" + } + }, + "sourceUrl": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "A URL to the source of the vulnerability information.
" + } + }, + "vendorSeverity": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The severity the vendor has given to this vulnerability type.
" + } + }, + "vendorCreatedAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The date and time that this vulnerability was first added to the vendor's database.
" + } + }, + "vendorUpdatedAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The date and time the vendor last updated this vulnerability in their database.
" + } + }, + "referenceUrls": { + "target": "com.amazonaws.inspector2#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "One or more URLs that contain details about this vulnerability type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a package vulnerability finding.
" + } + }, + "com.amazonaws.inspector2#Permission": { + "type": "structure", + "members": { + "service": { + "target": "com.amazonaws.inspector2#Service", + "traits": { + "smithy.api#documentation": "The services that the permissions allow an account to perform the given operations for.
", + "smithy.api#required": {} + } + }, + "operation": { + "target": "com.amazonaws.inspector2#Operation", + "traits": { + "smithy.api#documentation": "The operations that can be performed with the given permissions.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the permissions an account has within Amazon Inspector.
" + } + }, + "com.amazonaws.inspector2#Permissions": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Permission" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#Platform": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#Port": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 65535 + } + } + }, + "com.amazonaws.inspector2#PortRange": { + "type": "structure", + "members": { + "begin": { + "target": "com.amazonaws.inspector2#Port", + "traits": { + "smithy.api#documentation": "The beginning port in a port range.
", + "smithy.api#required": {} + } + }, + "end": { + "target": "com.amazonaws.inspector2#Port", + "traits": { + "smithy.api#documentation": "The ending port in a port range.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the port range associated with a finding.
" + } + }, + "com.amazonaws.inspector2#PortRangeFilter": { + "type": "structure", + "members": { + "beginInclusive": { + "target": "com.amazonaws.inspector2#Port", + "traits": { + "smithy.api#documentation": "The port number the port range begins at.
" + } + }, + "endInclusive": { + "target": "com.amazonaws.inspector2#Port", + "traits": { + "smithy.api#documentation": "The port number the port range ends at.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that describes the details of a port range filter.
" + } + }, + "com.amazonaws.inspector2#PortRangeFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#PortRangeFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#Recommendation": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The recommended course of action to remediate the finding.
" + } + }, + "Url": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The URL address to the CVE remediation recommendations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the recommended course of action to remediate the finding.
" + } + }, + "com.amazonaws.inspector2#RelationshipStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATED", + "name": "CREATED" + }, + { + "value": "INVITED", + "name": "INVITED" + }, + { + "value": "DISABLED", + "name": "DISABLED" + }, + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "REMOVED", + "name": "REMOVED" + }, + { + "value": "RESIGNED", + "name": "RESIGNED" + }, + { + "value": "DELETED", + "name": "DELETED" + }, + { + "value": "EMAIL_VERIFICATION_IN_PROGRESS", + "name": "EMAIL_VERIFICATION_IN_PROGRESS" + }, + { + "value": "EMAIL_VERIFICATION_FAILED", + "name": "EMAIL_VERIFICATION_FAILED" + }, + { + "value": "REGION_DISABLED", + "name": "REGION_DISABLED" + }, + { + "value": "ACCOUNT_SUSPENDED", + "name": "ACCOUNT_SUSPENDED" + }, + { + "value": "CANNOT_CREATE_DETECTOR_IN_ORG_MASTER", + "name": "CANNOT_CREATE_DETECTOR_IN_ORG_MASTER" + } + ] + } + }, + "com.amazonaws.inspector2#Remediation": { + "type": "structure", + "members": { + "recommendation": { + "target": "com.amazonaws.inspector2#Recommendation", + "traits": { + "smithy.api#documentation": "An object that contains information about the recommended course of action to remediate the finding.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information on how to remediate a finding.
" + } + }, + "com.amazonaws.inspector2#ReportFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CSV", + "name": "CSV" + }, + { + "value": "JSON", + "name": "JSON" + } + ] + } + }, + "com.amazonaws.inspector2#ReportId": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\b[a-f0-9]{8}\\b-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-\\b[a-f0-9]{12}\\b" + } + }, + "com.amazonaws.inspector2#ReportingErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INTERNAL_ERROR", + "name": "INTERNAL_ERROR" + }, + { + "value": "INVALID_PERMISSIONS", + "name": "INVALID_PERMISSIONS" + } + ] + } + }, + "com.amazonaws.inspector2#RepositoryAggregation": { + "type": "structure", + "members": { + "repositories": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "The names of repositories to aggregate findings on.
" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#SortOrder", + "traits": { + "smithy.api#documentation": "The order to sort results by.
" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#RepositorySortBy", + "traits": { + "smithy.api#documentation": "The value to sort results by.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details that define an aggregation based on repository.
" + } + }, + "com.amazonaws.inspector2#RepositoryAggregationResponse": { + "type": "structure", + "members": { + "repository": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The name of the repository associated with the findings.
", + "smithy.api#required": {} + } + }, + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account associated with the findings.
" + } + }, + "severityCounts": { + "target": "com.amazonaws.inspector2#SeverityCounts", + "traits": { + "smithy.api#documentation": "An object that represent the count of matched findings per severity.
" + } + }, + "affectedImages": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of container images impacted by the findings.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A response that contains details on the results of a finding aggregation by repository.
" + } + }, + "com.amazonaws.inspector2#RepositorySortBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CRITICAL", + "name": "CRITICAL" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "ALL", + "name": "ALL" + }, + { + "value": "AFFECTED_IMAGES", + "name": "AFFECTED_IMAGES" + } + ] + } + }, + "com.amazonaws.inspector2#Resource": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.inspector2#ResourceType", + "traits": { + "smithy.api#documentation": "The type of resource.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The ID of the resource.
", + "smithy.api#required": {} + } + }, + "partition": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The partition of the resource.
" + } + }, + "region": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region the impacted resource is located in.
" + } + }, + "tags": { + "target": "com.amazonaws.inspector2#TagMap", + "traits": { + "smithy.api#documentation": "The tags attached to the resource.
" + } + }, + "details": { + "target": "com.amazonaws.inspector2#ResourceDetails", + "traits": { + "smithy.api#documentation": "An object that contains details about the resource involved in a finding.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the resource involved in a finding.
" + } + }, + "com.amazonaws.inspector2#ResourceDetails": { + "type": "structure", + "members": { + "awsEc2Instance": { + "target": "com.amazonaws.inspector2#AwsEc2InstanceDetails", + "traits": { + "smithy.api#documentation": "An object that contains details about the Amazon EC2 instance involved in the finding.
" + } + }, + "awsEcrContainerImage": { + "target": "com.amazonaws.inspector2#AwsEcrContainerImageDetails", + "traits": { + "smithy.api#documentation": "An object that contains details about the Amazon ECR container image involved in the finding.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the resource involved in the finding.
" + } + }, + "com.amazonaws.inspector2#ResourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 341 + }, + "smithy.api#pattern": "(^arn:.*:ecr:.*:\\d{12}:repository\\/(?:[a-z0-9]+(?:[._-][a-z0-9]+)*\\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*(\\/sha256:[a-z0-9]{64})?$)|(^i-([a-z0-9]{8}|[a-z0-9]{17}|\\\\*)$)" + } + }, + "com.amazonaws.inspector2#ResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Resource" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The operation tried to access an invalid resource. Make sure the resource is specified correctly.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.inspector2#ResourceScanMetadata": { + "type": "structure", + "members": { + "ecrRepository": { + "target": "com.amazonaws.inspector2#EcrRepositoryMetadata", + "traits": { + "smithy.api#documentation": "An object that contains details about the repository an Amazon ECR image resides in.
" + } + }, + "ecrImage": { + "target": "com.amazonaws.inspector2#EcrContainerImageMetadata", + "traits": { + "smithy.api#documentation": "An object that contains details about the container metadata for an Amazon ECR image.
" + } + }, + "ec2": { + "target": "com.amazonaws.inspector2#Ec2Metadata", + "traits": { + "smithy.api#documentation": "An object that contains metadata details for an Amazon EC2 instance.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains details about the metadata for an Amazon ECR resource.
" + } + }, + "com.amazonaws.inspector2#ResourceScanType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EC2", + "name": "EC2" + }, + { + "value": "ECR", + "name": "ECR" + } + ] + } + }, + "com.amazonaws.inspector2#ResourceState": { + "type": "structure", + "members": { + "ec2": { + "target": "com.amazonaws.inspector2#State", + "traits": { + "smithy.api#documentation": "An object detailing the state of Amazon Inspector scanning for Amazon EC2 resources.
", + "smithy.api#required": {} + } + }, + "ecr": { + "target": "com.amazonaws.inspector2#State", + "traits": { + "smithy.api#documentation": "An object detailing the state of Amazon Inspector scanning for Amazon ECR resources.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details the state of Amazon Inspector for each resource type Amazon Inspector scans.
" + } + }, + "com.amazonaws.inspector2#ResourceStatus": { + "type": "structure", + "members": { + "ec2": { + "target": "com.amazonaws.inspector2#Status", + "traits": { + "smithy.api#documentation": "The status of Amazon Inspector scanning for Amazon EC2 resources.
", + "smithy.api#required": {} + } + }, + "ecr": { + "target": "com.amazonaws.inspector2#Status", + "traits": { + "smithy.api#documentation": "The status of Amazon Inspector scanning for Amazon ECR resources.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details the status of Amazon Inspector for each resource type Amazon Inspector scans.
" + } + }, + "com.amazonaws.inspector2#ResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWS_EC2_INSTANCE", + "name": "AWS_EC2_INSTANCE" + }, + { + "value": "AWS_ECR_CONTAINER_IMAGE", + "name": "AWS_ECR_CONTAINER_IMAGE" + }, + { + "value": "AWS_ECR_REPOSITORY", + "name": "AWS_ECR_REPOSITORY" + } + ] + } + }, + "com.amazonaws.inspector2#ScanStatus": { + "type": "structure", + "members": { + "statusCode": { + "target": "com.amazonaws.inspector2#ScanStatusCode", + "traits": { + "smithy.api#documentation": "The status code of the scan.
", + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.inspector2#ScanStatusReason", + "traits": { + "smithy.api#documentation": "The reason for the scan.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The status of the scan.
" + } + }, + "com.amazonaws.inspector2#ScanStatusCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "INACTIVE", + "name": "INACTIVE" + } + ] + } + }, + "com.amazonaws.inspector2#ScanStatusReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING_INITIAL_SCAN", + "name": "PENDING_INITIAL_SCAN" + }, + { + "value": "ACCESS_DENIED", + "name": "ACCESS_DENIED" + }, + { + "value": "INTERNAL_ERROR", + "name": "INTERNAL_ERROR" + }, + { + "value": "UNMANAGED_EC2_INSTANCE", + "name": "UNMANAGED_EC2_INSTANCE" + }, + { + "value": "UNSUPPORTED_OS", + "name": "UNSUPPORTED_OS" + }, + { + "value": "SCAN_ELIGIBILITY_EXPIRED", + "name": "SCAN_ELIGIBILITY_EXPIRED" + }, + { + "value": "RESOURCE_TERMINATED", + "name": "RESOURCE_TERMINATED" + }, + { + "value": "SUCCESSFUL", + "name": "SUCCESSFUL" + }, + { + "value": "NO_RESOURCES_FOUND", + "name": "NO_RESOURCES_FOUND" + }, + { + "value": "IMAGE_SIZE_EXCEEDED", + "name": "IMAGE_SIZE_EXCEEDED" + }, + { + "value": "SCAN_FREQUENCY_MANUAL", + "name": "SCAN_FREQUENCY_MANUAL" + }, + { + "value": "SCAN_FREQUENCY_SCAN_ON_PUSH", + "name": "SCAN_FREQUENCY_SCAN_ON_PUSH" + }, + { + "value": "EC2_INSTANCE_STOPPED", + "name": "EC2_INSTANCE_STOPPED" + } + ] + } + }, + "com.amazonaws.inspector2#ScanType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NETWORK", + "name": "NETWORK" + }, + { + "value": "PACKAGE", + "name": "PACKAGE" + } + ] + } + }, + "com.amazonaws.inspector2#Service": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EC2", + "name": "EC2" + }, + { + "value": "ECR", + "name": "ECR" + } + ] + } + }, + "com.amazonaws.inspector2#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the resource that exceeds a service quota.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "You have exceeded your service quota. To perform the requested action, remove some of\n the relevant resources, or use Service Quotas to request a service quota increase.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.inspector2#Severity": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INFORMATIONAL", + "name": "INFORMATIONAL" + }, + { + "value": "LOW", + "name": "LOW" + }, + { + "value": "MEDIUM", + "name": "MEDIUM" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "CRITICAL", + "name": "CRITICAL" + }, + { + "value": "UNTRIAGED", + "name": "UNTRIAGED" + } + ] + } + }, + "com.amazonaws.inspector2#SeverityCounts": { + "type": "structure", + "members": { + "all": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The total count of findings from all severities.
" + } + }, + "medium": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The total count of medium severity findings.
" + } + }, + "high": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The total count of high severity findings.
" + } + }, + "critical": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The total count of critical severity findings.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains the counts of aggregated finding per severity.
" + } + }, + "com.amazonaws.inspector2#SortCriteria": { + "type": "structure", + "members": { + "field": { + "target": "com.amazonaws.inspector2#SortField", + "traits": { + "smithy.api#documentation": "The finding detail field by which results are sorted.
", + "smithy.api#required": {} + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#SortOrder", + "traits": { + "smithy.api#documentation": "The order by which findings are sorted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the criteria used to sort finding results.
" + } + }, + "com.amazonaws.inspector2#SortField": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWS_ACCOUNT_ID", + "name": "AWS_ACCOUNT_ID" + }, + { + "value": "FINDING_TYPE", + "name": "FINDING_TYPE" + }, + { + "value": "SEVERITY", + "name": "SEVERITY" + }, + { + "value": "FIRST_OBSERVED_AT", + "name": "FIRST_OBSERVED_AT" + }, + { + "value": "LAST_OBSERVED_AT", + "name": "LAST_OBSERVED_AT" + }, + { + "value": "FINDING_STATUS", + "name": "FINDING_STATUS" + }, + { + "value": "RESOURCE_TYPE", + "name": "RESOURCE_TYPE" + }, + { + "value": "ECR_IMAGE_PUSHED_AT", + "name": "ECR_IMAGE_PUSHED_AT" + }, + { + "value": "ECR_IMAGE_REPOSITORY_NAME", + "name": "ECR_IMAGE_REPOSITORY_NAME" + }, + { + "value": "ECR_IMAGE_REGISTRY", + "name": "ECR_IMAGE_REGISTRY" + }, + { + "value": "NETWORK_PROTOCOL", + "name": "NETWORK_PROTOCOL" + }, + { + "value": "COMPONENT_TYPE", + "name": "COMPONENT_TYPE" + }, + { + "value": "VULNERABILITY_ID", + "name": "VULNERABILITY_ID" + }, + { + "value": "VULNERABILITY_SOURCE", + "name": "VULNERABILITY_SOURCE" + }, + { + "value": "INSPECTOR_SCORE", + "name": "INSPECTOR_SCORE" + }, + { + "value": "VENDOR_SEVERITY", + "name": "VENDOR_SEVERITY" + } + ] + } + }, + "com.amazonaws.inspector2#SortOrder": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ASC", + "name": "ASC" + }, + { + "value": "DESC", + "name": "DESC" + } + ] + } + }, + "com.amazonaws.inspector2#SourceLayerHash": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 71, + "max": 71 + }, + "smithy.api#pattern": "^sha256:[a-z0-9]{64}$" + } + }, + "com.amazonaws.inspector2#State": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.inspector2#Status", + "traits": { + "smithy.api#documentation": "The status of Amazon Inspector for the account.
", + "smithy.api#required": {} + } + }, + "errorCode": { + "target": "com.amazonaws.inspector2#ErrorCode", + "traits": { + "smithy.api#documentation": "The error code explaining why the account failed to enable Amazon Inspector.
", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The error message received when the account failed to enable Amazon Inspector.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object that described the state of Amazon Inspector scans for an account.
" + } + }, + "com.amazonaws.inspector2#Status": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENABLING", + "name": "ENABLING" + }, + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "DISABLING", + "name": "DISABLING" + }, + { + "value": "DISABLED", + "name": "DISABLED" + }, + { + "value": "SUSPENDING", + "name": "SUSPENDING" + }, + { + "value": "SUSPENDED", + "name": "SUSPENDED" + } + ] + } + }, + "com.amazonaws.inspector2#Step": { + "type": "structure", + "members": { + "componentId": { + "target": "com.amazonaws.inspector2#Component", + "traits": { + "smithy.api#documentation": "The component ID.
", + "smithy.api#required": {} + } + }, + "componentType": { + "target": "com.amazonaws.inspector2#ComponentType", + "traits": { + "smithy.api#documentation": "The component type.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the step associated with a finding.
" + } + }, + "com.amazonaws.inspector2#StepList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Step" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + } + } + }, + "com.amazonaws.inspector2#StringComparison": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EQUALS", + "name": "EQUALS" + }, + { + "value": "PREFIX", + "name": "PREFIX" + }, + { + "value": "NOT_EQUALS", + "name": "NOT_EQUALS" + } + ] + } + }, + "com.amazonaws.inspector2#StringFilter": { + "type": "structure", + "members": { + "comparison": { + "target": "com.amazonaws.inspector2#StringComparison", + "traits": { + "smithy.api#documentation": "The operator to use when comparing values in the filter
", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.inspector2#StringInput", + "traits": { + "smithy.api#documentation": "The value to filter on.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object that describes the details of a string filter.
" + } + }, + "com.amazonaws.inspector2#StringFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#StringFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#StringInput": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#NonEmptyString" + } + }, + "com.amazonaws.inspector2#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" + } + }, + "com.amazonaws.inspector2#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.inspector2#TagList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.inspector2#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.inspector2#MapKey" + }, + "value": { + "target": "com.amazonaws.inspector2#MapValue" + } + }, + "com.amazonaws.inspector2#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#BadRequestException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Adds tags to a resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.inspector2#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.inspector2#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to apply a tag to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.inspector2#TagMap", + "traits": { + "smithy.api#documentation": "The tags to be added to a resource.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.inspector2#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The limit on the number of requests per second was exceeded.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.inspector2#TitleAggregation": { + "type": "structure", + "members": { + "titles": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "The finding titles to aggregate on.
" + } + }, + "vulnerabilityIds": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "The vulnerability IDs of the findings.
" + } + }, + "resourceType": { + "target": "com.amazonaws.inspector2#AggregationResourceType", + "traits": { + "smithy.api#documentation": "The resource type to aggregate on.
" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#SortOrder", + "traits": { + "smithy.api#documentation": "The order to sort results by.
" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#TitleSortBy", + "traits": { + "smithy.api#documentation": "The value to sort results by.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details that define an aggregation based on finding title.
" + } + }, + "com.amazonaws.inspector2#TitleAggregationResponse": { + "type": "structure", + "members": { + "title": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The title that the findings were aggregated on.
", + "smithy.api#required": {} + } + }, + "vulnerabilityId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The vulnerability ID of the finding.
" + } + }, + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account associated with the findings.
" + } + }, + "severityCounts": { + "target": "com.amazonaws.inspector2#SeverityCounts", + "traits": { + "smithy.api#documentation": "An object that represent the count of matched findings per severity.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A response that contains details on the results of a finding aggregation by title.
" + } + }, + "com.amazonaws.inspector2#TitleSortBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CRITICAL", + "name": "CRITICAL" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "ALL", + "name": "ALL" + } + ] + } + }, + "com.amazonaws.inspector2#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes tags from a resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.inspector2#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.inspector2#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the resource to remove tags from.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.inspector2#TagKeyList", + "traits": { + "smithy.api#documentation": "The tag keys to remove from the resource.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.inspector2#UpdateFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#UpdateFilterRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#UpdateFilterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Specifies the action that is to be applied to the findings that match the filter.
", + "smithy.api#http": { + "method": "POST", + "uri": "/filters/update", + "code": 200 + } + } + }, + "com.amazonaws.inspector2#UpdateFilterRequest": { + "type": "structure", + "members": { + "action": { + "target": "com.amazonaws.inspector2#FilterAction", + "traits": { + "smithy.api#documentation": "Specifies the action that is to be applied to the findings that match the filter.
" + } + }, + "description": { + "target": "com.amazonaws.inspector2#FilterDescription", + "traits": { + "smithy.api#documentation": "A description of the filter.
" + } + }, + "filterCriteria": { + "target": "com.amazonaws.inspector2#FilterCriteria", + "traits": { + "smithy.api#documentation": "Defines the criteria to be update in the filter.
" + } + }, + "name": { + "target": "com.amazonaws.inspector2#FilterName", + "traits": { + "smithy.api#documentation": "The name of the filter.
" + } + }, + "filterArn": { + "target": "com.amazonaws.inspector2#FilterArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the filter to update.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#UpdateFilterResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.inspector2#FilterArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the successfully updated filter.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#UpdateOrganizationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#UpdateOrganizationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#UpdateOrganizationConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the configurations for your Amazon Inspector organization.
", + "smithy.api#http": { + "method": "POST", + "uri": "/organizationconfiguration/update", + "code": 200 + } + } + }, + "com.amazonaws.inspector2#UpdateOrganizationConfigurationRequest": { + "type": "structure", + "members": { + "autoEnable": { + "target": "com.amazonaws.inspector2#AutoEnable", + "traits": { + "smithy.api#documentation": "Defines which scan types are enabled automatically for new members of your Amazon Inspector organization.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#UpdateOrganizationConfigurationResponse": { + "type": "structure", + "members": { + "autoEnable": { + "target": "com.amazonaws.inspector2#AutoEnable", + "traits": { + "smithy.api#documentation": "The updated status of scan types automatically enabled for new members of your Amazon Inspector organization.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#Usage": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.inspector2#UsageType", + "traits": { + "smithy.api#documentation": "The type scan.
" + } + }, + "total": { + "target": "com.amazonaws.inspector2#UsageValue", + "traits": { + "smithy.api#documentation": "The total of usage.
" + } + }, + "estimatedMonthlyCost": { + "target": "com.amazonaws.inspector2#MonthlyCostEstimate", + "traits": { + "smithy.api#documentation": "The estimated monthly cost of Amazon Inspector.
" + } + }, + "currency": { + "target": "com.amazonaws.inspector2#Currency", + "traits": { + "smithy.api#documentation": "The currency type used when calculating usage data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains usage information about the cost of Amazon Inspector operation.
" + } + }, + "com.amazonaws.inspector2#UsageAccountId": { + "type": "string", + "traits": { + "smithy.api#pattern": "[0-9]{12}" + } + }, + "com.amazonaws.inspector2#UsageAccountIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#UsageAccountId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5000 + } + } + }, + "com.amazonaws.inspector2#UsageList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Usage" + } + }, + "com.amazonaws.inspector2#UsageTotal": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#MeteringAccountId", + "traits": { + "smithy.api#documentation": "The account ID of the account that usage data was retrieved for.
" + } + }, + "usage": { + "target": "com.amazonaws.inspector2#UsageList", + "traits": { + "smithy.api#documentation": "An object representing the total usage for an account.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The total of usage for an account ID.
" + } + }, + "com.amazonaws.inspector2#UsageTotalList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#UsageTotal" + } + }, + "com.amazonaws.inspector2#UsageType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EC2_INSTANCE_HOURS", + "name": "EC2_INSTANCE_HOURS" + }, + { + "value": "ECR_INITIAL_SCAN", + "name": "ECR_INITIAL_SCAN" + }, + { + "value": "ECR_RESCAN", + "name": "ECR_RESCAN" + } + ] + } + }, + "com.amazonaws.inspector2#UsageValue": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.inspector2#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.inspector2#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "The reason for the validation failure.
", + "smithy.api#required": {} + } + }, + "fields": { + "target": "com.amazonaws.inspector2#ValidationExceptionFields", + "traits": { + "smithy.api#documentation": "The fields that failed validation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request has failed validation due to missing required fields or having invalid\n inputs.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.inspector2#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the validation exception.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The validation exception message.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object that describes a validation exception.
" + } + }, + "com.amazonaws.inspector2#ValidationExceptionFields": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#ValidationExceptionField" + } + }, + "com.amazonaws.inspector2#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CANNOT_PARSE", + "name": "CANNOT_PARSE" + }, + { + "value": "FIELD_VALIDATION_FAILED", + "name": "FIELD_VALIDATION_FAILED" + }, + { + "value": "OTHER", + "name": "OTHER" + } + ] + } + }, + "com.amazonaws.inspector2#VulnerabilityId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.inspector2#VulnerabilityIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#VulnerabilityId" + } + }, + "com.amazonaws.inspector2#VulnerablePackage": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.inspector2#PackageName", + "traits": { + "smithy.api#documentation": "The name of the vulnerable package.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.inspector2#PackageVersion", + "traits": { + "smithy.api#documentation": "The version of the vulnerable package.
", + "smithy.api#required": {} + } + }, + "sourceLayerHash": { + "target": "com.amazonaws.inspector2#SourceLayerHash", + "traits": { + "smithy.api#documentation": "The source layer hash of the vulnerable package.
" + } + }, + "epoch": { + "target": "com.amazonaws.inspector2#PackageEpoch", + "traits": { + "smithy.api#documentation": "The epoch of the vulnerable package.
" + } + }, + "release": { + "target": "com.amazonaws.inspector2#PackageRelease", + "traits": { + "smithy.api#documentation": "The release of the vulnerable package.
" + } + }, + "arch": { + "target": "com.amazonaws.inspector2#PackageArchitecture", + "traits": { + "smithy.api#documentation": "The architecture of the vulnerable package.
" + } + }, + "packageManager": { + "target": "com.amazonaws.inspector2#PackageManager", + "traits": { + "smithy.api#documentation": "The package manager of the vulnerable package.
" + } + }, + "filePath": { + "target": "com.amazonaws.inspector2#FilePath", + "traits": { + "smithy.api#documentation": "The file path of the vulnerable package.
" + } + }, + "fixedInVersion": { + "target": "com.amazonaws.inspector2#PackageVersion", + "traits": { + "smithy.api#documentation": "The version of the package that contains the vulnerability fix.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information on the vulnerable package identified by a finding.
" + } + }, + "com.amazonaws.inspector2#VulnerablePackageList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#VulnerablePackage" + } + } + } +} diff --git a/aws/sdk/aws-models/iot.json b/aws/sdk/aws-models/iot.json index 94a4550b6557c4666688dbe03578eed869550c28..2141166c1b1086ee1ba4b60dedcb41af0c5d07e9 100644 --- a/aws/sdk/aws-models/iot.json +++ b/aws/sdk/aws-models/iot.json @@ -31,6 +31,21 @@ "shapes": { "com.amazonaws.iot#AWSIotService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "IoT", + "arnNamespace": "iot", + "cloudFormationName": "IoT", + "cloudTrailEventSource": "iot.amazonaws.com", + "endpointPrefix": "iot" + }, + "aws.auth#sigv4": { + "name": "execute-api" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "IoT provides secure, bi-directional communication between Internet-connected\n devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services\n cloud. You can discover your custom IoT-Data endpoint to communicate with, configure\n rules for data processing and integration with other services, organize resources\n associated with each device (Registry), configure logging, and create and manage\n policies and credentials to authenticate devices.
\nThe service endpoints that expose this API are listed in\n Amazon Web Services IoT Core Endpoints and Quotas.\n You must use the endpoint for the region that has the resources you want to access.
\nThe service name used by Amazon Web Services\n Signature Version 4 to sign the request is:\n execute-api.
\nFor more information about how IoT works, see the Developer\n Guide.
\nFor information about how to use the credentials provider for IoT, see Authorizing Direct Calls to Amazon Web Services Services.
", + "smithy.api#title": "AWS IoT" + }, "version": "2015-05-28", "operations": [ { @@ -324,6 +339,9 @@ { "target": "com.amazonaws.iot#DescribeJobTemplate" }, + { + "target": "com.amazonaws.iot#DescribeManagedJobTemplate" + }, { "target": "com.amazonaws.iot#DescribeMitigationAction" }, @@ -492,6 +510,9 @@ { "target": "com.amazonaws.iot#ListJobTemplates" }, + { + "target": "com.amazonaws.iot#ListManagedJobTemplates" + }, { "target": "com.amazonaws.iot#ListMitigationActions" }, @@ -735,22 +756,7 @@ { "target": "com.amazonaws.iot#ValidateSecurityProfileBehaviors" } - ], - "traits": { - "aws.api#service": { - "sdkId": "IoT", - "arnNamespace": "iot", - "cloudFormationName": "IoT", - "cloudTrailEventSource": "iot.amazonaws.com", - "endpointPrefix": "iot" - }, - "aws.auth#sigv4": { - "name": "execute-api" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "IoT provides secure, bi-directional communication between Internet-connected\n devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services\n cloud. You can discover your custom IoT-Data endpoint to communicate with, configure\n rules for data processing and integration with other services, organize resources\n associated with each device (Registry), configure logging, and create and manage\n policies and credentials to authenticate devices.
\nThe service endpoints that expose this API are listed in\n Amazon Web Services IoT Core Endpoints and Quotas.\n You must use the endpoint for the region that has the resources you want to access.
\nThe service name used by Amazon Web Services\n Signature Version 4 to sign the request is:\n execute-api.
\nFor more information about how IoT works, see the Developer\n Guide.
\nFor information about how to use the credentials provider for IoT, see Authorizing Direct Calls to Amazon Web Services Services.
", - "smithy.api#title": "AWS IoT" - } + ] }, "com.amazonaws.iot#AbortAction": { "type": "string", @@ -1190,7 +1196,7 @@ "billingGroupName": { "target": "com.amazonaws.iot#BillingGroupName", "traits": { - "smithy.api#documentation": "The name of the billing group.
" + "smithy.api#documentation": "The name of the billing group.
\n\t\tThis call is asynchronous. It might take several seconds for the detachment to propagate.
\n\n Each audit supression must have a unique client request token. If you try to create a new audit\n suppression with the same token as one that already exists, an exception occurs. If you omit this\n value, Amazon Web Services SDKs will automatically generate a unique client request.\n
", + "smithy.api#documentation": "\n Each audit supression must have a unique client request token. If you try to create a new audit\n suppression with the same token as one that already exists, an exception occurs. If you omit this\n value, Amazon Web Services SDKs will automatically generate a unique client request.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -5088,7 +5094,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an X.509 certificate using the specified certificate signing\n request.
\n\n Note: The CSR must include a public key that is either an\n RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384\n curves.
\n\n Note: Reusing the same certificate signing request (CSR)\n results in a distinct certificate.
\nRequires permission to access the CreateCertificateFromCsr action.
\n \nYou can create multiple certificates in a batch by creating a directory, copying\n multiple .csr files into that directory, and then specifying that directory on the command\n line. The following commands show how to create a batch of certificates given a batch of\n CSRs.
\nAssuming a set of CSRs are located inside of the directory\n my-csr-directory:
\n\nOn Linux and OS X, the command is:
\n\n$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr\n --certificate-signing-request file://my-csr-directory/{}
\nThis command lists all of the CSRs in my-csr-directory and pipes each CSR file name\n to the aws iot create-certificate-from-csr Amazon Web Services CLI command to create a certificate for the\n corresponding CSR.
\nThe aws iot create-certificate-from-csr part of the command can also be run in\n parallel to speed up the certificate creation process:
\n$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr\n --certificate-signing-request file://my-csr-directory/{}
\nOn Windows PowerShell, the command to create certificates for all CSRs in\n my-csr-directory is:
\n> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr\n --certificate-signing-request file://my-csr-directory/$_}
\nOn a Windows command prompt, the command to create certificates for all CSRs in\n my-csr-directory is:
\n> forfiles /p my-csr-directory /c \"cmd /c aws iot create-certificate-from-csr\n --certificate-signing-request file://@path\"
", + "smithy.api#documentation": "Creates an X.509 certificate using the specified certificate signing\n request.
\n\n Note: The CSR must include a public key that is either an\n RSA key with a length of at least 2048 bits or an ECC key from NIST P-256, NIST P-384, or NIST P-512\n curves. For supported certificates, consult \n Certificate signing algorithms supported by IoT.
\n\n Note: Reusing the same certificate signing request (CSR)\n results in a distinct certificate.
\nRequires permission to access the CreateCertificateFromCsr action.
\n \nYou can create multiple certificates in a batch by creating a directory, copying\n multiple .csr files into that directory, and then specifying that directory on the command\n line. The following commands show how to create a batch of certificates given a batch of\n CSRs.
\nAssuming a set of CSRs are located inside of the directory\n my-csr-directory:
\n\nOn Linux and OS X, the command is:
\n\n$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr\n --certificate-signing-request file://my-csr-directory/{}
\nThis command lists all of the CSRs in my-csr-directory and pipes each CSR file name\n to the aws iot create-certificate-from-csr Amazon Web Services CLI command to create a certificate for the\n corresponding CSR.
\nThe aws iot create-certificate-from-csr part of the command can also be run in\n parallel to speed up the certificate creation process:
\n$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr\n --certificate-signing-request file://my-csr-directory/{}
\nOn Windows PowerShell, the command to create certificates for all CSRs in\n my-csr-directory is:
\n> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr\n --certificate-signing-request file://my-csr-directory/$_}
\nOn a Windows command prompt, the command to create certificates for all CSRs in\n my-csr-directory is:
\n> forfiles /p my-csr-directory /c \"cmd /c aws iot create-certificate-from-csr\n --certificate-signing-request file://@path\"
", "smithy.api#http": { "method": "POST", "uri": "/certificates", @@ -5821,6 +5827,12 @@ "traits": { "smithy.api#documentation": "The ARN of the job template used to create the job.
" } + }, + "documentParameters": { + "target": "com.amazonaws.iot#ParameterMap", + "traits": { + "smithy.api#documentation": "Parameters of a managed template that you can specify to create the job document.
" + } } } }, @@ -7128,7 +7140,7 @@ "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { - "smithy.api#documentation": "An IAM role that allows the IoT service principal assumes to access your S3 files.
", + "smithy.api#documentation": "An IAM role that allows the IoT service principal to access your S3 files.
", "smithy.api#required": {} } }, @@ -10888,7 +10900,7 @@ "schema": { "target": "com.amazonaws.iot#IndexSchema", "traits": { - "smithy.api#documentation": "Contains a value that specifies the type of indexing performed. Valid values\n are:
\nREGISTRY – Your thing index contains only registry data.
\nREGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.
\nREGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and\n thing connectivity status data.
\nREGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry\n data, shadow data, and thing connectivity status data.
\nContains a value that specifies the type of indexing performed. Valid values\n are:
\nREGISTRY – Your thing index contains only registry data.
\nREGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.
\nREGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and\n thing connectivity status data.
\nREGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry\n data, shadow data, and thing connectivity status data.
\nMULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see \n GetIndexingConfiguration.
\nView details of a managed job template.
", + "smithy.api#http": { + "method": "GET", + "uri": "/managed-job-templates/{templateName}", + "code": 200 + } + } + }, + "com.amazonaws.iot#DescribeManagedJobTemplateRequest": { + "type": "structure", + "members": { + "templateName": { + "target": "com.amazonaws.iot#ManagedJobTemplateName", + "traits": { + "smithy.api#documentation": "The unique name of a managed job template, which is required.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "templateVersion": { + "target": "com.amazonaws.iot#ManagedTemplateVersion", + "traits": { + "smithy.api#documentation": "An optional parameter to specify version of a managed template. If not specified, the \n pre-defined default version is returned.
", + "smithy.api#httpQuery": "templateVersion" + } + } + } + }, + "com.amazonaws.iot#DescribeManagedJobTemplateResponse": { + "type": "structure", + "members": { + "templateName": { + "target": "com.amazonaws.iot#ManagedJobTemplateName", + "traits": { + "smithy.api#documentation": "The unique name of a managed template, such as AWS-Reboot.
The unique Amazon Resource Name (ARN) of the managed template.
" + } + }, + "description": { + "target": "com.amazonaws.iot#JobDescription", + "traits": { + "smithy.api#documentation": "The unique description of a managed template.
" + } + }, + "templateVersion": { + "target": "com.amazonaws.iot#ManagedTemplateVersion", + "traits": { + "smithy.api#documentation": "The version for a managed template.
" + } + }, + "environments": { + "target": "com.amazonaws.iot#Environments", + "traits": { + "smithy.api#documentation": "A list of environments that are supported with the managed job template.
" + } + }, + "documentParameters": { + "target": "com.amazonaws.iot#DocumentParameters", + "traits": { + "smithy.api#documentation": "A map of key-value pairs that you can use as guidance to specify the inputs for creating \n a job from a managed template.
" + } + }, + "document": { + "target": "com.amazonaws.iot#JobDocument", + "traits": { + "smithy.api#documentation": "The document schema for a managed job template.
" + } + } + } + }, "com.amazonaws.iot#DescribeMitigationAction": { "type": "operation", "input": { @@ -12714,6 +12824,21 @@ ] } }, + "com.amazonaws.iot#DeviceDefenderIndexingMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "OFF", + "name": "OFF" + }, + { + "value": "VIOLATIONS", + "name": "VIOLATIONS" + } + ] + } + }, "com.amazonaws.iot#DeviceDefenderThingName": { "type": "string", "traits": { @@ -12842,6 +12967,50 @@ "com.amazonaws.iot#DisconnectReason": { "type": "string" }, + "com.amazonaws.iot#DocumentParameter": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.iot#ParameterKey", + "traits": { + "smithy.api#documentation": "Key of the map field containing the patterns that need to be replaced in a managed\n template job document schema.
" + } + }, + "description": { + "target": "com.amazonaws.iot#JobDescription", + "traits": { + "smithy.api#documentation": "Description of the map field containing the patterns that need to be replaced in a \n managed template job document schema.
" + } + }, + "regex": { + "target": "com.amazonaws.iot#Regex", + "traits": { + "smithy.api#documentation": "A regular expression of the patterns that need to be replaced in a managed template \n job document schema.
" + } + }, + "example": { + "target": "com.amazonaws.iot#Example", + "traits": { + "smithy.api#documentation": "An example illustrating a pattern that need to be replaced in a managed template \n job document schema.
" + } + }, + "optional": { + "target": "com.amazonaws.iot#Optional", + "traits": { + "smithy.api#documentation": "Specifies whether a pattern that needs to be replaced in a managed template job document \n schema is optional or required.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A map of key-value pairs containing the patterns that need to be replaced in a managed\n template job document schema. You can use the description of each key as a guidance to specify \n the inputs during runtime when creating a job.
" + } + }, + "com.amazonaws.iot#DocumentParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.iot#DocumentParameter" + } + }, "com.amazonaws.iot#DomainConfigurationArn": { "type": "string" }, @@ -13241,6 +13410,18 @@ } } }, + "com.amazonaws.iot#Environment": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[^\\p{C}]+$" + } + }, + "com.amazonaws.iot#Environments": { + "type": "list", + "member": { + "target": "com.amazonaws.iot#Environment" + } + }, "com.amazonaws.iot#ErrorCode": { "type": "string" }, @@ -13342,6 +13523,12 @@ ] } }, + "com.amazonaws.iot#Example": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[^\\p{C}]+$" + } + }, "com.amazonaws.iot#ExecutionNamePrefix": { "type": "string" }, @@ -13961,7 +14148,7 @@ "totalCount": { "target": "com.amazonaws.iot#Count", "traits": { - "smithy.api#documentation": "The total number of documents that fit the query string criteria and contain a value for\n the Aggregation field targeted in the request.
" + "smithy.api#documentation": "The total number of things that fit the query string criteria.
" } }, "buckets": { @@ -15249,7 +15436,7 @@ "type": "double", "traits": { "smithy.api#range": { - "min": 1, + "min": 1.1, "max": 5 } } @@ -15352,6 +15539,19 @@ "smithy.api#httpError": 500 } }, + "com.amazonaws.iot#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iot#ErrorMessage2" + } + }, + "traits": { + "smithy.api#documentation": "Internal error from the service that indicates an unexpected error or that the service\n is unavailable.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, "com.amazonaws.iot#InvalidAggregationException": { "type": "structure", "members": { @@ -15654,6 +15854,12 @@ "traits": { "smithy.api#documentation": "The ARN of the job template used to create the job.
" } + }, + "documentParameters": { + "target": "com.amazonaws.iot#ParameterMap", + "traits": { + "smithy.api#documentation": "A key-value map that pairs the patterns that need to be replaced in a managed \n template job document schema. You can use the description of each key as a guidance \n to specify the inputs during runtime when creating a job.
" + } } }, "traits": { @@ -18399,6 +18605,80 @@ } } }, + "com.amazonaws.iot#ListManagedJobTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#ListManagedJobTemplatesRequest" + }, + "output": { + "target": "com.amazonaws.iot#ListManagedJobTemplatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iot#InternalServerException" + }, + { + "target": "com.amazonaws.iot#InvalidRequestException" + }, + { + "target": "com.amazonaws.iot#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iot#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of managed job templates.
", + "smithy.api#http": { + "method": "GET", + "uri": "/managed-job-templates", + "code": 200 + } + } + }, + "com.amazonaws.iot#ListManagedJobTemplatesRequest": { + "type": "structure", + "members": { + "templateName": { + "target": "com.amazonaws.iot#ManagedJobTemplateName", + "traits": { + "smithy.api#documentation": "An optional parameter for template name. If specified, only the versions of the\n managed job templates that have the specified template name will be returned.
", + "smithy.api#httpQuery": "templateName" + } + }, + "maxResults": { + "target": "com.amazonaws.iot#LaserMaxResults", + "traits": { + "smithy.api#documentation": "Maximum number of entries that can be returned.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "The token to retrieve the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.iot#ListManagedJobTemplatesResponse": { + "type": "structure", + "members": { + "managedJobTemplates": { + "target": "com.amazonaws.iot#ManagedJobTemplatesSummaryList", + "traits": { + "smithy.api#documentation": "A list of managed job templates that are returned.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "The token to retrieve the next set of results.
" + } + } + } + }, "com.amazonaws.iot#ListMitigationActions": { "type": "operation", "input": { @@ -21242,6 +21522,65 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.iot#ManagedJobTemplateName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.iot#ManagedJobTemplateSummary": { + "type": "structure", + "members": { + "templateArn": { + "target": "com.amazonaws.iot#JobTemplateArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for a managed template.
" + } + }, + "templateName": { + "target": "com.amazonaws.iot#ManagedJobTemplateName", + "traits": { + "smithy.api#documentation": "The unique Name for a managed template.
" + } + }, + "description": { + "target": "com.amazonaws.iot#JobDescription", + "traits": { + "smithy.api#documentation": "The description for a managed template.
" + } + }, + "environments": { + "target": "com.amazonaws.iot#Environments", + "traits": { + "smithy.api#documentation": "A list of environments that are supported with the managed job template.
" + } + }, + "templateVersion": { + "target": "com.amazonaws.iot#ManagedTemplateVersion", + "traits": { + "smithy.api#documentation": "The version for a managed template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information about the managed template.
" + } + }, + "com.amazonaws.iot#ManagedJobTemplatesSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.iot#ManagedJobTemplateSummary" + } + }, + "com.amazonaws.iot#ManagedTemplateVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[1-9]+.[0-9]+$" + } + }, "com.amazonaws.iot#Marker": { "type": "string", "traits": { @@ -21704,6 +22043,21 @@ } } }, + "com.amazonaws.iot#NamedShadowIndexingMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "OFF", + "name": "OFF" + }, + { + "value": "ON", + "name": "ON" + } + ] + } + }, "com.amazonaws.iot#NamespaceId": { "type": "string", "traits": { @@ -22085,6 +22439,9 @@ "smithy.api#documentation": "Describes an action that writes data to an Amazon OpenSearch Service\n domain.
" } }, + "com.amazonaws.iot#Optional": { + "type": "boolean" + }, "com.amazonaws.iot#OptionalVersion": { "type": "long", "traits": { @@ -22157,6 +22514,35 @@ "com.amazonaws.iot#Parameter": { "type": "string" }, + "com.amazonaws.iot#ParameterKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" + } + }, + "com.amazonaws.iot#ParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.iot#ParameterKey" + }, + "value": { + "target": "com.amazonaws.iot#ParameterValue" + } + }, + "com.amazonaws.iot#ParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[^\\p{C}]+$" + } + }, "com.amazonaws.iot#Parameters": { "type": "map", "key": { @@ -22840,6 +23226,9 @@ "smithy.api#box": {} } }, + "com.amazonaws.iot#Regex": { + "type": "string" + }, "com.amazonaws.iot#RegisterCACertificate": { "type": "operation", "input": { @@ -23090,7 +23479,7 @@ } ], "traits": { - "smithy.api#documentation": "Register a certificate that does not have a certificate authority (CA).
", + "smithy.api#documentation": "Register a certificate that does not have a certificate authority (CA). \n For supported certificates, consult \n Certificate signing algorithms supported by IoT.\n
", "smithy.api#http": { "method": "POST", "uri": "/certificate/register-no-ca", @@ -23416,7 +23805,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes the given thing from the billing group.
\n\t\tRequires permission to access the RemoveThingFromBillingGroup action.
", + "smithy.api#documentation": "Removes the given thing from the billing group.
\n\t\tRequires permission to access the RemoveThingFromBillingGroup action.
\n\t\tThis call is asynchronous. It might take several seconds for the detachment to propagate.
\nThe count of things that match the query.
" + "smithy.api#documentation": "The count of things that match the query string criteria and contain a valid aggregation field value.
" } }, "average": { @@ -25357,7 +25746,7 @@ } }, "traits": { - "smithy.api#documentation": "A map of key-value pairs for all supported statistics. Currently, only count is\n supported.
" + "smithy.api#documentation": "A map of key-value pairs for all supported statistics. For issues with missing or unexpected values for this API, \n consult \n Fleet indexing troubleshooting guide.
" } }, "com.amazonaws.iot#Status": { @@ -26380,7 +26769,13 @@ "shadow": { "target": "com.amazonaws.iot#JsonDocument", "traits": { - "smithy.api#documentation": "The shadow.
" + "smithy.api#documentation": "The unnamed shadow and named shadow.
\nFor more information about shadows, see IoT Device Shadow service.\n
" + } + }, + "deviceDefender": { + "target": "com.amazonaws.iot#JsonDocument", + "traits": { + "smithy.api#documentation": "Contains Device Defender data.
\nFor more information about Device Defender, see Device Defender.
" } }, "connectivity": { @@ -26614,6 +27009,18 @@ "smithy.api#documentation": "Thing connectivity indexing mode. Valid values are:
\nSTATUS – Your thing index contains connectivity status. To enable thing\n connectivity indexing, thingIndexMode must not be set to\n OFF.
\nOFF - Thing connectivity status indexing is disabled.
\nDevice Defender indexing mode. Valid values are:
\nVIOLATIONS – Your thing index contains Device Defender violations. To enable Device\n Defender indexing, deviceDefenderIndexingMode must not be set to\n OFF.
\nOFF - Device Defender indexing is disabled.
\nFor more information about Device Defender violations, see Device Defender Detect.\n
" + } + }, + "namedShadowIndexingMode": { + "target": "com.amazonaws.iot#NamedShadowIndexingMode", + "traits": { + "smithy.api#documentation": "Named shadow indexing mode. Valid values are:
\nON – Your thing index contains named shadow. To enable thing\n named shadow indexing, namedShadowIndexingMode must not be set to\n OFF.
\nOFF - Named shadow indexing is disabled.
\nFor more information about Shadows, see IoT Device Shadow service.\n
" + } + }, "managedFields": { "target": "com.amazonaws.iot#Fields", "traits": { @@ -28533,7 +28940,7 @@ "unit": { "target": "com.amazonaws.iot#FleetMetricUnit", "traits": { - "smithy.api#documentation": "Used to support unit transformation such as milliseconds to seconds. The unit must be\n supported by CW metric.
" + "smithy.api#documentation": "Used to support unit transformation such as milliseconds to seconds. The unit must be\n supported by CW metric.
" } }, "expectedVersion": { diff --git a/aws/sdk/aws-models/iotdeviceadvisor.json b/aws/sdk/aws-models/iotdeviceadvisor.json index 3f823947b334378f114192e4cfa6244d6afdb186..5047ac1e5a0f9f7036ad9d59860a5b4b8d3afe5c 100644 --- a/aws/sdk/aws-models/iotdeviceadvisor.json +++ b/aws/sdk/aws-models/iotdeviceadvisor.json @@ -44,12 +44,12 @@ "message": { "target": "com.amazonaws.iotdeviceadvisor#Message", "traits": { - "smithy.api#documentation": "Sends Conflict Exception message.
" + "smithy.api#documentation": "Sends a Conflict Exception message.
" } } }, "traits": { - "smithy.api#documentation": "Sends Conflict Exception.
", + "smithy.api#documentation": "Sends a Conflict Exception.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -71,7 +71,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a Device Advisor test suite.
", + "smithy.api#documentation": "Creates a Device Advisor test suite.
\nRequires permission to access the CreateSuiteDefinition action.
", "smithy.api#http": { "method": "POST", "uri": "/suiteDefinitions", @@ -108,7 +108,7 @@ "suiteDefinitionArn": { "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", "traits": { - "smithy.api#documentation": "Creates a Device Advisor test suite with Amazon Resource name.
" + "smithy.api#documentation": "Creates a Device Advisor test suite with Amazon Resource Name (ARN).
" } }, "suiteDefinitionName": { @@ -142,7 +142,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a Device Advisor test suite.
", + "smithy.api#documentation": "Deletes a Device Advisor test suite.
\nRequires permission to access the DeleteSuiteDefinition action.
", "smithy.api#http": { "method": "DELETE", "uri": "/suiteDefinitions/{suiteDefinitionId}", @@ -156,7 +156,7 @@ "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { - "smithy.api#documentation": "Suite definition Id of the test suite to be deleted.
", + "smithy.api#documentation": "Suite definition ID of the test suite to be deleted.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -173,18 +173,18 @@ "thingArn": { "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", "traits": { - "smithy.api#documentation": "Lists devices thing arn
" + "smithy.api#documentation": "Lists devices thing ARN.
" } }, "certificateArn": { "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", "traits": { - "smithy.api#documentation": "Lists devices certificate arn
" + "smithy.api#documentation": "Lists devices certificate ARN.
" } } }, "traits": { - "smithy.api#documentation": "Lists all the devices under test
" + "smithy.api#documentation": "Information of a test device. A thing ARN or a certificate ARN is required.
" } }, "com.amazonaws.iotdeviceadvisor#DeviceUnderTestList": { @@ -199,12 +199,79 @@ } } }, + "com.amazonaws.iotdeviceadvisor#Endpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 45, + "max": 75 + } + } + }, "com.amazonaws.iotdeviceadvisor#ErrorReason": { "type": "string" }, "com.amazonaws.iotdeviceadvisor#Failure": { "type": "string" }, + "com.amazonaws.iotdeviceadvisor#GetEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotdeviceadvisor#GetEndpointRequest" + }, + "output": { + "target": "com.amazonaws.iotdeviceadvisor#GetEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about an Device Advisor endpoint.
", + "smithy.api#http": { + "method": "GET", + "uri": "/endpoint", + "code": 200 + } + } + }, + "com.amazonaws.iotdeviceadvisor#GetEndpointRequest": { + "type": "structure", + "members": { + "thingArn": { + "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The thing ARN of the device. This is an optional parameter.
", + "smithy.api#httpQuery": "thingArn" + } + }, + "certificateArn": { + "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The certificate ARN of the device. This is an optional parameter.
", + "smithy.api#httpQuery": "certificateArn" + } + } + } + }, + "com.amazonaws.iotdeviceadvisor#GetEndpointResponse": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.iotdeviceadvisor#Endpoint", + "traits": { + "smithy.api#documentation": "The response of an Device Advisor endpoint.
" + } + } + } + }, "com.amazonaws.iotdeviceadvisor#GetSuiteDefinition": { "type": "operation", "input": { @@ -225,7 +292,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about a Device Advisor test suite.
", + "smithy.api#documentation": "Gets information about a Device Advisor test suite.
\nRequires permission to access the GetSuiteDefinition action.
", "smithy.api#http": { "method": "GET", "uri": "/suiteDefinitions/{suiteDefinitionId}", @@ -239,7 +306,7 @@ "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { - "smithy.api#documentation": "Suite definition Id of the test suite to get.
", + "smithy.api#documentation": "Suite definition ID of the test suite to get.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -259,7 +326,7 @@ "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { - "smithy.api#documentation": "Suite definition Id of the suite definition.
" + "smithy.api#documentation": "Suite definition ID of the suite definition.
" } }, "suiteDefinitionArn": { @@ -326,7 +393,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about a Device Advisor test suite run.
", + "smithy.api#documentation": "Gets information about a Device Advisor test suite run.
\nRequires permission to access the GetSuiteRun action.
", "smithy.api#http": { "method": "GET", "uri": "/suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}", @@ -354,7 +421,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets a report download link for a successful Device Advisor qualifying test suite run.
", + "smithy.api#documentation": "Gets a report download link for a successful Device Advisor qualifying test suite run.
\nRequires permission to access the GetSuiteRunReport action.
", "smithy.api#http": { "method": "GET", "uri": "/suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}/report", @@ -368,7 +435,7 @@ "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { - "smithy.api#documentation": "Suite definition Id of the test suite.
", + "smithy.api#documentation": "Suite definition ID of the test suite.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -376,7 +443,7 @@ "suiteRunId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { - "smithy.api#documentation": "Suite run Id of the test suite run.
", + "smithy.api#documentation": "Suite run ID of the test suite run.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -400,7 +467,7 @@ "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { - "smithy.api#documentation": "Suite definition Id for the test suite run.
", + "smithy.api#documentation": "Suite definition ID for the test suite run.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -408,7 +475,7 @@ "suiteRunId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { - "smithy.api#documentation": "Suite run Id for the test suite run.
", + "smithy.api#documentation": "Suite run ID for the test suite run.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -421,7 +488,7 @@ "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { - "smithy.api#documentation": "Suite definition Id for the test suite run.
" + "smithy.api#documentation": "Suite definition ID for the test suite run.
" } }, "suiteDefinitionVersion": { @@ -433,7 +500,7 @@ "suiteRunId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { - "smithy.api#documentation": "Suite run Id for the test suite run.
" + "smithy.api#documentation": "Suite run ID for the test suite run.
" } }, "suiteRunArn": { @@ -457,7 +524,7 @@ "startTime": { "target": "com.amazonaws.iotdeviceadvisor#Timestamp", "traits": { - "smithy.api#documentation": "Date (in Unix epoch time) when the test suite run was started.
" + "smithy.api#documentation": "Date (in Unix epoch time) when the test suite run started.
" } }, "endTime": { @@ -495,7 +562,7 @@ "groupId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { - "smithy.api#documentation": "Group result Id.
" + "smithy.api#documentation": "Group result ID.
" } }, "groupName": { @@ -533,18 +600,33 @@ "message": { "target": "com.amazonaws.iotdeviceadvisor#Message", "traits": { - "smithy.api#documentation": "Sends Internal Failure Exception message.
" + "smithy.api#documentation": "Sends an Internal Failure Exception message.
" } } }, "traits": { - "smithy.api#documentation": "Sends Internal Failure Exception.
", + "smithy.api#documentation": "Sends an Internal Failure exception.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.iotdeviceadvisor#IotSenateService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "IotDeviceAdvisor", + "arnNamespace": "iotdeviceadvisor", + "cloudFormationName": "IotDeviceAdvisor", + "cloudTrailEventSource": "iotdeviceadvisor.amazonaws.com", + "endpointPrefix": "api.iotdeviceadvisor" + }, + "aws.auth#sigv4": { + "name": "iotdeviceadvisor" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Amazon Web Services IoT Core Device Advisor is a cloud-based, fully managed test capability for\n validating IoT devices during device software development. Device Advisor provides\n pre-built tests that you can use to validate IoT devices for reliable and secure\n connectivity with Amazon Web Services IoT Core before deploying devices to production. By using Device Advisor,\n you can confirm that your devices can connect to Amazon Web Services IoT Core, follow security\n best practices and, if applicable, receive software updates from IoT Device Management.\n You can also download signed qualification reports to submit to the Amazon Web Services Partner Network\n to get your device qualified for the Amazon Web Services Partner Device Catalog without the need to send\n your device in and wait for it to be tested.
", + "smithy.api#title": "AWS IoT Core Device Advisor" + }, "version": "2020-09-18", "operations": [ { @@ -553,6 +635,9 @@ { "target": "com.amazonaws.iotdeviceadvisor#DeleteSuiteDefinition" }, + { + "target": "com.amazonaws.iotdeviceadvisor#GetEndpoint" + }, { "target": "com.amazonaws.iotdeviceadvisor#GetSuiteDefinition" }, @@ -586,22 +671,7 @@ { "target": "com.amazonaws.iotdeviceadvisor#UpdateSuiteDefinition" } - ], - "traits": { - "aws.api#service": { - "sdkId": "IotDeviceAdvisor", - "arnNamespace": "iotdeviceadvisor", - "cloudFormationName": "IotDeviceAdvisor", - "cloudTrailEventSource": "iotdeviceadvisor.amazonaws.com", - "endpointPrefix": "api.iotdeviceadvisor" - }, - "aws.auth#sigv4": { - "name": "iotdeviceadvisor" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "AWS IoT Core Device Advisor is a cloud-based, fully managed test capability for validating IoT devices during device software development. Device Advisor provides pre-built tests that you can use to validate IoT devices for reliable and secure connectivity with AWS IoT Core before deploying devices to production. By using Device Advisor, you can confirm that your devices can connect to AWS IoT Core, follow security best practices and, if applicable, receive software updates from IoT Device Management. You can also download signed qualification reports to submit to the AWS Partner Network to get your device qualified for the AWS Partner Device Catalog without the need to send your device in and wait for it to be tested.
", - "smithy.api#title": "AWS IoT Core Device Advisor" - } + ] }, "com.amazonaws.iotdeviceadvisor#ListSuiteDefinitions": { "type": "operation", @@ -620,7 +690,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the Device Advisor test suites you have created.
", + "smithy.api#documentation": "Lists the Device Advisor test suites you have created.
\nRequires permission to access the ListSuiteDefinitions action.
", "smithy.api#http": { "method": "GET", "uri": "/suiteDefinitions", @@ -686,7 +756,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the runs of the specified Device Advisor test suite.\n You can list all runs of the test suite, or the runs of a specific version of the test suite.
", + "smithy.api#documentation": "Lists runs of the specified Device Advisor test suite. You can list all runs of the test\n suite, or the runs of a specific version of the test suite.
\nRequires permission to access the ListSuiteRuns action.
", "smithy.api#http": { "method": "GET", "uri": "/suiteRuns", @@ -705,14 +775,14 @@ "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { - "smithy.api#documentation": "Lists the test suite runs of the specified test suite based on suite definition Id.
", + "smithy.api#documentation": "Lists the test suite runs of the specified test suite based on suite definition\n ID.
", "smithy.api#httpQuery": "suiteDefinitionId" } }, "suiteDefinitionVersion": { "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionVersion", "traits": { - "smithy.api#documentation": "Must be passed along with suiteDefinitionId. Lists the test suite runs of the specified test suite based on suite definition version.
", + "smithy.api#documentation": "Must be passed along with suiteDefinitionId. Lists the test suite runs of\n the specified test suite based on suite definition version.
Lists the tags attached to an IoT Device Advisor resource.
", + "smithy.api#documentation": "Lists the tags attached to an IoT Device Advisor resource.
\nRequires permission to access the ListTagsForResource action.
", "smithy.api#http": { "method": "GET", "uri": "/tags/{resourceArn}", @@ -822,6 +892,9 @@ } } }, + "com.amazonaws.iotdeviceadvisor#ParallelRun": { + "type": "boolean" + }, "com.amazonaws.iotdeviceadvisor#QualificationReportDownloadUrl": { "type": "string" }, @@ -831,12 +904,12 @@ "message": { "target": "com.amazonaws.iotdeviceadvisor#Message", "traits": { - "smithy.api#documentation": "Sends Resource Not Found Exception message.
" + "smithy.api#documentation": "Sends a Resource Not Found Exception message.
" } } }, "traits": { - "smithy.api#documentation": "Sends Resource Not Found Exception.
", + "smithy.api#documentation": "Sends a Resource Not Found exception.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -882,7 +955,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a Device Advisor test suite run.
", + "smithy.api#documentation": "Starts a Device Advisor test suite run.
\nRequires permission to access the StartSuiteRun action.
", "smithy.api#http": { "method": "POST", "uri": "/suiteDefinitions/{suiteDefinitionId}/suiteRuns", @@ -896,7 +969,7 @@ "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { - "smithy.api#documentation": "Suite definition Id of the test suite.
", + "smithy.api#documentation": "Suite definition ID of the test suite.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -927,19 +1000,19 @@ "suiteRunId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { - "smithy.api#documentation": "Suite Run Id of the started suite run.
" + "smithy.api#documentation": "Suite Run ID of the started suite run.
" } }, "suiteRunArn": { "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", "traits": { - "smithy.api#documentation": "Amazon resource name of the started suite run.
" + "smithy.api#documentation": "Amazon Resource Name (ARN) of the started suite run.
" } }, "createdAt": { "target": "com.amazonaws.iotdeviceadvisor#Timestamp", "traits": { - "smithy.api#documentation": "Date (in Unix epoch time) when the suite run was created.
" + "smithy.api#documentation": "Starts a Device Advisor test suite run based on suite create time.
" } } } @@ -1007,7 +1080,7 @@ } ], "traits": { - "smithy.api#documentation": "Stops a Device Advisor test suite run that is currently running.
", + "smithy.api#documentation": "Stops a Device Advisor test suite run that is currently running.
\nRequires permission to access the StopSuiteRun action.
", "smithy.api#http": { "method": "POST", "uri": "/suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}/stop", @@ -1021,7 +1094,7 @@ "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { - "smithy.api#documentation": "Suite definition Id of the test suite run to be stopped.
", + "smithy.api#documentation": "Suite definition ID of the test suite run to be stopped.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1029,7 +1102,7 @@ "suiteRunId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { - "smithy.api#documentation": "Suite run Id of the test suite run to be stopped.
", + "smithy.api#documentation": "Suite run ID of the test suite run to be stopped.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1088,7 +1161,7 @@ "devicePermissionRoleArn": { "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", "traits": { - "smithy.api#documentation": "Gets device permission arn.
" + "smithy.api#documentation": "Gets the device permission ARN.
" } } }, @@ -1102,7 +1175,7 @@ "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { - "smithy.api#documentation": "Suite definition Id of the test suite.
" + "smithy.api#documentation": "Suite definition ID of the test suite.
" } }, "suiteDefinitionName": { @@ -1114,7 +1187,7 @@ "defaultDevices": { "target": "com.amazonaws.iotdeviceadvisor#DeviceUnderTestList", "traits": { - "smithy.api#documentation": "Specifies the devices under test for the test suite.
" + "smithy.api#documentation": "Specifies the devices that are under test for the test suite.
" } }, "intendedForQualification": { @@ -1172,6 +1245,12 @@ "traits": { "smithy.api#documentation": "Gets test case list.
" } + }, + "parallelRun": { + "target": "com.amazonaws.iotdeviceadvisor#ParallelRun", + "traits": { + "smithy.api#documentation": "TRUE if multiple test suites run in parallel.
" + } } }, "traits": { @@ -1184,7 +1263,7 @@ "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { - "smithy.api#documentation": "Suite definition Id of the suite run.
" + "smithy.api#documentation": "Suite definition ID of the suite run.
" } }, "suiteDefinitionVersion": { @@ -1202,7 +1281,7 @@ "suiteRunId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { - "smithy.api#documentation": "Suite run Id of the suite run.
" + "smithy.api#documentation": "Suite run ID of the suite run.
" } }, "createdAt": { @@ -1243,7 +1322,7 @@ } }, "traits": { - "smithy.api#documentation": "Information about the suite run.
" + "smithy.api#documentation": "Information about the suite run.
\nRequires permission to access the SuiteRunInformation action.
" } }, "com.amazonaws.iotdeviceadvisor#SuiteRunResultCount": { @@ -1351,7 +1430,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds to and modifies existing tags of an IoT Device Advisor resource.
", + "smithy.api#documentation": "Adds to and modifies existing tags of an IoT Device Advisor resource.
\nRequires permission to access the TagResource action.
", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", @@ -1392,25 +1471,25 @@ "testCaseRunId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { - "smithy.api#documentation": "Provides test case run Id.
" + "smithy.api#documentation": "Provides the test case run ID.
" } }, "testCaseDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { - "smithy.api#documentation": "Provides test case run definition Id.
" + "smithy.api#documentation": "Provides the test case run definition ID.
" } }, "testCaseDefinitionName": { "target": "com.amazonaws.iotdeviceadvisor#TestCaseDefinitionName", "traits": { - "smithy.api#documentation": "Provides test case run definition Name.
" + "smithy.api#documentation": "Provides the test case run definition name.
" } }, "status": { "target": "com.amazonaws.iotdeviceadvisor#Status", "traits": { - "smithy.api#documentation": "Provides test case run status.
" + "smithy.api#documentation": "Provides the test case run status. Status is one of the following:
\n\n PASS: Test passed.
\n FAIL: Test failed.
\n PENDING: Test has not started running but is scheduled.
\n RUNNING: Test is running.
\n STOPPING: Test is performing cleanup steps. You will see this status only if you stop a suite run.
\n STOPPED Test is stopped. You will see this status only if you stop a suite run.
\n PASS_WITH_WARNINGS: Test passed with warnings.
\n ERORR: Test faced an error when running due to an internal issue.
Provides test case run log Url.
" + "smithy.api#documentation": "Provides test case run log URL.
" } }, "warnings": { @@ -1445,7 +1524,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides test case run.
" + "smithy.api#documentation": "Provides the test case run.
" } }, "com.amazonaws.iotdeviceadvisor#TestCaseRuns": { @@ -1512,7 +1591,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes tags from an IoT Device Advisor resource.
", + "smithy.api#documentation": "Removes tags from an IoT Device Advisor resource.
\nRequires permission to access the UntagResource action.
", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{resourceArn}", @@ -1562,7 +1641,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a Device Advisor test suite.
", + "smithy.api#documentation": "Updates a Device Advisor test suite.
\nRequires permission to access the UpdateSuiteDefinition action.
", "smithy.api#http": { "method": "PATCH", "uri": "/suiteDefinitions/{suiteDefinitionId}", @@ -1576,7 +1655,7 @@ "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { - "smithy.api#documentation": "Suite definition Id of the test suite to be updated.
", + "smithy.api#documentation": "Suite definition ID of the test suite to be updated.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1595,13 +1674,13 @@ "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { - "smithy.api#documentation": "Suite definition Id of the updated test suite.
" + "smithy.api#documentation": "Suite definition ID of the updated test suite.
" } }, "suiteDefinitionArn": { "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", "traits": { - "smithy.api#documentation": "Amazon Resource name of the updated test suite.
" + "smithy.api#documentation": "Amazon Resource Name (ARN) of the updated test suite.
" } }, "suiteDefinitionName": { @@ -1636,12 +1715,12 @@ "message": { "target": "com.amazonaws.iotdeviceadvisor#Message", "traits": { - "smithy.api#documentation": "Sends invalid request exception message.
" + "smithy.api#documentation": "Sends a Validation Exception message.
" } } }, "traits": { - "smithy.api#documentation": "Sends invalid request exception.
", + "smithy.api#documentation": "Sends a validation exception.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } diff --git a/aws/sdk/aws-models/iotsitewise.json b/aws/sdk/aws-models/iotsitewise.json index cbde458f355262da04ab18dfd58b579869bd8108..bedd1480c071f7e11728c09f127e7363713bf930 100644 --- a/aws/sdk/aws-models/iotsitewise.json +++ b/aws/sdk/aws-models/iotsitewise.json @@ -41,11 +41,29 @@ }, "com.amazonaws.iotsitewise#AWSIoTSiteWise": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "IoTSiteWise", + "arnNamespace": "iotsitewise", + "cloudFormationName": "IoTSiteWise", + "cloudTrailEventSource": "iotsitewise.amazonaws.com", + "endpointPrefix": "iotsitewise" + }, + "aws.auth#sigv4": { + "name": "iotsitewise" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web Services service that connects Industrial Internet of Things (IIoT) devices to the power of the Amazon Web Services Cloud. For more information, see the\n IoT SiteWise User Guide. For information about IoT SiteWise quotas, see Quotas in the IoT SiteWise User Guide.
", + "smithy.api#title": "AWS IoT SiteWise" + }, "version": "2019-12-02", "operations": [ { "target": "com.amazonaws.iotsitewise#AssociateAssets" }, + { + "target": "com.amazonaws.iotsitewise#AssociateTimeSeriesToAssetProperty" + }, { "target": "com.amazonaws.iotsitewise#BatchAssociateProjectAssets" }, @@ -97,6 +115,9 @@ { "target": "com.amazonaws.iotsitewise#DeleteProject" }, + { + "target": "com.amazonaws.iotsitewise#DeleteTimeSeries" + }, { "target": "com.amazonaws.iotsitewise#DescribeAccessPolicy" }, @@ -133,9 +154,15 @@ { "target": "com.amazonaws.iotsitewise#DescribeStorageConfiguration" }, + { + "target": "com.amazonaws.iotsitewise#DescribeTimeSeries" + }, { "target": "com.amazonaws.iotsitewise#DisassociateAssets" }, + { + "target": "com.amazonaws.iotsitewise#DisassociateTimeSeriesFromAssetProperty" + }, { "target": "com.amazonaws.iotsitewise#GetAssetPropertyAggregates" }, @@ -181,6 +208,9 @@ { "target": "com.amazonaws.iotsitewise#ListTagsForResource" }, + { + "target": "com.amazonaws.iotsitewise#ListTimeSeries" + }, { "target": "com.amazonaws.iotsitewise#PutDefaultEncryptionConfiguration" }, @@ -223,22 +253,7 @@ { "target": "com.amazonaws.iotsitewise#UpdateProject" } - ], - "traits": { - "aws.api#service": { - "sdkId": "IoTSiteWise", - "arnNamespace": "iotsitewise", - "cloudFormationName": "IoTSiteWise", - "cloudTrailEventSource": "iotsitewise.amazonaws.com", - "endpointPrefix": "iotsitewise" - }, - "aws.auth#sigv4": { - "name": "iotsitewise" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web Services service that connects Industrial Internet of Things (IIoT) devices to the power of the Amazon Web Services Cloud. For more information, see the\n IoT SiteWise User Guide. For information about IoT SiteWise quotas, see Quotas in the IoT SiteWise User Guide.
", - "smithy.api#title": "AWS IoT SiteWise" - } + ] }, "com.amazonaws.iotsitewise#AccessPolicySummaries": { "type": "list", @@ -1280,6 +1295,76 @@ } } }, + "com.amazonaws.iotsitewise#AssociateTimeSeriesToAssetProperty": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#AssociateTimeSeriesToAssetPropertyRequest" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#ConflictingOperationException" + }, + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Associates a time series (data stream) with an asset property.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/timeseries/associate", + "code": 200 + } + } + }, + "com.amazonaws.iotsitewise#AssociateTimeSeriesToAssetPropertyRequest": { + "type": "structure", + "members": { + "alias": { + "target": "com.amazonaws.iotsitewise#PropertyAlias", + "traits": { + "smithy.api#documentation": "The alias that identifies the time series.
", + "smithy.api#httpQuery": "alias", + "smithy.api#required": {} + } + }, + "assetId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "The ID of the asset in which the asset property was created.
", + "smithy.api#httpQuery": "assetId", + "smithy.api#required": {} + } + }, + "propertyId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "The ID of the asset property.
", + "smithy.api#httpQuery": "propertyId", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", + "traits": { + "smithy.api#documentation": "A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, "com.amazonaws.iotsitewise#AssociatedAssetsSummaries": { "type": "list", "member": { @@ -2492,7 +2577,7 @@ "portalAuthMode": { "target": "com.amazonaws.iotsitewise#AuthMode", "traits": { - "smithy.api#documentation": "The service to use to authenticate users to the portal. Choose from the following\n options:
\n\n SSO – The portal uses Amazon Web Services Single Sign On to authenticate users and manage\n user permissions. Before you can create a portal that uses Amazon Web Services SSO, you must enable Amazon Web Services SSO.\n For more information, see Enabling Amazon Web Services SSO in the\n IoT SiteWise User Guide. This option is only available in Amazon Web Services Regions other than\n the China Regions.
\n IAM – The portal uses Identity and Access Management to authenticate users and manage\n user permissions. This option is only available in the China Regions.
You can't change this value after you create a portal.
\nDefault: SSO\n
The service to use to authenticate users to the portal. Choose from the following\n options:
\n\n SSO – The portal uses Amazon Web Services Single Sign On to authenticate users and manage\n user permissions. Before you can create a portal that uses Amazon Web Services SSO, you must enable Amazon Web Services SSO.\n For more information, see Enabling Amazon Web Services SSO in the\n IoT SiteWise User Guide. This option is only available in Amazon Web Services Regions other than\n the China Regions.
\n IAM – The portal uses Identity and Access Management to authenticate users and manage\n user permissions.
You can't change this value after you create a portal.
\nDefault: SSO\n
Creates a project in the specified portal.
", + "smithy.api#documentation": "Creates a project in the specified portal.
\nMake sure that the project name and description don't contain confidential\n information.
\nThe ARN of the Amazon S3 object. For more information about how to find the ARN for an\n Amazon S3 object, see Amazon S3 resources in the\n Amazon Simple Storage Service User Guide.
", + "smithy.api#documentation": "The ARN of the Amazon S3 object. For more information about how to find the ARN for an\n Amazon S3 object, see Amazon S3 resources in the\n Amazon Simple Storage Service User Guide.
", "smithy.api#required": {} } }, @@ -3162,6 +3247,73 @@ "type": "structure", "members": {} }, + "com.amazonaws.iotsitewise#DeleteTimeSeries": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#DeleteTimeSeriesRequest" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#ConflictingOperationException" + }, + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a time series (data stream). If you delete a time series that's associated with an\n asset property, the asset property still exists, but the time series will no longer be\n associated with this asset property.
\nTo identify a time series, do one of the following:
\nIf the time series isn't associated with an asset property, \n specify the alias of the time series.
If the time series is associated with an asset property, \n specify one of the following:
\nThe alias of the time series.
The assetId and propertyId that identifies the asset property.
The alias that identifies the time series.
", + "smithy.api#httpQuery": "alias" + } + }, + "assetId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "The ID of the asset in which the asset property was created.
", + "smithy.api#httpQuery": "assetId" + } + }, + "propertyId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "The ID of the asset property.
", + "smithy.api#httpQuery": "propertyId" + } + }, + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", + "traits": { + "smithy.api#documentation": "A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, "com.amazonaws.iotsitewise#DescribeAccessPolicy": { "type": "operation", "input": { @@ -3829,7 +3981,7 @@ "kmsKeyArn": { "target": "com.amazonaws.iotsitewise#ARN", "traits": { - "smithy.api#documentation": "The key ARN of the customer managed customer master key (CMK) used for KMS encryption if\n you use KMS_BASED_ENCRYPTION.
The key ARN of the customer managed key used for KMS encryption if you use\n KMS_BASED_ENCRYPTION.
The type of storage that you specified for your data. The storage type can be one of the following values:
\n\n SITEWISE_DEFAULT_STORAGE – IoT SiteWise replicates your data into a service managed database.
\n MULTI_LAYER_STORAGE – IoT SiteWise replicates your data into a service managed database and saves a copy of your raw data and metadata in an Amazon S3 object that you specified.
The storage tier that you specified for your data. \n The storageType parameter can be one of the following values:
\n SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. \n The hot tier is a service-managed database.
\n MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the cold tier. \n The cold tier is a customer-managed Amazon S3 bucket.
Contains information about the storage destination.
" } }, - "configurationStatus": { - "target": "com.amazonaws.iotsitewise#ConfigurationStatus", + "disassociatedDataStorage": { + "target": "com.amazonaws.iotsitewise#DisassociatedDataStorageState", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "Contains the storage configuration for time series (data streams) that aren't associated with asset properties. \n The disassociatedDataStorage can be one of the following values:
\n ENABLED – IoT SiteWise accepts time series that aren't associated with asset properties.
After the disassociatedDataStorage is enabled, you can't disable it.
\n DISABLED – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.
For more information, see Data streams \n in the IoT SiteWise User Guide.
" } }, - "lastUpdateDate": { - "target": "com.amazonaws.iotsitewise#Timestamp", + "retentionPeriod": { + "target": "com.amazonaws.iotsitewise#RetentionPeriod", "traits": { - "smithy.api#documentation": "The date the storage configuration was last updated, in Unix epoch time.
" + "smithy.api#documentation": "How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.
" } - } - } - }, - "com.amazonaws.iotsitewise#Description": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 }, - "smithy.api#pattern": "^[^\\u0000-\\u001F\\u007F]+$" - } - }, - "com.amazonaws.iotsitewise#DetailedError": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.iotsitewise#DetailedErrorCode", + "configurationStatus": { + "target": "com.amazonaws.iotsitewise#ConfigurationStatus", "traits": { - "smithy.api#documentation": "The error code.
", "smithy.api#required": {} } }, - "message": { - "target": "com.amazonaws.iotsitewise#DetailedErrorMessage", + "lastUpdateDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { - "smithy.api#documentation": "The error message.
", - "smithy.api#required": {} + "smithy.api#documentation": "The date the storage configuration was last updated, in Unix epoch time.
" } } - }, - "traits": { - "smithy.api#documentation": "Contains detailed error information.
" - } - }, - "com.amazonaws.iotsitewise#DetailedErrorCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "INCOMPATIBLE_COMPUTE_LOCATION", - "name": "INCOMPATIBLE_COMPUTE_LOCATION" - }, - { - "value": "INCOMPATIBLE_FORWARDING_CONFIGURATION", - "name": "INCOMPATIBLE_FORWARDING_CONFIGURATION" - } - ] - } - }, - "com.amazonaws.iotsitewise#DetailedErrorMessage": { - "type": "string" - }, - "com.amazonaws.iotsitewise#DetailedErrors": { - "type": "list", - "member": { - "target": "com.amazonaws.iotsitewise#DetailedError" } }, - "com.amazonaws.iotsitewise#DisassociateAssets": { + "com.amazonaws.iotsitewise#DescribeTimeSeries": { "type": "operation", "input": { - "target": "com.amazonaws.iotsitewise#DisassociateAssetsRequest" + "target": "com.amazonaws.iotsitewise#DescribeTimeSeriesRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#DescribeTimeSeriesResponse" }, "errors": [ - { - "target": "com.amazonaws.iotsitewise#ConflictingOperationException" - }, { "target": "com.amazonaws.iotsitewise#InternalFailureException" }, @@ -4511,51 +4619,309 @@ } ], "traits": { - "smithy.api#documentation": "Disassociates a child asset from the given parent asset through a hierarchy defined in the\n parent asset's model.
", + "smithy.api#documentation": "Retrieves information about a time series (data stream).
\nTo identify a time series, do one of the following:
\nIf the time series isn't associated with an asset property, \n specify the alias of the time series.
If the time series is associated with an asset property, \n specify one of the following:
\nThe alias of the time series.
The assetId and propertyId that identifies the asset property.
The ID of the parent asset from which to disassociate the child asset.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The alias that identifies the time series.
", + "smithy.api#httpQuery": "alias" } }, - "hierarchyId": { + "assetId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings\n of assets to be formed that all come from the same asset model. You can use the hierarchy ID\n to identify the correct asset to disassociate. For more information, see\n Asset hierarchies in the IoT SiteWise User Guide.
", - "smithy.api#required": {} + "smithy.api#documentation": "The ID of the asset in which the asset property was created.
", + "smithy.api#httpQuery": "assetId" } }, - "childAssetId": { + "propertyId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "The ID of the child asset to disassociate.
", - "smithy.api#required": {} + "smithy.api#documentation": "The ID of the asset property.
", + "smithy.api#httpQuery": "propertyId" } - }, - "clientToken": { - "target": "com.amazonaws.iotsitewise#ClientToken", - "traits": { - "smithy.api#documentation": "A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
", - "smithy.api#idempotencyToken": {} + } + } + }, + "com.amazonaws.iotsitewise#DescribeTimeSeriesResponse": { + "type": "structure", + "members": { + "assetId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "The ID of the asset in which the asset property was created.
" + } + }, + "propertyId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "The ID of the asset property.
" + } + }, + "alias": { + "target": "com.amazonaws.iotsitewise#PropertyAlias", + "traits": { + "smithy.api#documentation": "The alias that identifies the time series.
" + } + }, + "timeSeriesId": { + "target": "com.amazonaws.iotsitewise#TimeSeriesId", + "traits": { + "smithy.api#documentation": "The ID of the time series.
", + "smithy.api#required": {} + } + }, + "dataType": { + "target": "com.amazonaws.iotsitewise#PropertyDataType", + "traits": { + "smithy.api#documentation": "The data type of the time series.
\nIf you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this time series.
The data type of the structure for this time series. This parameter is required for time series \n that have the STRUCT data type.
The options for this parameter depend on the type of the composite model \n in which you created the asset property that is associated with your time series. \n Use AWS/ALARM_STATE for alarm state in alarm composite models.
The date that the time series was created, in Unix epoch time.
", + "smithy.api#required": {} + } + }, + "timeSeriesLastUpdateDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the time series was last updated, in Unix epoch time.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotsitewise#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[^\\u0000-\\u001F\\u007F]+$" + } + }, + "com.amazonaws.iotsitewise#DetailedError": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.iotsitewise#DetailedErrorCode", + "traits": { + "smithy.api#documentation": "The error code.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "com.amazonaws.iotsitewise#DetailedErrorMessage", + "traits": { + "smithy.api#documentation": "The error message.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains detailed error information.
" + } + }, + "com.amazonaws.iotsitewise#DetailedErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INCOMPATIBLE_COMPUTE_LOCATION", + "name": "INCOMPATIBLE_COMPUTE_LOCATION" + }, + { + "value": "INCOMPATIBLE_FORWARDING_CONFIGURATION", + "name": "INCOMPATIBLE_FORWARDING_CONFIGURATION" + } + ] + } + }, + "com.amazonaws.iotsitewise#DetailedErrorMessage": { + "type": "string" + }, + "com.amazonaws.iotsitewise#DetailedErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#DetailedError" + } + }, + "com.amazonaws.iotsitewise#DisassociateAssets": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#DisassociateAssetsRequest" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#ConflictingOperationException" + }, + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates a child asset from the given parent asset through a hierarchy defined in the\n parent asset's model.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/assets/{assetId}/disassociate", + "code": 200 + } + } + }, + "com.amazonaws.iotsitewise#DisassociateAssetsRequest": { + "type": "structure", + "members": { + "assetId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "The ID of the parent asset from which to disassociate the child asset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } + }, + "hierarchyId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings\n of assets to be formed that all come from the same asset model. You can use the hierarchy ID\n to identify the correct asset to disassociate. For more information, see\n Asset hierarchies in the IoT SiteWise User Guide.
", + "smithy.api#required": {} + } + }, + "childAssetId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "The ID of the child asset to disassociate.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", + "traits": { + "smithy.api#documentation": "A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.iotsitewise#DisassociateTimeSeriesFromAssetProperty": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#DisassociateTimeSeriesFromAssetPropertyRequest" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#ConflictingOperationException" + }, + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates a time series (data stream) from an asset property.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/timeseries/disassociate", + "code": 200 } } }, + "com.amazonaws.iotsitewise#DisassociateTimeSeriesFromAssetPropertyRequest": { + "type": "structure", + "members": { + "alias": { + "target": "com.amazonaws.iotsitewise#PropertyAlias", + "traits": { + "smithy.api#documentation": "The alias that identifies the time series.
", + "smithy.api#httpQuery": "alias", + "smithy.api#required": {} + } + }, + "assetId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "The ID of the asset in which the asset property was created.
", + "smithy.api#httpQuery": "assetId", + "smithy.api#required": {} + } + }, + "propertyId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "The ID of the asset property.
", + "smithy.api#httpQuery": "propertyId", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", + "traits": { + "smithy.api#documentation": "A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.iotsitewise#DisassociatedDataStorageState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "DISABLED", + "name": "DISABLED" + } + ] + } + }, "com.amazonaws.iotsitewise#Email": { "type": "string", "traits": { @@ -5180,7 +5546,7 @@ } ], "traits": { - "smithy.api#documentation": "Get interpolated values for an asset property for a specified time interval, during a\n period of time. If your time series is missing data points during the specified time interval, \n you can use interpolation to estimate the missing data.
\nFor example, you can use this operation to return the interpolated\n temperature values for a wind turbine every 24 hours over a duration of 7 days.
\nTo identify an asset property, you must specify one of the following:
\nThe assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,\n /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
Get interpolated values for an asset property for a specified time interval, during a\n period of time. If your time series is missing data points during the specified time interval,\n you can use interpolation to estimate the missing data.
\nFor example, you can use this operation to return the interpolated temperature values for\n a wind turbine every 24 hours over a duration of 7 days.
\nTo identify an asset property, you must specify one of the following:
\nThe assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example,\n /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
The interpolation type.
\nValid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION\n
\n LINEAR_INTERPOLATION – Estimates missing data using linear interpolation.
For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. \n If the interpolation starts on July 1, 2021, at 9 AM, IoT SiteWise returns the first interpolated value on July 2, 2021, at 9 AM, the second interpolated value \n on July 3, 2021, at 9 AM, and so on.
\n\n LOCF_INTERPOLATION – Estimates missing data using last observation carried forward interpolation
If no data point is found for an interval, \n IoT SiteWise returns the last observed data point for the previous interval \n and carries forward this interpolated value until a new data point is found.
\nFor example, you can get the state of an on-off valve every 24 hours over a duration of 7 days. \n If the interpolation starts on July 1, 2021, at 9 AM, IoT SiteWise returns the last observed data point between July 1, 2021, \n at 9 AM and July 2, 2021, at 9 AM as the first interpolated value. \n If no data point is found after 9 AM on July 2, 2021, IoT SiteWise uses the same interpolated value for the rest of the days.
\nThe interpolation type.
\nValid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION\n
\n LINEAR_INTERPOLATION – Estimates missing data using linear\n interpolation.
For example, you can use this operation to return the interpolated temperature values\n for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts\n July 1, 2021, at 9 AM, IoT SiteWise returns the first interpolated value on July 2, 2021, at 9 AM,\n the second interpolated value on July 3, 2021, at 9 AM, and so on.
\n\n LOCF_INTERPOLATION – Estimates missing data using last observation\n carried forward interpolation
If no data point is found for an interval, IoT SiteWise returns the last observed data point\n for the previous interval and carries forward this interpolated value until a new data\n point is found.
\nFor example, you can get the state of an on-off valve every 24 hours over a duration\n of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the last\n observed data point between July 1, 2021, at 9 AM and July 2, 2021, at 9 AM as the first\n interpolated value. If a data point isn't found after 9 AM on July 2, 2021, IoT SiteWise uses the\n same interpolated value for the rest of the days.
\nThe query interval for the window in seconds. IoT SiteWise computes each interpolated value by using data points \n from the timestamp of each interval minus the window to the timestamp of each interval plus the window. \n If not specified, the window is between the start time minus the interval and the end time plus the interval.
\nIf you specify a value for the intervalWindowInSeconds parameter, \n the type parameter must be LINEAR_INTERPOLATION.
If no data point is found during the specified query window, \n IoT SiteWise won't return an interpolated value for the interval. \n This indicates that there's a gap in the ingested data points.
\nFor example, you can get the interpolated temperature values for a wind turbine \n every 24 hours over a duration of 7 days. If the interpolation starts on July 1, 2021, \n at 9 AM with a window of 2 hours, IoT SiteWise uses the data points from 7 AM (9 AM - 2 hours) \n to 11 AM (9 AM + 2 hours) on July 2, 2021 to compute the first interpolated value, \n uses the data points from 7 AM (9 AM - 2 hours) to 11 AM (9 AM + 2 hours) on July 3, 2021 \n to compute the second interpolated value, and so on.
", + "smithy.api#documentation": "The query interval for the window, in seconds. IoT SiteWise computes each interpolated value by\n using data points from the timestamp of each interval, minus the window to the timestamp of\n each interval plus the window. If not specified, the window ranges between the start time\n minus the interval and the end time plus the interval.
\nIf you specify a value for the intervalWindowInSeconds parameter, the\n value for the type parameter must be\n LINEAR_INTERPOLATION.
If a data point isn't found during the specified query window, IoT SiteWise won't return an\n interpolated value for the interval. This indicates that there's a gap in the ingested\n data points.
\nFor example, you can get the interpolated temperature values for a wind turbine every 24\n hours over a duration of 7 days. If the interpolation starts on July 1, 2021, at 9 AM with a\n window of 2 hours, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM\n plus 2 hours) on July 2, 2021 to compute the first interpolated value. Next, IoT SiteWise uses the\n data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 3, 2021 to\n compute the second interpolated value, and so on.
", "smithy.api#httpQuery": "intervalWindowInSeconds" } } @@ -5342,7 +5708,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains details for a gateway that runs on IoT Greengrass V2. To create a gateway that runs on IoT Greengrass V2, \n you must deploy the IoT SiteWise Edge component to your gateway device. \n Your Greengrass device role \n must use the AWSIoTSiteWiseEdgeAccess policy. For more information, \n see Using IoT SiteWise at the edge \n in the IoT SiteWise User Guide.
Contains details for a gateway that runs on IoT Greengrass V2. To create a gateway that runs on IoT Greengrass\n V2, you must deploy the IoT SiteWise Edge component to your gateway device. Your Greengrass\n device role must use the AWSIoTSiteWiseEdgeAccess policy. For more\n information, see Using IoT SiteWise at the edge in the\n IoT SiteWise User Guide.
Retrieves a paginated list of time series (data streams).
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "GET", + "uri": "/timeseries", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iotsitewise#ListTimeSeriesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.iotsitewise#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return for each paginated request.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "assetId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "The ID of the asset in which the asset property was created.
", + "smithy.api#httpQuery": "assetId" + } + }, + "aliasPrefix": { + "target": "com.amazonaws.iotsitewise#PropertyAlias", + "traits": { + "smithy.api#documentation": "The alias prefix of the time series.
", + "smithy.api#httpQuery": "aliasPrefix" + } + }, + "timeSeriesType": { + "target": "com.amazonaws.iotsitewise#ListTimeSeriesType", + "traits": { + "smithy.api#documentation": "The type of the time series. The time series type can be one of the following\n values:
\n\n ASSOCIATED – The time series is associated with an asset\n property.
\n DISASSOCIATED – The time series isn't associated with any asset\n property.
One or more time series summaries to list.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no additional results.
" + } + } + } + }, + "com.amazonaws.iotsitewise#ListTimeSeriesType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ASSOCIATED", + "name": "ASSOCIATED" + }, + { + "value": "DISASSOCIATED", + "name": "DISASSOCIATED" + } + ] + } + }, "com.amazonaws.iotsitewise#LoggingLevel": { "type": "string", "traits": { @@ -6839,6 +7317,15 @@ "smithy.api#pattern": "^[A-Za-z0-9+/=]+$" } }, + "com.amazonaws.iotsitewise#NumberOfDays": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 30 + } + } + }, "com.amazonaws.iotsitewise#Offset": { "type": "string", "traits": { @@ -7363,7 +7850,7 @@ "kmsKeyId": { "target": "com.amazonaws.iotsitewise#KmsKeyId", "traits": { - "smithy.api#documentation": "The Key ID of the customer managed customer master key (CMK) used for KMS encryption.\n This is required if you use KMS_BASED_ENCRYPTION.
The Key ID of the customer managed key used for KMS encryption. This is required if you\n use KMS_BASED_ENCRYPTION.
The Key ARN of the KMS CMK used for KMS encryption if you use\n KMS_BASED_ENCRYPTION.
The Key ARN of the KMS key used for KMS encryption if you use\n KMS_BASED_ENCRYPTION.
The type of storage that you specified for your data. The storage type can be one of the following values:
\n\n SITEWISE_DEFAULT_STORAGE – IoT SiteWise replicates your data into a service managed database.
\n MULTI_LAYER_STORAGE – IoT SiteWise replicates your data into a service managed database and saves a copy of your raw data and metadata in an Amazon S3 object that you specified.
The storage tier that you specified for your data. \n The storageType parameter can be one of the following values:
\n SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. \n The hot tier is a service-managed database.
\n MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the cold tier. \n The cold tier is a customer-managed Amazon S3 bucket.
Identifies a storage destination. If you specified MULTI_LAYER_STORAGE for the storage type, \n you must specify a MultiLayerStorage object.
Contains the storage configuration for time series (data streams) that aren't associated with asset properties. \n The disassociatedDataStorage can be one of the following values:
\n ENABLED – IoT SiteWise accepts time series that aren't associated with asset properties.
After the disassociatedDataStorage is enabled, you can't disable it.
\n DISABLED – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.
For more information, see Data streams \n in the IoT SiteWise User Guide.
" + } + }, + "retentionPeriod": { + "target": "com.amazonaws.iotsitewise#RetentionPeriod" } } }, @@ -7513,7 +8009,7 @@ "storageType": { "target": "com.amazonaws.iotsitewise#StorageType", "traits": { - "smithy.api#documentation": "The type of storage that you specified for your data. The storage type can be one of the following values:
\n\n SITEWISE_DEFAULT_STORAGE – IoT SiteWise replicates your data into a service managed database.
\n MULTI_LAYER_STORAGE – IoT SiteWise replicates your data into a service managed database and saves a copy of your raw data and metadata in an Amazon S3 object that you specified.
The storage tier that you specified for your data. \n The storageType parameter can be one of the following values:
\n SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. \n The hot tier is a service-managed database.
\n MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the cold tier. \n The cold tier is a customer-managed Amazon S3 bucket.
Contains information about the storage destination.
" } }, + "disassociatedDataStorage": { + "target": "com.amazonaws.iotsitewise#DisassociatedDataStorageState", + "traits": { + "smithy.api#documentation": "Contains the storage configuration for time series (data streams) that aren't associated with asset properties. \n The disassociatedDataStorage can be one of the following values:
\n ENABLED – IoT SiteWise accepts time series that aren't associated with asset properties.
After the disassociatedDataStorage is enabled, you can't disable it.
\n DISABLED – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.
For more information, see Data streams \n in the IoT SiteWise User Guide.
" + } + }, + "retentionPeriod": { + "target": "com.amazonaws.iotsitewise#RetentionPeriod" + }, "configurationStatus": { "target": "com.amazonaws.iotsitewise#ConfigurationStatus", "traits": { @@ -7659,6 +8164,26 @@ ] } }, + "com.amazonaws.iotsitewise#RetentionPeriod": { + "type": "structure", + "members": { + "numberOfDays": { + "target": "com.amazonaws.iotsitewise#NumberOfDays", + "traits": { + "smithy.api#documentation": "The number of days that your data is kept.
\nIf you specified a value for this parameter, the unlimited parameter must\n be false.
If true, your data is kept indefinitely.
\nIf configured to true, you must not specify a value for the\n numberOfDays parameter.
How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.
" + } + }, "com.amazonaws.iotsitewise#SSOApplicationId": { "type": "string", "traits": { @@ -7877,6 +8402,81 @@ ] } }, + "com.amazonaws.iotsitewise#TimeSeriesId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 73 + } + } + }, + "com.amazonaws.iotsitewise#TimeSeriesSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#TimeSeriesSummary" + } + }, + "com.amazonaws.iotsitewise#TimeSeriesSummary": { + "type": "structure", + "members": { + "assetId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "The ID of the asset in which the asset property was created.
" + } + }, + "propertyId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "The ID of the asset property.
" + } + }, + "alias": { + "target": "com.amazonaws.iotsitewise#PropertyAlias", + "traits": { + "smithy.api#documentation": "The alias that identifies the time series.
" + } + }, + "timeSeriesId": { + "target": "com.amazonaws.iotsitewise#TimeSeriesId", + "traits": { + "smithy.api#documentation": "The ID of the time series.
", + "smithy.api#required": {} + } + }, + "dataType": { + "target": "com.amazonaws.iotsitewise#PropertyDataType", + "traits": { + "smithy.api#documentation": "The data type of the time series.
\nIf you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this time series.
The data type of the structure for this time series. This parameter is required for time series \n that have the STRUCT data type.
The options for this parameter depend on the type of the composite model \n in which you created the asset property that is associated with your time series. \n Use AWS/ALARM_STATE for alarm state in alarm composite models.
The date that the time series was created, in Unix epoch time.
", + "smithy.api#required": {} + } + }, + "timeSeriesLastUpdateDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the time series was last updated, in Unix epoch time.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains a summary of a time series (data stream).
" + } + }, "com.amazonaws.iotsitewise#Timestamp": { "type": "timestamp" }, @@ -7983,19 +8583,19 @@ "interval": { "target": "com.amazonaws.iotsitewise#Interval", "traits": { - "smithy.api#documentation": "The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
\nIoT SiteWise computes the 1w interval the end of Sunday at midnight\n each week (UTC), the 1d interval at the end of each day at midnight (UTC), the\n 1h interval at the end of each hour, and so on.
When IoT SiteWise aggregates data points for metric computations, the start of each interval is\n exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at\n the end of the interval.
", + "smithy.api#documentation": "The time interval for the tumbling window. The interval time must be between 1 minute and\n 1 week.
\nIoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC),\n the 1d interval at the end of each day at midnight (UTC), the 1h\n interval at the end of each hour, and so on.
When IoT SiteWise aggregates data points for metric computations, the start of each interval is\n exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at\n the end of the interval.
", "smithy.api#required": {} } }, "offset": { "target": "com.amazonaws.iotsitewise#Offset", "traits": { - "smithy.api#documentation": "The offset for the tumbling window. The offset parameter accepts the following:
The offset time.
\nFor example, if you specify 18h for offset \n and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6:00 PM (UTC), \n you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
\nIf you create the metric after 6:00 PM (UTC), \n you get the first aggregation result at 6 PM (UTC) the next day.
\nThe ISO 8601 format.
\nFor example, if you specify PT18H for offset \n and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6:00 PM (UTC), \n you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
\nIf you create the metric after 6:00 PM (UTC), \n you get the first aggregation result at 6 PM (UTC) the next day.
\nThe 24-hour clock.
\nFor example, if you specify 00:03:00 for offset \n and 5m for interval, and you create the metric at 2 PM (UTC), \n you get the first aggregation result at 2:03 PM (UTC). \n You get the second aggregation result at 2:08 PM (UTC).
The offset time zone.
\nFor example, if you specify 2021-07-23T18:00-08 for offset \n and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6:00 PM (PST), \n you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
\nIf you create the metric after 6:00 PM (PST), \n you get the first aggregation result at 6 PM (PST) the next day.
\nThe offset for the tumbling window. The offset parameter accepts the\n following:
The offset time.
\nFor example, if you specify 18h for offset and\n 1d for interval, IoT SiteWise aggregates data in one of the following\n ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation\n result at 6 PM (UTC) on the day when you create the metric.
\nIf you create the metric after 6 PM (UTC), you get the first aggregation result at\n 6 PM (UTC) the next day.
\nThe ISO 8601 format.
\nFor example, if you specify PT18H for offset and\n 1d for interval, IoT SiteWise aggregates data in one of the following\n ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation\n result at 6 PM (UTC) on the day when you create the metric.
\nIf you create the metric after 6 PM (UTC), you get the first aggregation result at\n 6 PM (UTC) the next day.
\nThe 24-hour clock.
\nFor example, if you specify 00:03:00 for offset,\n 5m for interval, and you create the metric at 2 PM (UTC), you\n get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result\n at 2:08 PM (UTC).
The offset time zone.
\nFor example, if you specify 2021-07-23T18:00-08 for offset\n and 1d for interval, IoT SiteWise aggregates data in one of the\n following ways:
If you create the metric before or at 6 PM (PST), you get the first aggregation\n result at 6 PM (PST) on the day when you create the metric.
\nIf you create the metric after 6 PM (PST), you get the first aggregation result at\n 6 PM (PST) the next day.
\nContains a tumbling window, which is a repeating fixed-sized, non-overlapping, and\n contiguous time window. You use this window in metrics to aggregate data from properties and other assets.
\nYou can use m, h, d, and w \n when you specify an interval or offset. Note that m represents minutes, \n and w represents weeks. You can also use s to represent seconds \n in offset.
The interval and offset parameters support the \n ISO 8601 format. \n For example, PT5S represents five seconds, PT5M represents five minutes, \n and PT5H represents five hours.
Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and\n contiguous time window. You can use this window in metrics to aggregate data from properties\n and other assets.
\nYou can use m, h, d, and w when you\n specify an interval or offset. Note that m represents minutes, h\n represents hours, d represents days, and w represents weeks. You can\n also use s to represent seconds in offset.
The interval and offset parameters support the ISO 8601 format. For example,\n PT5S represents 5 seconds, PT5M represents 5 minutes, and\n PT5H represents 5 hours.
\n TwinMaker is in public preview and is subject to change.\n
\nIoT TwinMaker is a service that enables you to build operational digital twins of\n physical systems. IoT TwinMaker overlays measurements and analysis from real-world sensors,\n cameras, and enterprise applications so you can create data visualizations to monitor your\n physical factory, building, or industrial plant. You can use this real-world data to\n monitor operations and diagnose and repair errors.
", + "smithy.api#title": "AWS IoT TwinMaker" + }, + "version": "2021-11-29", + "operations": [ + { + "target": "com.amazonaws.iottwinmaker#BatchPutPropertyValues" + }, + { + "target": "com.amazonaws.iottwinmaker#CreateComponentType" + }, + { + "target": "com.amazonaws.iottwinmaker#CreateEntity" + }, + { + "target": "com.amazonaws.iottwinmaker#CreateScene" + }, + { + "target": "com.amazonaws.iottwinmaker#CreateWorkspace" + }, + { + "target": "com.amazonaws.iottwinmaker#DeleteComponentType" + }, + { + "target": "com.amazonaws.iottwinmaker#DeleteEntity" + }, + { + "target": "com.amazonaws.iottwinmaker#DeleteScene" + }, + { + "target": "com.amazonaws.iottwinmaker#DeleteWorkspace" + }, + { + "target": "com.amazonaws.iottwinmaker#GetComponentType" + }, + { + "target": "com.amazonaws.iottwinmaker#GetEntity" + }, + { + "target": "com.amazonaws.iottwinmaker#GetPropertyValue" + }, + { + "target": "com.amazonaws.iottwinmaker#GetPropertyValueHistory" + }, + { + "target": "com.amazonaws.iottwinmaker#GetScene" + }, + { + "target": "com.amazonaws.iottwinmaker#GetWorkspace" + }, + { + "target": "com.amazonaws.iottwinmaker#ListComponentTypes" + }, + { + "target": "com.amazonaws.iottwinmaker#ListEntities" + }, + { + "target": "com.amazonaws.iottwinmaker#ListScenes" + }, + { + "target": "com.amazonaws.iottwinmaker#ListTagsForResource" + }, + { + "target": "com.amazonaws.iottwinmaker#ListWorkspaces" + }, + { + "target": "com.amazonaws.iottwinmaker#TagResource" + }, + { + "target": "com.amazonaws.iottwinmaker#UntagResource" + }, + { + "target": "com.amazonaws.iottwinmaker#UpdateComponentType" + }, + { + "target": "com.amazonaws.iottwinmaker#UpdateEntity" + }, + { + "target": "com.amazonaws.iottwinmaker#UpdateScene" + }, + { + "target": "com.amazonaws.iottwinmaker#UpdateWorkspace" + } + ] + }, + "com.amazonaws.iottwinmaker#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iottwinmaker#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "Access is denied.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.iottwinmaker#BatchPutPropertyError": { + "type": "structure", + "members": { + "errorCode": { + "target": "com.amazonaws.iottwinmaker#String", + "traits": { + "smithy.api#documentation": "The error code.
", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "com.amazonaws.iottwinmaker#String", + "traits": { + "smithy.api#documentation": "The error message.
", + "smithy.api#required": {} + } + }, + "entry": { + "target": "com.amazonaws.iottwinmaker#PropertyValueEntry", + "traits": { + "smithy.api#documentation": "An object that contains information about errors returned by the BatchPutProperty action.
An error returned by the BatchPutProperty action.
A list of objects that contain information about errors returned by the\n BatchPutProperty action.
An object that contains information about errors returned by the BatchPutProperty action.
Sets values for multiple time series properties.
", + "smithy.api#endpoint": { + "hostPrefix": "data." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/workspaces/{workspaceId}/entity-properties", + "code": 200 + } + } + }, + "com.amazonaws.iottwinmaker#BatchPutPropertyValuesRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace that contains the properties to set.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entries": { + "target": "com.amazonaws.iottwinmaker#Entries", + "traits": { + "smithy.api#documentation": "An object that maps strings to the property value entries to set. Each string \n in the mapping must be unique to this object.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#BatchPutPropertyValuesResponse": { + "type": "structure", + "members": { + "errorEntries": { + "target": "com.amazonaws.iottwinmaker#ErrorEntries", + "traits": { + "smithy.api#documentation": "Entries that caused errors in the batch put operation.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.iottwinmaker#ComponentRequest": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.iottwinmaker#Description", + "traits": { + "smithy.api#documentation": "The description of the component request.
" + } + }, + "componentTypeId": { + "target": "com.amazonaws.iottwinmaker#ComponentTypeId", + "traits": { + "smithy.api#documentation": "The ID of the component type.
" + } + }, + "properties": { + "target": "com.amazonaws.iottwinmaker#PropertyRequests", + "traits": { + "smithy.api#documentation": "An object that maps strings to the properties to set in the component type. Each string \n in the mapping must be unique to this object.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that sets information about a component type create or update request.
" + } + }, + "com.amazonaws.iottwinmaker#ComponentResponse": { + "type": "structure", + "members": { + "componentName": { + "target": "com.amazonaws.iottwinmaker#Name", + "traits": { + "smithy.api#documentation": "The name of the component.
" + } + }, + "description": { + "target": "com.amazonaws.iottwinmaker#Description", + "traits": { + "smithy.api#documentation": "The description of the component type.
" + } + }, + "componentTypeId": { + "target": "com.amazonaws.iottwinmaker#ComponentTypeId", + "traits": { + "smithy.api#documentation": "The ID of the component type.
" + } + }, + "status": { + "target": "com.amazonaws.iottwinmaker#Status", + "traits": { + "smithy.api#documentation": "The status of the component type.
" + } + }, + "definedIn": { + "target": "com.amazonaws.iottwinmaker#String", + "traits": { + "smithy.api#documentation": "The name of the property definition set in the request.
" + } + }, + "properties": { + "target": "com.amazonaws.iottwinmaker#PropertyResponses", + "traits": { + "smithy.api#documentation": "An object that maps strings to the properties to set in the component type. Each string \n in the mapping must be unique to this object.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that returns information about a component type create or update request.
" + } + }, + "com.amazonaws.iottwinmaker#ComponentTypeId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z_\\.\\-0-9:]+$" + } + }, + "com.amazonaws.iottwinmaker#ComponentTypeSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.iottwinmaker#ComponentTypeSummary" + } + }, + "com.amazonaws.iottwinmaker#ComponentTypeSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.iottwinmaker#TwinMakerArn", + "traits": { + "smithy.api#documentation": "The ARN of the component type.
", + "smithy.api#required": {} + } + }, + "componentTypeId": { + "target": "com.amazonaws.iottwinmaker#ComponentTypeId", + "traits": { + "smithy.api#documentation": "The ID of the component type.
", + "smithy.api#required": {} + } + }, + "creationDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the component type was created.
", + "smithy.api#required": {} + } + }, + "updateDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the component type was last updated.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iottwinmaker#Description", + "traits": { + "smithy.api#documentation": "The description of the component type.
" + } + }, + "status": { + "target": "com.amazonaws.iottwinmaker#Status", + "traits": { + "smithy.api#documentation": "The current status of the component type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information about a component type.
" + } + }, + "com.amazonaws.iottwinmaker#ComponentUpdateRequest": { + "type": "structure", + "members": { + "updateType": { + "target": "com.amazonaws.iottwinmaker#ComponentUpdateType", + "traits": { + "smithy.api#documentation": "The update type of the component update request.
" + } + }, + "description": { + "target": "com.amazonaws.iottwinmaker#Description", + "traits": { + "smithy.api#documentation": "The description of the component type.
" + } + }, + "componentTypeId": { + "target": "com.amazonaws.iottwinmaker#ComponentTypeId", + "traits": { + "smithy.api#documentation": "The ID of the component type.
" + } + }, + "propertyUpdates": { + "target": "com.amazonaws.iottwinmaker#PropertyRequests", + "traits": { + "smithy.api#documentation": "An object that maps strings to the properties to set in the component type update. Each string \n in the mapping must be unique to this object.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The component update request.
" + } + }, + "com.amazonaws.iottwinmaker#ComponentUpdateType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATE", + "name": "CREATE" + }, + { + "value": "UPDATE", + "name": "UPDATE" + }, + { + "value": "DELETE", + "name": "DELETE" + } + ] + } + }, + "com.amazonaws.iottwinmaker#ComponentUpdatesMapRequest": { + "type": "map", + "key": { + "target": "com.amazonaws.iottwinmaker#Name" + }, + "value": { + "target": "com.amazonaws.iottwinmaker#ComponentUpdateRequest" + } + }, + "com.amazonaws.iottwinmaker#ComponentsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.iottwinmaker#Name" + }, + "value": { + "target": "com.amazonaws.iottwinmaker#ComponentResponse" + } + }, + "com.amazonaws.iottwinmaker#ComponentsMapRequest": { + "type": "map", + "key": { + "target": "com.amazonaws.iottwinmaker#Name" + }, + "value": { + "target": "com.amazonaws.iottwinmaker#ComponentRequest" + } + }, + "com.amazonaws.iottwinmaker#Configuration": { + "type": "map", + "key": { + "target": "com.amazonaws.iottwinmaker#Name" + }, + "value": { + "target": "com.amazonaws.iottwinmaker#Value" + } + }, + "com.amazonaws.iottwinmaker#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iottwinmaker#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "A conflict occurred.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.iottwinmaker#ConnectorFailureException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iottwinmaker#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The connector failed.
", + "smithy.api#error": "client", + "smithy.api#httpError": 424 + } + }, + "com.amazonaws.iottwinmaker#ConnectorTimeoutException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iottwinmaker#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The connector timed out.
", + "smithy.api#error": "client", + "smithy.api#httpError": 424 + } + }, + "com.amazonaws.iottwinmaker#CreateComponentType": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#CreateComponentTypeRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#CreateComponentTypeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#AccessDeniedException" + }, + { + "target": "com.amazonaws.iottwinmaker#ConflictException" + }, + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a component type.
\n\n TwinMaker is in public preview and is subject to change.\n
\nThe ID of the workspace that contains the component type.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "isSingleton": { + "target": "com.amazonaws.iottwinmaker#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that specifies whether an entity can have more than one component of\n this type.
" + } + }, + "componentTypeId": { + "target": "com.amazonaws.iottwinmaker#ComponentTypeId", + "traits": { + "smithy.api#documentation": "The ID of the component type.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iottwinmaker#Description", + "traits": { + "smithy.api#documentation": "The description of the component type.
" + } + }, + "propertyDefinitions": { + "target": "com.amazonaws.iottwinmaker#PropertyDefinitionsRequest", + "traits": { + "smithy.api#documentation": "An object that maps strings to the property definitions in the component type. Each string \n in the mapping must be unique to this object.
" + } + }, + "extendsFrom": { + "target": "com.amazonaws.iottwinmaker#ExtendsFrom", + "traits": { + "smithy.api#documentation": "Specifies the parent component type to extend.
" + } + }, + "functions": { + "target": "com.amazonaws.iottwinmaker#FunctionsRequest", + "traits": { + "smithy.api#documentation": "An object that maps strings to the functions in the component type. Each string in the\n mapping must be unique to this object.
" + } + }, + "tags": { + "target": "com.amazonaws.iottwinmaker#TagMap", + "traits": { + "smithy.api#documentation": "Metadata that you can use to manage the component type.
" + } + } + } + }, + "com.amazonaws.iottwinmaker#CreateComponentTypeResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.iottwinmaker#TwinMakerArn", + "traits": { + "smithy.api#documentation": "The ARN of the component type.
", + "smithy.api#required": {} + } + }, + "creationDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the entity was created.
", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.iottwinmaker#State", + "traits": { + "smithy.api#documentation": "The current state of the component type.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#CreateEntity": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#CreateEntityRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#CreateEntityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#AccessDeniedException" + }, + { + "target": "com.amazonaws.iottwinmaker#ConflictException" + }, + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an entity.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/workspaces/{workspaceId}/entities", + "code": 200 + } + } + }, + "com.amazonaws.iottwinmaker#CreateEntityRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace that contains the entity.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityId": { + "target": "com.amazonaws.iottwinmaker#EntityId", + "traits": { + "smithy.api#documentation": "The ID of the entity.
" + } + }, + "entityName": { + "target": "com.amazonaws.iottwinmaker#EntityName", + "traits": { + "smithy.api#documentation": "The name of the entity.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iottwinmaker#Description", + "traits": { + "smithy.api#documentation": "The description of the entity.
" + } + }, + "components": { + "target": "com.amazonaws.iottwinmaker#ComponentsMapRequest", + "traits": { + "smithy.api#documentation": "An object that maps strings to the components in the entity. Each string \n in the mapping must be unique to this object.
" + } + }, + "parentEntityId": { + "target": "com.amazonaws.iottwinmaker#ParentEntityId", + "traits": { + "smithy.api#documentation": "The ID of the entity's parent entity.
" + } + }, + "tags": { + "target": "com.amazonaws.iottwinmaker#TagMap", + "traits": { + "smithy.api#documentation": "Metadata that you can use to manage the entity.
" + } + } + } + }, + "com.amazonaws.iottwinmaker#CreateEntityResponse": { + "type": "structure", + "members": { + "entityId": { + "target": "com.amazonaws.iottwinmaker#EntityId", + "traits": { + "smithy.api#documentation": "The ID of the entity.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iottwinmaker#TwinMakerArn", + "traits": { + "smithy.api#documentation": "The ARN of the entity.
", + "smithy.api#required": {} + } + }, + "creationDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the entity was created.
", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.iottwinmaker#State", + "traits": { + "smithy.api#documentation": "The current state of the entity.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#CreateScene": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#CreateSceneRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#CreateSceneResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#AccessDeniedException" + }, + { + "target": "com.amazonaws.iottwinmaker#ConflictException" + }, + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a scene.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/workspaces/{workspaceId}/scenes", + "code": 200 + } + } + }, + "com.amazonaws.iottwinmaker#CreateSceneRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace that contains the scene.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sceneId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the scene.
", + "smithy.api#required": {} + } + }, + "contentLocation": { + "target": "com.amazonaws.iottwinmaker#S3Url", + "traits": { + "smithy.api#documentation": "The relative path that specifies the location of the content definition file.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iottwinmaker#Description", + "traits": { + "smithy.api#documentation": "The description for this scene.
" + } + }, + "capabilities": { + "target": "com.amazonaws.iottwinmaker#SceneCapabilities", + "traits": { + "smithy.api#documentation": "A list of capabilities that the scene uses to render itself.
" + } + }, + "tags": { + "target": "com.amazonaws.iottwinmaker#TagMap", + "traits": { + "smithy.api#documentation": "Metadata that you can use to manage the scene.
" + } + } + } + }, + "com.amazonaws.iottwinmaker#CreateSceneResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.iottwinmaker#TwinMakerArn", + "traits": { + "smithy.api#documentation": "The ARN of the scene.
", + "smithy.api#required": {} + } + }, + "creationDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the scene was created.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#CreateWorkspace": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#CreateWorkspaceRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#CreateWorkspaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#AccessDeniedException" + }, + { + "target": "com.amazonaws.iottwinmaker#ConflictException" + }, + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a workplace.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/workspaces/{workspaceId}", + "code": 200 + } + } + }, + "com.amazonaws.iottwinmaker#CreateWorkspaceRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iottwinmaker#Description", + "traits": { + "smithy.api#documentation": "The description of the workspace.
" + } + }, + "s3Location": { + "target": "com.amazonaws.iottwinmaker#S3Location", + "traits": { + "smithy.api#documentation": "The ARN of the S3 bucket where resources associated with the workspace are stored.
", + "smithy.api#required": {} + } + }, + "role": { + "target": "com.amazonaws.iottwinmaker#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the execution role associated with the workspace.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.iottwinmaker#TagMap", + "traits": { + "smithy.api#documentation": "Metadata that you can use to manage the workspace
" + } + } + } + }, + "com.amazonaws.iottwinmaker#CreateWorkspaceResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.iottwinmaker#TwinMakerArn", + "traits": { + "smithy.api#documentation": "The ARN of the workspace.
", + "smithy.api#required": {} + } + }, + "creationDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the workspace was created.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#DataConnector": { + "type": "structure", + "members": { + "lambda": { + "target": "com.amazonaws.iottwinmaker#LambdaFunction", + "traits": { + "smithy.api#documentation": "The Lambda function associated with this data connector.
" + } + }, + "isNative": { + "target": "com.amazonaws.iottwinmaker#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that specifies whether the data connector is native to TwinMaker.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The data connector.
" + } + }, + "com.amazonaws.iottwinmaker#DataType": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.iottwinmaker#Type", + "traits": { + "smithy.api#documentation": "The underlying type of the data type.
", + "smithy.api#required": {} + } + }, + "nestedType": { + "target": "com.amazonaws.iottwinmaker#DataType", + "traits": { + "smithy.api#documentation": "The nested type in the data type.
" + } + }, + "allowedValues": { + "target": "com.amazonaws.iottwinmaker#DataValueList", + "traits": { + "smithy.api#documentation": "The allowed values for this data type.
" + } + }, + "unitOfMeasure": { + "target": "com.amazonaws.iottwinmaker#String", + "traits": { + "smithy.api#documentation": "The unit of measure used in this data type.
" + } + }, + "relationship": { + "target": "com.amazonaws.iottwinmaker#Relationship", + "traits": { + "smithy.api#documentation": "A relationship that associates a component with another component.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that specifies the data type of a property.
" + } + }, + "com.amazonaws.iottwinmaker#DataValue": { + "type": "structure", + "members": { + "booleanValue": { + "target": "com.amazonaws.iottwinmaker#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean value.
" + } + }, + "doubleValue": { + "target": "com.amazonaws.iottwinmaker#Double", + "traits": { + "smithy.api#documentation": "A double value.
" + } + }, + "integerValue": { + "target": "com.amazonaws.iottwinmaker#Integer", + "traits": { + "smithy.api#documentation": "An integer value.
" + } + }, + "longValue": { + "target": "com.amazonaws.iottwinmaker#Long", + "traits": { + "smithy.api#documentation": "A long value.
" + } + }, + "stringValue": { + "target": "com.amazonaws.iottwinmaker#String", + "traits": { + "smithy.api#documentation": "A string value.
" + } + }, + "listValue": { + "target": "com.amazonaws.iottwinmaker#DataValueList", + "traits": { + "smithy.api#documentation": "A list of multiple values.
" + } + }, + "mapValue": { + "target": "com.amazonaws.iottwinmaker#DataValueMap", + "traits": { + "smithy.api#documentation": "An object that maps strings to multiple DataValue objects.
A value that relates a component to another component.
" + } + }, + "expression": { + "target": "com.amazonaws.iottwinmaker#Expression", + "traits": { + "smithy.api#documentation": "An expression that produces the value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that specifies a value for a property.
" + } + }, + "com.amazonaws.iottwinmaker#DataValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.iottwinmaker#DataValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.iottwinmaker#DataValueMap": { + "type": "map", + "key": { + "target": "com.amazonaws.iottwinmaker#String" + }, + "value": { + "target": "com.amazonaws.iottwinmaker#DataValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.iottwinmaker#DeleteComponentType": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#DeleteComponentTypeRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#DeleteComponentTypeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#AccessDeniedException" + }, + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a component type.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "DELETE", + "uri": "/workspaces/{workspaceId}/component-types/{componentTypeId}", + "code": 200 + } + } + }, + "com.amazonaws.iottwinmaker#DeleteComponentTypeRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace that contains the component type.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "componentTypeId": { + "target": "com.amazonaws.iottwinmaker#ComponentTypeId", + "traits": { + "smithy.api#documentation": "The ID of the component type to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#DeleteComponentTypeResponse": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.iottwinmaker#State", + "traits": { + "smithy.api#documentation": "The current state of the component type to be deleted.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#DeleteEntity": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#DeleteEntityRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#DeleteEntityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iottwinmaker#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an entity.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "DELETE", + "uri": "/workspaces/{workspaceId}/entities/{entityId}", + "code": 200 + } + } + }, + "com.amazonaws.iottwinmaker#DeleteEntityRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace that contains the entity to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityId": { + "target": "com.amazonaws.iottwinmaker#EntityId", + "traits": { + "smithy.api#documentation": "The ID of the entity to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "isRecursive": { + "target": "com.amazonaws.iottwinmaker#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that specifies whether the operation deletes child entities.
", + "smithy.api#httpQuery": "isRecursive" + } + } + } + }, + "com.amazonaws.iottwinmaker#DeleteEntityResponse": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.iottwinmaker#State", + "traits": { + "smithy.api#documentation": "The current state of the deleted entity.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#DeleteScene": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#DeleteSceneRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#DeleteSceneResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#AccessDeniedException" + }, + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a scene.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "DELETE", + "uri": "/workspaces/{workspaceId}/scenes/{sceneId}", + "code": 200 + } + } + }, + "com.amazonaws.iottwinmaker#DeleteSceneRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sceneId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the scene to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#DeleteSceneResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iottwinmaker#DeleteWorkspace": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#DeleteWorkspaceRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#DeleteWorkspaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#AccessDeniedException" + }, + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a workspace.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "DELETE", + "uri": "/workspaces/{workspaceId}", + "code": 200 + } + } + }, + "com.amazonaws.iottwinmaker#DeleteWorkspaceRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#DeleteWorkspaceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iottwinmaker#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.iottwinmaker#Double": { + "type": "double", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.iottwinmaker#EntityId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.iottwinmaker#EntityName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z_0-9-.][a-zA-Z_0-9-. ]*[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.iottwinmaker#EntityPropertyReference": { + "type": "structure", + "members": { + "componentName": { + "target": "com.amazonaws.iottwinmaker#Name", + "traits": { + "smithy.api#documentation": "The name of the component.
" + } + }, + "externalIdProperty": { + "target": "com.amazonaws.iottwinmaker#ExternalIdProperty", + "traits": { + "smithy.api#documentation": "A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
" + } + }, + "entityId": { + "target": "com.amazonaws.iottwinmaker#EntityId", + "traits": { + "smithy.api#documentation": "The ID of the entity.
" + } + }, + "propertyName": { + "target": "com.amazonaws.iottwinmaker#Name", + "traits": { + "smithy.api#documentation": "The name of the property.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object that uniquely identifies an entity property.
" + } + }, + "com.amazonaws.iottwinmaker#EntitySummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.iottwinmaker#EntitySummary" + } + }, + "com.amazonaws.iottwinmaker#EntitySummary": { + "type": "structure", + "members": { + "entityId": { + "target": "com.amazonaws.iottwinmaker#EntityId", + "traits": { + "smithy.api#documentation": "The ID of the entity.
", + "smithy.api#required": {} + } + }, + "entityName": { + "target": "com.amazonaws.iottwinmaker#EntityName", + "traits": { + "smithy.api#documentation": "The name of the entity.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iottwinmaker#TwinMakerArn", + "traits": { + "smithy.api#documentation": "The ARN of the entity.
", + "smithy.api#required": {} + } + }, + "parentEntityId": { + "target": "com.amazonaws.iottwinmaker#ParentEntityId", + "traits": { + "smithy.api#documentation": "The ID of the parent entity.
" + } + }, + "status": { + "target": "com.amazonaws.iottwinmaker#Status", + "traits": { + "smithy.api#documentation": "The current status of the entity.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iottwinmaker#Description", + "traits": { + "smithy.api#documentation": "The description of the entity.
" + } + }, + "hasChildEntities": { + "target": "com.amazonaws.iottwinmaker#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that specifies whether the entity has child entities or not.
" + } + }, + "creationDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the entity was created.
", + "smithy.api#required": {} + } + }, + "updateDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The last date and time when the entity was updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information about an entity.
" + } + }, + "com.amazonaws.iottwinmaker#Entries": { + "type": "list", + "member": { + "target": "com.amazonaws.iottwinmaker#PropertyValueEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.iottwinmaker#ErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "VALIDATION_ERROR", + "name": "VALIDATION_ERROR" + }, + { + "value": "INTERNAL_FAILURE", + "name": "INTERNAL_FAILURE" + } + ] + } + }, + "com.amazonaws.iottwinmaker#ErrorDetails": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.iottwinmaker#ErrorCode", + "traits": { + "smithy.api#documentation": "The error code.
" + } + }, + "message": { + "target": "com.amazonaws.iottwinmaker#ErrorMessage", + "traits": { + "smithy.api#documentation": "The error message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The error details.
" + } + }, + "com.amazonaws.iottwinmaker#ErrorEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.iottwinmaker#BatchPutPropertyErrorEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.iottwinmaker#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.iottwinmaker#Errors": { + "type": "list", + "member": { + "target": "com.amazonaws.iottwinmaker#BatchPutPropertyError" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.iottwinmaker#ExceptionMessage": { + "type": "string" + }, + "com.amazonaws.iottwinmaker#Expression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 316 + }, + "smithy.api#pattern": "^(^\\$\\{Parameters\\.[a-zA-z]+([a-zA-z_0-9]*)}$)$" + } + }, + "com.amazonaws.iottwinmaker#ExtendsFrom": { + "type": "list", + "member": { + "target": "com.amazonaws.iottwinmaker#ComponentTypeId" + } + }, + "com.amazonaws.iottwinmaker#ExternalIdProperty": { + "type": "map", + "key": { + "target": "com.amazonaws.iottwinmaker#String" + }, + "value": { + "target": "com.amazonaws.iottwinmaker#String" + } + }, + "com.amazonaws.iottwinmaker#FunctionRequest": { + "type": "structure", + "members": { + "requiredProperties": { + "target": "com.amazonaws.iottwinmaker#RequiredProperties", + "traits": { + "smithy.api#documentation": "The required properties of the function.
" + } + }, + "scope": { + "target": "com.amazonaws.iottwinmaker#Scope", + "traits": { + "smithy.api#documentation": "The scope of the function.
" + } + }, + "implementedBy": { + "target": "com.amazonaws.iottwinmaker#DataConnector", + "traits": { + "smithy.api#documentation": "The data connector.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The function request body.
" + } + }, + "com.amazonaws.iottwinmaker#FunctionResponse": { + "type": "structure", + "members": { + "requiredProperties": { + "target": "com.amazonaws.iottwinmaker#RequiredProperties", + "traits": { + "smithy.api#documentation": "The required properties of the function.
" + } + }, + "scope": { + "target": "com.amazonaws.iottwinmaker#Scope", + "traits": { + "smithy.api#documentation": "The scope of the function.
" + } + }, + "implementedBy": { + "target": "com.amazonaws.iottwinmaker#DataConnector", + "traits": { + "smithy.api#documentation": "The data connector.
" + } + }, + "isInherited": { + "target": "com.amazonaws.iottwinmaker#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether this function is inherited.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The function response.
" + } + }, + "com.amazonaws.iottwinmaker#FunctionsRequest": { + "type": "map", + "key": { + "target": "com.amazonaws.iottwinmaker#Name" + }, + "value": { + "target": "com.amazonaws.iottwinmaker#FunctionRequest" + } + }, + "com.amazonaws.iottwinmaker#FunctionsResponse": { + "type": "map", + "key": { + "target": "com.amazonaws.iottwinmaker#Name" + }, + "value": { + "target": "com.amazonaws.iottwinmaker#FunctionResponse" + } + }, + "com.amazonaws.iottwinmaker#GetComponentType": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#GetComponentTypeRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#GetComponentTypeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#AccessDeniedException" + }, + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a component type.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "GET", + "uri": "/workspaces/{workspaceId}/component-types/{componentTypeId}", + "code": 200 + } + } + }, + "com.amazonaws.iottwinmaker#GetComponentTypeRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace that contains the component type.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "componentTypeId": { + "target": "com.amazonaws.iottwinmaker#ComponentTypeId", + "traits": { + "smithy.api#documentation": "The ID of the component type.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#GetComponentTypeResponse": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace that contains the component type.
", + "smithy.api#required": {} + } + }, + "isSingleton": { + "target": "com.amazonaws.iottwinmaker#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that specifies whether an entity can have more than one component of this\n type.
" + } + }, + "componentTypeId": { + "target": "com.amazonaws.iottwinmaker#ComponentTypeId", + "traits": { + "smithy.api#documentation": "The ID of the component type.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iottwinmaker#Description", + "traits": { + "smithy.api#documentation": "The description of the component type.
" + } + }, + "propertyDefinitions": { + "target": "com.amazonaws.iottwinmaker#PropertyDefinitionsResponse", + "traits": { + "smithy.api#documentation": "An object that maps strings to the property definitions in the component type. Each string \n in the mapping must be unique to this object.
" + } + }, + "extendsFrom": { + "target": "com.amazonaws.iottwinmaker#ExtendsFrom", + "traits": { + "smithy.api#documentation": "The name of the parent component type that this component type extends.
" + } + }, + "functions": { + "target": "com.amazonaws.iottwinmaker#FunctionsResponse", + "traits": { + "smithy.api#documentation": "An object that maps strings to the functions in the component type. Each string \n in the mapping must be unique to this object.
" + } + }, + "creationDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the component type was created.
", + "smithy.api#required": {} + } + }, + "updateDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the component was last updated.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iottwinmaker#TwinMakerArn", + "traits": { + "smithy.api#documentation": "The ARN of the component type.
", + "smithy.api#required": {} + } + }, + "isAbstract": { + "target": "com.amazonaws.iottwinmaker#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that specifies whether the component type is abstract.
" + } + }, + "isSchemaInitialized": { + "target": "com.amazonaws.iottwinmaker#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that specifies whether the component type has a schema initializer and that the \n schema initializer has run.
" + } + }, + "status": { + "target": "com.amazonaws.iottwinmaker#Status", + "traits": { + "smithy.api#documentation": "The current status of the component type.
" + } + } + } + }, + "com.amazonaws.iottwinmaker#GetEntity": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#GetEntityRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#GetEntityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iottwinmaker#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about an entity.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "GET", + "uri": "/workspaces/{workspaceId}/entities/{entityId}", + "code": 200 + } + } + }, + "com.amazonaws.iottwinmaker#GetEntityRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityId": { + "target": "com.amazonaws.iottwinmaker#EntityId", + "traits": { + "smithy.api#documentation": "The ID of the entity.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#GetEntityResponse": { + "type": "structure", + "members": { + "entityId": { + "target": "com.amazonaws.iottwinmaker#EntityId", + "traits": { + "smithy.api#documentation": "The ID of the entity.
", + "smithy.api#required": {} + } + }, + "entityName": { + "target": "com.amazonaws.iottwinmaker#EntityName", + "traits": { + "smithy.api#documentation": "The name of the entity.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iottwinmaker#TwinMakerArn", + "traits": { + "smithy.api#documentation": "The ARN of the entity.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.iottwinmaker#Status", + "traits": { + "smithy.api#documentation": "The current status of the entity.
", + "smithy.api#required": {} + } + }, + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iottwinmaker#Description", + "traits": { + "smithy.api#documentation": "The description of the entity.
" + } + }, + "components": { + "target": "com.amazonaws.iottwinmaker#ComponentsMap", + "traits": { + "smithy.api#documentation": "An object that maps strings to the components in the entity. Each string \n in the mapping must be unique to this object.
" + } + }, + "parentEntityId": { + "target": "com.amazonaws.iottwinmaker#ParentEntityId", + "traits": { + "smithy.api#documentation": "The ID of the parent entity for this entity.
", + "smithy.api#required": {} + } + }, + "hasChildEntities": { + "target": "com.amazonaws.iottwinmaker#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that specifies whether the entity has associated child entities.
", + "smithy.api#required": {} + } + }, + "creationDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the entity was created.
", + "smithy.api#required": {} + } + }, + "updateDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the entity was last updated.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#GetPropertyValue": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#GetPropertyValueRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#GetPropertyValueResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#AccessDeniedException" + }, + { + "target": "com.amazonaws.iottwinmaker#ConnectorFailureException" + }, + { + "target": "com.amazonaws.iottwinmaker#ConnectorTimeoutException" + }, + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the property values for a component, component type, entity, or workspace.
\nYou must specify a value for either componentName, componentTypeId, entityId, or workspaceId.
Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.
\nYou must specify a value for workspaceId. For entity-specific queries, specify values for componentName and \n entityId. For cross-entity quries, specify a value for componentTypeId.
The ID of the workspace.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityId": { + "target": "com.amazonaws.iottwinmaker#EntityId", + "traits": { + "smithy.api#documentation": "The ID of the entity.
" + } + }, + "componentName": { + "target": "com.amazonaws.iottwinmaker#Name", + "traits": { + "smithy.api#documentation": "The name of the component.
" + } + }, + "componentTypeId": { + "target": "com.amazonaws.iottwinmaker#ComponentTypeId", + "traits": { + "smithy.api#documentation": "The ID of the component type.
" + } + }, + "selectedProperties": { + "target": "com.amazonaws.iottwinmaker#SelectedPropertyList", + "traits": { + "smithy.api#documentation": "A list of properties whose value histories the request retrieves.
", + "smithy.api#required": {} + } + }, + "propertyFilters": { + "target": "com.amazonaws.iottwinmaker#PropertyFilters", + "traits": { + "smithy.api#documentation": "A list of objects that filter the property value history request.
" + } + }, + "startDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time of the earliest property value to return.
", + "smithy.api#required": {} + } + }, + "endDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time of the latest property value to return.
", + "smithy.api#required": {} + } + }, + "interpolation": { + "target": "com.amazonaws.iottwinmaker#InterpolationParameters", + "traits": { + "smithy.api#documentation": "An object that specifies the interpolation type and the interval over which to interpolate data.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iottwinmaker#NextToken", + "traits": { + "smithy.api#documentation": "The string that specifies the next page of results.
" + } + }, + "maxResults": { + "target": "com.amazonaws.iottwinmaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return.
" + } + }, + "orderByTime": { + "target": "com.amazonaws.iottwinmaker#OrderByTime", + "traits": { + "smithy.api#documentation": "The time direction to use in the result order.
" + } + } + } + }, + "com.amazonaws.iottwinmaker#GetPropertyValueHistoryResponse": { + "type": "structure", + "members": { + "propertyValues": { + "target": "com.amazonaws.iottwinmaker#PropertyValueList", + "traits": { + "smithy.api#documentation": "An object that maps strings to the property definitions in the component type. Each string \n in the mapping must be unique to this object.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.iottwinmaker#NextToken", + "traits": { + "smithy.api#documentation": "The string that specifies the next page of results.
" + } + } + } + }, + "com.amazonaws.iottwinmaker#GetPropertyValueRequest": { + "type": "structure", + "members": { + "componentName": { + "target": "com.amazonaws.iottwinmaker#Name", + "traits": { + "smithy.api#documentation": "The name of the component whose property values the operation returns.
" + } + }, + "componentTypeId": { + "target": "com.amazonaws.iottwinmaker#ComponentTypeId", + "traits": { + "smithy.api#documentation": "The ID of the component type whose property values the operation returns.
" + } + }, + "entityId": { + "target": "com.amazonaws.iottwinmaker#EntityId", + "traits": { + "smithy.api#documentation": "The ID of the entity whose property values the operation returns.
" + } + }, + "selectedProperties": { + "target": "com.amazonaws.iottwinmaker#SelectedPropertyList", + "traits": { + "smithy.api#documentation": "The properties whose values the operation returns.
", + "smithy.api#required": {} + } + }, + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace whose values the operation returns.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#GetPropertyValueResponse": { + "type": "structure", + "members": { + "propertyValues": { + "target": "com.amazonaws.iottwinmaker#PropertyLatestValueMap", + "traits": { + "smithy.api#documentation": "An object that maps strings to the properties and latest property values in the response. Each string \n in the mapping must be unique to this object.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#GetScene": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#GetSceneRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#GetSceneResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#AccessDeniedException" + }, + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a scene.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "GET", + "uri": "/workspaces/{workspaceId}/scenes/{sceneId}", + "code": 200 + } + } + }, + "com.amazonaws.iottwinmaker#GetSceneRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace that contains the scene.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sceneId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the scene.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#GetSceneResponse": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace that contains the scene.
", + "smithy.api#required": {} + } + }, + "sceneId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the scene.
", + "smithy.api#required": {} + } + }, + "contentLocation": { + "target": "com.amazonaws.iottwinmaker#S3Url", + "traits": { + "smithy.api#documentation": "The relative path that specifies the location of the content definition file.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iottwinmaker#TwinMakerArn", + "traits": { + "smithy.api#documentation": "The ARN of the scene.
", + "smithy.api#required": {} + } + }, + "creationDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the scene was created.
", + "smithy.api#required": {} + } + }, + "updateDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the scene was last updated.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iottwinmaker#Description", + "traits": { + "smithy.api#documentation": "The description of the scene.
" + } + }, + "capabilities": { + "target": "com.amazonaws.iottwinmaker#SceneCapabilities", + "traits": { + "smithy.api#documentation": "A list of capabilities that the scene uses to render.
" + } + } + } + }, + "com.amazonaws.iottwinmaker#GetWorkspace": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#GetWorkspaceRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#GetWorkspaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iottwinmaker#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a workspace.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "GET", + "uri": "/workspaces/{workspaceId}", + "code": 200 + } + } + }, + "com.amazonaws.iottwinmaker#GetWorkspaceRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#IdOrArn", + "traits": { + "smithy.api#documentation": "The ID of the workspace.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#GetWorkspaceResponse": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iottwinmaker#TwinMakerArn", + "traits": { + "smithy.api#documentation": "The ARN of the workspace.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iottwinmaker#Description", + "traits": { + "smithy.api#documentation": "The description of the workspace.
" + } + }, + "s3Location": { + "target": "com.amazonaws.iottwinmaker#S3Location", + "traits": { + "smithy.api#documentation": "The ARN of the S3 bucket where resources associated with the workspace are stored.
", + "smithy.api#required": {} + } + }, + "role": { + "target": "com.amazonaws.iottwinmaker#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the execution role associated with the workspace.
", + "smithy.api#required": {} + } + }, + "creationDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the workspace was created.
", + "smithy.api#required": {} + } + }, + "updateDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the workspace was last updated.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#Id": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z_0-9][a-zA-Z_\\-0-9]*[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.iottwinmaker#IdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z_\\-0-9]*[a-zA-Z0-9]+$|^arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\\/a-zA-Z0-9_-]+$" + } + }, + "com.amazonaws.iottwinmaker#Integer": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.iottwinmaker#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iottwinmaker#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "An unexpected error has occurred.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.iottwinmaker#InterpolationParameters": { + "type": "structure", + "members": { + "interpolationType": { + "target": "com.amazonaws.iottwinmaker#InterpolationType", + "traits": { + "smithy.api#documentation": "The interpolation type.
" + } + }, + "intervalInSeconds": { + "target": "com.amazonaws.iottwinmaker#IntervalInSeconds", + "traits": { + "smithy.api#documentation": "The interpolation time interval in seconds.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that specifies how to interpolate data in a list.
" + } + }, + "com.amazonaws.iottwinmaker#InterpolationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LINEAR", + "name": "LINEAR" + } + ] + } + }, + "com.amazonaws.iottwinmaker#IntervalInSeconds": { + "type": "long", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.iottwinmaker#LambdaArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:((aws)|(aws-cn)|(aws-us-gov)):lambda:[a-z0-9-]+:[0-9]{12}:function:[\\/a-zA-Z0-9_-]+$" + } + }, + "com.amazonaws.iottwinmaker#LambdaFunction": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.iottwinmaker#LambdaArn", + "traits": { + "smithy.api#documentation": "The ARN of the Lambda function.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The Lambda function.
" + } + }, + "com.amazonaws.iottwinmaker#ListComponentTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#ListComponentTypesRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#ListComponentTypesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#AccessDeniedException" + }, + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all component types in a workspace.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/workspaces/{workspaceId}/component-types-list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iottwinmaker#ListComponentTypesFilter": { + "type": "union", + "members": { + "extendsFrom": { + "target": "com.amazonaws.iottwinmaker#ComponentTypeId", + "traits": { + "smithy.api#documentation": "The component type that the component types in the list extend.
" + } + }, + "namespace": { + "target": "com.amazonaws.iottwinmaker#String", + "traits": { + "smithy.api#documentation": "The namespace to which the component types in the list belong.
" + } + }, + "isAbstract": { + "target": "com.amazonaws.iottwinmaker#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that specifies whether the component types in the list are abstract.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that filters items in a list of component types.
" + } + }, + "com.amazonaws.iottwinmaker#ListComponentTypesFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.iottwinmaker#ListComponentTypesFilter" + } + }, + "com.amazonaws.iottwinmaker#ListComponentTypesRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "filters": { + "target": "com.amazonaws.iottwinmaker#ListComponentTypesFilters", + "traits": { + "smithy.api#documentation": "A list of objects that filter the request.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iottwinmaker#NextToken", + "traits": { + "smithy.api#documentation": "The string that specifies the next page of results.
" + } + }, + "maxResults": { + "target": "com.amazonaws.iottwinmaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to display.
" + } + } + } + }, + "com.amazonaws.iottwinmaker#ListComponentTypesResponse": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace.
", + "smithy.api#required": {} + } + }, + "componentTypeSummaries": { + "target": "com.amazonaws.iottwinmaker#ComponentTypeSummaries", + "traits": { + "smithy.api#documentation": "A list of objects that contain information about the component types.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.iottwinmaker#NextToken", + "traits": { + "smithy.api#documentation": "The string that specifies the next page of results.
" + } + }, + "maxResults": { + "target": "com.amazonaws.iottwinmaker#MaxResults", + "traits": { + "smithy.api#documentation": "Specifies the maximum number of results to display.
" + } + } + } + }, + "com.amazonaws.iottwinmaker#ListEntities": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#ListEntitiesRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#ListEntitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all entities in a workspace.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/workspaces/{workspaceId}/entities-list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iottwinmaker#ListEntitiesFilter": { + "type": "union", + "members": { + "parentEntityId": { + "target": "com.amazonaws.iottwinmaker#ParentEntityId", + "traits": { + "smithy.api#documentation": "The parent of the entities in the list.
" + } + }, + "componentTypeId": { + "target": "com.amazonaws.iottwinmaker#ComponentTypeId", + "traits": { + "smithy.api#documentation": "The ID of the component type in the entities in the list.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that filters items in a list of entities.
" + } + }, + "com.amazonaws.iottwinmaker#ListEntitiesFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.iottwinmaker#ListEntitiesFilter" + } + }, + "com.amazonaws.iottwinmaker#ListEntitiesRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "filters": { + "target": "com.amazonaws.iottwinmaker#ListEntitiesFilters", + "traits": { + "smithy.api#documentation": "A list of objects that filter the request.
" + } + }, + "maxResults": { + "target": "com.amazonaws.iottwinmaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to display.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iottwinmaker#NextToken", + "traits": { + "smithy.api#documentation": "The string that specifies the next page of results.
" + } + } + } + }, + "com.amazonaws.iottwinmaker#ListEntitiesResponse": { + "type": "structure", + "members": { + "entitySummaries": { + "target": "com.amazonaws.iottwinmaker#EntitySummaries", + "traits": { + "smithy.api#documentation": "A list of objects that contain information about the entities.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iottwinmaker#NextToken", + "traits": { + "smithy.api#documentation": "The string that specifies the next page of results.
" + } + } + } + }, + "com.amazonaws.iottwinmaker#ListScenes": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#ListScenesRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#ListScenesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#AccessDeniedException" + }, + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all scenes in a workspace.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/workspaces/{workspaceId}/scenes-list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iottwinmaker#ListScenesRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace that contains the scenes.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.iottwinmaker#MaxResults", + "traits": { + "smithy.api#documentation": "Specifies the maximum number of results to display.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iottwinmaker#NextToken", + "traits": { + "smithy.api#documentation": "The string that specifies the next page of results.
" + } + } + } + }, + "com.amazonaws.iottwinmaker#ListScenesResponse": { + "type": "structure", + "members": { + "sceneSummaries": { + "target": "com.amazonaws.iottwinmaker#SceneSummaries", + "traits": { + "smithy.api#documentation": "A list of objects that contain information about the scenes.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iottwinmaker#NextToken", + "traits": { + "smithy.api#documentation": "The string that specifies the next page of results.
" + } + } + } + }, + "com.amazonaws.iottwinmaker#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#AccessDeniedException" + }, + { + "target": "com.amazonaws.iottwinmaker#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all tags associated with a resource.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/tags-list", + "code": 200 + } + } + }, + "com.amazonaws.iottwinmaker#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceARN": { + "target": "com.amazonaws.iottwinmaker#TwinMakerArn", + "traits": { + "smithy.api#documentation": "The ARN of the resource.
", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.iottwinmaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to display.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iottwinmaker#NextToken", + "traits": { + "smithy.api#documentation": "The string that specifies the next page of results.
" + } + } + } + }, + "com.amazonaws.iottwinmaker#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.iottwinmaker#TagMap", + "traits": { + "smithy.api#documentation": "Metadata that you can use to manage a resource.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iottwinmaker#NextToken", + "traits": { + "smithy.api#documentation": "The string that specifies the next page of results.
" + } + } + } + }, + "com.amazonaws.iottwinmaker#ListWorkspaces": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#ListWorkspacesRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#ListWorkspacesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about workspaces in the current account.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/workspaces-list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iottwinmaker#ListWorkspacesRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.iottwinmaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to display.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iottwinmaker#NextToken", + "traits": { + "smithy.api#documentation": "The string that specifies the next page of results.
" + } + } + } + }, + "com.amazonaws.iottwinmaker#ListWorkspacesResponse": { + "type": "structure", + "members": { + "workspaceSummaries": { + "target": "com.amazonaws.iottwinmaker#WorkspaceSummaries", + "traits": { + "smithy.api#documentation": "A list of objects that contain information about the workspaces.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iottwinmaker#NextToken", + "traits": { + "smithy.api#documentation": "The string that specifies the next page of results.
" + } + } + } + }, + "com.amazonaws.iottwinmaker#Long": { + "type": "long", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.iottwinmaker#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.iottwinmaker#Name": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z_\\-0-9]+$" + } + }, + "com.amazonaws.iottwinmaker#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 17880 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.iottwinmaker#OrderByTime": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ASCENDING", + "name": "ASCENDING" + }, + { + "value": "DESCENDING", + "name": "DESCENDING" + } + ] + } + }, + "com.amazonaws.iottwinmaker#ParentEntityId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^\\$ROOT|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.iottwinmaker#ParentEntityUpdateRequest": { + "type": "structure", + "members": { + "updateType": { + "target": "com.amazonaws.iottwinmaker#ParentEntityUpdateType", + "traits": { + "smithy.api#documentation": "The type of the update.
", + "smithy.api#required": {} + } + }, + "parentEntityId": { + "target": "com.amazonaws.iottwinmaker#ParentEntityId", + "traits": { + "smithy.api#documentation": "The ID of the parent entity.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The parent entity update request.
" + } + }, + "com.amazonaws.iottwinmaker#ParentEntityUpdateType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UPDATE", + "name": "UPDATE" + }, + { + "value": "DELETE", + "name": "DELETE" + } + ] + } + }, + "com.amazonaws.iottwinmaker#PropertyDefinitionRequest": { + "type": "structure", + "members": { + "dataType": { + "target": "com.amazonaws.iottwinmaker#DataType", + "traits": { + "smithy.api#documentation": "An object that contains information about the data type.
" + } + }, + "isRequiredInEntity": { + "target": "com.amazonaws.iottwinmaker#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that specifies whether the property is required.
" + } + }, + "isExternalId": { + "target": "com.amazonaws.iottwinmaker#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that specifies whether the property ID comes from an external data store.
" + } + }, + "isStoredExternally": { + "target": "com.amazonaws.iottwinmaker#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that specifies whether the property is stored externally.
" + } + }, + "isTimeSeries": { + "target": "com.amazonaws.iottwinmaker#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that specifies whether the property consists of time series data.
" + } + }, + "defaultValue": { + "target": "com.amazonaws.iottwinmaker#DataValue", + "traits": { + "smithy.api#documentation": "An object that contains the default value.
" + } + }, + "configuration": { + "target": "com.amazonaws.iottwinmaker#Configuration", + "traits": { + "smithy.api#documentation": "A mapping that specifies configuration information about the property. Use this field to\n specify information that you read from and write to an external source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that sets information about a property.
" + } + }, + "com.amazonaws.iottwinmaker#PropertyDefinitionResponse": { + "type": "structure", + "members": { + "dataType": { + "target": "com.amazonaws.iottwinmaker#DataType", + "traits": { + "smithy.api#documentation": "An object that contains information about the data type.
", + "smithy.api#required": {} + } + }, + "isTimeSeries": { + "target": "com.amazonaws.iottwinmaker#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that specifies whether the property consists of time series data.
", + "smithy.api#required": {} + } + }, + "isRequiredInEntity": { + "target": "com.amazonaws.iottwinmaker#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that specifies whether the property is required in an entity.
", + "smithy.api#required": {} + } + }, + "isExternalId": { + "target": "com.amazonaws.iottwinmaker#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that specifies whether the property ID comes from an external data store.
", + "smithy.api#required": {} + } + }, + "isStoredExternally": { + "target": "com.amazonaws.iottwinmaker#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that specifies whether the property is stored externally.
", + "smithy.api#required": {} + } + }, + "isImported": { + "target": "com.amazonaws.iottwinmaker#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that specifies whether the property definition is imported from an external data store.
", + "smithy.api#required": {} + } + }, + "isFinal": { + "target": "com.amazonaws.iottwinmaker#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that specifies whether the property definition can be updated.
", + "smithy.api#required": {} + } + }, + "isInherited": { + "target": "com.amazonaws.iottwinmaker#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that specifies whether the property definition is inherited from a parent entity.
", + "smithy.api#required": {} + } + }, + "defaultValue": { + "target": "com.amazonaws.iottwinmaker#DataValue", + "traits": { + "smithy.api#documentation": "An object that contains the default value.
" + } + }, + "configuration": { + "target": "com.amazonaws.iottwinmaker#Configuration", + "traits": { + "smithy.api#documentation": "A mapping that specifies configuration information about the property.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains response data from a property definition request.
" + } + }, + "com.amazonaws.iottwinmaker#PropertyDefinitionsRequest": { + "type": "map", + "key": { + "target": "com.amazonaws.iottwinmaker#Name" + }, + "value": { + "target": "com.amazonaws.iottwinmaker#PropertyDefinitionRequest" + } + }, + "com.amazonaws.iottwinmaker#PropertyDefinitionsResponse": { + "type": "map", + "key": { + "target": "com.amazonaws.iottwinmaker#Name" + }, + "value": { + "target": "com.amazonaws.iottwinmaker#PropertyDefinitionResponse" + } + }, + "com.amazonaws.iottwinmaker#PropertyFilter": { + "type": "structure", + "members": { + "propertyName": { + "target": "com.amazonaws.iottwinmaker#String", + "traits": { + "smithy.api#documentation": "The property name associated with this property filter.
" + } + }, + "operator": { + "target": "com.amazonaws.iottwinmaker#String", + "traits": { + "smithy.api#documentation": "The operator associated with this property filter.
" + } + }, + "value": { + "target": "com.amazonaws.iottwinmaker#DataValue", + "traits": { + "smithy.api#documentation": "The value associated with this property filter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that filters items returned by a property request.
" + } + }, + "com.amazonaws.iottwinmaker#PropertyFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.iottwinmaker#PropertyFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.iottwinmaker#PropertyLatestValue": { + "type": "structure", + "members": { + "propertyReference": { + "target": "com.amazonaws.iottwinmaker#EntityPropertyReference", + "traits": { + "smithy.api#documentation": "An object that specifies information about a property.>
", + "smithy.api#required": {} + } + }, + "propertyValue": { + "target": "com.amazonaws.iottwinmaker#DataValue", + "traits": { + "smithy.api#documentation": "The value of the property.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The latest value of the property.
" + } + }, + "com.amazonaws.iottwinmaker#PropertyLatestValueMap": { + "type": "map", + "key": { + "target": "com.amazonaws.iottwinmaker#Name" + }, + "value": { + "target": "com.amazonaws.iottwinmaker#PropertyLatestValue" + } + }, + "com.amazonaws.iottwinmaker#PropertyRequest": { + "type": "structure", + "members": { + "definition": { + "target": "com.amazonaws.iottwinmaker#PropertyDefinitionRequest", + "traits": { + "smithy.api#documentation": "An object that specifies information about a property.
" + } + }, + "value": { + "target": "com.amazonaws.iottwinmaker#DataValue", + "traits": { + "smithy.api#documentation": "The value of the property.
" + } + }, + "updateType": { + "target": "com.amazonaws.iottwinmaker#PropertyUpdateType", + "traits": { + "smithy.api#documentation": "The update type of the update property request.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that sets information about a property.
" + } + }, + "com.amazonaws.iottwinmaker#PropertyRequests": { + "type": "map", + "key": { + "target": "com.amazonaws.iottwinmaker#Name" + }, + "value": { + "target": "com.amazonaws.iottwinmaker#PropertyRequest" + } + }, + "com.amazonaws.iottwinmaker#PropertyResponse": { + "type": "structure", + "members": { + "definition": { + "target": "com.amazonaws.iottwinmaker#PropertyDefinitionResponse", + "traits": { + "smithy.api#documentation": "An object that specifies information about a property.
" + } + }, + "value": { + "target": "com.amazonaws.iottwinmaker#DataValue", + "traits": { + "smithy.api#documentation": "The value of the property.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information about a property response.
" + } + }, + "com.amazonaws.iottwinmaker#PropertyResponses": { + "type": "map", + "key": { + "target": "com.amazonaws.iottwinmaker#Name" + }, + "value": { + "target": "com.amazonaws.iottwinmaker#PropertyResponse" + } + }, + "com.amazonaws.iottwinmaker#PropertyUpdateType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UPDATE", + "name": "UPDATE" + }, + { + "value": "DELETE", + "name": "DELETE" + } + ] + } + }, + "com.amazonaws.iottwinmaker#PropertyValue": { + "type": "structure", + "members": { + "timestamp": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of a value for a time series property.
", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.iottwinmaker#DataValue", + "traits": { + "smithy.api#documentation": "An object that specifies a value for a time series property.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information about a value for a time series property.
" + } + }, + "com.amazonaws.iottwinmaker#PropertyValueEntry": { + "type": "structure", + "members": { + "entityPropertyReference": { + "target": "com.amazonaws.iottwinmaker#EntityPropertyReference", + "traits": { + "smithy.api#documentation": "An object that contains information about the entity that has the property.
", + "smithy.api#required": {} + } + }, + "propertyValues": { + "target": "com.amazonaws.iottwinmaker#PropertyValues", + "traits": { + "smithy.api#documentation": "A list of objects that specify time series property values.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that specifies information about time series property values.
" + } + }, + "com.amazonaws.iottwinmaker#PropertyValueHistory": { + "type": "structure", + "members": { + "entityPropertyReference": { + "target": "com.amazonaws.iottwinmaker#EntityPropertyReference", + "traits": { + "smithy.api#documentation": "An object that uniquely identifies an entity property.
", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.iottwinmaker#Values", + "traits": { + "smithy.api#documentation": "A list of objects that contain information about the values in the history of a time series property.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The history of values for a time series property.
" + } + }, + "com.amazonaws.iottwinmaker#PropertyValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.iottwinmaker#PropertyValueHistory" + } + }, + "com.amazonaws.iottwinmaker#PropertyValues": { + "type": "list", + "member": { + "target": "com.amazonaws.iottwinmaker#PropertyValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.iottwinmaker#Relationship": { + "type": "structure", + "members": { + "targetComponentTypeId": { + "target": "com.amazonaws.iottwinmaker#ComponentTypeId", + "traits": { + "smithy.api#documentation": "The ID of the target component type associated with this relationship.
" + } + }, + "relationshipType": { + "target": "com.amazonaws.iottwinmaker#String", + "traits": { + "smithy.api#documentation": "The type of the relationship.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that specifies a relationship with another component type.
" + } + }, + "com.amazonaws.iottwinmaker#RelationshipValue": { + "type": "structure", + "members": { + "targetEntityId": { + "target": "com.amazonaws.iottwinmaker#EntityId", + "traits": { + "smithy.api#documentation": "The ID of the target entity associated with this relationship value.
" + } + }, + "targetComponentName": { + "target": "com.amazonaws.iottwinmaker#Name", + "traits": { + "smithy.api#documentation": "The name of the target component associated with the relationship value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A value that associates a component and an entity.
" + } + }, + "com.amazonaws.iottwinmaker#RequiredProperties": { + "type": "set", + "member": { + "target": "com.amazonaws.iottwinmaker#Name" + } + }, + "com.amazonaws.iottwinmaker#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iottwinmaker#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The resource wasn't found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.iottwinmaker#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:((aws)|(aws-cn)|(aws-us-gov)):iam::[0-9]{12}:role/" + } + }, + "com.amazonaws.iottwinmaker#S3Location": { + "type": "string" + }, + "com.amazonaws.iottwinmaker#S3Url": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[sS]3://[A-Za-z0-9._/-]+$" + } + }, + "com.amazonaws.iottwinmaker#SceneCapabilities": { + "type": "list", + "member": { + "target": "com.amazonaws.iottwinmaker#SceneCapability" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.iottwinmaker#SceneCapability": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.iottwinmaker#SceneSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.iottwinmaker#SceneSummary" + } + }, + "com.amazonaws.iottwinmaker#SceneSummary": { + "type": "structure", + "members": { + "sceneId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the scene.
", + "smithy.api#required": {} + } + }, + "contentLocation": { + "target": "com.amazonaws.iottwinmaker#S3Url", + "traits": { + "smithy.api#documentation": "The relative path that specifies the location of the content definition file.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iottwinmaker#TwinMakerArn", + "traits": { + "smithy.api#documentation": "The ARN of the scene.
", + "smithy.api#required": {} + } + }, + "creationDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the scene was created.
", + "smithy.api#required": {} + } + }, + "updateDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the scene was last updated.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iottwinmaker#Description", + "traits": { + "smithy.api#documentation": "The scene description.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information about a scene.
" + } + }, + "com.amazonaws.iottwinmaker#Scope": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENTITY", + "name": "ENTITY" + }, + { + "value": "WORKSPACE", + "name": "WORKSPACE" + } + ] + } + }, + "com.amazonaws.iottwinmaker#SelectedPropertyList": { + "type": "list", + "member": { + "target": "com.amazonaws.iottwinmaker#String" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.iottwinmaker#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iottwinmaker#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The service quota was exceeded.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.iottwinmaker#State": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "UPDATING", + "name": "UPDATING" + }, + { + "value": "DELETING", + "name": "DELETING" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "ERROR", + "name": "ERROR" + } + ] + } + }, + "com.amazonaws.iottwinmaker#Status": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.iottwinmaker#State", + "traits": { + "smithy.api#documentation": "The current state of the entity, component, component type, or workspace.
" + } + }, + "error": { + "target": "com.amazonaws.iottwinmaker#ErrorDetails", + "traits": { + "smithy.api#documentation": "The error message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that represents the status of an entity, component, component type, or workspace.
" + } + }, + "com.amazonaws.iottwinmaker#String": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.iottwinmaker#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.iottwinmaker#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.iottwinmaker#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.iottwinmaker#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.iottwinmaker#TagKey" + }, + "value": { + "target": "com.amazonaws.iottwinmaker#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.iottwinmaker#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#AccessDeniedException" + }, + { + "target": "com.amazonaws.iottwinmaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iottwinmaker#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "Adds tags to a resource.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/tags", + "code": 200 + } + } + }, + "com.amazonaws.iottwinmaker#TagResourceRequest": { + "type": "structure", + "members": { + "resourceARN": { + "target": "com.amazonaws.iottwinmaker#TwinMakerArn", + "traits": { + "smithy.api#documentation": "The ARN of the resource.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.iottwinmaker#TagMap", + "traits": { + "smithy.api#documentation": "Metadata to add to this resource.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iottwinmaker#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.iottwinmaker#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iottwinmaker#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The rate exceeds the limit.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.iottwinmaker#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.iottwinmaker#TooManyTagsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iottwinmaker#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "The number of tags exceeds the limit.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iottwinmaker#TwinMakerArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\\/a-zA-Z0-9_\\-\\.:]+$" + } + }, + "com.amazonaws.iottwinmaker#Type": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RELATIONSHIP", + "name": "RELATIONSHIP" + }, + { + "value": "STRING", + "name": "STRING" + }, + { + "value": "LONG", + "name": "LONG" + }, + { + "value": "BOOLEAN", + "name": "BOOLEAN" + }, + { + "value": "INTEGER", + "name": "INTEGER" + }, + { + "value": "DOUBLE", + "name": "DOUBLE" + }, + { + "value": "LIST", + "name": "LIST" + }, + { + "value": "MAP", + "name": "MAP" + } + ] + } + }, + "com.amazonaws.iottwinmaker#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#AccessDeniedException" + }, + { + "target": "com.amazonaws.iottwinmaker#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Removes tags from a resource.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags", + "code": 200 + } + } + }, + "com.amazonaws.iottwinmaker#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceARN": { + "target": "com.amazonaws.iottwinmaker#TwinMakerArn", + "traits": { + "smithy.api#documentation": "The ARN of the resource.
", + "smithy.api#httpQuery": "resourceARN", + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.iottwinmaker#TagKeyList", + "traits": { + "smithy.api#documentation": "A list of tag key names to remove from the resource. You don't specify the value. Both the key and its associated value are removed.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iottwinmaker#UpdateComponentType": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#UpdateComponentTypeRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#UpdateComponentTypeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#AccessDeniedException" + }, + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iottwinmaker#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates information in a component type.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "PUT", + "uri": "/workspaces/{workspaceId}/component-types/{componentTypeId}", + "code": 200 + } + } + }, + "com.amazonaws.iottwinmaker#UpdateComponentTypeRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace that contains the component type.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "isSingleton": { + "target": "com.amazonaws.iottwinmaker#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that specifies whether an entity can have more than one component of this\n type.
" + } + }, + "componentTypeId": { + "target": "com.amazonaws.iottwinmaker#ComponentTypeId", + "traits": { + "smithy.api#documentation": "The ID of the component type.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iottwinmaker#Description", + "traits": { + "smithy.api#documentation": "The description of the component type.
" + } + }, + "propertyDefinitions": { + "target": "com.amazonaws.iottwinmaker#PropertyDefinitionsRequest", + "traits": { + "smithy.api#documentation": "An object that maps strings to the property definitions in the component type. Each string \n in the mapping must be unique to this object.
" + } + }, + "extendsFrom": { + "target": "com.amazonaws.iottwinmaker#ExtendsFrom", + "traits": { + "smithy.api#documentation": "Specifies the component type that this component type extends.
" + } + }, + "functions": { + "target": "com.amazonaws.iottwinmaker#FunctionsRequest", + "traits": { + "smithy.api#documentation": "An object that maps strings to the functions in the component type. Each string \n in the mapping must be unique to this object.
" + } + } + } + }, + "com.amazonaws.iottwinmaker#UpdateComponentTypeResponse": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace that contains the component type.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iottwinmaker#TwinMakerArn", + "traits": { + "smithy.api#documentation": "The ARN of the component type.
", + "smithy.api#required": {} + } + }, + "componentTypeId": { + "target": "com.amazonaws.iottwinmaker#ComponentTypeId", + "traits": { + "smithy.api#documentation": "The ID of the component type.
", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.iottwinmaker#State", + "traits": { + "smithy.api#documentation": "The current state of the component type.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#UpdateEntity": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#UpdateEntityRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#UpdateEntityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#AccessDeniedException" + }, + { + "target": "com.amazonaws.iottwinmaker#ConflictException" + }, + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iottwinmaker#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an entity.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "PUT", + "uri": "/workspaces/{workspaceId}/entities/{entityId}", + "code": 200 + } + } + }, + "com.amazonaws.iottwinmaker#UpdateEntityRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace that contains the entity.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityId": { + "target": "com.amazonaws.iottwinmaker#EntityId", + "traits": { + "smithy.api#documentation": "The ID of the entity.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityName": { + "target": "com.amazonaws.iottwinmaker#EntityName", + "traits": { + "smithy.api#documentation": "The name of the entity.
" + } + }, + "description": { + "target": "com.amazonaws.iottwinmaker#Description", + "traits": { + "smithy.api#documentation": "The description of the entity.
" + } + }, + "componentUpdates": { + "target": "com.amazonaws.iottwinmaker#ComponentUpdatesMapRequest", + "traits": { + "smithy.api#documentation": "An object that maps strings to the component updates in the request. Each string \n in the mapping must be unique to this object.
" + } + }, + "parentEntityUpdate": { + "target": "com.amazonaws.iottwinmaker#ParentEntityUpdateRequest", + "traits": { + "smithy.api#documentation": "An object that describes the update request for a parent entity.
" + } + } + } + }, + "com.amazonaws.iottwinmaker#UpdateEntityResponse": { + "type": "structure", + "members": { + "updateDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the entity was last updated.
", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.iottwinmaker#State", + "traits": { + "smithy.api#documentation": "The current state of the entity update.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#UpdateScene": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#UpdateSceneRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#UpdateSceneResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#AccessDeniedException" + }, + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a scene.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "PUT", + "uri": "/workspaces/{workspaceId}/scenes/{sceneId}", + "code": 200 + } + } + }, + "com.amazonaws.iottwinmaker#UpdateSceneRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace that contains the scene.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sceneId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the scene.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "contentLocation": { + "target": "com.amazonaws.iottwinmaker#S3Url", + "traits": { + "smithy.api#documentation": "The relative path that specifies the location of the content definition file.
" + } + }, + "description": { + "target": "com.amazonaws.iottwinmaker#Description", + "traits": { + "smithy.api#documentation": "The description of this scene.
" + } + }, + "capabilities": { + "target": "com.amazonaws.iottwinmaker#SceneCapabilities", + "traits": { + "smithy.api#documentation": "A list of capabilities that the scene uses to render.
" + } + } + } + }, + "com.amazonaws.iottwinmaker#UpdateSceneResponse": { + "type": "structure", + "members": { + "updateDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the scene was last updated.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#UpdateWorkspace": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#UpdateWorkspaceRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#UpdateWorkspaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#AccessDeniedException" + }, + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iottwinmaker#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a workspace.
", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "PUT", + "uri": "/workspaces/{workspaceId}", + "code": 200 + } + } + }, + "com.amazonaws.iottwinmaker#UpdateWorkspaceRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iottwinmaker#Description", + "traits": { + "smithy.api#documentation": "The description of the workspace.
" + } + }, + "role": { + "target": "com.amazonaws.iottwinmaker#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the execution role associated with the workspace.
" + } + } + } + }, + "com.amazonaws.iottwinmaker#UpdateWorkspaceResponse": { + "type": "structure", + "members": { + "updateDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time of the current update.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iottwinmaker#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "Failed
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iottwinmaker#Value": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z_\\-0-9]+$" + } + }, + "com.amazonaws.iottwinmaker#Values": { + "type": "list", + "member": { + "target": "com.amazonaws.iottwinmaker#PropertyValue" + } + }, + "com.amazonaws.iottwinmaker#WorkspaceSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.iottwinmaker#WorkspaceSummary" + } + }, + "com.amazonaws.iottwinmaker#WorkspaceSummary": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "The ID of the workspace.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iottwinmaker#TwinMakerArn", + "traits": { + "smithy.api#documentation": "The ARN of the workspace.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iottwinmaker#Description", + "traits": { + "smithy.api#documentation": "The description of the workspace.
" + } + }, + "creationDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the workspace was created.
", + "smithy.api#required": {} + } + }, + "updateDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the workspace was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information about a workspace.
" + } + } + } +} diff --git a/aws/sdk/aws-models/iotwireless.json b/aws/sdk/aws-models/iotwireless.json index e420074280b49fb7bc8fe670ef85fbc07cde68d5..ec91da5ae10bf200570086178740e3a7226c3fc7 100644 --- a/aws/sdk/aws-models/iotwireless.json +++ b/aws/sdk/aws-models/iotwireless.json @@ -3462,6 +3462,72 @@ } } }, + "com.amazonaws.iotwireless#GetNetworkAnalyzerConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#GetNetworkAnalyzerConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#GetNetworkAnalyzerConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get NetworkAnalyzer configuration.
", + "smithy.api#http": { + "method": "GET", + "uri": "/network-analyzer-configurations/{ConfigurationName}", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#GetNetworkAnalyzerConfigurationRequest": { + "type": "structure", + "members": { + "ConfigurationName": { + "target": "com.amazonaws.iotwireless#NetworkAnalyzerConfigurationName", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#GetNetworkAnalyzerConfigurationResponse": { + "type": "structure", + "members": { + "TraceContent": { + "target": "com.amazonaws.iotwireless#TraceContent" + }, + "WirelessDevices": { + "target": "com.amazonaws.iotwireless#WirelessDeviceList", + "traits": { + "smithy.api#documentation": "List of WirelessDevices in the NetworkAnalyzerConfiguration.
" + } + }, + "WirelessGateways": { + "target": "com.amazonaws.iotwireless#WirelessGatewayList", + "traits": { + "smithy.api#documentation": "List of WirelessGateways in the NetworkAnalyzerConfiguration.
" + } + } + } + }, "com.amazonaws.iotwireless#GetPartnerAccount": { "type": "operation", "input": { @@ -6279,6 +6345,17 @@ } } }, + "com.amazonaws.iotwireless#NetworkAnalyzerConfigurationName": { + "type": "string", + "traits": { + "smithy.api#documentation": "NetworkAnalyzer configuration name.
", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^NetworkAnalyzerConfig_Default$" + } + }, "com.amazonaws.iotwireless#NextToken": { "type": "string", "traits": { @@ -7815,6 +7892,20 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.iotwireless#TraceContent": { + "type": "structure", + "members": { + "WirelessDeviceFrameInfo": { + "target": "com.amazonaws.iotwireless#WirelessDeviceFrameInfo" + }, + "LogLevel": { + "target": "com.amazonaws.iotwireless#LogLevel" + } + }, + "traits": { + "smithy.api#documentation": "Trace Content for resources.
" + } + }, "com.amazonaws.iotwireless#TransmitMode": { "type": "integer", "traits": { @@ -8182,6 +8273,83 @@ "type": "structure", "members": {} }, + "com.amazonaws.iotwireless#UpdateNetworkAnalyzerConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#UpdateNetworkAnalyzerConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#UpdateNetworkAnalyzerConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Update NetworkAnalyzer configuration.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/network-analyzer-configurations/{ConfigurationName}", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#UpdateNetworkAnalyzerConfigurationRequest": { + "type": "structure", + "members": { + "ConfigurationName": { + "target": "com.amazonaws.iotwireless#NetworkAnalyzerConfigurationName", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TraceContent": { + "target": "com.amazonaws.iotwireless#TraceContent" + }, + "WirelessDevicesToAdd": { + "target": "com.amazonaws.iotwireless#WirelessDeviceList", + "traits": { + "smithy.api#documentation": "WirelessDevices to add into NetworkAnalyzerConfiguration.
" + } + }, + "WirelessDevicesToRemove": { + "target": "com.amazonaws.iotwireless#WirelessDeviceList", + "traits": { + "smithy.api#documentation": "WirelessDevices to remove from NetworkAnalyzerConfiguration.
" + } + }, + "WirelessGatewaysToAdd": { + "target": "com.amazonaws.iotwireless#WirelessGatewayList", + "traits": { + "smithy.api#documentation": "WirelessGateways to add into NetworkAnalyzerConfiguration.
" + } + }, + "WirelessGatewaysToRemove": { + "target": "com.amazonaws.iotwireless#WirelessGatewayList", + "traits": { + "smithy.api#documentation": "WirelessGateways to remove from NetworkAnalyzerConfiguration.
" + } + } + } + }, + "com.amazonaws.iotwireless#UpdateNetworkAnalyzerConfigurationResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.iotwireless#UpdatePartnerAccount": { "type": "operation", "input": { @@ -8604,6 +8772,22 @@ "smithy.api#documentation": "The list of wireless device event log options.
" } }, + "com.amazonaws.iotwireless#WirelessDeviceFrameInfo": { + "type": "string", + "traits": { + "smithy.api#documentation": "WirelessDevice FrameInfo for trace content.
", + "smithy.api#enum": [ + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "DISABLED", + "name": "DISABLED" + } + ] + } + }, "com.amazonaws.iotwireless#WirelessDeviceId": { "type": "string", "traits": { @@ -8637,6 +8821,18 @@ ] } }, + "com.amazonaws.iotwireless#WirelessDeviceList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotwireless#WirelessDeviceId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 250 + } + } + }, "com.amazonaws.iotwireless#WirelessDeviceLogOption": { "type": "structure", "members": { @@ -8844,6 +9040,12 @@ ] } }, + "com.amazonaws.iotwireless#WirelessGatewayList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotwireless#WirelessGatewayId" + } + }, "com.amazonaws.iotwireless#WirelessGatewayLogOption": { "type": "structure", "members": { @@ -9054,6 +9256,21 @@ }, "com.amazonaws.iotwireless#iotwireless": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "IoT Wireless", + "arnNamespace": "iotwireless", + "cloudFormationName": "IoTWireless", + "cloudTrailEventSource": "iotwireless.amazonaws.com", + "endpointPrefix": "api.iotwireless" + }, + "aws.auth#sigv4": { + "name": "iotwireless" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "AWS IoT Wireless API documentation
", + "smithy.api#title": "AWS IoT Wireless" + }, "version": "2020-11-22", "operations": [ { @@ -9173,6 +9390,9 @@ { "target": "com.amazonaws.iotwireless#GetMulticastGroupSession" }, + { + "target": "com.amazonaws.iotwireless#GetNetworkAnalyzerConfiguration" + }, { "target": "com.amazonaws.iotwireless#GetPartnerAccount" }, @@ -9293,6 +9513,9 @@ { "target": "com.amazonaws.iotwireless#UpdateMulticastGroup" }, + { + "target": "com.amazonaws.iotwireless#UpdateNetworkAnalyzerConfiguration" + }, { "target": "com.amazonaws.iotwireless#UpdatePartnerAccount" }, @@ -9305,22 +9528,7 @@ { "target": "com.amazonaws.iotwireless#UpdateWirelessGateway" } - ], - "traits": { - "aws.api#service": { - "sdkId": "IoT Wireless", - "arnNamespace": "iotwireless", - "cloudFormationName": "IoTWireless", - "cloudTrailEventSource": "iotwireless.amazonaws.com", - "endpointPrefix": "api.iotwireless" - }, - "aws.auth#sigv4": { - "name": "iotwireless" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "AWS IoT Wireless API documentation
", - "smithy.api#title": "AWS IoT Wireless" - } + ] } } } diff --git a/aws/sdk/aws-models/kafka.json b/aws/sdk/aws-models/kafka.json index 8a8a9cf84468c86321f758a8fe76737bbab05b3b..106cc3a4951abd14fda88cba2349c7edd630f011 100644 --- a/aws/sdk/aws-models/kafka.json +++ b/aws/sdk/aws-models/kafka.json @@ -476,6 +476,91 @@ } } }, + "com.amazonaws.kafka#Cluster": { + "type": "structure", + "members": { + "ActiveOperationArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies a cluster operation.
", + "smithy.api#jsonName": "activeOperationArn" + } + }, + "ClusterType": { + "target": "com.amazonaws.kafka#ClusterType", + "traits": { + "smithy.api#documentation": "Cluster Type.
", + "smithy.api#jsonName": "clusterType" + } + }, + "ClusterArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the cluster.
", + "smithy.api#jsonName": "clusterArn" + } + }, + "ClusterName": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "The name of the cluster.
", + "smithy.api#jsonName": "clusterName" + } + }, + "CreationTime": { + "target": "com.amazonaws.kafka#__timestampIso8601", + "traits": { + "smithy.api#documentation": "The time when the cluster was created.
", + "smithy.api#jsonName": "creationTime" + } + }, + "CurrentVersion": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "The current version of the MSK cluster.
", + "smithy.api#jsonName": "currentVersion" + } + }, + "State": { + "target": "com.amazonaws.kafka#ClusterState", + "traits": { + "smithy.api#documentation": "The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
", + "smithy.api#jsonName": "state" + } + }, + "StateInfo": { + "target": "com.amazonaws.kafka#StateInfo", + "traits": { + "smithy.api#documentation": "State Info for the Amazon MSK cluster.
", + "smithy.api#jsonName": "stateInfo" + } + }, + "Tags": { + "target": "com.amazonaws.kafka#__mapOf__string", + "traits": { + "smithy.api#documentation": "Tags attached to the cluster.
", + "smithy.api#jsonName": "tags" + } + }, + "Provisioned": { + "target": "com.amazonaws.kafka#Provisioned", + "traits": { + "smithy.api#documentation": "Information about the provisioned cluster.
", + "smithy.api#jsonName": "provisioned" + } + }, + "Serverless": { + "target": "com.amazonaws.kafka#Serverless", + "traits": { + "smithy.api#documentation": "Information about the serverless cluster.
", + "smithy.api#jsonName": "serverless" + } + } + }, + "traits": { + "smithy.api#documentation": "Returns information about a cluster.
" + } + }, "com.amazonaws.kafka#ClusterInfo": { "type": "structure", "members": { @@ -770,6 +855,22 @@ ] } }, + "com.amazonaws.kafka#ClusterType": { + "type": "string", + "traits": { + "smithy.api#documentation": "The type of cluster.
", + "smithy.api#enum": [ + { + "value": "PROVISIONED", + "name": "PROVISIONED" + }, + { + "value": "SERVERLESS", + "name": "SERVERLESS" + } + ] + } + }, "com.amazonaws.kafka#CompatibleKafkaVersion": { "type": "structure", "members": { @@ -1121,6 +1222,113 @@ } } }, + "com.amazonaws.kafka#CreateClusterV2": { + "type": "operation", + "input": { + "target": "com.amazonaws.kafka#CreateClusterV2Request" + }, + "output": { + "target": "com.amazonaws.kafka#CreateClusterV2Response" + }, + "errors": [ + { + "target": "com.amazonaws.kafka#BadRequestException" + }, + { + "target": "com.amazonaws.kafka#ConflictException" + }, + { + "target": "com.amazonaws.kafka#ForbiddenException" + }, + { + "target": "com.amazonaws.kafka#InternalServerErrorException" + }, + { + "target": "com.amazonaws.kafka#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.kafka#TooManyRequestsException" + }, + { + "target": "com.amazonaws.kafka#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new MSK cluster.
", + "smithy.api#http": { + "method": "POST", + "uri": "/api/v2/clusters", + "code": 200 + } + } + }, + "com.amazonaws.kafka#CreateClusterV2Request": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.kafka#__stringMin1Max64", + "traits": { + "smithy.api#documentation": "The name of the cluster.
", + "smithy.api#jsonName": "clusterName", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.kafka#__mapOf__string", + "traits": { + "smithy.api#documentation": "A map of tags that you want the cluster to have.
", + "smithy.api#jsonName": "tags" + } + }, + "Provisioned": { + "target": "com.amazonaws.kafka#ProvisionedRequest", + "traits": { + "smithy.api#documentation": "Information about the provisioned cluster.
", + "smithy.api#jsonName": "provisioned" + } + }, + "Serverless": { + "target": "com.amazonaws.kafka#ServerlessRequest", + "traits": { + "smithy.api#documentation": "Information about the serverless cluster.
", + "smithy.api#jsonName": "serverless" + } + } + } + }, + "com.amazonaws.kafka#CreateClusterV2Response": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cluster.
", + "smithy.api#jsonName": "clusterArn" + } + }, + "ClusterName": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "The name of the MSK cluster.
", + "smithy.api#jsonName": "clusterName" + } + }, + "State": { + "target": "com.amazonaws.kafka#ClusterState", + "traits": { + "smithy.api#documentation": "The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
", + "smithy.api#jsonName": "state" + } + }, + "ClusterType": { + "target": "com.amazonaws.kafka#ClusterType", + "traits": { + "smithy.api#documentation": "The type of the cluster. The possible states are PROVISIONED or SERVERLESS.
", + "smithy.api#jsonName": "clusterType" + } + } + } + }, "com.amazonaws.kafka#CreateConfiguration": { "type": "operation", "input": { @@ -1487,6 +1695,65 @@ } } }, + "com.amazonaws.kafka#DescribeClusterV2": { + "type": "operation", + "input": { + "target": "com.amazonaws.kafka#DescribeClusterV2Request" + }, + "output": { + "target": "com.amazonaws.kafka#DescribeClusterV2Response" + }, + "errors": [ + { + "target": "com.amazonaws.kafka#BadRequestException" + }, + { + "target": "com.amazonaws.kafka#ForbiddenException" + }, + { + "target": "com.amazonaws.kafka#InternalServerErrorException" + }, + { + "target": "com.amazonaws.kafka#NotFoundException" + }, + { + "target": "com.amazonaws.kafka#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
", + "smithy.api#http": { + "method": "GET", + "uri": "/api/v2/clusters/{ClusterArn}", + "code": 200 + } + } + }, + "com.amazonaws.kafka#DescribeClusterV2Request": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.kafka#DescribeClusterV2Response": { + "type": "structure", + "members": { + "ClusterInfo": { + "target": "com.amazonaws.kafka#Cluster", + "traits": { + "smithy.api#documentation": "The cluster information.
", + "smithy.api#jsonName": "clusterInfo" + } + } + } + }, "com.amazonaws.kafka#DescribeConfiguration": { "type": "operation", "input": { @@ -2116,6 +2383,9 @@ { "target": "com.amazonaws.kafka#CreateCluster" }, + { + "target": "com.amazonaws.kafka#CreateClusterV2" + }, { "target": "com.amazonaws.kafka#CreateConfiguration" }, @@ -2131,6 +2401,9 @@ { "target": "com.amazonaws.kafka#DescribeClusterOperation" }, + { + "target": "com.amazonaws.kafka#DescribeClusterV2" + }, { "target": "com.amazonaws.kafka#DescribeConfiguration" }, @@ -2149,6 +2422,9 @@ { "target": "com.amazonaws.kafka#ListClusters" }, + { + "target": "com.amazonaws.kafka#ListClustersV2" + }, { "target": "com.amazonaws.kafka#ListConfigurationRevisions" }, @@ -2277,12 +2553,94 @@ "com.amazonaws.kafka#ListClusterOperationsRequest": { "type": "structure", "members": { - "ClusterArn": { + "ClusterArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.kafka#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.
", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.kafka#ListClusterOperationsResponse": { + "type": "structure", + "members": { + "ClusterOperationInfoList": { + "target": "com.amazonaws.kafka#__listOfClusterOperationInfo", + "traits": { + "smithy.api#documentation": "An array of cluster operation information objects.
", + "smithy.api#jsonName": "clusterOperationInfoList" + } + }, + "NextToken": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "If the response of ListClusterOperations is truncated, it returns a NextToken in the response. This Nexttoken should be sent in the subsequent request to ListClusterOperations.
", + "smithy.api#jsonName": "nextToken" + } + } + } + }, + "com.amazonaws.kafka#ListClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.kafka#ListClustersRequest" + }, + "output": { + "target": "com.amazonaws.kafka#ListClustersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kafka#BadRequestException" + }, + { + "target": "com.amazonaws.kafka#ForbiddenException" + }, + { + "target": "com.amazonaws.kafka#InternalServerErrorException" + }, + { + "target": "com.amazonaws.kafka#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of all the MSK clusters in the current Region.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/clusters", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ClusterInfoList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.kafka#ListClustersRequest": { + "type": "structure", + "members": { + "ClusterNameFilter": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.
", + "smithy.api#httpQuery": "clusterNameFilter" } }, "MaxResults": { @@ -2301,32 +2659,32 @@ } } }, - "com.amazonaws.kafka#ListClusterOperationsResponse": { + "com.amazonaws.kafka#ListClustersResponse": { "type": "structure", "members": { - "ClusterOperationInfoList": { - "target": "com.amazonaws.kafka#__listOfClusterOperationInfo", + "ClusterInfoList": { + "target": "com.amazonaws.kafka#__listOfClusterInfo", "traits": { - "smithy.api#documentation": "An array of cluster operation information objects.
", - "smithy.api#jsonName": "clusterOperationInfoList" + "smithy.api#documentation": "Information on each of the MSK clusters in the response.
", + "smithy.api#jsonName": "clusterInfoList" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "If the response of ListClusterOperations is truncated, it returns a NextToken in the response. This Nexttoken should be sent in the subsequent request to ListClusterOperations.
", + "smithy.api#documentation": "The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. \n To get another batch of clusters, provide this token in your next request.
", "smithy.api#jsonName": "nextToken" } } } }, - "com.amazonaws.kafka#ListClusters": { + "com.amazonaws.kafka#ListClustersV2": { "type": "operation", "input": { - "target": "com.amazonaws.kafka#ListClustersRequest" + "target": "com.amazonaws.kafka#ListClustersV2Request" }, "output": { - "target": "com.amazonaws.kafka#ListClustersResponse" + "target": "com.amazonaws.kafka#ListClustersV2Response" }, "errors": [ { @@ -2346,7 +2704,7 @@ "smithy.api#documentation": "Returns a list of all the MSK clusters in the current Region.
", "smithy.api#http": { "method": "GET", - "uri": "/v1/clusters", + "uri": "/api/v2/clusters", "code": 200 }, "smithy.api#paginated": { @@ -2357,16 +2715,23 @@ } } }, - "com.amazonaws.kafka#ListClustersRequest": { + "com.amazonaws.kafka#ListClustersV2Request": { "type": "structure", "members": { "ClusterNameFilter": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.
", + "smithy.api#documentation": "Specify a prefix of the names of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.
", "smithy.api#httpQuery": "clusterNameFilter" } }, + "ClusterTypeFilter": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "Specify either PROVISIONED or SERVERLESS.
", + "smithy.api#httpQuery": "clusterTypeFilter" + } + }, "MaxResults": { "target": "com.amazonaws.kafka#MaxResults", "traits": { @@ -2383,11 +2748,11 @@ } } }, - "com.amazonaws.kafka#ListClustersResponse": { + "com.amazonaws.kafka#ListClustersV2Response": { "type": "structure", "members": { "ClusterInfoList": { - "target": "com.amazonaws.kafka#__listOfClusterInfo", + "target": "com.amazonaws.kafka#__listOfCluster", "traits": { "smithy.api#documentation": "Information on each of the MSK clusters in the response.
", "smithy.api#jsonName": "clusterInfoList" @@ -3170,6 +3535,160 @@ "smithy.api#documentation": "Prometheus settings.
" } }, + "com.amazonaws.kafka#Provisioned": { + "type": "structure", + "members": { + "BrokerNodeGroupInfo": { + "target": "com.amazonaws.kafka#BrokerNodeGroupInfo", + "traits": { + "smithy.api#documentation": "Information about the brokers.
", + "smithy.api#jsonName": "brokerNodeGroupInfo", + "smithy.api#required": {} + } + }, + "CurrentBrokerSoftwareInfo": { + "target": "com.amazonaws.kafka#BrokerSoftwareInfo", + "traits": { + "smithy.api#documentation": "Information about the Apache Kafka version deployed on the brokers.
", + "smithy.api#jsonName": "currentBrokerSoftwareInfo" + } + }, + "ClientAuthentication": { + "target": "com.amazonaws.kafka#ClientAuthentication", + "traits": { + "smithy.api#documentation": "Includes all client authentication information.
", + "smithy.api#jsonName": "clientAuthentication" + } + }, + "EncryptionInfo": { + "target": "com.amazonaws.kafka#EncryptionInfo", + "traits": { + "smithy.api#documentation": "Includes all encryption-related information.
", + "smithy.api#jsonName": "encryptionInfo" + } + }, + "EnhancedMonitoring": { + "target": "com.amazonaws.kafka#EnhancedMonitoring", + "traits": { + "smithy.api#documentation": "Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.
", + "smithy.api#jsonName": "enhancedMonitoring" + } + }, + "OpenMonitoring": { + "target": "com.amazonaws.kafka#OpenMonitoringInfo", + "traits": { + "smithy.api#documentation": "The settings for open monitoring.
", + "smithy.api#jsonName": "openMonitoring" + } + }, + "LoggingInfo": { + "target": "com.amazonaws.kafka#LoggingInfo", + "traits": { + "smithy.api#documentation": "Log delivery information for the cluster.
", + "smithy.api#jsonName": "loggingInfo" + } + }, + "NumberOfBrokerNodes": { + "target": "com.amazonaws.kafka#__integerMin1Max15", + "traits": { + "smithy.api#documentation": "The number of broker nodes in the cluster.
", + "smithy.api#jsonName": "numberOfBrokerNodes", + "smithy.api#required": {} + } + }, + "ZookeeperConnectString": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "The connection string to use to connect to the Apache ZooKeeper cluster.
", + "smithy.api#jsonName": "zookeeperConnectString" + } + }, + "ZookeeperConnectStringTls": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "The connection string to use to connect to the Apache ZooKeeper cluster on a TLS port.
", + "smithy.api#jsonName": "zookeeperConnectStringTls" + } + } + }, + "traits": { + "smithy.api#documentation": "Provisioned cluster.
" + } + }, + "com.amazonaws.kafka#ProvisionedRequest": { + "type": "structure", + "members": { + "BrokerNodeGroupInfo": { + "target": "com.amazonaws.kafka#BrokerNodeGroupInfo", + "traits": { + "smithy.api#documentation": "Information about the brokers.
", + "smithy.api#jsonName": "brokerNodeGroupInfo", + "smithy.api#required": {} + } + }, + "ClientAuthentication": { + "target": "com.amazonaws.kafka#ClientAuthentication", + "traits": { + "smithy.api#documentation": "Includes all client authentication information.
", + "smithy.api#jsonName": "clientAuthentication" + } + }, + "ConfigurationInfo": { + "target": "com.amazonaws.kafka#ConfigurationInfo", + "traits": { + "smithy.api#documentation": "Represents the configuration that you want Amazon MSK to use for the brokers in a cluster.
", + "smithy.api#jsonName": "configurationInfo" + } + }, + "EncryptionInfo": { + "target": "com.amazonaws.kafka#EncryptionInfo", + "traits": { + "smithy.api#documentation": "Includes all encryption-related information.
", + "smithy.api#jsonName": "encryptionInfo" + } + }, + "EnhancedMonitoring": { + "target": "com.amazonaws.kafka#EnhancedMonitoring", + "traits": { + "smithy.api#documentation": "Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.
", + "smithy.api#jsonName": "enhancedMonitoring" + } + }, + "OpenMonitoring": { + "target": "com.amazonaws.kafka#OpenMonitoringInfo", + "traits": { + "smithy.api#documentation": "The settings for open monitoring.
", + "smithy.api#jsonName": "openMonitoring" + } + }, + "KafkaVersion": { + "target": "com.amazonaws.kafka#__stringMin1Max128", + "traits": { + "smithy.api#documentation": "The Apache Kafka version that you want for the cluster.
", + "smithy.api#jsonName": "kafkaVersion", + "smithy.api#required": {} + } + }, + "LoggingInfo": { + "target": "com.amazonaws.kafka#LoggingInfo", + "traits": { + "smithy.api#documentation": "Log delivery information for the cluster.
", + "smithy.api#jsonName": "loggingInfo" + } + }, + "NumberOfBrokerNodes": { + "target": "com.amazonaws.kafka#__integerMin1Max15", + "traits": { + "smithy.api#documentation": "The number of broker nodes in the cluster.
", + "smithy.api#jsonName": "numberOfBrokerNodes", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provisioned cluster request.
" + } + }, "com.amazonaws.kafka#PublicAccess": { "type": "structure", "members": { @@ -3329,6 +3848,82 @@ "smithy.api#documentation": "Details for SASL/SCRAM client authentication.
" } }, + "com.amazonaws.kafka#Serverless": { + "type": "structure", + "members": { + "VpcConfigs": { + "target": "com.amazonaws.kafka#__listOfVpcConfig", + "traits": { + "smithy.api#documentation": "The configuration of the Amazon VPCs for the cluster.
", + "smithy.api#jsonName": "vpcConfigs", + "smithy.api#required": {} + } + }, + "ClientAuthentication": { + "target": "com.amazonaws.kafka#ServerlessClientAuthentication", + "traits": { + "smithy.api#documentation": "Includes all client authentication information.
", + "smithy.api#jsonName": "clientAuthentication" + } + } + }, + "traits": { + "smithy.api#documentation": "Serverless cluster.
" + } + }, + "com.amazonaws.kafka#ServerlessClientAuthentication": { + "type": "structure", + "members": { + "Sasl": { + "target": "com.amazonaws.kafka#ServerlessSasl", + "traits": { + "smithy.api#documentation": "Details for ClientAuthentication using SASL.
", + "smithy.api#jsonName": "sasl" + } + } + }, + "traits": { + "smithy.api#documentation": "Includes all client authentication information.
" + } + }, + "com.amazonaws.kafka#ServerlessRequest": { + "type": "structure", + "members": { + "VpcConfigs": { + "target": "com.amazonaws.kafka#__listOfVpcConfig", + "traits": { + "smithy.api#documentation": "The configuration of the Amazon VPCs for the cluster.
", + "smithy.api#jsonName": "vpcConfigs", + "smithy.api#required": {} + } + }, + "ClientAuthentication": { + "target": "com.amazonaws.kafka#ServerlessClientAuthentication", + "traits": { + "smithy.api#documentation": "Includes all client authentication information.
", + "smithy.api#jsonName": "clientAuthentication" + } + } + }, + "traits": { + "smithy.api#documentation": "Serverless cluster request.
" + } + }, + "com.amazonaws.kafka#ServerlessSasl": { + "type": "structure", + "members": { + "Iam": { + "target": "com.amazonaws.kafka#Iam", + "traits": { + "smithy.api#documentation": "Indicates whether IAM access control is enabled.
", + "smithy.api#jsonName": "iam" + } + } + }, + "traits": { + "smithy.api#documentation": "Details for client authentication using SASL.
" + } + }, "com.amazonaws.kafka#ServiceUnavailableException": { "type": "structure", "members": { @@ -4383,6 +4978,29 @@ } } }, + "com.amazonaws.kafka#VpcConfig": { + "type": "structure", + "members": { + "SubnetIds": { + "target": "com.amazonaws.kafka#__listOf__string", + "traits": { + "smithy.api#documentation": "The IDs of the subnets associated with the cluster.
", + "smithy.api#jsonName": "subnetIds", + "smithy.api#required": {} + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.kafka#__listOf__string", + "traits": { + "smithy.api#documentation": "The IDs of the security groups associated with the cluster.
", + "smithy.api#jsonName": "securityGroupIds" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of the Amazon VPCs for the cluster.
" + } + }, "com.amazonaws.kafka#ZookeeperNodeInfo": { "type": "structure", "members": { @@ -4462,6 +5080,12 @@ "target": "com.amazonaws.kafka#BrokerEBSVolumeInfo" } }, + "com.amazonaws.kafka#__listOfCluster": { + "type": "list", + "member": { + "target": "com.amazonaws.kafka#Cluster" + } + }, "com.amazonaws.kafka#__listOfClusterInfo": { "type": "list", "member": { @@ -4516,6 +5140,12 @@ "target": "com.amazonaws.kafka#UnprocessedScramSecret" } }, + "com.amazonaws.kafka#__listOfVpcConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.kafka#VpcConfig" + } + }, "com.amazonaws.kafka#__listOf__string": { "type": "list", "member": { diff --git a/aws/sdk/aws-models/kendra.json b/aws/sdk/aws-models/kendra.json index dc249e9245c1c5e7bb81f85222f2274c2916759d..8e071d9e15f7580f3a2e1fbfdf2224edafe97882 100644 --- a/aws/sdk/aws-models/kendra.json +++ b/aws/sdk/aws-models/kendra.json @@ -31,8 +31,29 @@ "shapes": { "com.amazonaws.kendra#AWSKendraFrontendService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "kendra", + "arnNamespace": "kendra", + "cloudFormationName": "Kendra", + "cloudTrailEventSource": "kendra.amazonaws.com", + "endpointPrefix": "kendra" + }, + "aws.auth#sigv4": { + "name": "kendra" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Amazon Kendra is a service for indexing large document sets.
", + "smithy.api#title": "AWSKendraFrontendService" + }, "version": "2019-02-03", "operations": [ + { + "target": "com.amazonaws.kendra#AssociateEntitiesToExperience" + }, + { + "target": "com.amazonaws.kendra#AssociatePersonasToEntities" + }, { "target": "com.amazonaws.kendra#BatchDeleteDocument" }, @@ -48,6 +69,9 @@ { "target": "com.amazonaws.kendra#CreateDataSource" }, + { + "target": "com.amazonaws.kendra#CreateExperience" + }, { "target": "com.amazonaws.kendra#CreateFaq" }, @@ -63,6 +87,9 @@ { "target": "com.amazonaws.kendra#DeleteDataSource" }, + { + "target": "com.amazonaws.kendra#DeleteExperience" + }, { "target": "com.amazonaws.kendra#DeleteFaq" }, @@ -81,6 +108,9 @@ { "target": "com.amazonaws.kendra#DescribeDataSource" }, + { + "target": "com.amazonaws.kendra#DescribeExperience" + }, { "target": "com.amazonaws.kendra#DescribeFaq" }, @@ -99,15 +129,33 @@ { "target": "com.amazonaws.kendra#DescribeThesaurus" }, + { + "target": "com.amazonaws.kendra#DisassociateEntitiesFromExperience" + }, + { + "target": "com.amazonaws.kendra#DisassociatePersonasFromEntities" + }, { "target": "com.amazonaws.kendra#GetQuerySuggestions" }, + { + "target": "com.amazonaws.kendra#GetSnapshots" + }, { "target": "com.amazonaws.kendra#ListDataSources" }, { "target": "com.amazonaws.kendra#ListDataSourceSyncJobs" }, + { + "target": "com.amazonaws.kendra#ListEntityPersonas" + }, + { + "target": "com.amazonaws.kendra#ListExperienceEntities" + }, + { + "target": "com.amazonaws.kendra#ListExperiences" + }, { "target": "com.amazonaws.kendra#ListFaqs" }, @@ -150,6 +198,9 @@ { "target": "com.amazonaws.kendra#UpdateDataSource" }, + { + "target": "com.amazonaws.kendra#UpdateExperience" + }, { "target": "com.amazonaws.kendra#UpdateIndex" }, @@ -162,22 +213,7 @@ { "target": "com.amazonaws.kendra#UpdateThesaurus" } - ], - "traits": { - "aws.api#service": { - "sdkId": "kendra", - "arnNamespace": "kendra", - "cloudFormationName": "Kendra", - "cloudTrailEventSource": "kendra.amazonaws.com", - "endpointPrefix": "kendra" - }, - "aws.auth#sigv4": { - "name": "kendra" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Kendra is a service for indexing large document sets.
", - "smithy.api#title": "AWSKendraFrontendService" - } + ] }, "com.amazonaws.kendra#AccessControlListConfiguration": { "type": "structure", @@ -290,6 +326,168 @@ } } }, + "com.amazonaws.kendra#AssociateEntitiesToExperience": { + "type": "operation", + "input": { + "target": "com.amazonaws.kendra#AssociateEntitiesToExperienceRequest" + }, + "output": { + "target": "com.amazonaws.kendra#AssociateEntitiesToExperienceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kendra#AccessDeniedException" + }, + { + "target": "com.amazonaws.kendra#InternalServerException" + }, + { + "target": "com.amazonaws.kendra#ResourceAlreadyExistException" + }, + { + "target": "com.amazonaws.kendra#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.kendra#ThrottlingException" + }, + { + "target": "com.amazonaws.kendra#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Grants users or groups in your Amazon Web Services SSO identity source access \n to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a \n search application. For more information on creating a search application \n experience, see Building \n a search experience with no code.
" + } + }, + "com.amazonaws.kendra#AssociateEntitiesToExperienceFailedEntityList": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#FailedEntity" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.kendra#AssociateEntitiesToExperienceRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.kendra#ExperienceId", + "traits": { + "smithy.api#documentation": "The identifier of your Amazon Kendra experience.
", + "smithy.api#required": {} + } + }, + "IndexId": { + "target": "com.amazonaws.kendra#IndexId", + "traits": { + "smithy.api#documentation": "The identifier of the index for your Amazon Kendra experience.
", + "smithy.api#required": {} + } + }, + "EntityList": { + "target": "com.amazonaws.kendra#AssociateEntityList", + "traits": { + "smithy.api#documentation": "Lists users or groups in your Amazon Web Services SSO identity source.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.kendra#AssociateEntitiesToExperienceResponse": { + "type": "structure", + "members": { + "FailedEntityList": { + "target": "com.amazonaws.kendra#AssociateEntitiesToExperienceFailedEntityList", + "traits": { + "smithy.api#documentation": "Lists the users or groups in your Amazon Web Services SSO identity source that \n failed to properly configure with your Amazon Kendra experience.
" + } + } + } + }, + "com.amazonaws.kendra#AssociateEntityList": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#EntityConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.kendra#AssociatePersonasToEntities": { + "type": "operation", + "input": { + "target": "com.amazonaws.kendra#AssociatePersonasToEntitiesRequest" + }, + "output": { + "target": "com.amazonaws.kendra#AssociatePersonasToEntitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kendra#AccessDeniedException" + }, + { + "target": "com.amazonaws.kendra#InternalServerException" + }, + { + "target": "com.amazonaws.kendra#ResourceAlreadyExistException" + }, + { + "target": "com.amazonaws.kendra#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.kendra#ThrottlingException" + }, + { + "target": "com.amazonaws.kendra#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Defines the specific permissions of users or groups in your Amazon Web Services SSO\n identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra \n experience such as a search application. For more information on creating a \n search application experience, see Building \n a search experience with no code.
" + } + }, + "com.amazonaws.kendra#AssociatePersonasToEntitiesRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.kendra#ExperienceId", + "traits": { + "smithy.api#documentation": "The identifier of your Amazon Kendra experience.
", + "smithy.api#required": {} + } + }, + "IndexId": { + "target": "com.amazonaws.kendra#IndexId", + "traits": { + "smithy.api#documentation": "The identifier of the index for your Amazon Kendra experience.
", + "smithy.api#required": {} + } + }, + "Personas": { + "target": "com.amazonaws.kendra#EntityPersonaConfigurationList", + "traits": { + "smithy.api#documentation": "The personas that define the specific permissions of users or groups in \n your Amazon Web Services SSO identity source. The available personas or access \n roles are Owner and Viewer. For more information \n on these personas, see Providing \n access to your search page.
Lists the users or groups in your Amazon Web Services SSO identity source that \n failed to properly configure with your Amazon Kendra experience.
" + } + } + } + }, "com.amazonaws.kendra#AttributeFilter": { "type": "structure", "members": { @@ -355,7 +553,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides filtering the query results based on document\n attributes.
\nWhen you use the AndAllFilters or\n OrAllFilters, filters you can use 2 layers under the\n first attribute filter. For example, you can use:
\n
\n \n
\n \n
If you use more than 2 layers, you receive a\n ValidationException exception with the message\n \"AttributeFilter cannot have a depth of more \n than 2.\"
If you use more than 10 attribute filters in a given list for \n AndAllFilters or OrAllFilters, you receive \n a ValidationException with the message \n \"AttributeFilter cannot have a length of more than 10\".
Provides filtering the query results based on document\n attributes.
\nWhen you use the AndAllFilters or\n OrAllFilters, filters you can use 2 layers under the\n first attribute filter. For example, you can use:
\n
\n \n
\n \n
If you use more than 2 layers, you receive a\n ValidationException exception with the message\n \"AttributeFilter cannot have a depth of more \n than 2.\"
If you use more than 10 attribute filters in a given list for \n AndAllFilters or OrAllFilters, you receive \n a ValidationException with the message \n \"AttributeFilter cannot have a length of more than 10\".
Your secret ARN, which you can create in AWS Secrets Manager\n
\nYou use a secret if basic authentication credentials are required to connect \n to a website. The secret stores your credentials of user name and password.
", + "smithy.api#documentation": "Your secret ARN, which you can create in Secrets Manager\n
\nYou use a secret if basic authentication credentials are required to connect \n to a website. The secret stores your credentials of user name and password.
", "smithy.api#required": {} } } @@ -673,6 +871,12 @@ "smithy.api#documentation": "One or more documents to add to the index.
\nDocuments can include custom attributes. For example, \n 'DataSourceId' and 'DataSourceSyncJobId' are custom \n attributes that provide information on the synchronization \n of documents running on a data source. Note, \n 'DataSourceSyncJobId' could be an optional custom attribute \n as Amazon Kendra will use the ID of a running sync job.
\nDocuments have the following file size limits.
\n5 MB total size for inline documents
\n50 MB total size for files from an S3 bucket
\n5 MB extracted text for any file
\nFor more information about file size and transaction per second\n quotas, see Quotas.
", "smithy.api#required": {} } + }, + "CustomDocumentEnrichmentConfiguration": { + "target": "com.amazonaws.kendra#CustomDocumentEnrichmentConfiguration", + "traits": { + "smithy.api#documentation": "Configuration information for altering your document metadata and content during \n the document ingestion process when you use the BatchPutDocument \n operation.
For more information on how to create, modify and delete document metadata, \n or make other content alterations when you ingest documents into Amazon Kendra, see \n Customizing \n document metadata during the ingestion process.
" + } } } }, @@ -795,7 +999,7 @@ } ], "traits": { - "smithy.api#documentation": "Clears existing query suggestions from an index.
\nThis deletes existing suggestions only, not the queries \n in the query log. After you clear suggestions, Amazon Kendra learns \n new suggestions based on new queries added to the query log \n from the time you cleared suggestions. If you do not see any \n new suggestions, then please allow Amazon Kendra to collect \n enough queries to learn new suggestions.
" + "smithy.api#documentation": "Clears existing query suggestions from an index.
\nThis deletes existing suggestions only, not the queries \n in the query log. After you clear suggestions, Amazon Kendra learns \n new suggestions based on new queries added to the query log \n from the time you cleared suggestions. If you do not see any \n new suggestions, then please allow Amazon Kendra to collect \n enough queries to learn new suggestions.
\n\n ClearQuerySuggestions is currently not supported in the \n Amazon Web Services GovCloud (US-West) region.
The Amazon Resource Name (ARN) of an Secrets Managersecret\n that contains the key/value pairs required to connect to your\n Confluence server. The secret must contain a JSON structure with the\n following keys:
\nusername - The user name or email address of a user with\n administrative privileges for the Confluence server.
\npassword - The password associated with the user logging\n in to the Confluence server.
\nThe Amazon Resource Name (ARN) of an Secrets Manager secret\n that contains the key/value pairs required to connect to your\n Confluence server. The secret must contain a JSON structure with the\n following keys:
\nusername - The user name or email address of a user with\n administrative privileges for the Confluence server.
\npassword - The password associated with the user logging\n in to the Confluence server.
\nProvides the information necessary to connect to a\n database.
" } }, + "com.amazonaws.kendra#ContentSourceConfiguration": { + "type": "structure", + "members": { + "DataSourceIds": { + "target": "com.amazonaws.kendra#DataSourceIdList", + "traits": { + "smithy.api#documentation": "The identifier of the data sources you want to use for your Amazon Kendra experience.
" + } + }, + "FaqIds": { + "target": "com.amazonaws.kendra#FaqIdsList", + "traits": { + "smithy.api#documentation": "The identifier of the FAQs that you want to use for your Amazon Kendra experience.
" + } + }, + "DirectPutContent": { + "target": "com.amazonaws.kendra#Boolean", + "traits": { + "smithy.api#documentation": "\n TRUE to use documents you indexed directly using the\n BatchPutDocument operation.
Configuration information for your content sources, such as data sources, \n FAQs, and content indexed directly via BatchPutDocument.
" + } + }, "com.amazonaws.kendra#ContentType": { "type": "string", "traits": { @@ -1543,7 +1824,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a data source that you want to use with an Amazon Kendra index.
\nYou specify a name, data source connector type and description for\n your data source. You also specify configuration information for the \n data source connector.
\n\n CreateDataSource is a synchronous operation. The\n operation returns 200 if the data source was successfully created.\n Otherwise, an exception is raised.
Creates a data source that you want to use with an Amazon Kendra index.
\nYou specify a name, data source connector type and description for\n your data source. You also specify configuration information for the \n data source connector.
\n\n CreateDataSource is a synchronous operation. The\n operation returns 200 if the data source was successfully created.\n Otherwise, an exception is raised.
Amazon S3 and custom data sources are \n the only supported data sources in the Amazon Web Services GovCloud (US-West) region.
" } }, "com.amazonaws.kendra#CreateDataSourceRequest": { @@ -1612,6 +1893,12 @@ "traits": { "smithy.api#documentation": "The code for a language. This allows you to support a language for all \n documents when creating the data source. English is supported \n by default. For more information on supported languages, including their codes, \n see Adding \n documents in languages other than English.
" } + }, + "CustomDocumentEnrichmentConfiguration": { + "target": "com.amazonaws.kendra#CustomDocumentEnrichmentConfiguration", + "traits": { + "smithy.api#documentation": "Configuration information for altering document metadata and content during the\n document ingestion process when you create a data source.
\nFor more information on how to create, modify and delete document metadata, or make\n other content alterations when you ingest documents into Amazon Kendra, see \n Customizing \n document metadata during the ingestion process.
" + } } } }, @@ -1627,13 +1914,13 @@ } } }, - "com.amazonaws.kendra#CreateFaq": { + "com.amazonaws.kendra#CreateExperience": { "type": "operation", "input": { - "target": "com.amazonaws.kendra#CreateFaqRequest" + "target": "com.amazonaws.kendra#CreateExperienceRequest" }, "output": { - "target": "com.amazonaws.kendra#CreateFaqResponse" + "target": "com.amazonaws.kendra#CreateExperienceResponse" }, "errors": [ { @@ -1659,40 +1946,131 @@ } ], "traits": { - "smithy.api#documentation": "Creates an new set of frequently asked question (FAQ) questions and answers.
" + "smithy.api#documentation": "Creates an Amazon Kendra experience such as a search application. For more information \n on creating a search application experience, see Building a \n search experience with no code.
" } }, - "com.amazonaws.kendra#CreateFaqRequest": { + "com.amazonaws.kendra#CreateExperienceRequest": { "type": "structure", "members": { - "IndexId": { - "target": "com.amazonaws.kendra#IndexId", + "Name": { + "target": "com.amazonaws.kendra#ExperienceName", "traits": { - "smithy.api#documentation": "The identifier of the index that contains the FAQ.
", + "smithy.api#documentation": "A name for your Amazon Kendra experience.
", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.kendra#FaqName", + "IndexId": { + "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The name that should be associated with the FAQ.
", + "smithy.api#documentation": "The identifier of the index for your Amazon Kendra experience.
", "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.kendra#Description", + "RoleArn": { + "target": "com.amazonaws.kendra#RoleArn", "traits": { - "smithy.api#documentation": "A description of the FAQ.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access Query\n operations, QuerySuggestions operations, SubmitFeedback\n operations, and Amazon Web Services SSO that stores your user and group information. \n For more information, see IAM roles for Amazon Kendra.
The S3 location of the FAQ input data.
", - "smithy.api#required": {} + "smithy.api#documentation": "Provides the configuration information for your Amazon Kendra experience. This includes\n ContentSourceConfiguration, which specifies the data source IDs \n and/or FAQ IDs, and UserIdentityConfiguration, which specifies the \n user or group information to grant access to your Amazon Kendra experience.
A description for your Amazon Kendra experience.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.kendra#ClientTokenName", + "traits": { + "smithy.api#documentation": "A token that you provide to identify the request to create your Amazon Kendra experience.\n Multiple calls to the CreateExperience operation with the same client \n token creates only one Amazon Kendra experience.
The identifier for your created Amazon Kendra experience.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.kendra#CreateFaq": { + "type": "operation", + "input": { + "target": "com.amazonaws.kendra#CreateFaqRequest" + }, + "output": { + "target": "com.amazonaws.kendra#CreateFaqResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kendra#AccessDeniedException" + }, + { + "target": "com.amazonaws.kendra#ConflictException" + }, + { + "target": "com.amazonaws.kendra#InternalServerException" + }, + { + "target": "com.amazonaws.kendra#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.kendra#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.kendra#ThrottlingException" + }, + { + "target": "com.amazonaws.kendra#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an new set of frequently asked question (FAQ) questions and answers.
" + } + }, + "com.amazonaws.kendra#CreateFaqRequest": { + "type": "structure", + "members": { + "IndexId": { + "target": "com.amazonaws.kendra#IndexId", + "traits": { + "smithy.api#documentation": "The identifier of the index that contains the FAQ.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.kendra#FaqName", + "traits": { + "smithy.api#documentation": "The name that should be associated with the FAQ.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.kendra#Description", + "traits": { + "smithy.api#documentation": "A description of the FAQ.
" + } + }, + "S3Path": { + "target": "com.amazonaws.kendra#S3Path", + "traits": { + "smithy.api#documentation": "The S3 location of the FAQ input data.
", + "smithy.api#required": {} + } + }, + "RoleArn": { "target": "com.amazonaws.kendra#RoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that\n contains the FAQs. For more information, see IAM Roles for Amazon Kendra.
", @@ -1835,7 +2213,7 @@ "UserGroupResolutionConfiguration": { "target": "com.amazonaws.kendra#UserGroupResolutionConfiguration", "traits": { - "smithy.api#documentation": "Enables fetching access levels of groups and users from an AWS Single Sign-On \n identity source. To configure this, see \n UserGroupResolutionConfiguration.
" + "smithy.api#documentation": "Enables fetching access levels of groups and users from an Amazon Web Services Single Sign On \n identity source. To configure this, see \n UserGroupResolutionConfiguration.
" } } } @@ -1883,7 +2261,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a block list to exlcude certain queries from suggestions.
\nAny query that contains words or phrases specified in the block \n list is blocked or filtered out from being shown as a suggestion.
\nYou need to provide the file location of your block list text file \n in your S3 bucket. In your text file, enter each block word or phrase \n on a separate line.
\nFor information on the current quota limits for block lists, see \n Quotas \n for Amazon Kendra.
" + "smithy.api#documentation": "Creates a block list to exlcude certain queries from suggestions.
\nAny query that contains words or phrases specified in the block \n list is blocked or filtered out from being shown as a suggestion.
\nYou need to provide the file location of your block list text file \n in your S3 bucket. In your text file, enter each block word or phrase \n on a separate line.
\nFor information on the current quota limits for block lists, see \n Quotas \n for Amazon Kendra.
\n\n CreateQuerySuggestionsBlockList is currently not supported in the \n Amazon Web Services GovCloud (US-West) region.
An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions \n to access thesaurus file specified in SourceS3Path.\n
An IAM role that gives Amazon Kendra permissions \n to access thesaurus file specified in SourceS3Path.\n
Configuration information to alter document attributes or metadata fields and \n content when ingesting documents into Amazon Kendra.
" + } + }, + "PreExtractionHookConfiguration": { + "target": "com.amazonaws.kendra#HookConfiguration", + "traits": { + "smithy.api#documentation": "Configuration information for invoking a Lambda function in Lambda \n on the original or raw documents before extracting their metadata and text. You can \n use a Lambda function to apply advanced logic for creating, modifying, or deleting\n document metadata and content. For more information, see Advanced \n data manipulation.
" + } + }, + "PostExtractionHookConfiguration": { + "target": "com.amazonaws.kendra#HookConfiguration", + "traits": { + "smithy.api#documentation": "Configuration information for invoking a Lambda function in Lambda \n on the structured documents with their metadata and text extracted. You can use a \n Lambda function to apply advanced logic for creating, modifying, or deleting document\n metadata and content. For more information, see Advanced \n data manipulation.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.kendra#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to run \n PreExtractionHookConfiguration and \n PostExtractionHookConfiguration for altering document metadata \n and content during the document ingestion process. For more information, \n see IAM roles for\n Amazon Kendra.
Provides the configuration information for altering document metadata and content\n during the document ingestion process.
\nFor more information, see Customizing document metadata\n during the ingestion process.
" + } + }, "com.amazonaws.kendra#DataSourceConfiguration": { "type": "structure", "members": { @@ -2109,7 +2519,7 @@ } }, "traits": { - "smithy.api#documentation": "Configuration information for a Amazon Kendra data source.
" + "smithy.api#documentation": "Configuration information for an Amazon Kendra data source.
" } }, "com.amazonaws.kendra#DataSourceDateFieldFormat": { @@ -2176,6 +2586,18 @@ "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$" } }, + "com.amazonaws.kendra#DataSourceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#DataSourceId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings": { "type": "list", "member": { @@ -2713,6 +3135,61 @@ } } }, + "com.amazonaws.kendra#DeleteExperience": { + "type": "operation", + "input": { + "target": "com.amazonaws.kendra#DeleteExperienceRequest" + }, + "output": { + "target": "com.amazonaws.kendra#DeleteExperienceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kendra#AccessDeniedException" + }, + { + "target": "com.amazonaws.kendra#ConflictException" + }, + { + "target": "com.amazonaws.kendra#InternalServerException" + }, + { + "target": "com.amazonaws.kendra#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.kendra#ThrottlingException" + }, + { + "target": "com.amazonaws.kendra#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes your Amazon Kendra experience such as a search application. For more information on\n creating a search application experience, see Building a search\n experience with no code.
" + } + }, + "com.amazonaws.kendra#DeleteExperienceRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.kendra#ExperienceId", + "traits": { + "smithy.api#documentation": "The identifier of your Amazon Kendra experience you want to delete.
", + "smithy.api#required": {} + } + }, + "IndexId": { + "target": "com.amazonaws.kendra#IndexId", + "traits": { + "smithy.api#documentation": "The identifier of the index for your Amazon Kendra experience you want to delete.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.kendra#DeleteExperienceResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.kendra#DeleteFaq": { "type": "operation", "input": { @@ -2828,7 +3305,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a group so that all users and sub groups that belong to the group can \n no longer access documents only available to that group.
\nFor example, after deleting the group \"Summer Interns\", all interns who \n belonged to that group no longer see intern-only documents in their search \n results.
\nIf you want to delete or replace users or sub groups of a group, you need to \n use the PutPrincipalMapping operation. For example, if a user in \n the group \"Engineering\" leaves the engineering team and another user takes \n their place, you provide an updated list of users or sub groups that belong \n to the \"Engineering\" group when calling PutPrincipalMapping. You \n can update your internal list of users or sub groups and input this list \n when calling PutPrincipalMapping.
Deletes a group so that all users and sub groups that belong to the group can \n no longer access documents only available to that group.
\nFor example, after deleting the group \"Summer Interns\", all interns who \n belonged to that group no longer see intern-only documents in their search \n results.
\nIf you want to delete or replace users or sub groups of a group, you need to \n use the PutPrincipalMapping operation. For example, if a user in \n the group \"Engineering\" leaves the engineering team and another user takes \n their place, you provide an updated list of users or sub groups that belong \n to the \"Engineering\" group when calling PutPrincipalMapping. You \n can update your internal list of users or sub groups and input this list \n when calling PutPrincipalMapping.
\n DeletePrincipalMapping is currently not supported in the \n Amazon Web Services GovCloud (US-West) region.
Deletes a block list used for query suggestions for an index.
\nA deleted block list might not take effect right away. Amazon Kendra \n needs to refresh the entire suggestions list to add back the \n queries that were previously blocked.
" + "smithy.api#documentation": "Deletes a block list used for query suggestions for an index.
\nA deleted block list might not take effect right away. Amazon Kendra \n needs to refresh the entire suggestions list to add back the \n queries that were previously blocked.
\n\n DeleteQuerySuggestionsBlockList is currently not supported in the \n Amazon Web Services GovCloud (US-West) region.
The code for a language. This shows a supported language for all \n documents in the data source. English is supported by \n default. For more information on supported languages, including their codes, \n see Adding \n documents in languages other than English.
" } + }, + "CustomDocumentEnrichmentConfiguration": { + "target": "com.amazonaws.kendra#CustomDocumentEnrichmentConfiguration", + "traits": { + "smithy.api#documentation": "Configuration information for altering document metadata and content during the\n document ingestion process when you describe a data source.
\nFor more information on how to create, modify and delete document metadata, or make\n other content alterations when you ingest documents into Amazon Kendra, see \n Customizing \n document metadata during the ingestion process.
" + } } } }, - "com.amazonaws.kendra#DescribeFaq": { + "com.amazonaws.kendra#DescribeExperience": { "type": "operation", "input": { - "target": "com.amazonaws.kendra#DescribeFaqRequest" + "target": "com.amazonaws.kendra#DescribeExperienceRequest" }, "output": { - "target": "com.amazonaws.kendra#DescribeFaqResponse" + "target": "com.amazonaws.kendra#DescribeExperienceResponse" }, "errors": [ { @@ -3115,109 +3598,106 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about an FAQ list.
" + "smithy.api#documentation": "Gets information about your Amazon Kendra experience such as a search application. \n For more information on creating a search application experience, \n see Building \n a search experience with no code.
" } }, - "com.amazonaws.kendra#DescribeFaqRequest": { + "com.amazonaws.kendra#DescribeExperienceRequest": { "type": "structure", "members": { "Id": { - "target": "com.amazonaws.kendra#FaqId", + "target": "com.amazonaws.kendra#ExperienceId", "traits": { - "smithy.api#documentation": "The unique identifier of the FAQ.
", + "smithy.api#documentation": "The identifier of your Amazon Kendra experience you want to get information on.
", "smithy.api#required": {} } }, "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index that contains the FAQ.
", + "smithy.api#documentation": "The identifier of the index for your Amazon Kendra experience you want to get \n information on.
", "smithy.api#required": {} } } } }, - "com.amazonaws.kendra#DescribeFaqResponse": { + "com.amazonaws.kendra#DescribeExperienceResponse": { "type": "structure", "members": { "Id": { - "target": "com.amazonaws.kendra#FaqId", + "target": "com.amazonaws.kendra#ExperienceId", "traits": { - "smithy.api#documentation": "The identifier of the FAQ.
" + "smithy.api#documentation": "Shows the identifier of your Amazon Kendra experience.
" } }, "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index that contains the FAQ.
" + "smithy.api#documentation": "Shows the identifier of the index for your Amazon Kendra experience.
" } }, "Name": { - "target": "com.amazonaws.kendra#FaqName", + "target": "com.amazonaws.kendra#ExperienceName", "traits": { - "smithy.api#documentation": "The name that you gave the FAQ when it was created.
" + "smithy.api#documentation": "Shows the name of your Amazon Kendra experience.
" } }, - "Description": { - "target": "com.amazonaws.kendra#Description", + "Endpoints": { + "target": "com.amazonaws.kendra#ExperienceEndpoints", "traits": { - "smithy.api#documentation": "The description of the FAQ that you provided when it was created.
" + "smithy.api#documentation": "Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully\n hosted by Amazon Web Services.
" + } + }, + "Configuration": { + "target": "com.amazonaws.kendra#ExperienceConfiguration", + "traits": { + "smithy.api#documentation": "Shows the configuration information for your Amazon Kendra experience. This includes\n ContentSourceConfiguration, which specifies the data source IDs \n and/or FAQ IDs, and UserIdentityConfiguration, which specifies the \n user or group information to grant access to your Amazon Kendra experience.
The date and time that the FAQ was created.
" + "smithy.api#documentation": "Shows the date-time your Amazon Kendra experience was created.
" } }, "UpdatedAt": { "target": "com.amazonaws.kendra#Timestamp", "traits": { - "smithy.api#documentation": "The date and time that the FAQ was last updated.
" + "smithy.api#documentation": "Shows the date-time your Amazon Kendra experience was last updated.
" } }, - "S3Path": { - "target": "com.amazonaws.kendra#S3Path" + "Description": { + "target": "com.amazonaws.kendra#Description", + "traits": { + "smithy.api#documentation": "Shows the description for your Amazon Kendra experience.
" + } }, "Status": { - "target": "com.amazonaws.kendra#FaqStatus", + "target": "com.amazonaws.kendra#ExperienceStatus", "traits": { - "smithy.api#documentation": "The status of the FAQ. It is ready to use when the status is\n ACTIVE.
The current processing status of your Amazon Kendra experience. When the status \n is ACTIVE, your Amazon Kendra experience is ready to use. When the \n status is FAILED, the ErrorMessage field contains \n the reason that this failed.
The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket\n containing the input files for the FAQ.
" + "smithy.api#documentation": "Shows the Amazon Resource Name (ARN) of a role with permission to access \n Query operations, QuerySuggestions operations, \n SubmitFeedback operations, and Amazon Web Services SSO that stores \n your user and group information.
If the Status field is FAILED, the ErrorMessage\n field contains the reason why the FAQ failed.
The file format used by the input files for the FAQ.
" - } - }, - "LanguageCode": { - "target": "com.amazonaws.kendra#LanguageCode", - "traits": { - "smithy.api#documentation": "The code for a language. This shows a supported language \n for the FAQ document. English is supported by default. \n For more information on supported languages, including their codes, \n see Adding \n documents in languages other than English.
" + "smithy.api#documentation": "The reason your Amazon Kendra experience could not properly process.
" } } } }, - "com.amazonaws.kendra#DescribeIndex": { + "com.amazonaws.kendra#DescribeFaq": { "type": "operation", "input": { - "target": "com.amazonaws.kendra#DescribeIndexRequest" + "target": "com.amazonaws.kendra#DescribeFaqRequest" }, "output": { - "target": "com.amazonaws.kendra#DescribeIndexResponse" + "target": "com.amazonaws.kendra#DescribeFaqResponse" }, "errors": [ { @@ -3237,49 +3717,171 @@ } ], "traits": { - "smithy.api#documentation": "Describes an existing Amazon Kendra index
" + "smithy.api#documentation": "Gets information about an FAQ list.
" } }, - "com.amazonaws.kendra#DescribeIndexRequest": { + "com.amazonaws.kendra#DescribeFaqRequest": { "type": "structure", "members": { "Id": { + "target": "com.amazonaws.kendra#FaqId", + "traits": { + "smithy.api#documentation": "The unique identifier of the FAQ.
", + "smithy.api#required": {} + } + }, + "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The name of the index to describe.
", + "smithy.api#documentation": "The identifier of the index that contains the FAQ.
", "smithy.api#required": {} } } } }, - "com.amazonaws.kendra#DescribeIndexResponse": { + "com.amazonaws.kendra#DescribeFaqResponse": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.kendra#IndexName", + "Id": { + "target": "com.amazonaws.kendra#FaqId", "traits": { - "smithy.api#documentation": "The name of the index.
" + "smithy.api#documentation": "The identifier of the FAQ.
" } }, - "Id": { + "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The name of the index.
" + "smithy.api#documentation": "The identifier of the index that contains the FAQ.
" } }, - "Edition": { - "target": "com.amazonaws.kendra#IndexEdition", + "Name": { + "target": "com.amazonaws.kendra#FaqName", "traits": { - "smithy.api#documentation": "The Amazon Kendra edition used for the index. You decide the edition\n when you create the index.
" + "smithy.api#documentation": "The name that you gave the FAQ when it was created.
" } }, - "RoleArn": { - "target": "com.amazonaws.kendra#RoleArn", + "Description": { + "target": "com.amazonaws.kendra#Description", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra\n permission to write to your Amazon Cloudwatch logs.
" + "smithy.api#documentation": "The description of the FAQ that you provided when it was created.
" } }, - "ServerSideEncryptionConfiguration": { + "CreatedAt": { + "target": "com.amazonaws.kendra#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the FAQ was created.
" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.kendra#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the FAQ was last updated.
" + } + }, + "S3Path": { + "target": "com.amazonaws.kendra#S3Path" + }, + "Status": { + "target": "com.amazonaws.kendra#FaqStatus", + "traits": { + "smithy.api#documentation": "The status of the FAQ. It is ready to use when the status is\n ACTIVE.
The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket\n containing the input files for the FAQ.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.kendra#ErrorMessage", + "traits": { + "smithy.api#documentation": "If the Status field is FAILED, the ErrorMessage\n field contains the reason why the FAQ failed.
The file format used by the input files for the FAQ.
" + } + }, + "LanguageCode": { + "target": "com.amazonaws.kendra#LanguageCode", + "traits": { + "smithy.api#documentation": "The code for a language. This shows a supported language \n for the FAQ document. English is supported by default. \n For more information on supported languages, including their codes, \n see Adding \n documents in languages other than English.
" + } + } + } + }, + "com.amazonaws.kendra#DescribeIndex": { + "type": "operation", + "input": { + "target": "com.amazonaws.kendra#DescribeIndexRequest" + }, + "output": { + "target": "com.amazonaws.kendra#DescribeIndexResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kendra#AccessDeniedException" + }, + { + "target": "com.amazonaws.kendra#InternalServerException" + }, + { + "target": "com.amazonaws.kendra#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.kendra#ThrottlingException" + }, + { + "target": "com.amazonaws.kendra#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Describes an existing Amazon Kendra index
" + } + }, + "com.amazonaws.kendra#DescribeIndexRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.kendra#IndexId", + "traits": { + "smithy.api#documentation": "The name of the index to describe.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.kendra#DescribeIndexResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.kendra#IndexName", + "traits": { + "smithy.api#documentation": "The name of the index.
" + } + }, + "Id": { + "target": "com.amazonaws.kendra#IndexId", + "traits": { + "smithy.api#documentation": "The name of the index.
" + } + }, + "Edition": { + "target": "com.amazonaws.kendra#IndexEdition", + "traits": { + "smithy.api#documentation": "The Amazon Kendra edition used for the index. You decide the edition\n when you create the index.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.kendra#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra\n permission to write to your Amazon Cloudwatch logs.
" + } + }, + "ServerSideEncryptionConfiguration": { "target": "com.amazonaws.kendra#ServerSideEncryptionConfiguration", "traits": { "smithy.api#documentation": "The identifier of the KMScustomer master key (CMK) used to\n encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
" @@ -3348,7 +3950,7 @@ "UserGroupResolutionConfiguration": { "target": "com.amazonaws.kendra#UserGroupResolutionConfiguration", "traits": { - "smithy.api#documentation": "Shows whether you have enabled the configuration for fetching access \n levels of groups and users from an AWS Single Sign-On identity source.
" + "smithy.api#documentation": "Shows whether you have enabled the configuration for fetching access \n levels of groups and users from an Amazon Web Services Single Sign On identity source.
" } } } @@ -3379,7 +3981,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the processing of PUT and DELETE actions \n for mapping users to their groups. This includes information on the status of \n actions currently processing or yet to be processed, when actions were last updated, \n when actions were received by Amazon Kendra, the latest action that should process \n and apply after other actions, and useful error messages if an action could \n not be processed.
Describes the processing of PUT and DELETE actions \n for mapping users to their groups. This includes information on the status of \n actions currently processing or yet to be processed, when actions were last updated, \n when actions were received by Amazon Kendra, the latest action that should process \n and apply after other actions, and useful error messages if an action could \n not be processed.
\n DescribePrincipalMapping is currently not supported in the \n Amazon Web Services GovCloud (US-West) region.
Describes a block list used for query suggestions for an index.
\nThis is used to check the current settings that are applied to a \n block list.
" + "smithy.api#documentation": "Describes a block list used for query suggestions for an index.
\nThis is used to check the current settings that are applied to a \n block list.
\n\n DescribeQuerySuggestionsBlockList is currently not supported in the \n Amazon Web Services GovCloud (US-West) region.
Describes the settings of query suggestions for an index.
\nThis is used to check the current settings applied \n to query suggestions.
" + "smithy.api#documentation": "Describes the settings of query suggestions for an index.
\nThis is used to check the current settings applied \n to query suggestions.
\n\n DescribeQuerySuggestionsConfig is currently not supported in the \n Amazon Web Services GovCloud (US-West) region.
An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions \n to access thesaurus file specified in SourceS3Path.\n
An IAM role that gives Amazon Kendra permissions \n to access thesaurus file specified in SourceS3Path.\n
Prevents users or groups in your Amazon Web Services SSO identity source\n from accessing your Amazon Kendra experience. You can create an Amazon Kendra experience \n such as a search application. For more information on creating a search \n application experience, see Building \n a search experience with no code.
" + } + }, + "com.amazonaws.kendra#DisassociateEntitiesFromExperienceRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.kendra#ExperienceId", + "traits": { + "smithy.api#documentation": "The identifier of your Amazon Kendra experience.
", + "smithy.api#required": {} + } + }, + "IndexId": { + "target": "com.amazonaws.kendra#IndexId", + "traits": { + "smithy.api#documentation": "The identifier of the index for your Amazon Kendra experience.
", + "smithy.api#required": {} + } + }, + "EntityList": { + "target": "com.amazonaws.kendra#DisassociateEntityList", + "traits": { + "smithy.api#documentation": "Lists users or groups in your Amazon Web Services SSO identity source.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.kendra#DisassociateEntitiesFromExperienceResponse": { + "type": "structure", + "members": { + "FailedEntityList": { + "target": "com.amazonaws.kendra#FailedEntityList", + "traits": { + "smithy.api#documentation": "Lists the users or groups in your Amazon Web Services SSO identity source that \n failed to properly remove access to your Amazon Kendra experience.
" + } + } + } + }, + "com.amazonaws.kendra#DisassociateEntityList": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#EntityConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 40 + } + } + }, + "com.amazonaws.kendra#DisassociatePersonasFromEntities": { + "type": "operation", + "input": { + "target": "com.amazonaws.kendra#DisassociatePersonasFromEntitiesRequest" + }, + "output": { + "target": "com.amazonaws.kendra#DisassociatePersonasFromEntitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kendra#AccessDeniedException" + }, + { + "target": "com.amazonaws.kendra#InternalServerException" + }, + { + "target": "com.amazonaws.kendra#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.kendra#ThrottlingException" + }, + { + "target": "com.amazonaws.kendra#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes the specific permissions of users or groups in your Amazon Web Services SSO \n identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra \n experience such as a search application. For more information on creating a \n search application experience, see Building a \n search experience with no code.
" + } + }, + "com.amazonaws.kendra#DisassociatePersonasFromEntitiesRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.kendra#ExperienceId", + "traits": { + "smithy.api#documentation": "The identifier of your Amazon Kendra experience.
", + "smithy.api#required": {} + } + }, + "IndexId": { + "target": "com.amazonaws.kendra#IndexId", + "traits": { + "smithy.api#documentation": "The identifier of the index for your Amazon Kendra experience.
", + "smithy.api#required": {} + } + }, + "EntityIds": { + "target": "com.amazonaws.kendra#EntityIdsList", + "traits": { + "smithy.api#documentation": "The identifiers of users or groups in your Amazon Web Services SSO identity \n source. For example, user IDs could be user emails.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.kendra#DisassociatePersonasFromEntitiesResponse": { + "type": "structure", + "members": { + "FailedEntityList": { + "target": "com.amazonaws.kendra#FailedEntityList", + "traits": { + "smithy.api#documentation": "Lists the users or groups in your Amazon Web Services SSO identity source that \n failed to properly remove access to your Amazon Kendra experience.
" + } + } + } + }, "com.amazonaws.kendra#Document": { "type": "structure", "members": { @@ -3875,6 +4621,34 @@ "smithy.api#documentation": "A custom attribute value assigned to a document.
" } }, + "com.amazonaws.kendra#DocumentAttributeCondition": { + "type": "structure", + "members": { + "ConditionDocumentAttributeKey": { + "target": "com.amazonaws.kendra#DocumentAttributeKey", + "traits": { + "smithy.api#documentation": "The identifier of the document attribute used for the condition.
\nFor example, 'Source_URI' could be an identifier for the attribute or metadata \n field that contains source URIs associated with the documents.
\nAmazon Kendra currently does not support _document_body as an attribute \n key used for the condition.
The condition operator.
\nFor example, you can use 'Contains' to partially match a string.
", + "smithy.api#required": {} + } + }, + "ConditionOnValue": { + "target": "com.amazonaws.kendra#DocumentAttributeValue", + "traits": { + "smithy.api#documentation": "The value used by the operator.
\nFor example, you can specify the value 'financial' for strings in the 'Source_URI'\n field that partially match or contain this value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The condition used for the target document attribute or metadata field when \n ingesting documents into Amazon Kendra. You use this with DocumentAttributeTarget \n to apply the condition.
\nFor example, you can create the 'Department' target field and have it prefill \n department names associated with the documents based on information in the \n 'Source_URI' field. Set the condition that if the 'Source_URI' field contains \n 'financial' in its URI value, then prefill the target field 'Department' with \n the target value 'Finance' for the document.
\nAmazon Kendra cannot create a target field if it has not already been created as an \n index field. After you create your index field, you can create a document metadata \n field using DocumentAttributeTarget. Amazon Kendra then will map your newly \n created metadata field to your index field.
A string, such as \"department\".
" + "smithy.api#documentation": "The identifier of the target document attribute or metadata field.
\nFor example, 'Department' could be an identifier for the target attribute or \n metadata field that includes the department names associated with the documents.
" } }, - "StringListValue": { - "target": "com.amazonaws.kendra#DocumentAttributeStringListValue", + "TargetDocumentAttributeValueDeletion": { + "target": "com.amazonaws.kendra#Boolean", "traits": { - "smithy.api#documentation": "A list of strings.
" + "smithy.api#documentation": "\n TRUE to delete the existing target value for your specified target \n attribute key. You cannot create a target value and set this to TRUE. \n To create a target value (TargetDocumentAttributeValue), set this to \n FALSE.
The target value you want to create for the target attribute.
\nFor example, 'Finance' could be the target value for the target attribute key\n 'Department'.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The target document attribute or metadata field you want to alter when ingesting\n documents into Amazon Kendra.
\nFor example, you can delete customer identification numbers associated with the\n documents, stored in the document metadata field called 'Customer_ID'. You set the\n target key as 'Customer_ID' and the deletion flag to TRUE. This\n removes all customer ID values in the field 'Customer_ID'. This would scrub \n personally identifiable information from each document's metadata.
Amazon Kendra cannot create a target field if it has not already been created as an \n index field. After you create your index field, you can create a document metadata \n field using DocumentAttributeTarget. Amazon Kendra then will map your newly \n created metadata field to your index field.
You can also use this with DocumentAttributeCondition.
" + } + }, + "com.amazonaws.kendra#DocumentAttributeValue": { + "type": "structure", + "members": { + "StringValue": { + "target": "com.amazonaws.kendra#DocumentAttributeStringValue", + "traits": { + "smithy.api#documentation": "A string, such as \"department\".
" + } + }, + "StringListValue": { + "target": "com.amazonaws.kendra#DocumentAttributeStringListValue", + "traits": { + "smithy.api#documentation": "A list of strings.
" } }, "LongValue": { @@ -4220,6 +5020,158 @@ "smithy.api#pattern": "^[0-9]+[s]$" } }, + "com.amazonaws.kendra#Endpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\P{C}*$" + } + }, + "com.amazonaws.kendra#EndpointType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HOME", + "name": "HOME" + } + ] + } + }, + "com.amazonaws.kendra#EntityConfiguration": { + "type": "structure", + "members": { + "EntityId": { + "target": "com.amazonaws.kendra#EntityId", + "traits": { + "smithy.api#documentation": "The identifier of a user or group in your Amazon Web Services SSO identity \n source. For example, a user ID could be an email.
", + "smithy.api#required": {} + } + }, + "EntityType": { + "target": "com.amazonaws.kendra#EntityType", + "traits": { + "smithy.api#documentation": "Specifies whether you are configuring a User or a\n Group.
Provides the configuration information of users or groups in \n your Amazon Web Services SSO identity source to grant access your Amazon Kendra \n experience.
" + } + }, + "com.amazonaws.kendra#EntityDisplayData": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.kendra#NameType", + "traits": { + "smithy.api#documentation": "The name of the user.
" + } + }, + "GroupName": { + "target": "com.amazonaws.kendra#NameType", + "traits": { + "smithy.api#documentation": "The name of the group.
" + } + }, + "IdentifiedUserName": { + "target": "com.amazonaws.kendra#NameType", + "traits": { + "smithy.api#documentation": "The user name of the user.
" + } + }, + "FirstName": { + "target": "com.amazonaws.kendra#NameType", + "traits": { + "smithy.api#documentation": "The first name of the user.
" + } + }, + "LastName": { + "target": "com.amazonaws.kendra#NameType", + "traits": { + "smithy.api#documentation": "The last name of the user.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the user entity.
" + } + }, + "com.amazonaws.kendra#EntityId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 47 + }, + "smithy.api#pattern": "^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$" + } + }, + "com.amazonaws.kendra#EntityIdsList": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#EntityId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.kendra#EntityPersonaConfiguration": { + "type": "structure", + "members": { + "EntityId": { + "target": "com.amazonaws.kendra#EntityId", + "traits": { + "smithy.api#documentation": "The identifier of a user or group in your Amazon Web Services SSO identity \n source. For example, a user ID could be an email.
", + "smithy.api#required": {} + } + }, + "Persona": { + "target": "com.amazonaws.kendra#Persona", + "traits": { + "smithy.api#documentation": "The persona that defines the specific permissions of the user or group \n in your Amazon Web Services SSO identity source. The available personas or \n access roles are Owner and Viewer. For more \n information on these personas, see Providing \n access to your search page.
Provides the configuration information of users or groups in your \n Amazon Web Services SSO identity source for access to your Amazon Kendra experience. \n Specific permissions are defined for each user or group once they are \n granted access to your Amazon Kendra experience.
" + } + }, + "com.amazonaws.kendra#EntityPersonaConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#EntityPersonaConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.kendra#EntityType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "USER", + "name": "USER" + }, + { + "value": "GROUP", + "name": "GROUP" + } + ] + } + }, "com.amazonaws.kendra#ErrorCode": { "type": "string", "traits": { @@ -4281,123 +5233,111 @@ } } }, - "com.amazonaws.kendra#Facet": { + "com.amazonaws.kendra#ExperienceConfiguration": { "type": "structure", "members": { - "DocumentAttributeKey": { - "target": "com.amazonaws.kendra#DocumentAttributeKey", + "ContentSourceConfiguration": { + "target": "com.amazonaws.kendra#ContentSourceConfiguration", "traits": { - "smithy.api#documentation": "The unique key for the document attribute.
" + "smithy.api#documentation": "The identifiers of your data sources and FAQs. Or, you can specify \n that you want to use documents indexed via the BatchPutDocument \n operation. This is the content you want to use for your Amazon Kendra experience.
The Amazon Web Services SSO field name that contains the identifiers of your users, \n such as their emails.
" } } }, "traits": { - "smithy.api#documentation": "Information about a document attribute
" + "smithy.api#documentation": "Specifies the configuration information for your Amazon Kendra experience. This includes \n the data source IDs and/or FAQ IDs, and user or group information to grant access \n to your Amazon Kendra experience.
" } }, - "com.amazonaws.kendra#FacetList": { + "com.amazonaws.kendra#ExperienceEndpoint": { + "type": "structure", + "members": { + "EndpointType": { + "target": "com.amazonaws.kendra#EndpointType", + "traits": { + "smithy.api#documentation": "The type of endpoint for your Amazon Kendra experience. The type currently available \n is HOME, which is a unique and fully hosted URL to the home page \n of your Amazon Kendra experience.
The endpoint of your Amazon Kendra experience.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides the configuration information of the endpoint for your Amazon Kendra\n experience.
" + } + }, + "com.amazonaws.kendra#ExperienceEndpoints": { "type": "list", "member": { - "target": "com.amazonaws.kendra#Facet" + "target": "com.amazonaws.kendra#ExperienceEndpoint" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } } }, - "com.amazonaws.kendra#FacetResult": { + "com.amazonaws.kendra#ExperienceEntitiesSummary": { "type": "structure", "members": { - "DocumentAttributeKey": { - "target": "com.amazonaws.kendra#DocumentAttributeKey", + "EntityId": { + "target": "com.amazonaws.kendra#EntityId", "traits": { - "smithy.api#documentation": "The key for the facet values. This is the same as the\n DocumentAttributeKey provided in the query.
The identifier of a user or group in your Amazon Web Services SSO identity source. \n For example, a user ID could be an email.
" } }, - "DocumentAttributeValueType": { - "target": "com.amazonaws.kendra#DocumentAttributeValueType", + "EntityType": { + "target": "com.amazonaws.kendra#EntityType", "traits": { - "smithy.api#documentation": "The data type of the facet value. This is the same as the type\n defined for the index field when it was created.
" + "smithy.api#documentation": "Shows the type as User or Group.
An array of key/value pairs, where the key is the value of the\n attribute and the count is the number of documents that share the key\n value.
" + "smithy.api#documentation": "Information about the user entity.
" } } }, "traits": { - "smithy.api#documentation": "The facet values for the documents in the response.
" + "smithy.api#documentation": "Summary information for users or groups in your Amazon Web Services SSO identity\n source with granted access to your Amazon Kendra experience. You can create an Amazon Kendra \n experience such as a search application. For more information on creating a \n search application experience, see Building \n a search experience with no code.
" } }, - "com.amazonaws.kendra#FacetResultList": { + "com.amazonaws.kendra#ExperienceEntitiesSummaryList": { "type": "list", "member": { - "target": "com.amazonaws.kendra#FacetResult" - } - }, - "com.amazonaws.kendra#FailureReason": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^\\P{C}*$" - } - }, - "com.amazonaws.kendra#FaqFileFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CSV", - "name": "CSV" - }, - { - "value": "CSV_WITH_HEADER", - "name": "CSV_WITH_HEADER" - }, - { - "value": "JSON", - "name": "JSON" - } - ] + "target": "com.amazonaws.kendra#ExperienceEntitiesSummary" } }, - "com.amazonaws.kendra#FaqId": { + "com.amazonaws.kendra#ExperienceId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, - "max": 100 + "max": 36 }, "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$" } }, - "com.amazonaws.kendra#FaqName": { + "com.amazonaws.kendra#ExperienceName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, - "max": 100 + "max": 1000 }, "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$" } }, - "com.amazonaws.kendra#FaqStatistics": { - "type": "structure", - "members": { - "IndexedQuestionAnswersCount": { - "target": "com.amazonaws.kendra#IndexedQuestionAnswersCount", - "traits": { - "smithy.api#documentation": "The total number of FAQ questions and answers contained in the\n index.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Provides statistical information about the FAQ questions and\n answers contained in an index.
" - } - }, - "com.amazonaws.kendra#FaqStatus": { + "com.amazonaws.kendra#ExperienceStatus": { "type": "string", "traits": { "smithy.api#enum": [ @@ -4405,10 +5345,6 @@ "value": "CREATING", "name": "CREATING" }, - { - "value": "UPDATING", - "name": "UPDATING" - }, { "value": "ACTIVE", "name": "ACTIVE" @@ -4424,64 +5360,295 @@ ] } }, - "com.amazonaws.kendra#FaqSummary": { + "com.amazonaws.kendra#ExperiencesSummary": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.kendra#FaqId", - "traits": { - "smithy.api#documentation": "The unique identifier of the FAQ.
" - } - }, "Name": { - "target": "com.amazonaws.kendra#FaqName", + "target": "com.amazonaws.kendra#ExperienceName", "traits": { - "smithy.api#documentation": "The name that you assigned the FAQ when you created or updated the\n FAQ.
" + "smithy.api#documentation": "The name of your Amazon Kendra experience.
" } }, - "Status": { - "target": "com.amazonaws.kendra#FaqStatus", + "Id": { + "target": "com.amazonaws.kendra#ExperienceId", "traits": { - "smithy.api#documentation": "The current status of the FAQ. When the status is\n ACTIVE the FAQ is ready for use.
The identifier of your Amazon Kendra experience.
" } }, "CreatedAt": { "target": "com.amazonaws.kendra#Timestamp", "traits": { - "smithy.api#documentation": "The UNIX datetime that the FAQ was added to the index.
" - } - }, - "UpdatedAt": { - "target": "com.amazonaws.kendra#Timestamp", - "traits": { - "smithy.api#documentation": "The UNIX datetime that the FAQ was last updated.
" + "smithy.api#documentation": "The date-time your Amazon Kendra experience was created.
" } }, - "FileFormat": { - "target": "com.amazonaws.kendra#FaqFileFormat", + "Status": { + "target": "com.amazonaws.kendra#ExperienceStatus", "traits": { - "smithy.api#documentation": "The file type used to create the FAQ.
" + "smithy.api#documentation": "The processing status of your Amazon Kendra experience.
" } }, - "LanguageCode": { - "target": "com.amazonaws.kendra#LanguageCode", + "Endpoints": { + "target": "com.amazonaws.kendra#ExperienceEndpoints", "traits": { - "smithy.api#documentation": "The code for a language. This shows a supported language for the FAQ document \n as part of the summary information for FAQs. English is supported by default. \n For more information on supported languages, including their codes, \n see Adding \n documents in languages other than English.
" + "smithy.api#documentation": "The endpoint URLs for your Amazon Kendra experiences. The URLs are unique \n and fully hosted by Amazon Web Services.
" } } }, "traits": { - "smithy.api#documentation": "Provides information about a frequently asked questions and answer\n contained in an index.
" + "smithy.api#documentation": "Summary information for your Amazon Kendra experience. You can create an Amazon Kendra \n experience such as a search application. For more information on creating \n a search application experience, see Building \n a search experience with no code.
" } }, - "com.amazonaws.kendra#FaqSummaryItems": { + "com.amazonaws.kendra#ExperiencesSummaryList": { "type": "list", "member": { - "target": "com.amazonaws.kendra#FaqSummary" + "target": "com.amazonaws.kendra#ExperiencesSummary" } }, - "com.amazonaws.kendra#FeedbackToken": { - "type": "string", + "com.amazonaws.kendra#Facet": { + "type": "structure", + "members": { + "DocumentAttributeKey": { + "target": "com.amazonaws.kendra#DocumentAttributeKey", + "traits": { + "smithy.api#documentation": "The unique key for the document attribute.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a document attribute
" + } + }, + "com.amazonaws.kendra#FacetList": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#Facet" + } + }, + "com.amazonaws.kendra#FacetResult": { + "type": "structure", + "members": { + "DocumentAttributeKey": { + "target": "com.amazonaws.kendra#DocumentAttributeKey", + "traits": { + "smithy.api#documentation": "The key for the facet values. This is the same as the\n DocumentAttributeKey provided in the query.
The data type of the facet value. This is the same as the type\n defined for the index field when it was created.
" + } + }, + "DocumentAttributeValueCountPairs": { + "target": "com.amazonaws.kendra#DocumentAttributeValueCountPairList", + "traits": { + "smithy.api#documentation": "An array of key/value pairs, where the key is the value of the\n attribute and the count is the number of documents that share the key\n value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The facet values for the documents in the response.
" + } + }, + "com.amazonaws.kendra#FacetResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#FacetResult" + } + }, + "com.amazonaws.kendra#FailedEntity": { + "type": "structure", + "members": { + "EntityId": { + "target": "com.amazonaws.kendra#EntityId", + "traits": { + "smithy.api#documentation": "The identifier of the user or group in your Amazon Web Services SSO identity \n source. For example, a user ID could be an email.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.kendra#ErrorMessage", + "traits": { + "smithy.api#documentation": "The reason the user or group in your Amazon Web Services SSO identity source \n failed to properly configure with your Amazon Kendra experience.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information on the users or groups in your Amazon Web Services SSO identity \n source that failed to properly configure with your Amazon Kendra experience.
" + } + }, + "com.amazonaws.kendra#FailedEntityList": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#FailedEntity" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.kendra#FailureReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\P{C}*$" + } + }, + "com.amazonaws.kendra#FaqFileFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CSV", + "name": "CSV" + }, + { + "value": "CSV_WITH_HEADER", + "name": "CSV_WITH_HEADER" + }, + { + "value": "JSON", + "name": "JSON" + } + ] + } + }, + "com.amazonaws.kendra#FaqId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$" + } + }, + "com.amazonaws.kendra#FaqIdsList": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#FaqId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.kendra#FaqName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$" + } + }, + "com.amazonaws.kendra#FaqStatistics": { + "type": "structure", + "members": { + "IndexedQuestionAnswersCount": { + "target": "com.amazonaws.kendra#IndexedQuestionAnswersCount", + "traits": { + "smithy.api#documentation": "The total number of FAQ questions and answers contained in the\n index.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides statistical information about the FAQ questions and\n answers contained in an index.
" + } + }, + "com.amazonaws.kendra#FaqStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "UPDATING", + "name": "UPDATING" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "DELETING", + "name": "DELETING" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.kendra#FaqSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.kendra#FaqId", + "traits": { + "smithy.api#documentation": "The unique identifier of the FAQ.
" + } + }, + "Name": { + "target": "com.amazonaws.kendra#FaqName", + "traits": { + "smithy.api#documentation": "The name that you assigned the FAQ when you created or updated the\n FAQ.
" + } + }, + "Status": { + "target": "com.amazonaws.kendra#FaqStatus", + "traits": { + "smithy.api#documentation": "The current status of the FAQ. When the status is\n ACTIVE the FAQ is ready for use.
The UNIX datetime that the FAQ was added to the index.
" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.kendra#Timestamp", + "traits": { + "smithy.api#documentation": "The UNIX datetime that the FAQ was last updated.
" + } + }, + "FileFormat": { + "target": "com.amazonaws.kendra#FaqFileFormat", + "traits": { + "smithy.api#documentation": "The file type used to create the FAQ.
" + } + }, + "LanguageCode": { + "target": "com.amazonaws.kendra#LanguageCode", + "traits": { + "smithy.api#documentation": "The code for a language. This shows a supported language for the FAQ document \n as part of the summary information for FAQs. English is supported by default. \n For more information on supported languages, including their codes, \n see Adding \n documents in languages other than English.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information about a frequently asked questions and answer\n contained in an index.
" + } + }, + "com.amazonaws.kendra#FaqSummaryItems": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#FaqSummary" + } + }, + "com.amazonaws.kendra#FeedbackToken": { + "type": "string", "traits": { "smithy.api#length": { "min": 1, @@ -4522,7 +5689,7 @@ } ], "traits": { - "smithy.api#documentation": "Fetches the queries that are suggested to your users.
" + "smithy.api#documentation": "Fetches the queries that are suggested to your users.
\n\n GetQuerySuggestions is currently not supported in the \n Amazon Web Services GovCloud (US-West) region.
Retrieves search metrics data. The data provides a snapshot of how\n your users interact with your search application and how effective\n the application is.
" + } + }, + "com.amazonaws.kendra#GetSnapshotsRequest": { + "type": "structure", + "members": { + "IndexId": { + "target": "com.amazonaws.kendra#IndexId", + "traits": { + "smithy.api#documentation": "The identifier of the index to get search metrics data.
", + "smithy.api#required": {} + } + }, + "Interval": { + "target": "com.amazonaws.kendra#Interval", + "traits": { + "smithy.api#documentation": "The time interval or time window to get search metrics data. \n The time interval uses the time zone of your index. \n You can view data in the following time windows:
\n\n THIS_WEEK: The current week, starting on \n the Sunday and ending on the day before the current date.
\n ONE_WEEK_AGO: The previous week, starting on \n the Sunday and ending on the following Saturday.
\n TWO_WEEKS_AGO: The week before the previous week, \n starting on the Sunday and ending on the following Saturday.
\n THIS_MONTH: The current month, starting on the \n first day of the month and ending on the day before the current date.
\n ONE_MONTH_AGO: The previous month, starting on the \n first day of the month and ending on the last day of the month.
\n TWO_MONTHS_AGO: The month before the previous month, \n starting on the first day of the month and ending on last day of the month.
The metric you want to retrieve. You\n can specify only one metric per call.
\nFor more information about the metrics you can view, see \n Gaining \n insights with search analytics.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.kendra#NextToken", + "traits": { + "smithy.api#documentation": "If the previous response was incomplete (because there\n is more data to retrieve), Amazon Kendra returns a pagination token in \n the response. You can use this pagination token to\n retrieve the next set of search metrics data.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.kendra#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of returned data for the metric.
" + } + } + } + }, + "com.amazonaws.kendra#GetSnapshotsResponse": { + "type": "structure", + "members": { + "SnapShotTimeFilter": { + "target": "com.amazonaws.kendra#TimeRange", + "traits": { + "smithy.api#documentation": "The date-time for the beginning and end of the time window \n for the search metrics data.
" + } + }, + "SnapshotsDataHeader": { + "target": "com.amazonaws.kendra#SnapshotsDataHeaderFields", + "traits": { + "smithy.api#documentation": "The column headers for the search metrics data.
" + } + }, + "SnapshotsData": { + "target": "com.amazonaws.kendra#SnapshotsDataRecords", + "traits": { + "smithy.api#documentation": "The search metrics data. The data returned depends on the \n metric type you requested.
" + } + }, + "NextToken": { + "target": "com.amazonaws.kendra#NextToken", + "traits": { + "smithy.api#documentation": "If the response is truncated, Amazon Kendra returns this\n token, which you can use in a later request to retrieve the \n next set of search metrics data.
" + } + } + } + }, "com.amazonaws.kendra#GoogleDriveConfiguration": { "type": "structure", "members": { @@ -4829,6 +6089,34 @@ ] } }, + "com.amazonaws.kendra#HookConfiguration": { + "type": "structure", + "members": { + "InvocationCondition": { + "target": "com.amazonaws.kendra#DocumentAttributeCondition", + "traits": { + "smithy.api#documentation": "The condition used for when a Lambda function should be invoked.
\nFor example, you can specify a condition that if there are empty date-time\n values, then Amazon Kendra should invoke a function that inserts the current date-time.
" + } + }, + "LambdaArn": { + "target": "com.amazonaws.kendra#LambdaArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to run a Lambda function\n during ingestion. For more information, see IAM roles for Amazon Kendra.
", + "smithy.api#required": {} + } + }, + "S3Bucket": { + "target": "com.amazonaws.kendra#S3BucketName", + "traits": { + "smithy.api#documentation": "Stores the original, raw documents or the structured, parsed\n documents before and after altering them. For more information, \n see Data \n contracts for Lambda functions.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides the configuration information for invoking a Lambda function in \n Lambda to alter document metadata and content when ingesting \n documents into Amazon Kendra. You can configure your Lambda function using \n PreExtractionHookConfiguration \n if you want to apply advanced alterations on the original or raw documents. \n If you want to apply advanced alterations on the Amazon Kendra structured documents, \n you must configure your Lambda function using PostExtractionHookConfiguration. \n You can only invoke one Lambda function. However, this function can invoke other \n functions it requires.
\nFor more information, see Customizing document metadata\n during the ingestion process.
" + } + }, "com.amazonaws.kendra#Host": { "type": "string", "traits": { @@ -4839,6 +6127,16 @@ "smithy.api#pattern": "^([^\\s]*)$" } }, + "com.amazonaws.kendra#IdentityAttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$" + } + }, "com.amazonaws.kendra#Importance": { "type": "integer", "traits": { @@ -5024,13 +6322,95 @@ } } }, + "com.amazonaws.kendra#InlineCustomDocumentEnrichmentConfiguration": { + "type": "structure", + "members": { + "Condition": { + "target": "com.amazonaws.kendra#DocumentAttributeCondition", + "traits": { + "smithy.api#documentation": "Configuration of the condition used for the target document attribute or metadata\n field when ingesting documents into Amazon Kendra.
" + } + }, + "Target": { + "target": "com.amazonaws.kendra#DocumentAttributeTarget", + "traits": { + "smithy.api#documentation": "Configuration of the target document attribute or metadata field when ingesting\n documents into Amazon Kendra. You can also include a value.
" + } + }, + "DocumentContentDeletion": { + "target": "com.amazonaws.kendra#Boolean", + "traits": { + "smithy.api#documentation": "\n TRUE to delete content if the condition used for the target \n attribute is met.
Provides the configuration information for applying basic logic to alter document\n metadata and content when ingesting documents into Amazon Kendra. To apply advanced \n logic, to go beyond what you can do with basic logic, see HookConfiguration.
\nFor more information, see Customizing document metadata\n during the ingestion process.
" + } + }, + "com.amazonaws.kendra#InlineCustomDocumentEnrichmentConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#InlineCustomDocumentEnrichmentConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.kendra#Integer": { "type": "integer", "traits": { "smithy.api#box": {} } }, - "com.amazonaws.kendra#InternalServerException": { + "com.amazonaws.kendra#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.kendra#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.kendra#Interval": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "THIS_MONTH", + "name": "THIS_MONTH" + }, + { + "value": "THIS_WEEK", + "name": "THIS_WEEK" + }, + { + "value": "ONE_WEEK_AGO", + "name": "ONE_WEEK_AGO" + }, + { + "value": "TWO_WEEKS_AGO", + "name": "TWO_WEEKS_AGO" + }, + { + "value": "ONE_MONTH_AGO", + "name": "ONE_MONTH_AGO" + }, + { + "value": "TWO_MONTHS_AGO", + "name": "TWO_MONTHS_AGO" + } + ] + } + }, + "com.amazonaws.kendra#InvalidRequestException": { "type": "structure", "members": { "Message": { @@ -5038,9 +6418,9 @@ } }, "traits": { - "smithy.api#documentation": "", - "smithy.api#error": "server", - "smithy.api#httpError": 500 + "smithy.api#documentation": "The input to the request is not valid.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 } }, "com.amazonaws.kendra#Issuer": { @@ -5138,45 +6518,306 @@ "value": "SECRET_MANAGER", "name": "SECRET_MANAGER" } - ] - } - }, - "com.amazonaws.kendra#KmsKeyId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 + ] + } + }, + "com.amazonaws.kendra#KmsKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.kendra#LambdaArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^/arn:aws[a-zA-Z-]*:lambda:[a-z]+-[a-z]+-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?/$" + } + }, + "com.amazonaws.kendra#LanguageCode": { + "type": "string", + "traits": { + "smithy.api#documentation": "The code for a language. The default language is English. \n For more information on supported languages, including their codes, \n see Adding \n documents in languages other than English.
", + "smithy.api#length": { + "min": 2, + "max": 10 + }, + "smithy.api#pattern": "^[a-zA-Z-]*$" + } + }, + "com.amazonaws.kendra#ListDataSourceSyncJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.kendra#ListDataSourceSyncJobsRequest" + }, + "output": { + "target": "com.amazonaws.kendra#ListDataSourceSyncJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kendra#AccessDeniedException" + }, + { + "target": "com.amazonaws.kendra#ConflictException" + }, + { + "target": "com.amazonaws.kendra#InternalServerException" + }, + { + "target": "com.amazonaws.kendra#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.kendra#ThrottlingException" + }, + { + "target": "com.amazonaws.kendra#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets statistics about synchronizing Amazon Kendra with a data\n source.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.kendra#ListDataSourceSyncJobsRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.kendra#DataSourceId", + "traits": { + "smithy.api#documentation": "The identifier of the data source.
", + "smithy.api#required": {} + } + }, + "IndexId": { + "target": "com.amazonaws.kendra#IndexId", + "traits": { + "smithy.api#documentation": "The identifier of the index that contains the data source.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.kendra#NextToken", + "traits": { + "smithy.api#documentation": "If the previous response was incomplete (because there is more data to retrieve), \n Amazon Kendra returns a pagination token in the response. You can use this pagination token \n to retrieve the next set of jobs.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.kendra#MaxResultsIntegerForListDataSourceSyncJobsRequest", + "traits": { + "smithy.api#documentation": "The maximum number of synchronization jobs to return in the response.\n If there are fewer results in the list, this response contains only the\n actual results.
" + } + }, + "StartTimeFilter": { + "target": "com.amazonaws.kendra#TimeRange", + "traits": { + "smithy.api#documentation": "When specified, the synchronization jobs returned in the list are\n limited to jobs between the specified dates.
" + } + }, + "StatusFilter": { + "target": "com.amazonaws.kendra#DataSourceSyncJobStatus", + "traits": { + "smithy.api#documentation": "When specified, only returns synchronization jobs with the\n Status field equal to the specified status.
A history of synchronization jobs for the data source.
" + } + }, + "NextToken": { + "target": "com.amazonaws.kendra#NextToken", + "traits": { + "smithy.api#documentation": "If the response is truncated, Amazon Kendra returns this token that you \n can use in the subsequent request to retrieve the next set of jobs.
" + } + } + } + }, + "com.amazonaws.kendra#ListDataSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.kendra#ListDataSourcesRequest" + }, + "output": { + "target": "com.amazonaws.kendra#ListDataSourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kendra#AccessDeniedException" + }, + { + "target": "com.amazonaws.kendra#InternalServerException" + }, + { + "target": "com.amazonaws.kendra#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.kendra#ThrottlingException" + }, + { + "target": "com.amazonaws.kendra#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the data sources that you have created.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.kendra#ListDataSourcesRequest": { + "type": "structure", + "members": { + "IndexId": { + "target": "com.amazonaws.kendra#IndexId", + "traits": { + "smithy.api#documentation": "The identifier of the index that contains the data source.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.kendra#NextToken", + "traits": { + "smithy.api#documentation": "If the previous response was incomplete (because there is more data to\n retrieve), Amazon Kendra returns a pagination token in the response. You\n can use this pagination token to retrieve the next set of data sources\n (DataSourceSummaryItems).
The maximum number of data sources to return.
" + } + } + } + }, + "com.amazonaws.kendra#ListDataSourcesResponse": { + "type": "structure", + "members": { + "SummaryItems": { + "target": "com.amazonaws.kendra#DataSourceSummaryList", + "traits": { + "smithy.api#documentation": "An array of summary information for one or more data sources.
" + } + }, + "NextToken": { + "target": "com.amazonaws.kendra#NextToken", + "traits": { + "smithy.api#documentation": "If the response is truncated, Amazon Kendra returns this token that you\n can use in the subsequent request to retrieve the next set of data\n sources.
" + } + } + } + }, + "com.amazonaws.kendra#ListEntityPersonas": { + "type": "operation", + "input": { + "target": "com.amazonaws.kendra#ListEntityPersonasRequest" + }, + "output": { + "target": "com.amazonaws.kendra#ListEntityPersonasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kendra#AccessDeniedException" + }, + { + "target": "com.amazonaws.kendra#InternalServerException" + }, + { + "target": "com.amazonaws.kendra#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.kendra#ThrottlingException" + }, + { + "target": "com.amazonaws.kendra#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists specific permissions of users and groups with access to your \n Amazon Kendra experience.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.kendra#ListEntityPersonasRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.kendra#ExperienceId", + "traits": { + "smithy.api#documentation": "The identifier of your Amazon Kendra experience.
", + "smithy.api#required": {} + } + }, + "IndexId": { + "target": "com.amazonaws.kendra#IndexId", + "traits": { + "smithy.api#documentation": "The identifier of the index for your Amazon Kendra experience.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.kendra#NextToken", + "traits": { + "smithy.api#documentation": "If the previous response was incomplete (because there is more data to retrieve),\n Amazon Kendra returns a pagination token in the response. You can use this pagination \n token to retrieve the next set of users or groups.
" + } }, - "smithy.api#sensitive": {} + "MaxResults": { + "target": "com.amazonaws.kendra#MaxResultsIntegerForListEntityPersonasRequest", + "traits": { + "smithy.api#documentation": "The maximum number of returned users or groups.
" + } + } } }, - "com.amazonaws.kendra#LanguageCode": { - "type": "string", - "traits": { - "smithy.api#documentation": "The code for a language. The default language is English. \n For more information on supported languages, including their codes, \n see Adding \n documents in languages other than English.
", - "smithy.api#length": { - "min": 2, - "max": 10 + "com.amazonaws.kendra#ListEntityPersonasResponse": { + "type": "structure", + "members": { + "SummaryItems": { + "target": "com.amazonaws.kendra#PersonasSummaryList", + "traits": { + "smithy.api#documentation": "An array of summary information for one or more users or groups.
" + } }, - "smithy.api#pattern": "^[a-zA-Z-]*$" + "NextToken": { + "target": "com.amazonaws.kendra#NextToken", + "traits": { + "smithy.api#documentation": "If the response is truncated, Amazon Kendra returns this token, which you can use in \n a later request to retrieve the next set of users or groups.
" + } + } } }, - "com.amazonaws.kendra#ListDataSourceSyncJobs": { + "com.amazonaws.kendra#ListExperienceEntities": { "type": "operation", "input": { - "target": "com.amazonaws.kendra#ListDataSourceSyncJobsRequest" + "target": "com.amazonaws.kendra#ListExperienceEntitiesRequest" }, "output": { - "target": "com.amazonaws.kendra#ListDataSourceSyncJobsResponse" + "target": "com.amazonaws.kendra#ListExperienceEntitiesResponse" }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" }, - { - "target": "com.amazonaws.kendra#ConflictException" - }, { "target": "com.amazonaws.kendra#InternalServerException" }, @@ -5191,81 +6832,62 @@ } ], "traits": { - "smithy.api#documentation": "Gets statistics about synchronizing Amazon Kendra with a data\n source.
", + "smithy.api#documentation": "Lists users or groups in your Amazon Web Services SSO identity source that are \n granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience \n such as a search application. For more information on creating a search \n application experience, see Building \n a search experience with no code.
", "smithy.api#paginated": { "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" + "outputToken": "NextToken" } } }, - "com.amazonaws.kendra#ListDataSourceSyncJobsRequest": { + "com.amazonaws.kendra#ListExperienceEntitiesRequest": { "type": "structure", "members": { "Id": { - "target": "com.amazonaws.kendra#DataSourceId", + "target": "com.amazonaws.kendra#ExperienceId", "traits": { - "smithy.api#documentation": "The identifier of the data source.
", + "smithy.api#documentation": "The identifier of your Amazon Kendra experience.
", "smithy.api#required": {} } }, "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index that contains the data source.
", + "smithy.api#documentation": "The identifier of the index for your Amazon Kendra experience.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.kendra#NextToken", "traits": { - "smithy.api#documentation": "If the previous response was incomplete (because there is more data to retrieve), \n Amazon Kendra returns a pagination token in the response. You can use this pagination token \n to retrieve the next set of jobs.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.kendra#MaxResultsIntegerForListDataSourceSyncJobsRequest", - "traits": { - "smithy.api#documentation": "The maximum number of synchronization jobs to return in the response.\n If there are fewer results in the list, this response contains only the\n actual results.
" - } - }, - "StartTimeFilter": { - "target": "com.amazonaws.kendra#TimeRange", - "traits": { - "smithy.api#documentation": "When specified, the synchronization jobs returned in the list are\n limited to jobs between the specified dates.
" - } - }, - "StatusFilter": { - "target": "com.amazonaws.kendra#DataSourceSyncJobStatus", - "traits": { - "smithy.api#documentation": "When specified, only returns synchronization jobs with the\n Status field equal to the specified status.
If the previous response was incomplete (because there is more data to retrieve),\n Amazon Kendra returns a pagination token in the response. You can use this pagination \n token to retrieve the next set of users or groups.
" } } } }, - "com.amazonaws.kendra#ListDataSourceSyncJobsResponse": { + "com.amazonaws.kendra#ListExperienceEntitiesResponse": { "type": "structure", "members": { - "History": { - "target": "com.amazonaws.kendra#DataSourceSyncJobHistoryList", + "SummaryItems": { + "target": "com.amazonaws.kendra#ExperienceEntitiesSummaryList", "traits": { - "smithy.api#documentation": "A history of synchronization jobs for the data source.
" + "smithy.api#documentation": "An array of summary information for one or more users or groups.
" } }, "NextToken": { "target": "com.amazonaws.kendra#NextToken", "traits": { - "smithy.api#documentation": "If the response is truncated, Amazon Kendra returns this token that you \n can use in the subsequent request to retrieve the next set of jobs.
" + "smithy.api#documentation": "If the response is truncated, Amazon Kendra returns this token, which you can use in \n a later request to retrieve the next set of users or groups.
" } } } }, - "com.amazonaws.kendra#ListDataSources": { + "com.amazonaws.kendra#ListExperiences": { "type": "operation", "input": { - "target": "com.amazonaws.kendra#ListDataSourcesRequest" + "target": "com.amazonaws.kendra#ListExperiencesRequest" }, "output": { - "target": "com.amazonaws.kendra#ListDataSourcesResponse" + "target": "com.amazonaws.kendra#ListExperiencesResponse" }, "errors": [ { @@ -5285,7 +6907,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the data sources that you have created.
", + "smithy.api#documentation": "Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience such \n as a search application. For more information on creating a search application \n experience, see Building a \n search experience with no code.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5293,43 +6915,43 @@ } } }, - "com.amazonaws.kendra#ListDataSourcesRequest": { + "com.amazonaws.kendra#ListExperiencesRequest": { "type": "structure", "members": { "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index that contains the data source.
", + "smithy.api#documentation": "The identifier of the index for your Amazon Kendra experience.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.kendra#NextToken", "traits": { - "smithy.api#documentation": "If the previous response was incomplete (because there is more data to\n retrieve), Amazon Kendra returns a pagination token in the response. You\n can use this pagination token to retrieve the next set of data sources\n (DataSourceSummaryItems).
If the previous response was incomplete (because there is more data\n to retrieve), Amazon Kendra returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Kendra experiences.
" } }, "MaxResults": { - "target": "com.amazonaws.kendra#MaxResultsIntegerForListDataSourcesRequest", + "target": "com.amazonaws.kendra#MaxResultsIntegerForListExperiencesRequest", "traits": { - "smithy.api#documentation": "The maximum number of data sources to return.
" + "smithy.api#documentation": "The maximum number of returned Amazon Kendra experiences.
" } } } }, - "com.amazonaws.kendra#ListDataSourcesResponse": { + "com.amazonaws.kendra#ListExperiencesResponse": { "type": "structure", "members": { "SummaryItems": { - "target": "com.amazonaws.kendra#DataSourceSummaryList", + "target": "com.amazonaws.kendra#ExperiencesSummaryList", "traits": { - "smithy.api#documentation": "An array of summary information for one or more data sources.
" + "smithy.api#documentation": "An array of summary information for one or more Amazon Kendra experiences.
" } }, "NextToken": { "target": "com.amazonaws.kendra#NextToken", "traits": { - "smithy.api#documentation": "If the response is truncated, Amazon Kendra returns this token that you\n can use in the subsequent request to retrieve the next set of data\n sources.
" + "smithy.api#documentation": "If the response is truncated, Amazon Kendra returns this token, which you can use \n in a later request to retrieve the next set of Amazon Kendra experiences.
" } } } @@ -5433,7 +7055,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides a list of groups that are mapped to users before a \n given ordering or timestamp identifier.
" + "smithy.api#documentation": "Provides a list of groups that are mapped to users before a \n given ordering or timestamp identifier.
\n\n ListGroupsOlderThanOrderingId is currently not supported in the \n Amazon Web Services GovCloud (US-West) region.
Lists the block lists used for query suggestions for an index.
\nFor information on the current quota limits for block lists, see \n Quotas \n for Amazon Kendra.
" + "smithy.api#documentation": "Lists the block lists used for query suggestions for an index.
\nFor information on the current quota limits for block lists, see \n Quotas \n for Amazon Kendra.
\n\n ListQuerySuggestionsBlockLists is currently not supported in the \n Amazon Web Services GovCloud (US-West) region.
The identifier of a user or group in your Amazon Web Services SSO identity source. \n For example, a user ID could be an email.
" + } + }, + "Persona": { + "target": "com.amazonaws.kendra#Persona", + "traits": { + "smithy.api#documentation": "The persona that defines the specific permissions of the user or group in \n your Amazon Web Services SSO identity source. The available personas or access \n roles are Owner and Viewer. For more information on \n these personas, see Providing \n access to your search page.
The date-time the summary information was created.
" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.kendra#Timestamp", + "traits": { + "smithy.api#documentation": "The date-time the summary information was last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information for users or groups in your Amazon Web Services SSO identity \n source. This applies to users and groups with specific permissions that define \n their level of access to your Amazon Kendra experience. You can create an Amazon Kendra experience \n such as a search application. For more information on creating a search application \n experience, see Building a \n search experience with no code.
" + } + }, + "com.amazonaws.kendra#PersonasSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#PersonasSummary" + } + }, "com.amazonaws.kendra#Port": { "type": "integer", "traits": { @@ -6238,7 +7975,7 @@ "Credentials": { "target": "com.amazonaws.kendra#SecretArn", "traits": { - "smithy.api#documentation": "Your secret ARN, which you can create in AWS Secrets Manager\n
\nThe credentials are optional. You use a secret if web proxy credentials \n are required to connect to a website host. Amazon Kendra currently support basic \n authentication to connect to a web proxy server. The secret stores your \n credentials.
" + "smithy.api#documentation": "Your secret ARN, which you can create in Secrets Manager\n
\nThe credentials are optional. You use a secret if web proxy credentials \n are required to connect to a website host. Amazon Kendra currently support basic \n authentication to connect to a web proxy server. The secret stores your \n credentials.
" } } }, @@ -6275,7 +8012,7 @@ } ], "traits": { - "smithy.api#documentation": "Maps users to their groups so that you only need to provide \n the user ID when you issue the query.
\nYou can also map sub groups to groups. \n For example, the group \"Company Intellectual Property Teams\" includes \n sub groups \"Research\" and \"Engineering\". These sub groups include their\n own list of users or people who work in these teams. Only users who work \n in research and engineering, and therefore belong in the intellectual \n property group, can see top-secret company documents in their search \n results.
\nYou map users to their groups when you want to filter search results \n for different users based on their group’s access to documents. For more \n information on filtering search results for different users, see \n Filtering \n on user context.
\nIf more than five PUT actions for a group are currently \n processing, a validation exception is thrown.
Maps users to their groups so that you only need to provide \n the user ID when you issue the query.
\nYou can also map sub groups to groups. \n For example, the group \"Company Intellectual Property Teams\" includes \n sub groups \"Research\" and \"Engineering\". These sub groups include their\n own list of users or people who work in these teams. Only users who work \n in research and engineering, and therefore belong in the intellectual \n property group, can see top-secret company documents in their search \n results.
\nYou map users to their groups when you want to filter search results \n for different users based on their group’s access to documents. For more \n information on filtering search results for different users, see \n Filtering \n on user context.
\nIf more than five PUT actions for a group are currently \n processing, a validation exception is thrown.
\n PutPrincipalMapping is currently not supported in the \n Amazon Web Services GovCloud (US-West) region.
Provides the configuration information of the seed or starting point URLs to crawl.
\n\n When selecting websites to index, you must adhere to \n the Amazon Acceptable Use Policy \n and all other Amazon terms. Remember that you must only use the Amazon Kendra web \n crawler to index your own webpages, or webpages that you have authorization \n to index.\n
" + "smithy.api#documentation": "Provides the configuration information of the seed or starting point URLs to crawl.
\n\n When selecting websites to index, you must adhere to \n the Amazon Acceptable Use Policy \n and all other Amazon terms. Remember that you must only use Amazon Kendra Web \n Crawler to index your own webpages, or webpages that you have authorization \n to index.\n
" } }, "com.amazonaws.kendra#SeedUrlList": { @@ -7608,7 +9345,7 @@ "AuthenticationType": { "target": "com.amazonaws.kendra#ServiceNowAuthenticationType", "traits": { - "smithy.api#documentation": "Determines the type of authentication used to connect to the\n ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is\n authenticated using the user name and password provided in the AWS\n Secrets Manager secret in the SecretArn field. When you\n choose OAUTH2, Amazon Kendra is authenticated using the OAuth\n token and secret provided in the Secrets Manager secret, and the\n user name and password are used to determine which information Amazon Kendra\n has access to.
When you use OAUTH2 authentication, you must generate\n a token and a client secret using the ServiceNow console. For more\n information, see Using a\n ServiceNow data source.
Determines the type of authentication used to connect to the\n ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is\n authenticated using the user name and password provided in the \n Secrets Manager secret in the SecretArn field. When you\n choose OAUTH2, Amazon Kendra is authenticated using the OAuth\n token and secret provided in the Secrets Manager secret, and the\n user name and password are used to determine which information Amazon Kendra\n has access to.
When you use OAUTH2 authentication, you must generate\n a token and a client secret using the ServiceNow console. For more\n information, see Using a\n ServiceNow data source.
The Amazon Resource Name (ARN) of credentials stored in \n Secrets Manager. The credentials should be a user/password pair. \n If you use SharePoint Server, you also need to provide the sever \n domain name as part of the credentials. For\n more information, see Using a\n Microsoft SharePoint Data Source. For more information\n about Secrets Manager, see What Is \n Secrets Manager in the Secrets Manager\n user guide.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of credentials stored in \n Secrets Manager. The credentials should be a user/password pair. \n If you use SharePoint Server, you also need to provide the sever \n domain name as part of the credentials. For\n more information, see Using a\n Microsoft SharePoint Data Source. For more information\n about Secrets Manager see What Is \n Secrets Manager in the Secrets Manager\n user guide.
", "smithy.api#required": {} } }, @@ -7885,7 +9622,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides the configuration information of the sitemap URLs to crawl.
\n\n When selecting websites to index, you must adhere to \n the Amazon Acceptable Use Policy \n and all other Amazon terms. Remember that you must only use the Amazon Kendra web \n crawler to index your own webpages, or webpages that you have authorization \n to index.\n
" + "smithy.api#documentation": "Provides the configuration information of the sitemap URLs to crawl.
\n\n When selecting websites to index, you must adhere to \n the Amazon Acceptable Use Policy \n and all other Amazon terms. Remember that you must only use Amazon Kendra Web \n Crawler to index your own webpages, or webpages that you have authorization \n to index.\n
" } }, "com.amazonaws.kendra#SiteMapsList": { @@ -7900,6 +9637,24 @@ } } }, + "com.amazonaws.kendra#SnapshotsDataHeaderFields": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#String" + } + }, + "com.amazonaws.kendra#SnapshotsDataRecord": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#String" + } + }, + "com.amazonaws.kendra#SnapshotsDataRecords": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#SnapshotsDataRecord" + } + }, "com.amazonaws.kendra#SortOrder": { "type": "string", "traits": { @@ -8137,7 +9892,7 @@ } ], "traits": { - "smithy.api#documentation": "Enables you to provide feedback to Amazon Kendra to improve the\n performance of your index.
" + "smithy.api#documentation": "Enables you to provide feedback to Amazon Kendra to improve the\n performance of your index.
\n\n SubmitFeedback is currently not supported in the \n Amazon Web Services GovCloud (US-West) region.
Configuration information for an Amazon Kendra data source.
" + } }, "Description": { "target": "com.amazonaws.kendra#Description", @@ -8737,6 +10495,84 @@ "traits": { "smithy.api#documentation": "The code for a language. This allows you to support a language for all \n documents when updating the data source. English is supported \n by default. For more information on supported languages, including their codes, \n see Adding \n documents in languages other than English.
" } + }, + "CustomDocumentEnrichmentConfiguration": { + "target": "com.amazonaws.kendra#CustomDocumentEnrichmentConfiguration", + "traits": { + "smithy.api#documentation": "Configuration information for altering document metadata and content during the\n document ingestion process when you update a data source.
\nFor more information on how to create, modify and delete document metadata, or make\n other content alterations when you ingest documents into Amazon Kendra, see \n Customizing \n document metadata during the ingestion process.
" + } + } + } + }, + "com.amazonaws.kendra#UpdateExperience": { + "type": "operation", + "input": { + "target": "com.amazonaws.kendra#UpdateExperienceRequest" + }, + "errors": [ + { + "target": "com.amazonaws.kendra#AccessDeniedException" + }, + { + "target": "com.amazonaws.kendra#ConflictException" + }, + { + "target": "com.amazonaws.kendra#InternalServerException" + }, + { + "target": "com.amazonaws.kendra#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.kendra#ThrottlingException" + }, + { + "target": "com.amazonaws.kendra#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates your Amazon Kendra experience such as a search application. For more information on\n creating a search application experience, see Building a \n search experience with no code.
" + } + }, + "com.amazonaws.kendra#UpdateExperienceRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.kendra#ExperienceId", + "traits": { + "smithy.api#documentation": "The identifier of your Amazon Kendra experience you want to update.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.kendra#ExperienceName", + "traits": { + "smithy.api#documentation": "The name of your Amazon Kendra experience you want to update.
" + } + }, + "IndexId": { + "target": "com.amazonaws.kendra#IndexId", + "traits": { + "smithy.api#documentation": "The identifier of the index for your Amazon Kendra experience you want to update.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.kendra#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access Query\n operations, QuerySuggestions operations, SubmitFeedback\n operations, and Amazon Web Services SSO that stores your user and group information. \n For more information, see IAM roles for Amazon Kendra.
Provides the user configuration information. This includes the Amazon Web Services SSO\n field name that contains the identifiers of your users, such as their emails.
" + } + }, + "Description": { + "target": "com.amazonaws.kendra#Description", + "traits": { + "smithy.api#documentation": "The description of your Amazon Kendra experience you want to update.
" + } } } }, @@ -8827,7 +10663,7 @@ "UserGroupResolutionConfiguration": { "target": "com.amazonaws.kendra#UserGroupResolutionConfiguration", "traits": { - "smithy.api#documentation": "Enables fetching access levels of groups and users from an AWS Single Sign-On \n identity source. To configure this, see \n UserGroupResolutionConfiguration.
" + "smithy.api#documentation": "Enables fetching access levels of groups and users from an Amazon Web Services Single Sign On \n identity source. To configure this, see \n UserGroupResolutionConfiguration.
" } } } @@ -8858,7 +10694,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a block list used for query suggestions for an index.
\nUpdates to a block list might not take effect right away. Amazon Kendra \n needs to refresh the entire suggestions list to apply any updates to the \n block list. Other changes not related to the block list apply immediately.
\nIf a block list is updating, then you need to wait for the first update to \n finish before submitting another update.
\nAmazon Kendra supports partial updates, so you only need to provide the fields \n you want to update.
" + "smithy.api#documentation": "Updates a block list used for query suggestions for an index.
\nUpdates to a block list might not take effect right away. Amazon Kendra \n needs to refresh the entire suggestions list to apply any updates to the \n block list. Other changes not related to the block list apply immediately.
\nIf a block list is updating, then you need to wait for the first update to \n finish before submitting another update.
\nAmazon Kendra supports partial updates, so you only need to provide the fields \n you want to update.
\n\n UpdateQuerySuggestionsBlockList is currently not supported in the \n Amazon Web Services GovCloud (US-West) region.
Updates the settings of query suggestions for an index.
\nAmazon Kendra supports partial updates, so you only need to provide \n the fields you want to update.
\nIf an update is currently processing (i.e. 'happening'), you \n need to wait for the update to finish before making another update.
\nUpdates to query suggestions settings might not take effect right away. \n The time for your updated settings to take effect depends on the updates \n made and the number of search queries in your index.
\nYou can still enable/disable query suggestions at any time.
" + "smithy.api#documentation": "Updates the settings of query suggestions for an index.
\nAmazon Kendra supports partial updates, so you only need to provide \n the fields you want to update.
\nIf an update is currently processing (i.e. 'happening'), you \n need to wait for the update to finish before making another update.
\nUpdates to query suggestions settings might not take effect right away. \n The time for your updated settings to take effect depends on the updates \n made and the number of search queries in your index.
\nYou can still enable/disable query suggestions at any time.
\n\n UpdateQuerySuggestionsConfig is currently not supported in the \n Amazon Web Services GovCloud (US-West) region.
Provides the configuration information of the URLs to crawl.
\nYou can only crawl websites that use the secure communication protocol, \n Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when \n crawling a website, it could be that the website is blocked from crawling.
\n\n When selecting websites to index, you must adhere to \n the Amazon Acceptable Use Policy \n and all other Amazon terms. Remember that you must only use the Amazon Kendra web \n crawler to index your own webpages, or webpages that you have authorization to \n index.\n
" + "smithy.api#documentation": "Provides the configuration information of the URLs to crawl.
\nYou can only crawl websites that use the secure communication protocol, \n Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when \n crawling a website, it could be that the website is blocked from crawling.
\n\n When selecting websites to index, you must adhere to \n the Amazon Acceptable Use Policy \n and all other Amazon terms. Remember that you must only use Amazon Kendra Web \n Crawler to index your own webpages, or webpages that you have authorization to \n index.\n
" } }, "com.amazonaws.kendra#UserAccount": { @@ -9137,13 +10973,13 @@ "UserGroupResolutionMode": { "target": "com.amazonaws.kendra#UserGroupResolutionMode", "traits": { - "smithy.api#documentation": "The identity store provider (mode) you want to use to fetch access levels of groups and\n users. AWS Single Sign-On is currently the only available mode. Your users and groups\n must\n exist in an AWS SSO identity source in order to use this mode.
", + "smithy.api#documentation": "The identity store provider (mode) you want to use to fetch access levels of groups and\n users. Amazon Web Services Single Sign On is currently the only available mode. Your users and groups\n must\n exist in an Amazon Web Services SSO identity source in order to use this mode.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Provides the configuration information to fetch access levels \n of groups and users from an AWS Single Sign-On identity \n source. This is useful for setting up user context filtering, where \n Amazon Kendra filters search results for different users based on their \n group's access to documents. You can also map your users to their \n groups for user context filtering using the \n PutPrincipalMapping \n operation.
\nTo set up an AWS SSO identity source in the console to use with \n Amazon Kendra, see Getting started \n with an AWS SSO identity source. You must also grant the required \n permissions to use AWS SSO with Amazon Kendra. For more information, see \n IAM roles for \n AWS Single Sign-On.
" + "smithy.api#documentation": "Provides the configuration information to fetch access levels \n of groups and users from an Amazon Web Services Single Sign On identity \n source. This is useful for setting up user context filtering, where \n Amazon Kendra filters search results for different users based on their \n group's access to documents. You can also map your users to their \n groups for user context filtering using the \n PutPrincipalMapping \n operation.
\nTo set up an Amazon Web Services SSO identity source in the console to use with \n Amazon Kendra, see Getting started \n with an Amazon Web Services SSO identity source. You must also grant the required \n permissions to use Amazon Web Services SSO with Amazon Kendra. For more information, see \n IAM roles for \n Amazon Web Services SSO.
" } }, "com.amazonaws.kendra#UserGroupResolutionMode": { @@ -9171,6 +11007,20 @@ "smithy.api#pattern": "^\\P{C}*$" } }, + "com.amazonaws.kendra#UserIdentityConfiguration": { + "type": "structure", + "members": { + "IdentityAttributeName": { + "target": "com.amazonaws.kendra#IdentityAttributeName", + "traits": { + "smithy.api#documentation": "The Amazon Web Services SSO field name that contains the identifiers of your users, \n such as their emails. This is used for user context filtering \n and for granting access to your Amazon Kendra experience. You must set up Amazon Web Services SSO \n with Amazon Kendra. You must include your users and groups in your Access Control List when \n you ingest documents into your index. For more information, see \n Getting \n started with an Amazon Web Services SSO identity source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration information for the identifiers of your users.
" + } + }, "com.amazonaws.kendra#UserNameAttributeField": { "type": "string", "traits": { @@ -9270,7 +11120,7 @@ "Urls": { "target": "com.amazonaws.kendra#Urls", "traits": { - "smithy.api#documentation": "Specifies the seed or starting point URLs of the \n websites or the sitemap URLs of the websites you want to crawl.
\nYou can include website subdomains. You can list up to 100 seed \n URLs and up to three sitemap URLs.
\nYou can only crawl websites that use the secure communication protocol, \n Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when \n crawling a website, it could be that the website is blocked from crawling.
\n\n When selecting websites to index, you must adhere to \n the Amazon Acceptable Use Policy \n and all other Amazon terms. Remember that you must only use the Amazon Kendra \n web crawler to index your own webpages, or webpages that you have \n authorization to index.\n
", + "smithy.api#documentation": "Specifies the seed or starting point URLs of the \n websites or the sitemap URLs of the websites you want to crawl.
\nYou can include website subdomains. You can list up to 100 seed \n URLs and up to three sitemap URLs.
\nYou can only crawl websites that use the secure communication protocol, \n Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when \n crawling a website, it could be that the website is blocked from crawling.
\n\n When selecting websites to index, you must adhere to \n the Amazon Acceptable Use Policy \n and all other Amazon terms. Remember that you must only use Amazon Kendra \n Web Crawler to index your own webpages, or webpages that you have \n authorization to index.\n
", "smithy.api#required": {} } }, @@ -9313,18 +11163,18 @@ "ProxyConfiguration": { "target": "com.amazonaws.kendra#ProxyConfiguration", "traits": { - "smithy.api#documentation": "Provides configuration information required to connect to your internal \n websites via a web proxy.
\nYou must provide the website host name and port number. For example, the \n host name of https://a.example.com/page1.html is \"a.example.com\" and the \n port is 443, the standard port for HTTPS.
\nWeb proxy credentials are optional and you can use them to connect to a \n web proxy server that requires basic authentication. To store web proxy \n credentials, you use a secret in AWS Secrets Manager.
" + "smithy.api#documentation": "Provides configuration information required to connect to your internal \n websites via a web proxy.
\nYou must provide the website host name and port number. For example, the \n host name of https://a.example.com/page1.html is \"a.example.com\" and the \n port is 443, the standard port for HTTPS.
\nWeb proxy credentials are optional and you can use them to connect to a \n web proxy server that requires basic authentication. To store web proxy \n credentials, you use a secret in Secrets Manager.
" } }, "AuthenticationConfiguration": { "target": "com.amazonaws.kendra#AuthenticationConfiguration", "traits": { - "smithy.api#documentation": "Provides configuration information required to connect to websites using \n authentication.
\nYou can connect to websites using basic authentication of user name and password.
\nYou must provide the website host name and port number. For example, the host name \n of https://a.example.com/page1.html is \"a.example.com\" and the port is 443, the \n standard port for HTTPS. You use a secret in AWS Secrets Manager to store \n your authentication credentials.
" + "smithy.api#documentation": "Provides configuration information required to connect to websites using \n authentication.
\nYou can connect to websites using basic authentication of user name and password.
\nYou must provide the website host name and port number. For example, the host name \n of https://a.example.com/page1.html is \"a.example.com\" and the port is 443, the \n standard port for HTTPS. You use a secret in Secrets Manager to store \n your authentication credentials.
" } } }, "traits": { - "smithy.api#documentation": "Provides the configuration information required for Amazon Kendra \n web crawler.
" + "smithy.api#documentation": "Provides the configuration information required for Amazon Kendra \n Web Crawler.
" } }, "com.amazonaws.kendra#WebCrawlerMode": { @@ -9352,7 +11202,7 @@ "OrganizationId": { "target": "com.amazonaws.kendra#OrganizationId", "traits": { - "smithy.api#documentation": "The identifier of the directory corresponding to your \n Amazon WorkDocs site repository.
\nYou can find the organization ID in the \n AWS Directory Service by going to \n Active Directory, then \n Directories. Your Amazon WorkDocs site directory has an \n ID, which is the organization ID. You can also set up a new Amazon WorkDocs \n directory in the AWS Directory Service console and enable a Amazon WorkDocs site \n for the directory in the Amazon WorkDocs console.
", + "smithy.api#documentation": "The identifier of the directory corresponding to your \n Amazon WorkDocs site repository.
\nYou can find the organization ID in the \n Directory Service by going to \n Active Directory, then \n Directories. Your Amazon WorkDocs site directory has an \n ID, which is the organization ID. You can also set up a new Amazon WorkDocs \n directory in the Directory Service console and enable a Amazon WorkDocs site \n for the directory in the Amazon WorkDocs console.
", "smithy.api#required": {} } }, diff --git a/aws/sdk/aws-models/kinesis.json b/aws/sdk/aws-models/kinesis.json index 87fdb75ea2d3b2f2c20c9204232447da21c00746..519a8f2fab89ddb86e8598320b2d9acc11b20505 100644 --- a/aws/sdk/aws-models/kinesis.json +++ b/aws/sdk/aws-models/kinesis.json @@ -49,7 +49,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds or updates tags for the specified Kinesis data stream. Each time you invoke\n this operation, you can specify up to 10 tags. If you want to add more than 10 tags to\n your stream, you can invoke this operation multiple times. In total, each stream can\n have up to 50 tags.
\nIf tags have already been assigned to the stream, AddTagsToStream\n overwrites any existing tags that correspond to the specified tag keys.
\n AddTagsToStream has a limit of five transactions per second per\n account.
" + "smithy.api#documentation": "Adds or updates tags for the specified Kinesis data stream. You can assign up to 50\n tags to a data stream.
\nIf tags have already been assigned to the stream, AddTagsToStream\n overwrites any existing tags that correspond to the specified tag keys.
\n AddTagsToStream has a limit of five transactions per second per\n account.
" } }, "com.amazonaws.kinesis#AddTagsToStreamInput": { @@ -86,12 +86,14 @@ "ShardId": { "target": "com.amazonaws.kinesis#ShardId", "traits": { + "smithy.api#documentation": "The shard ID of the existing child shard of the current shard.
", "smithy.api#required": {} } }, "ParentShards": { "target": "com.amazonaws.kinesis#ShardIdList", "traits": { + "smithy.api#documentation": "The current shard that is the parent of the existing child shard.
", "smithy.api#required": {} } }, @@ -101,6 +103,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "Output parameter of the GetRecords API. The existing child shard of the current\n shard.
" } }, "com.amazonaws.kinesis#ChildShardList": { @@ -152,7 +157,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "^(arn):aws.*:kinesis:.*:\\d{12}:.*stream\\/[a-zA-Z0-9_.-]+\\/consumer\\/[a-zA-Z0-9_.-]+:[0-9]+" + "smithy.api#pattern": "^(arn):aws.*:kinesis:.*:\\d{12}:.*stream\\/[a-zA-Z0-9_.-]+\\/consumer\\/[a-zA-Z0-9_.-]+:[0-9]+$" } }, "com.amazonaws.kinesis#ConsumerCountObject": { @@ -221,7 +226,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "[a-zA-Z0-9_.-]+" + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" } }, "com.amazonaws.kinesis#ConsumerStatus": { @@ -260,7 +265,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a Kinesis data stream. A stream captures and transports data records that\n are continuously emitted from different data sources or producers.\n Scale-out within a stream is explicitly supported by means of shards, which are uniquely\n identified groups of data records in a stream.
\nYou specify and control the number of shards that a stream is composed of. Each\n shard can support reads up to five transactions per second, up to a maximum data read\n total of 2 MiB per second. Each shard can support writes up to 1,000 records per second,\n up to a maximum data write total of 1 MiB per second. If the amount of data input\n increases or decreases, you can add or remove shards.
\nThe stream name identifies the stream. The name is scoped to the AWS account used\n by the application. It is also scoped by AWS Region. That is, two streams in two\n different accounts can have the same name, and two streams in the same account, but in\n two different Regions, can have the same name.
\n\n CreateStream is an asynchronous operation. Upon receiving a\n CreateStream request, Kinesis Data Streams immediately returns and sets\n the stream status to CREATING. After the stream is created, Kinesis Data\n Streams sets the stream status to ACTIVE. You should perform read and write\n operations only on an ACTIVE stream.
You receive a LimitExceededException when making a\n CreateStream request when you try to do one of the following:
Have more than five streams in the CREATING state at any point\n in time.
Create more shards than are authorized for your account.
\nFor the default shard limit for an AWS account, see Amazon Kinesis Data Streams\n Limits in the Amazon Kinesis Data Streams Developer\n Guide. To increase this limit, contact AWS\n Support.
\nYou can use DescribeStream to check the stream status, which is\n returned in StreamStatus.
\n CreateStream has a limit of five transactions per second per\n account.
" + "smithy.api#documentation": "Creates a Kinesis data stream. A stream captures and transports data records that are\n continuously emitted from different data sources or producers.\n Scale-out within a stream is explicitly supported by means of shards, which are uniquely\n identified groups of data records in a stream.
\nYou specify and control the number of shards that a stream is composed of. Each shard\n can support reads up to five transactions per second, up to a maximum data read total of\n 2 MiB per second. Each shard can support writes up to 1,000 records per second, up to a\n maximum data write total of 1 MiB per second. If the amount of data input increases or\n decreases, you can add or remove shards.
\nThe stream name identifies the stream. The name is scoped to the Amazon Web Services\n account used by the application. It is also scoped by Amazon Web Services Region. That\n is, two streams in two different accounts can have the same name, and two streams in the\n same account, but in two different Regions, can have the same name.
\n\n CreateStream is an asynchronous operation. Upon receiving a\n CreateStream request, Kinesis Data Streams immediately returns and sets\n the stream status to CREATING. After the stream is created, Kinesis Data\n Streams sets the stream status to ACTIVE. You should perform read and write\n operations only on an ACTIVE stream.
You receive a LimitExceededException when making a\n CreateStream request when you try to do one of the following:
Have more than five streams in the CREATING state at any point in\n time.
Create more shards than are authorized for your account.
\nFor the default shard limit for an Amazon Web Services account, see Amazon\n Kinesis Data Streams Limits in the Amazon Kinesis Data Streams\n Developer Guide. To increase this limit, contact Amazon Web Services\n Support.
\nYou can use DescribeStreamSummary to check the stream status, which\n is returned in StreamStatus.
\n CreateStream has a limit of five transactions per second per\n account.
" } }, "com.amazonaws.kinesis#CreateStreamInput": { @@ -269,15 +274,20 @@ "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "A name to identify the stream. The stream name is scoped to the AWS account used by\n the application that creates the stream. It is also scoped by AWS Region. That is, two\n streams in two different AWS accounts can have the same name. Two streams in the same\n AWS account but in two different Regions can also have the same name.
", + "smithy.api#documentation": "A name to identify the stream. The stream name is scoped to the Amazon Web Services\n account used by the application that creates the stream. It is also scoped by Amazon Web Services Region. That is, two streams in two different Amazon Web Services accounts\n can have the same name. Two streams in the same Amazon Web Services account but in two\n different Regions can also have the same name.
", "smithy.api#required": {} } }, "ShardCount": { "target": "com.amazonaws.kinesis#PositiveIntegerObject", "traits": { - "smithy.api#documentation": "The number of shards that the stream will use. The throughput of the stream is a\n function of the number of shards; more shards are required for greater provisioned\n throughput.
", - "smithy.api#required": {} + "smithy.api#documentation": "The number of shards that the stream will use. The throughput of the stream is a\n function of the number of shards; more shards are required for greater provisioned\n throughput.
" + } + }, + "StreamModeDetails": { + "target": "com.amazonaws.kinesis#StreamModeDetails", + "traits": { + "smithy.api#documentation": "Indicates the capacity mode of the data stream. Currently, in Kinesis Data Streams,\n you can choose between an on-demand capacity mode and a\n provisioned capacity mode for your data\n streams.
" } } }, @@ -314,7 +324,7 @@ } ], "traits": { - "smithy.api#documentation": "Decreases the Kinesis data stream's retention period, which is the length of time\n data records are accessible after they are added to the stream. The minimum value of a\n stream's retention period is 24 hours.
\nThis operation may result in lost data. For example, if the stream's retention\n period is 48 hours and is decreased to 24 hours, any data already in the stream that is\n older than 24 hours is inaccessible.
" + "smithy.api#documentation": "Decreases the Kinesis data stream's retention period, which is the length of time data\n records are accessible after they are added to the stream. The minimum value of a\n stream's retention period is 24 hours.
\nThis operation may result in lost data. For example, if the stream's retention period\n is 48 hours and is decreased to 24 hours, any data already in the stream that is older\n than 24 hours is inaccessible.
" } }, "com.amazonaws.kinesis#DecreaseStreamRetentionPeriodInput": { @@ -356,7 +366,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a Kinesis data stream and all its shards and data. You must shut down any\n applications that are operating on the stream before you delete the stream. If an\n application attempts to operate on a deleted stream, it receives the exception\n ResourceNotFoundException.
If the stream is in the ACTIVE state, you can delete it. After a\n DeleteStream request, the specified stream is in the\n DELETING state until Kinesis Data Streams completes the\n deletion.
\n Note: Kinesis Data Streams might continue to accept\n data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the\n DELETING state until the stream deletion is complete.
When you delete a stream, any shards in that stream are also deleted, and any tags\n are dissociated from the stream.
\nYou can use the DescribeStream operation to check the state of\n the stream, which is returned in StreamStatus.
\n DeleteStream has a limit of five transactions per second per\n account.
" + "smithy.api#documentation": "Deletes a Kinesis data stream and all its shards and data. You must shut down any\n applications that are operating on the stream before you delete the stream. If an\n application attempts to operate on a deleted stream, it receives the exception\n ResourceNotFoundException.
If the stream is in the ACTIVE state, you can delete it. After a\n DeleteStream request, the specified stream is in the\n DELETING state until Kinesis Data Streams completes the\n deletion.
\n Note: Kinesis Data Streams might continue to accept\n data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the\n DELETING state until the stream deletion is complete.
When you delete a stream, any shards in that stream are also deleted, and any tags are\n dissociated from the stream.
\nYou can use the DescribeStreamSummary operation to check the state\n of the stream, which is returned in StreamStatus.
\n DeleteStream has a limit of five transactions per second per\n account.
" } }, "com.amazonaws.kinesis#DeleteStreamInput": { @@ -406,7 +416,7 @@ "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { - "smithy.api#documentation": "The ARN of the Kinesis data stream that the consumer is registered with. For more\n information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
" + "smithy.api#documentation": "The ARN of the Kinesis data stream that the consumer is registered with. For more\n information, see Amazon Resource Names (ARNs) and Amazon Web Services Service\n Namespaces.
" } }, "ConsumerName": { @@ -460,6 +470,20 @@ "smithy.api#documentation": "The number of open shards.
", "smithy.api#required": {} } + }, + "OnDemandStreamCount": { + "target": "com.amazonaws.kinesis#OnDemandStreamCountObject", + "traits": { + "smithy.api#documentation": "Indicates the number of data streams with the on-demand capacity mode.
", + "smithy.api#required": {} + } + }, + "OnDemandStreamCountLimit": { + "target": "com.amazonaws.kinesis#OnDemandStreamCountLimitObject", + "traits": { + "smithy.api#documentation": "The maximum number of data streams with the on-demand capacity mode.
", + "smithy.api#required": {} + } } } }, @@ -480,7 +504,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified Kinesis data stream.
\n\nThe information returned includes the stream name, Amazon Resource Name (ARN),\n creation time, enhanced metric configuration, and shard map. The shard map is an array\n of shard objects. For each shard object, there is the hash key and sequence number\n ranges that the shard spans, and the IDs of any earlier shards that played in a role in\n creating the shard. Every record ingested in the stream is identified by a sequence\n number, which is assigned when the record is put into the stream.
\n\nYou can limit the number of shards returned by each call. For more information, see\n Retrieving\n Shards from a Stream in the Amazon Kinesis Data Streams Developer\n Guide.
\nThere are no guarantees about the chronological order shards returned. To process\n shards in chronological order, use the ID of the parent shard to track the lineage to\n the oldest shard.
\nThis operation has a limit of 10 transactions per second per account.
", + "smithy.api#documentation": "Describes the specified Kinesis data stream.
\nThis API has been revised. It's highly recommended that you use the DescribeStreamSummary API to get a summarized description of the\n specified Kinesis data stream and the ListShards API to list the\n shards in a specified data stream and obtain information about each shard.
\nThe information returned includes the stream name, Amazon Resource Name (ARN),\n creation time, enhanced metric configuration, and shard map. The shard map is an array\n of shard objects. For each shard object, there is the hash key and sequence number\n ranges that the shard spans, and the IDs of any earlier shards that played in a role in\n creating the shard. Every record ingested in the stream is identified by a sequence\n number, which is assigned when the record is put into the stream.
\n\nYou can limit the number of shards returned by each call. For more information, see\n Retrieving\n Shards from a Stream in the Amazon Kinesis Data Streams Developer\n Guide.
\nThere are no guarantees about the chronological order shards returned. To process\n shards in chronological order, use the ID of the parent shard to track the lineage to\n the oldest shard.
\nThis operation has a limit of 10 transactions per second per account.
", "smithy.waiters#waitable": { "StreamExists": { "acceptors": [ @@ -540,7 +564,7 @@ "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { - "smithy.api#documentation": "The ARN of the Kinesis data stream that the consumer is registered with. For more\n information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
" + "smithy.api#documentation": "The ARN of the Kinesis data stream that the consumer is registered with. For more\n information, see Amazon Resource Names (ARNs) and Amazon Web Services Service\n Namespaces.
" } }, "ConsumerName": { @@ -582,13 +606,13 @@ "Limit": { "target": "com.amazonaws.kinesis#DescribeStreamInputLimit", "traits": { - "smithy.api#documentation": "The maximum number of shards to return in a single call. The default value is 100.\n If you specify a value greater than 100, at most 100 shards are returned.
" + "smithy.api#documentation": "The maximum number of shards to return in a single call. The default value is 100. If\n you specify a value greater than 100, at most 100 results are returned.
" } }, "ExclusiveStartShardId": { "target": "com.amazonaws.kinesis#ShardId", "traits": { - "smithy.api#documentation": "The shard ID of the shard to start with.
" + "smithy.api#documentation": "The shard ID of the shard to start with.
\nSpecify this parameter to indicate that you want to describe the stream starting with\n the shard whose ID immediately follows ExclusiveStartShardId.
If you don't specify this parameter, the default behavior for\n DescribeStream is to describe the stream starting with the first shard\n in the stream.
The current status of the stream, the stream Amazon Resource Name (ARN), an array\n of shard objects that comprise the stream, and whether there are more shards\n available.
", + "smithy.api#documentation": "The current status of the stream, the stream Amazon Resource Name (ARN), an array of\n shard objects that comprise the stream, and whether there are more shards\n available.
", "smithy.api#required": {} } } @@ -638,7 +662,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides a summarized description of the specified Kinesis data stream without the\n shard list.
\nThe information returned includes the stream name, Amazon Resource Name (ARN),\n status, record retention period, approximate creation time, monitoring, encryption\n details, and open shard count.
\n\n DescribeStreamSummary has a limit of 20 transactions per second\n per account.
" + "smithy.api#documentation": "Provides a summarized description of the specified Kinesis data stream without the\n shard list.
\nThe information returned includes the stream name, Amazon Resource Name (ARN), status,\n record retention period, approximate creation time, monitoring, encryption details, and\n open shard count.
\n\n DescribeStreamSummary has a limit of 20 transactions per second per\n account.
" } }, "com.amazonaws.kinesis#DescribeStreamSummaryInput": { @@ -697,14 +721,14 @@ "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "The name of the Kinesis data stream for which to disable enhanced\n monitoring.
", + "smithy.api#documentation": "The name of the Kinesis data stream for which to disable enhanced monitoring.
", "smithy.api#required": {} } }, "ShardLevelMetrics": { "target": "com.amazonaws.kinesis#MetricsNameList", "traits": { - "smithy.api#documentation": "List of shard-level metrics to disable.
\nThe following are the valid shard-level metrics. The value \"ALL\"\n disables every metric.
\n IncomingBytes\n
\n IncomingRecords\n
\n OutgoingBytes\n
\n OutgoingRecords\n
\n WriteProvisionedThroughputExceeded\n
\n ReadProvisionedThroughputExceeded\n
\n IteratorAgeMilliseconds\n
\n ALL\n
For more information, see Monitoring the Amazon\n Kinesis Data Streams Service with Amazon CloudWatch in the Amazon\n Kinesis Data Streams Developer Guide.
", + "smithy.api#documentation": "List of shard-level metrics to disable.
\nThe following are the valid shard-level metrics. The value \"ALL\" disables\n every metric.
\n IncomingBytes\n
\n IncomingRecords\n
\n OutgoingBytes\n
\n OutgoingRecords\n
\n WriteProvisionedThroughputExceeded\n
\n ReadProvisionedThroughputExceeded\n
\n IteratorAgeMilliseconds\n
\n ALL\n
For more information, see Monitoring the Amazon\n Kinesis Data Streams Service with Amazon CloudWatch in the Amazon\n Kinesis Data Streams Developer Guide.
", "smithy.api#required": {} } } @@ -752,7 +776,7 @@ "ShardLevelMetrics": { "target": "com.amazonaws.kinesis#MetricsNameList", "traits": { - "smithy.api#documentation": "List of shard-level metrics to enable.
\nThe following are the valid shard-level metrics. The value \"ALL\"\n enables every metric.
\n IncomingBytes\n
\n IncomingRecords\n
\n OutgoingBytes\n
\n OutgoingRecords\n
\n WriteProvisionedThroughputExceeded\n
\n ReadProvisionedThroughputExceeded\n
\n IteratorAgeMilliseconds\n
\n ALL\n
For more information, see Monitoring the Amazon\n Kinesis Data Streams Service with Amazon CloudWatch in the Amazon\n Kinesis Data Streams Developer Guide.
", + "smithy.api#documentation": "List of shard-level metrics to enable.
\nThe following are the valid shard-level metrics. The value \"ALL\" enables\n every metric.
\n IncomingBytes\n
\n IncomingRecords\n
\n OutgoingBytes\n
\n OutgoingRecords\n
\n WriteProvisionedThroughputExceeded\n
\n ReadProvisionedThroughputExceeded\n
\n IteratorAgeMilliseconds\n
\n ALL\n
For more information, see Monitoring the Amazon\n Kinesis Data Streams Service with Amazon CloudWatch in the Amazon\n Kinesis Data Streams Developer Guide.
", "smithy.api#required": {} } } @@ -782,7 +806,7 @@ "ShardLevelMetrics": { "target": "com.amazonaws.kinesis#MetricsNameList", "traits": { - "smithy.api#documentation": "List of shard-level metrics.
\nThe following are the valid shard-level metrics. The value \"ALL\"\n enhances every metric.
\n IncomingBytes\n
\n IncomingRecords\n
\n OutgoingBytes\n
\n OutgoingRecords\n
\n WriteProvisionedThroughputExceeded\n
\n ReadProvisionedThroughputExceeded\n
\n IteratorAgeMilliseconds\n
\n ALL\n
For more information, see Monitoring the Amazon\n Kinesis Data Streams Service with Amazon CloudWatch in the Amazon\n Kinesis Data Streams Developer Guide.
" + "smithy.api#documentation": "List of shard-level metrics.
\nThe following are the valid shard-level metrics. The value \"ALL\" enhances\n every metric.
\n IncomingBytes\n
\n IncomingRecords\n
\n OutgoingBytes\n
\n OutgoingRecords\n
\n WriteProvisionedThroughputExceeded\n
\n ReadProvisionedThroughputExceeded\n
\n IteratorAgeMilliseconds\n
\n ALL\n
For more information, see Monitoring the Amazon\n Kinesis Data Streams Service with Amazon CloudWatch in the Amazon\n Kinesis Data Streams Developer Guide.
" } } }, @@ -808,13 +832,13 @@ "CurrentShardLevelMetrics": { "target": "com.amazonaws.kinesis#MetricsNameList", "traits": { - "smithy.api#documentation": "Represents the current state of the metrics that are in the enhanced state before\n the operation.
" + "smithy.api#documentation": "Represents the current state of the metrics that are in the enhanced state before the\n operation.
" } }, "DesiredShardLevelMetrics": { "target": "com.amazonaws.kinesis#MetricsNameList", "traits": { - "smithy.api#documentation": "Represents the list of all the metrics that would be in the enhanced state after\n the operation.
" + "smithy.api#documentation": "Represents the list of all the metrics that would be in the enhanced state after the\n operation.
" } } }, @@ -896,7 +920,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets data records from a Kinesis data stream's shard.
\nSpecify a shard iterator using the ShardIterator parameter. The shard\n iterator specifies the position in the shard from which you want to start reading data\n records sequentially. If there are no records available in the portion of the shard that\n the iterator points to, GetRecords returns an empty list. It might\n take multiple calls to get to a portion of the shard that contains records.
You can scale by provisioning multiple shards per stream while considering service\n limits (for more information, see Amazon Kinesis Data Streams\n Limits in the Amazon Kinesis Data Streams Developer\n Guide). Your application should have one thread per shard, each reading\n continuously from its stream. To read from a stream continually, call GetRecords in a loop. Use GetShardIterator to get the\n shard iterator to specify in the first GetRecords call. GetRecords returns a new shard iterator in\n NextShardIterator. Specify the shard iterator returned in\n NextShardIterator in subsequent calls to GetRecords.\n If the shard has been closed, the shard iterator can't return more data and GetRecords returns null in NextShardIterator.\n You can terminate the loop when the shard is closed, or when the shard iterator reaches\n the record with the sequence number or other attribute that marks it as the last record\n to process.
Each data record can be up to 1 MiB in size, and each shard can read up to 2 MiB\n per second. You can ensure that your calls don't exceed the maximum supported size or\n throughput by using the Limit parameter to specify the maximum number of\n records that GetRecords can return. Consider your average record size\n when determining this limit. The maximum number of records that can be returned per call\n is 10,000.
The size of the data returned by GetRecords varies depending on\n the utilization of the shard. The maximum size of data that GetRecords\n can return is 10 MiB. If a call returns this amount of data, subsequent calls made\n within the next 5 seconds throw ProvisionedThroughputExceededException. If\n there is insufficient provisioned throughput on the stream, subsequent calls made within\n the next 1 second throw ProvisionedThroughputExceededException. GetRecords doesn't return any data when it throws an exception. For this\n reason, we recommend that you wait 1 second between calls to GetRecords. However, it's possible that the application will get exceptions for longer than 1\n second.
To detect whether the application is falling behind in processing, you can use the\n MillisBehindLatest response attribute. You can also monitor the stream\n using CloudWatch metrics and other mechanisms (see Monitoring in the Amazon\n Kinesis Data Streams Developer Guide).
Each Amazon Kinesis record includes a value,\n ApproximateArrivalTimestamp, that is set when a stream successfully\n receives and stores a record. This is commonly referred to as a server-side time stamp,\n whereas a client-side time stamp is set when a data producer creates or sends the record\n to a stream (a data producer is any data source putting data records into a stream, for\n example with PutRecords). The time stamp has millisecond precision.\n There are no guarantees about the time stamp accuracy, or that the time stamp is always\n increasing. For example, records in a shard or across a stream might have time stamps\n that are out of order.
This operation has a limit of five transactions per second per shard.
" + "smithy.api#documentation": "Gets data records from a Kinesis data stream's shard.
\nSpecify a shard iterator using the ShardIterator parameter. The shard\n iterator specifies the position in the shard from which you want to start reading data\n records sequentially. If there are no records available in the portion of the shard that\n the iterator points to, GetRecords returns an empty list. It might\n take multiple calls to get to a portion of the shard that contains records.
You can scale by provisioning multiple shards per stream while considering service\n limits (for more information, see Amazon Kinesis Data Streams\n Limits in the Amazon Kinesis Data Streams Developer\n Guide). Your application should have one thread per shard, each reading\n continuously from its stream. To read from a stream continually, call GetRecords in a loop. Use GetShardIterator to get the\n shard iterator to specify in the first GetRecords call. GetRecords returns a new shard iterator in\n NextShardIterator. Specify the shard iterator returned in\n NextShardIterator in subsequent calls to GetRecords.\n If the shard has been closed, the shard iterator can't return more data and GetRecords returns null in NextShardIterator.\n You can terminate the loop when the shard is closed, or when the shard iterator reaches\n the record with the sequence number or other attribute that marks it as the last record\n to process.
Each data record can be up to 1 MiB in size, and each shard can read up to 2 MiB per\n second. You can ensure that your calls don't exceed the maximum supported size or\n throughput by using the Limit parameter to specify the maximum number of\n records that GetRecords can return. Consider your average record size\n when determining this limit. The maximum number of records that can be returned per call\n is 10,000.
The size of the data returned by GetRecords varies depending on the\n utilization of the shard. It is recommended that consumer applications retrieve records\n via the GetRecords command using the 5 TPS limit to remain caught up.\n Retrieving records less frequently can lead to consumer applications falling behind. The\n maximum size of data that GetRecords can return is 10 MiB. If a call\n returns this amount of data, subsequent calls made within the next 5 seconds throw\n ProvisionedThroughputExceededException. If there is insufficient\n provisioned throughput on the stream, subsequent calls made within the next 1 second\n throw ProvisionedThroughputExceededException. GetRecords\n doesn't return any data when it throws an exception. For this reason, we recommend that\n you wait 1 second between calls to GetRecords. However, it's possible\n that the application will get exceptions for longer than 1 second.
To detect whether the application is falling behind in processing, you can use the\n MillisBehindLatest response attribute. You can also monitor the stream\n using CloudWatch metrics and other mechanisms (see Monitoring in the Amazon\n Kinesis Data Streams Developer Guide).
Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp,\n that is set when a stream successfully receives and stores a record. This is commonly\n referred to as a server-side time stamp, whereas a client-side time stamp is set when a\n data producer creates or sends the record to a stream (a data producer is any data\n source putting data records into a stream, for example with PutRecords). The time stamp has millisecond precision. There are no guarantees about the time\n stamp accuracy, or that the time stamp is always increasing. For example, records in a\n shard or across a stream might have time stamps that are out of order.
This operation has a limit of five transactions per second per shard.
" } }, "com.amazonaws.kinesis#GetRecordsInput": { @@ -943,17 +967,20 @@ "NextShardIterator": { "target": "com.amazonaws.kinesis#ShardIterator", "traits": { - "smithy.api#documentation": "The next position in the shard from which to start sequentially reading data\n records. If set to null, the shard has been closed and the requested\n iterator does not return any more data.
The next position in the shard from which to start sequentially reading data records.\n If set to null, the shard has been closed and the requested iterator does\n not return any more data.
The number of milliseconds the GetRecords response is from the\n tip of the stream, indicating how far behind current time the consumer is. A value of\n zero indicates that record processing is caught up, and there are no new records to\n process at this moment.
" + "smithy.api#documentation": "The number of milliseconds the GetRecords response is from the tip\n of the stream, indicating how far behind current time the consumer is. A value of zero\n indicates that record processing is caught up, and there are no new records to process\n at this moment.
" } }, "ChildShards": { - "target": "com.amazonaws.kinesis#ChildShardList" + "target": "com.amazonaws.kinesis#ChildShardList", + "traits": { + "smithy.api#documentation": "The list of the current shard's child shards, returned in the GetRecords\n API's response only when the end of the current shard is reached.
Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it\n is returned to the requester.
\nA shard iterator specifies the shard position from which to start reading data\n records sequentially. The position is specified using the sequence number of a data\n record in a shard. A sequence number is the identifier associated with every record\n ingested in the stream, and is assigned when a record is put into the stream. Each\n stream has one or more shards.
\nYou must specify the shard iterator type. For example, you can set the\n ShardIteratorType parameter to read exactly from the position denoted\n by a specific sequence number by using the AT_SEQUENCE_NUMBER shard\n iterator type. Alternatively, the parameter can read right after the sequence number by\n using the AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers\n returned by earlier calls to PutRecord, PutRecords,\n GetRecords, or DescribeStream. In the request,\n you can specify the shard iterator type AT_TIMESTAMP to read records from\n an arbitrary point in time, TRIM_HORIZON to cause\n ShardIterator to point to the last untrimmed record in the shard in the\n system (the oldest data record in the shard), or LATEST so that you always\n read the most recent data in the shard.
When you read repeatedly from a stream, use a GetShardIterator\n request to get the first shard iterator for use in your first GetRecords request and for subsequent reads use the shard iterator returned by the GetRecords request in NextShardIterator. A new shard\n iterator is returned by every GetRecords request in\n NextShardIterator, which you use in the ShardIterator\n parameter of the next GetRecords request.
If a GetShardIterator request is made too often, you receive a\n ProvisionedThroughputExceededException. For more information about\n throughput limits, see GetRecords, and Streams Limits in the\n Amazon Kinesis Data Streams Developer Guide.
If the shard is closed, GetShardIterator returns a valid iterator\n for the last sequence number of the shard. A shard can be closed as a result of using\n SplitShard or MergeShards.
\n\n GetShardIterator has a limit of five transactions per second per\n account per open shard.
" + "smithy.api#documentation": "Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is\n returned to the requester.
\nA shard iterator specifies the shard position from which to start reading data records\n sequentially. The position is specified using the sequence number of a data record in a\n shard. A sequence number is the identifier associated with every record ingested in the\n stream, and is assigned when a record is put into the stream. Each stream has one or\n more shards.
\nYou must specify the shard iterator type. For example, you can set the\n ShardIteratorType parameter to read exactly from the position denoted\n by a specific sequence number by using the AT_SEQUENCE_NUMBER shard\n iterator type. Alternatively, the parameter can read right after the sequence number by\n using the AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers\n returned by earlier calls to PutRecord, PutRecords,\n GetRecords, or DescribeStream. In the request,\n you can specify the shard iterator type AT_TIMESTAMP to read records from\n an arbitrary point in time, TRIM_HORIZON to cause\n ShardIterator to point to the last untrimmed record in the shard in the\n system (the oldest data record in the shard), or LATEST so that you always\n read the most recent data in the shard.
When you read repeatedly from a stream, use a GetShardIterator\n request to get the first shard iterator for use in your first GetRecords request and for subsequent reads use the shard iterator returned by the GetRecords request in NextShardIterator. A new shard\n iterator is returned by every GetRecords request in\n NextShardIterator, which you use in the ShardIterator\n parameter of the next GetRecords request.
If a GetShardIterator request is made too often, you receive a\n ProvisionedThroughputExceededException. For more information about\n throughput limits, see GetRecords, and Streams Limits in the\n Amazon Kinesis Data Streams Developer Guide.
If the shard is closed, GetShardIterator returns a valid iterator\n for the last sequence number of the shard. A shard can be closed as a result of using\n SplitShard or MergeShards.
\n\n GetShardIterator has a limit of five transactions per second per\n account per open shard.
" } }, "com.amazonaws.kinesis#GetShardIteratorInput": { @@ -1003,14 +1030,14 @@ "ShardIteratorType": { "target": "com.amazonaws.kinesis#ShardIteratorType", "traits": { - "smithy.api#documentation": "Determines how the shard iterator is used to start reading data records from the\n shard.
\nThe following are the valid Amazon Kinesis shard iterator types:
\nAT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific\n sequence number, provided in the value\n StartingSequenceNumber.
AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a\n specific sequence number, provided in the value\n StartingSequenceNumber.
AT_TIMESTAMP - Start reading from the position denoted by a specific time\n stamp, provided in the value Timestamp.
TRIM_HORIZON - Start reading at the last untrimmed record in the shard in\n the system, which is the oldest data record in the shard.
\nLATEST - Start reading just after the most recent record in the shard, so\n that you always read the most recent data in the shard.
\nDetermines how the shard iterator is used to start reading data records from the\n shard.
\nThe following are the valid Amazon Kinesis shard iterator types:
\nAT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific\n sequence number, provided in the value\n StartingSequenceNumber.
AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a\n specific sequence number, provided in the value\n StartingSequenceNumber.
AT_TIMESTAMP - Start reading from the position denoted by a specific time\n stamp, provided in the value Timestamp.
TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the\n system, which is the oldest data record in the shard.
\nLATEST - Start reading just after the most recent record in the shard, so that\n you always read the most recent data in the shard.
\nThe sequence number of the data record in the shard from which to start reading.\n Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.
" + "smithy.api#documentation": "The sequence number of the data record in the shard from which to start reading. Used\n with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.
" } }, "Timestamp": { @@ -1041,7 +1068,7 @@ "com.amazonaws.kinesis#HashKey": { "type": "string", "traits": { - "smithy.api#pattern": "0|([1-9]\\d{0,38})" + "smithy.api#pattern": "^0|([1-9]\\d{0,38})$" } }, "com.amazonaws.kinesis#HashKeyRange": { @@ -1086,7 +1113,7 @@ } ], "traits": { - "smithy.api#documentation": "Increases the Kinesis data stream's retention period, which is the length of time\n data records are accessible after they are added to the stream. The maximum value of a\n stream's retention period is 168 hours (7 days).
\nIf you choose a longer stream retention period, this operation increases the time\n period during which records that have not yet expired are accessible. However, it does\n not make previous, expired data (older than the stream's previous retention period)\n accessible after the operation has been called. For example, if a stream's retention\n period is set to 24 hours and is increased to 168 hours, any data that is older than 24\n hours remains inaccessible to consumer applications.
" + "smithy.api#documentation": "Increases the Kinesis data stream's retention period, which is the length of time data\n records are accessible after they are added to the stream. The maximum value of a\n stream's retention period is 8760 hours (365 days).
\nIf you choose a longer stream retention period, this operation increases the time\n period during which records that have not yet expired are accessible. However, it does\n not make previous, expired data (older than the stream's previous retention period)\n accessible after the operation has been called. For example, if a stream's retention\n period is set to 24 hours and is increased to 168 hours, any data that is older than 24\n hours remains inaccessible to consumer applications.
" } }, "com.amazonaws.kinesis#IncreaseStreamRetentionPeriodInput": { @@ -1179,7 +1206,7 @@ } }, "traits": { - "smithy.api#documentation": "The request was rejected because the state of the specified resource isn't valid\n for this request. For more information, see How Key State Affects Use of a\n Customer Master Key in the AWS Key Management Service Developer\n Guide.
", + "smithy.api#documentation": "The request was rejected because the state of the specified resource isn't valid for\n this request. For more information, see How Key State Affects Use of a\n Customer Master Key in the Amazon Web Services Key Management\n Service Developer Guide.
", "smithy.api#error": "client" } }, @@ -1209,7 +1236,7 @@ } }, "traits": { - "smithy.api#documentation": "The AWS access key ID needs a subscription for the service.
", + "smithy.api#documentation": "The Amazon Web Services access key ID needs a subscription for the service.
", "smithy.api#error": "client" } }, @@ -1224,7 +1251,7 @@ } }, "traits": { - "smithy.api#documentation": "The request was denied due to request throttling. For more information about\n throttling, see Limits in\n the AWS Key Management Service Developer Guide.
", + "smithy.api#documentation": "The request was denied due to request throttling. For more information about\n throttling, see Limits in\n the Amazon Web Services Key Management Service Developer\n Guide.
", "smithy.api#error": "client" } }, @@ -1239,6 +1266,24 @@ }, "com.amazonaws.kinesis#Kinesis_20131202": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Kinesis", + "arnNamespace": "kinesis", + "cloudFormationName": "Kinesis", + "cloudTrailEventSource": "kinesis.amazonaws.com", + "endpointPrefix": "kinesis" + }, + "aws.auth#sigv4": { + "name": "kinesis" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Amazon Kinesis Data Streams is a managed service that scales elastically for real-time\n processing of streaming big data.
", + "smithy.api#title": "Amazon Kinesis", + "smithy.api#xmlNamespace": { + "uri": "http://kinesis.amazonaws.com/doc/2013-12-02" + } + }, "version": "2013-12-02", "operations": [ { @@ -1324,26 +1369,11 @@ }, { "target": "com.amazonaws.kinesis#UpdateShardCount" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "Kinesis", - "arnNamespace": "kinesis", - "cloudFormationName": "Kinesis", - "cloudTrailEventSource": "kinesis.amazonaws.com", - "endpointPrefix": "kinesis" - }, - "aws.auth#sigv4": { - "name": "kinesis" }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Kinesis Data Streams is a managed service that scales elastically for\n real-time processing of streaming big data.
", - "smithy.api#title": "Amazon Kinesis", - "smithy.api#xmlNamespace": { - "uri": "http://kinesis.amazonaws.com/doc/2013-12-02" + { + "target": "com.amazonaws.kinesis#UpdateStreamMode" } - } + ] }, "com.amazonaws.kinesis#LimitExceededException": { "type": "structure", @@ -1356,7 +1386,7 @@ } }, "traits": { - "smithy.api#documentation": "The requested resource exceeds the maximum number allowed, or the number of\n concurrent stream requests exceeds the maximum number allowed.
", + "smithy.api#documentation": "The requested resource exceeds the maximum number allowed, or the number of concurrent\n stream requests exceeds the maximum number allowed.
", "smithy.api#error": "client" } }, @@ -1386,7 +1416,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the shards in a stream and provides information about each shard. This\n operation has a limit of 100 transactions per second per data stream.
\nThis API is a new operation that is used by the Amazon Kinesis Client Library\n (KCL). If you have a fine-grained IAM policy that only allows specific operations,\n you must update your policy to allow calls to this API. For more information, see\n Controlling Access to Amazon Kinesis Data Streams Resources Using\n IAM.
\nLists the shards in a stream and provides information about each shard. This operation\n has a limit of 1000 transactions per second per data stream.
\nThis action does not list expired shards. For information about expired shards, see\n Data Routing, Data Persistence, and Shard State after a Reshard.
\nThis API is a new operation that is used by the Amazon Kinesis Client Library\n (KCL). If you have a fine-grained IAM policy that only allows specific operations,\n you must update your policy to allow calls to this API. For more information, see\n Controlling Access to Amazon Kinesis Data Streams Resources Using\n IAM.
\nWhen the number of shards in the data stream is greater than the default value for\n the MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of shards in the data stream,\n the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListShards to\n list the next set of shards.
Don't specify StreamName or StreamCreationTimestamp if\n you specify NextToken because the latter unambiguously identifies the\n stream.
You can optionally specify a value for the MaxResults parameter when\n you specify NextToken. If you specify a MaxResults value that\n is less than the number of shards that the operation returns if you don't specify\n MaxResults, the response will contain a new NextToken\n value. You can use the new NextToken value in a subsequent call to the\n ListShards operation.
Tokens expire after 300 seconds. When you obtain a value for\n NextToken in the response to a call to ListShards, you\n have 300 seconds to use that value. If you specify an expired token in a call to\n ListShards, you get\n ExpiredNextTokenException.
When the number of shards in the data stream is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of shards in the data stream,\n the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListShards to\n list the next set of shards.
Don't specify StreamName or StreamCreationTimestamp if you\n specify NextToken because the latter unambiguously identifies the\n stream.
You can optionally specify a value for the MaxResults parameter when you\n specify NextToken. If you specify a MaxResults value that is\n less than the number of shards that the operation returns if you don't specify\n MaxResults, the response will contain a new NextToken\n value. You can use the new NextToken value in a subsequent call to the\n ListShards operation.
Tokens expire after 300 seconds. When you obtain a value for\n NextToken in the response to a call to ListShards, you\n have 300 seconds to use that value. If you specify an expired token in a call to\n ListShards, you get ExpiredNextTokenException.
Specify this parameter to indicate that you want to list the shards starting with\n the shard whose ID immediately follows ExclusiveStartShardId.
If you don't specify this parameter, the default behavior is for\n ListShards to list the shards starting with the first one in the\n stream.
You cannot specify this parameter if you specify NextToken.
Specify this parameter to indicate that you want to list the shards starting with the\n shard whose ID immediately follows ExclusiveStartShardId.
If you don't specify this parameter, the default behavior is for\n ListShards to list the shards starting with the first one in the\n stream.
You cannot specify this parameter if you specify NextToken.
The maximum number of shards to return in a single call to ListShards.\n The minimum value you can specify for this parameter is 1, and the maximum is 10,000,\n which is also the default.
When the number of shards to be listed is greater than the value of\n MaxResults, the response contains a NextToken value that\n you can use in a subsequent call to ListShards to list the next set of\n shards.
The maximum number of shards to return in a single call to ListShards.\n The maximum number of shards to return in a single call. The default value is 1000. If\n you specify a value greater than 1000, at most 1000 results are returned.
When the number of shards to be listed is greater than the value of\n MaxResults, the response contains a NextToken value that\n you can use in a subsequent call to ListShards to list the next set of\n shards.
Specify this input parameter to distinguish data streams that have the same name.\n For example, if you create a data stream and then delete it, and you later create\n another data stream with the same name, you can use this input parameter to specify\n which of the two streams you want to list the shards for.
\nYou cannot specify this parameter if you specify the NextToken\n parameter.
Specify this input parameter to distinguish data streams that have the same name. For\n example, if you create a data stream and then delete it, and you later create another\n data stream with the same name, you can use this input parameter to specify which of the\n two streams you want to list the shards for.
\nYou cannot specify this parameter if you specify the NextToken\n parameter.
Enables you to filter out the response of the ListShards API. You can\n only specify one filter at a time.
If you use the ShardFilter parameter when invoking the ListShards API,\n the Type is the required property and must be specified. If you specify the\n AT_TRIM_HORIZON, FROM_TRIM_HORIZON, or\n AT_LATEST types, you do not need to specify either the\n ShardId or the Timestamp optional properties.
If you specify the AFTER_SHARD_ID type, you must also provide the value\n for the optional ShardId property. The ShardId property is\n identical in fuctionality to the ExclusiveStartShardId parameter of the\n ListShards API. When ShardId property is specified, the\n response includes the shards starting with the shard whose ID immediately follows the\n ShardId that you provided.
If you specify the AT_TIMESTAMP or FROM_TIMESTAMP_ID type,\n you must also provide the value for the optional Timestamp property. If you\n specify the AT_TIMESTAMP type, then all shards that were open at the provided timestamp\n are returned. If you specify the FROM_TIMESTAMP type, then all shards starting from the\n provided timestamp to TIP are returned.
When the number of shards in the data stream is greater than the default value for\n the MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of shards in the data stream,\n the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListShards to\n list the next set of shards. For more information about the use of this pagination token\n when calling the ListShards operation, see ListShardsInput$NextToken.
Tokens expire after 300 seconds. When you obtain a value for\n NextToken in the response to a call to ListShards, you\n have 300 seconds to use that value. If you specify an expired token in a call to\n ListShards, you get\n ExpiredNextTokenException.
When the number of shards in the data stream is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of shards in the data stream,\n the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListShards to\n list the next set of shards. For more information about the use of this pagination token\n when calling the ListShards operation, see ListShardsInput$NextToken.
Tokens expire after 300 seconds. When you obtain a value for\n NextToken in the response to a call to ListShards, you\n have 300 seconds to use that value. If you specify an expired token in a call to\n ListShards, you get ExpiredNextTokenException.
The ARN of the Kinesis data stream for which you want to list the registered\n consumers. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
", + "smithy.api#documentation": "The ARN of the Kinesis data stream for which you want to list the registered\n consumers. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service\n Namespaces.
", "smithy.api#required": {} } }, @@ -1507,7 +1540,7 @@ "MaxResults": { "target": "com.amazonaws.kinesis#ListStreamConsumersInputLimit", "traits": { - "smithy.api#documentation": "The maximum number of consumers that you want a single call of\n ListStreamConsumers to return.
The maximum number of consumers that you want a single call of\n ListStreamConsumers to return. The default value is 100. If you specify\n a value greater than 100, at most 100 results are returned.
Lists your Kinesis data streams.
\nThe number of streams may be too large to return from a single call to\n ListStreams. You can limit the number of returned streams using the\n Limit parameter. If you do not specify a value for the\n Limit parameter, Kinesis Data Streams uses the default limit, which is\n currently 10.
You can detect if there are more streams available to list by using the\n HasMoreStreams flag from the returned output. If there are more streams\n available, you can request more streams by using the name of the last stream returned by\n the ListStreams request in the ExclusiveStartStreamName\n parameter in a subsequent request to ListStreams. The group of stream names\n returned by the subsequent request is then added to the list. You can continue this\n process until all the stream names have been collected in the list.
\n ListStreams has a limit of five transactions per second per\n account.
" + "smithy.api#documentation": "Lists your Kinesis data streams.
\nThe number of streams may be too large to return from a single call to\n ListStreams. You can limit the number of returned streams using the\n Limit parameter. If you do not specify a value for the\n Limit parameter, Kinesis Data Streams uses the default limit, which is\n currently 100.
You can detect if there are more streams available to list by using the\n HasMoreStreams flag from the returned output. If there are more streams\n available, you can request more streams by using the name of the last stream returned by\n the ListStreams request in the ExclusiveStartStreamName\n parameter in a subsequent request to ListStreams. The group of stream names\n returned by the subsequent request is then added to the list. You can continue this\n process until all the stream names have been collected in the list.
\n ListStreams has a limit of five transactions per second per\n account.
" } }, "com.amazonaws.kinesis#ListStreamsInput": { @@ -1568,7 +1601,7 @@ "Limit": { "target": "com.amazonaws.kinesis#ListStreamsInputLimit", "traits": { - "smithy.api#documentation": "The maximum number of streams to list.
" + "smithy.api#documentation": "The maximum number of streams to list. The default value is 100. If you specify a\n value greater than 100, at most 100 results are returned.
" } }, "ExclusiveStartStreamName": { @@ -1598,7 +1631,7 @@ "StreamNames": { "target": "com.amazonaws.kinesis#StreamNameList", "traits": { - "smithy.api#documentation": "The names of the streams that are associated with the AWS account making the\n ListStreams request.
The names of the streams that are associated with the Amazon Web Services account\n making the ListStreams request.
The key to use as the starting point for the list of tags. If this parameter is\n set, ListTagsForStream gets all tags that occur after\n ExclusiveStartTagKey.
The key to use as the starting point for the list of tags. If this parameter is set,\n ListTagsForStream gets all tags that occur after\n ExclusiveStartTagKey.
If set to true, more tags are available. To request additional tags,\n set ExclusiveStartTagKey to the key of the last tag returned.
If set to true, more tags are available. To request additional tags, set\n ExclusiveStartTagKey to the key of the last tag returned.
Merges two adjacent shards in a Kinesis data stream and combines them into a single\n shard to reduce the stream's capacity to ingest and transport data. Two shards are\n considered adjacent if the union of the hash key ranges for the two shards form a\n contiguous set with no gaps. For example, if you have two shards, one with a hash key\n range of 276...381 and the other with a hash key range of 382...454, then you could\n merge these two shards into a single shard that would have a hash key range of\n 276...454. After the merge, the single child shard receives data for all hash key values\n covered by the two parent shards.
\n\n MergeShards is called when there is a need to reduce the overall capacity\n of a stream because of excess capacity that is not being used. You must specify the\n shard to be merged and the adjacent shard for a stream. For more information about\n merging shards, see Merge Two\n Shards in the Amazon Kinesis Data Streams Developer\n Guide.
If the stream is in the ACTIVE state, you can call\n MergeShards. If a stream is in the CREATING,\n UPDATING, or DELETING state, MergeShards\n returns a ResourceInUseException. If the specified stream does not exist,\n MergeShards returns a ResourceNotFoundException.
You can use DescribeStream to check the state of the stream,\n which is returned in StreamStatus.
\n MergeShards is an asynchronous operation. Upon receiving a\n MergeShards request, Amazon Kinesis Data Streams immediately returns a\n response and sets the StreamStatus to UPDATING. After the\n operation is completed, Kinesis Data Streams sets the StreamStatus to\n ACTIVE. Read and write operations continue to work while the stream is\n in the UPDATING state.
You use DescribeStream to determine the shard IDs that are\n specified in the MergeShards request.
If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards,\n or SplitShard, you receive a LimitExceededException.
\n MergeShards has a limit of five transactions per second per\n account.
Merges two adjacent shards in a Kinesis data stream and combines them into a single\n shard to reduce the stream's capacity to ingest and transport data. Two shards are\n considered adjacent if the union of the hash key ranges for the two shards form a\n contiguous set with no gaps. For example, if you have two shards, one with a hash key\n range of 276...381 and the other with a hash key range of 382...454, then you could\n merge these two shards into a single shard that would have a hash key range of\n 276...454. After the merge, the single child shard receives data for all hash key values\n covered by the two parent shards.
\n\n MergeShards is called when there is a need to reduce the overall capacity\n of a stream because of excess capacity that is not being used. You must specify the\n shard to be merged and the adjacent shard for a stream. For more information about\n merging shards, see Merge Two\n Shards in the Amazon Kinesis Data Streams Developer\n Guide.
If the stream is in the ACTIVE state, you can call\n MergeShards. If a stream is in the CREATING,\n UPDATING, or DELETING state, MergeShards\n returns a ResourceInUseException. If the specified stream does not exist,\n MergeShards returns a ResourceNotFoundException.
You can use DescribeStreamSummary to check the state of the stream,\n which is returned in StreamStatus.
\n MergeShards is an asynchronous operation. Upon receiving a\n MergeShards request, Amazon Kinesis Data Streams immediately returns a\n response and sets the StreamStatus to UPDATING. After the\n operation is completed, Kinesis Data Streams sets the StreamStatus to\n ACTIVE. Read and write operations continue to work while the stream is\n in the UPDATING state.
You use DescribeStreamSummary and the ListShards\n APIs to determine the shard IDs that are specified in the MergeShards\n request.
If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards,\n or SplitShard, you receive a LimitExceededException.
\n MergeShards has a limit of five transactions per second per account.
The shard ID of the shard to combine with the adjacent shard for the\n merge.
", + "smithy.api#documentation": "The shard ID of the shard to combine with the adjacent shard for the merge.
", "smithy.api#required": {} } }, @@ -1817,6 +1853,26 @@ } } }, + "com.amazonaws.kinesis#OnDemandStreamCountLimitObject": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 1000000 + } + } + }, + "com.amazonaws.kinesis#OnDemandStreamCountObject": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 1000000 + } + } + }, "com.amazonaws.kinesis#PartitionKey": { "type": "string", "traits": { @@ -1846,7 +1902,7 @@ } }, "traits": { - "smithy.api#documentation": "The request rate for the stream is too high, or the requested data is too large for\n the available throughput. Reduce the frequency or size of your requests. For more\n information, see Streams Limits in the\n Amazon Kinesis Data Streams Developer Guide, and Error Retries and\n Exponential Backoff in AWS in the AWS General\n Reference.
", + "smithy.api#documentation": "The request rate for the stream is too high, or the requested data is too large for\n the available throughput. Reduce the frequency or size of your requests. For more\n information, see Streams Limits in the\n Amazon Kinesis Data Streams Developer Guide, and Error Retries and\n Exponential Backoff in Amazon Web Services in the Amazon Web Services General Reference.
", "smithy.api#error": "client" } }, @@ -1888,7 +1944,7 @@ } ], "traits": { - "smithy.api#documentation": "Writes a single data record into an Amazon Kinesis data stream. Call\n PutRecord to send data into the stream for real-time ingestion and\n subsequent processing, one record at a time. Each shard can support writes up to 1,000\n records per second, up to a maximum data write total of 1 MiB per second.
You must specify the name of the stream that captures, stores, and transports the\n data; a partition key; and the data blob itself.
\nThe data blob can be any type of data; for example, a segment from a log file,\n geographic/location data, website clickstream data, and so on.
\nThe partition key is used by Kinesis Data Streams to distribute data across shards.\n Kinesis Data Streams segregates the data records that belong to a stream into multiple\n shards, using the partition key associated with each data record to determine the shard\n to which a given data record belongs.
\nPartition keys are Unicode strings, with a maximum length limit of 256 characters\n for each key. An MD5 hash function is used to map partition keys to 128-bit integer\n values and to map associated data records to shards using the hash key ranges of the\n shards. You can override hashing the partition key to determine the shard by explicitly\n specifying a hash value using the ExplicitHashKey parameter. For more\n information, see Adding Data to a Stream in the Amazon Kinesis Data Streams\n Developer Guide.
\n PutRecord returns the shard ID of where the data record was placed and the\n sequence number that was assigned to the data record.
Sequence numbers increase over time and are specific to a shard within a stream,\n not across all shards within a stream. To guarantee strictly increasing ordering, write\n serially to a shard and use the SequenceNumberForOrdering parameter. For\n more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams\n Developer Guide.
After you write a record to a stream, you cannot modify that record or its order\n within the stream.
\nIf a PutRecord request cannot be processed because of insufficient\n provisioned throughput on the shard involved in the request, PutRecord\n throws ProvisionedThroughputExceededException.
By default, data records are accessible for 24 hours from the time that they are\n added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.
" + "smithy.api#documentation": "Writes a single data record into an Amazon Kinesis data stream. Call\n PutRecord to send data into the stream for real-time ingestion and\n subsequent processing, one record at a time. Each shard can support writes up to 1,000\n records per second, up to a maximum data write total of 1 MiB per second.
You must specify the name of the stream that captures, stores, and transports the\n data; a partition key; and the data blob itself.
\nThe data blob can be any type of data; for example, a segment from a log file,\n geographic/location data, website clickstream data, and so on.
\nThe partition key is used by Kinesis Data Streams to distribute data across shards.\n Kinesis Data Streams segregates the data records that belong to a stream into multiple\n shards, using the partition key associated with each data record to determine the shard\n to which a given data record belongs.
\nPartition keys are Unicode strings, with a maximum length limit of 256 characters for\n each key. An MD5 hash function is used to map partition keys to 128-bit integer values\n and to map associated data records to shards using the hash key ranges of the shards.\n You can override hashing the partition key to determine the shard by explicitly\n specifying a hash value using the ExplicitHashKey parameter. For more\n information, see Adding Data to a Stream in the Amazon Kinesis Data Streams\n Developer Guide.
\n PutRecord returns the shard ID of where the data record was placed and the\n sequence number that was assigned to the data record.
Sequence numbers increase over time and are specific to a shard within a stream, not\n across all shards within a stream. To guarantee strictly increasing ordering, write\n serially to a shard and use the SequenceNumberForOrdering parameter. For\n more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams\n Developer Guide.
After you write a record to a stream, you cannot modify that record or its order\n within the stream.
\nIf a PutRecord request cannot be processed because of insufficient\n provisioned throughput on the shard involved in the request, PutRecord\n throws ProvisionedThroughputExceededException.
By default, data records are accessible for 24 hours from the time that they are added\n to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.
" } }, "com.amazonaws.kinesis#PutRecordInput": { @@ -1918,13 +1974,13 @@ "ExplicitHashKey": { "target": "com.amazonaws.kinesis#HashKey", "traits": { - "smithy.api#documentation": "The hash value used to explicitly determine the shard the data record is assigned\n to by overriding the partition key hash.
" + "smithy.api#documentation": "The hash value used to explicitly determine the shard the data record is assigned to\n by overriding the partition key hash.
" } }, "SequenceNumberForOrdering": { "target": "com.amazonaws.kinesis#SequenceNumber", "traits": { - "smithy.api#documentation": "Guarantees strictly increasing sequence numbers, for puts from the same client and\n to the same partition key. Usage: set the SequenceNumberForOrdering of\n record n to the sequence number of record n-1\n (as returned in the result when putting record n-1). If this\n parameter is not set, records are coarsely ordered based on arrival time.
Guarantees strictly increasing sequence numbers, for puts from the same client and to\n the same partition key. Usage: set the SequenceNumberForOrdering of record\n n to the sequence number of record n-1 (as\n returned in the result when putting record n-1). If this parameter\n is not set, records are coarsely ordered based on arrival time.
The sequence number identifier that was assigned to the put data record. The\n sequence number for the record is unique across all records in the stream. A sequence\n number is the identifier associated with every record put into the stream.
", + "smithy.api#documentation": "The sequence number identifier that was assigned to the put data record. The sequence\n number for the record is unique across all records in the stream. A sequence number is\n the identifier associated with every record put into the stream.
", "smithy.api#required": {} } }, "EncryptionType": { "target": "com.amazonaws.kinesis#EncryptionType", "traits": { - "smithy.api#documentation": "The encryption type to use on the record. This parameter can be one of the\n following values:
\n\n NONE: Do not encrypt the records in the stream.
\n KMS: Use server-side encryption on the records in the stream\n using a customer-managed AWS KMS key.
The encryption type to use on the record. This parameter can be one of the following\n values:
\n\n NONE: Do not encrypt the records in the stream.
\n KMS: Use server-side encryption on the records in the stream\n using a customer-managed Amazon Web Services KMS key.
Writes multiple data records into a Kinesis data stream in a single call (also\n referred to as a PutRecords request). Use this operation to send data into\n the stream for data ingestion and processing.
Each PutRecords request can support up to 500 records. Each record in\n the request can be as large as 1 MiB, up to a limit of 5 MiB for the entire request,\n including partition keys. Each shard can support writes up to 1,000 records per second,\n up to a maximum data write total of 1 MiB per second.
You must specify the name of the stream that captures, stores, and transports the\n data; and an array of request Records, with each record in the array\n requiring a partition key and data blob. The record size limit applies to the total size\n of the partition key and data blob.
The data blob can be any type of data; for example, a segment from a log file,\n geographic/location data, website clickstream data, and so on.
\nThe partition key is used by Kinesis Data Streams as input to a hash function that\n maps the partition key and associated data to a specific shard. An MD5 hash function is\n used to map partition keys to 128-bit integer values and to map associated data records\n to shards. As a result of this hashing mechanism, all data records with the same\n partition key map to the same shard within the stream. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams\n Developer Guide.
\nEach record in the Records array may include an optional parameter,\n ExplicitHashKey, which overrides the partition key to shard mapping.\n This parameter allows a data producer to determine explicitly the shard where the record\n is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis\n Data Streams Developer Guide.
The PutRecords response includes an array of response\n Records. Each record in the response array directly correlates with a\n record in the request array using natural ordering, from the top to the bottom of the\n request and response. The response Records array always includes the same\n number of records as the request array.
The response Records array includes both successfully and\n unsuccessfully processed records. Kinesis Data Streams attempts to process all records\n in each PutRecords request. A single record failure does not stop the\n processing of subsequent records. As a result, PutRecords doesn't guarantee the ordering\n of records. If you need to read records in the same order they are written to the\n stream, use PutRecord instead of PutRecords, and write to\n the same shard.
A successfully processed record includes ShardId and\n SequenceNumber values. The ShardId parameter identifies\n the shard in the stream where the record is stored. The SequenceNumber\n parameter is an identifier assigned to the put record, unique to all records in the\n stream.
An unsuccessfully processed record includes ErrorCode and\n ErrorMessage values. ErrorCode reflects the type of error\n and can be one of the following values:\n ProvisionedThroughputExceededException or InternalFailure.\n ErrorMessage provides more detailed information about the\n ProvisionedThroughputExceededException exception including the account\n ID, stream name, and shard ID of the record that was throttled. For more information\n about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis\n Data Streams Developer Guide.
After you write a record to a stream, you cannot modify that record or its order\n within the stream.
\nBy default, data records are accessible for 24 hours from the time that they are\n added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.
" + "smithy.api#documentation": "Writes multiple data records into a Kinesis data stream in a single call (also\n referred to as a PutRecords request). Use this operation to send data into\n the stream for data ingestion and processing.
Each PutRecords request can support up to 500 records. Each record in the\n request can be as large as 1 MiB, up to a limit of 5 MiB for the entire request,\n including partition keys. Each shard can support writes up to 1,000 records per second,\n up to a maximum data write total of 1 MiB per second.
You must specify the name of the stream that captures, stores, and transports the\n data; and an array of request Records, with each record in the array\n requiring a partition key and data blob. The record size limit applies to the total size\n of the partition key and data blob.
The data blob can be any type of data; for example, a segment from a log file,\n geographic/location data, website clickstream data, and so on.
\nThe partition key is used by Kinesis Data Streams as input to a hash function that\n maps the partition key and associated data to a specific shard. An MD5 hash function is\n used to map partition keys to 128-bit integer values and to map associated data records\n to shards. As a result of this hashing mechanism, all data records with the same\n partition key map to the same shard within the stream. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams\n Developer Guide.
\nEach record in the Records array may include an optional parameter,\n ExplicitHashKey, which overrides the partition key to shard mapping.\n This parameter allows a data producer to determine explicitly the shard where the record\n is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis\n Data Streams Developer Guide.
The PutRecords response includes an array of response\n Records. Each record in the response array directly correlates with a\n record in the request array using natural ordering, from the top to the bottom of the\n request and response. The response Records array always includes the same\n number of records as the request array.
The response Records array includes both successfully and unsuccessfully\n processed records. Kinesis Data Streams attempts to process all records in each\n PutRecords request. A single record failure does not stop the\n processing of subsequent records. As a result, PutRecords doesn't guarantee the ordering\n of records. If you need to read records in the same order they are written to the\n stream, use PutRecord instead of PutRecords, and write to\n the same shard.
A successfully processed record includes ShardId and\n SequenceNumber values. The ShardId parameter identifies\n the shard in the stream where the record is stored. The SequenceNumber\n parameter is an identifier assigned to the put record, unique to all records in the\n stream.
An unsuccessfully processed record includes ErrorCode and\n ErrorMessage values. ErrorCode reflects the type of error\n and can be one of the following values:\n ProvisionedThroughputExceededException or InternalFailure.\n ErrorMessage provides more detailed information about the\n ProvisionedThroughputExceededException exception including the account\n ID, stream name, and shard ID of the record that was throttled. For more information\n about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis\n Data Streams Developer Guide.
After you write a record to a stream, you cannot modify that record or its order\n within the stream.
\nBy default, data records are accessible for 24 hours from the time that they are added\n to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.
" } }, "com.amazonaws.kinesis#PutRecordsInput": { @@ -2035,14 +2091,14 @@ "Records": { "target": "com.amazonaws.kinesis#PutRecordsResultEntryList", "traits": { - "smithy.api#documentation": "An array of successfully and unsuccessfully processed record results, correlated\n with the request by natural ordering. A record that is successfully added to a stream\n includes SequenceNumber and ShardId in the result. A record\n that fails to be added to a stream includes ErrorCode and\n ErrorMessage in the result.
An array of successfully and unsuccessfully processed record results. A record that is\n successfully added to a stream includes SequenceNumber and\n ShardId in the result. A record that fails to be added to a stream\n includes ErrorCode and ErrorMessage in the result.
The encryption type used on the records. This parameter can be one of the following\n values:
\n\n NONE: Do not encrypt the records.
\n KMS: Use server-side encryption on the records using a\n customer-managed AWS KMS key.
The encryption type used on the records. This parameter can be one of the following\n values:
\n\n NONE: Do not encrypt the records.
\n KMS: Use server-side encryption on the records using a\n customer-managed Amazon Web Services KMS key.
The hash value used to determine explicitly the shard that the data record is\n assigned to by overriding the partition key hash.
" + "smithy.api#documentation": "The hash value used to determine explicitly the shard that the data record is assigned\n to by overriding the partition key hash.
" } }, "PartitionKey": { @@ -2108,18 +2164,18 @@ "ErrorCode": { "target": "com.amazonaws.kinesis#ErrorCode", "traits": { - "smithy.api#documentation": "The error code for an individual record result. ErrorCodes can be\n either ProvisionedThroughputExceededException or\n InternalFailure.
The error code for an individual record result. ErrorCodes can be either\n ProvisionedThroughputExceededException or\n InternalFailure.
The error message for an individual record result. An ErrorCode value\n of ProvisionedThroughputExceededException has an error message that\n includes the account ID, stream name, and shard ID. An ErrorCode value of\n InternalFailure has the error message \"Internal Service\n Failure\".
The error message for an individual record result. An ErrorCode value of\n ProvisionedThroughputExceededException has an error message that\n includes the account ID, stream name, and shard ID. An ErrorCode value of\n InternalFailure has the error message \"Internal Service\n Failure\".
Represents the result of an individual record from a PutRecords\n request. A record that is successfully added to a stream includes\n SequenceNumber and ShardId in the result. A record that\n fails to be added to the stream includes ErrorCode and\n ErrorMessage in the result.
Represents the result of an individual record from a PutRecords request.\n A record that is successfully added to a stream includes SequenceNumber and\n ShardId in the result. A record that fails to be added to the stream\n includes ErrorCode and ErrorMessage in the result.
The encryption type used on the record. This parameter can be one of the following\n values:
\n\n NONE: Do not encrypt the records in the stream.
\n KMS: Use server-side encryption on the records in the stream\n using a customer-managed AWS KMS key.
The encryption type used on the record. This parameter can be one of the following\n values:
\n\n NONE: Do not encrypt the records in the stream.
\n KMS: Use server-side encryption on the records in the stream\n using a customer-managed Amazon Web Services KMS key.
The unit of data of the Kinesis data stream, which is composed of a sequence\n number, a partition key, and a data blob.
" + "smithy.api#documentation": "The unit of data of the Kinesis data stream, which is composed of a sequence number, a\n partition key, and a data blob.
" } }, "com.amazonaws.kinesis#RecordList": { @@ -2213,7 +2269,7 @@ "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { - "smithy.api#documentation": "The ARN of the Kinesis data stream that you want to register the consumer with. For\n more info, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
", + "smithy.api#documentation": "The ARN of the Kinesis data stream that you want to register the consumer with. For\n more info, see Amazon Resource Names (ARNs) and Amazon Web Services Service\n Namespaces.
", "smithy.api#required": {} } }, @@ -2333,7 +2389,7 @@ "com.amazonaws.kinesis#SequenceNumber": { "type": "string", "traits": { - "smithy.api#pattern": "0|([1-9]\\d{0,128})" + "smithy.api#pattern": "^0|([1-9]\\d{0,128})$" } }, "com.amazonaws.kinesis#SequenceNumberRange": { @@ -2414,15 +2470,25 @@ "Type": { "target": "com.amazonaws.kinesis#ShardFilterType", "traits": { + "smithy.api#documentation": "The shard type specified in the ShardFilter parameter. This is a required\n property of the ShardFilter parameter.
You can specify the following valid values:
\n\n AFTER_SHARD_ID - the response includes all the shards, starting\n with the shard whose ID immediately follows the ShardId that you\n provided.
\n AT_TRIM_HORIZON - the response includes all the shards that were\n open at TRIM_HORIZON.
\n FROM_TRIM_HORIZON - (default), the response includes all the\n shards within the retention period of the data stream (trim to tip).
\n AT_LATEST - the response includes only the currently open shards\n of the data stream.
\n AT_TIMESTAMP - the response includes all shards whose start\n timestamp is less than or equal to the given timestamp and end timestamp is\n greater than or equal to the given timestamp or still open.
\n FROM_TIMESTAMP - the response incldues all closed shards whose\n end timestamp is greater than or equal to the given timestamp and also all open\n shards. Corrected to TRIM_HORIZON of the data stream if\n FROM_TIMESTAMP is less than the TRIM_HORIZON\n value.
The exclusive start shardID speified in the ShardFilter\n parameter. This property can only be used if the AFTER_SHARD_ID shard type\n is specified.
The timestamps specified in the ShardFilter parameter. A timestamp is a\n Unix epoch date with precision in milliseconds. For example,\n 2016-04-04T19:58:46.480-00:00 or 1459799926.480. This property can only be used if\n FROM_TIMESTAMP or AT_TIMESTAMP shard types are\n specified.
The request parameter used to filter out the response of the ListShards\n API.
Splits a shard into two new shards in the Kinesis data stream, to increase the\n stream's capacity to ingest and transport data. SplitShard is called when\n there is a need to increase the overall capacity of a stream because of an expected\n increase in the volume of data records being ingested.
You can also use SplitShard when a shard appears to be approaching its\n maximum utilization; for example, the producers sending data into the specific shard are\n suddenly sending more than previously anticipated. You can also call\n SplitShard to increase stream capacity, so that more Kinesis Data\n Streams applications can simultaneously read data from the stream for real-time\n processing.
You must specify the shard to be split and the new hash key, which is the position\n in the shard where the shard gets split in two. In many cases, the new hash key might be\n the average of the beginning and ending hash key, but it can be any hash key value in\n the range being mapped into the shard. For more information, see Split a\n Shard in the Amazon Kinesis Data Streams Developer\n Guide.
\nYou can use DescribeStream to determine the shard ID and hash key\n values for the ShardToSplit and NewStartingHashKey parameters\n that are specified in the SplitShard request.
\n SplitShard is an asynchronous operation. Upon receiving a\n SplitShard request, Kinesis Data Streams immediately returns a response\n and sets the stream status to UPDATING. After the operation is completed,\n Kinesis Data Streams sets the stream status to ACTIVE. Read and write\n operations continue to work while the stream is in the UPDATING state.
You can use DescribeStream to check the status of the stream, which is\n returned in StreamStatus. If the stream is in the ACTIVE\n state, you can call SplitShard. If a stream is in CREATING or\n UPDATING or DELETING states, DescribeStream\n returns a ResourceInUseException.
If the specified stream does not exist, DescribeStream returns a\n ResourceNotFoundException. If you try to create more shards than are\n authorized for your account, you receive a LimitExceededException.
For the default shard limit for an AWS account, see Kinesis Data Streams\n Limits in the Amazon Kinesis Data Streams Developer\n Guide. To increase this limit, contact AWS\n Support.
\nIf you try to operate on too many streams simultaneously using CreateStream, DeleteStream, MergeShards, and/or SplitShard, you receive a\n LimitExceededException.
\n SplitShard has a limit of five transactions per second per\n account.
Splits a shard into two new shards in the Kinesis data stream, to increase the\n stream's capacity to ingest and transport data. SplitShard is called when\n there is a need to increase the overall capacity of a stream because of an expected\n increase in the volume of data records being ingested.
You can also use SplitShard when a shard appears to be approaching its\n maximum utilization; for example, the producers sending data into the specific shard are\n suddenly sending more than previously anticipated. You can also call\n SplitShard to increase stream capacity, so that more Kinesis Data\n Streams applications can simultaneously read data from the stream for real-time\n processing.
You must specify the shard to be split and the new hash key, which is the position in\n the shard where the shard gets split in two. In many cases, the new hash key might be\n the average of the beginning and ending hash key, but it can be any hash key value in\n the range being mapped into the shard. For more information, see Split a\n Shard in the Amazon Kinesis Data Streams Developer\n Guide.
\nYou can use DescribeStreamSummary and the ListShards APIs to determine the shard ID and hash key values for the ShardToSplit\n and NewStartingHashKey parameters that are specified in the\n SplitShard request.
\n SplitShard is an asynchronous operation. Upon receiving a\n SplitShard request, Kinesis Data Streams immediately returns a response\n and sets the stream status to UPDATING. After the operation is completed,\n Kinesis Data Streams sets the stream status to ACTIVE. Read and write\n operations continue to work while the stream is in the UPDATING state.
You can use DescribeStreamSummary to check the status of the stream,\n which is returned in StreamStatus. If the stream is in the\n ACTIVE state, you can call SplitShard.\n
If the specified stream does not exist, DescribeStreamSummary\n returns a ResourceNotFoundException. If you try to create more shards than\n are authorized for your account, you receive a LimitExceededException.
For the default shard limit for an Amazon Web Services account, see Kinesis\n Data Streams Limits in the Amazon Kinesis Data Streams Developer\n Guide. To increase this limit, contact Amazon Web Services\n Support.
\nIf you try to operate on too many streams simultaneously using CreateStream, DeleteStream, MergeShards, and/or SplitShard, you receive a\n LimitExceededException.
\n SplitShard has a limit of five transactions per second per account.
A hash key value for the starting hash key of one of the child shards created by\n the split. The hash key range for a given shard constitutes a set of ordered contiguous\n positive integers. The value for NewStartingHashKey must be in the range of\n hash keys being mapped into the shard. The NewStartingHashKey hash key\n value and all higher hash key values in hash key range are distributed to one of the\n child shards. All the lower hash key values in the range are distributed to the other\n child shard.
A hash key value for the starting hash key of one of the child shards created by the\n split. The hash key range for a given shard constitutes a set of ordered contiguous\n positive integers. The value for NewStartingHashKey must be in the range of\n hash keys being mapped into the shard. The NewStartingHashKey hash key\n value and all higher hash key values in hash key range are distributed to one of the\n child shards. All the lower hash key values in the range are distributed to the other\n child shard.
Enables or updates server-side encryption using an AWS KMS key for a specified\n stream.
\nStarting encryption is an asynchronous operation. Upon receiving the request,\n Kinesis Data Streams returns immediately and sets the status of the stream to\n UPDATING. After the update is complete, Kinesis Data Streams sets the\n status of the stream back to ACTIVE. Updating or applying encryption\n normally takes a few seconds to complete, but it can take minutes. You can continue to\n read and write data to your stream while its status is UPDATING. Once the\n status of the stream is ACTIVE, encryption begins for records written to\n the stream.
API Limits: You can successfully apply a new AWS KMS key for server-side encryption\n 25 times in a rolling 24-hour period.
\nNote: It can take up to 5 seconds after the stream is in an ACTIVE\n status before all records written to the stream are encrypted. After you enable\n encryption, you can verify that encryption is applied by inspecting the API response\n from PutRecord or PutRecords.
Enables or updates server-side encryption using an Amazon Web Services KMS key for a\n specified stream.
\nStarting encryption is an asynchronous operation. Upon receiving the request, Kinesis\n Data Streams returns immediately and sets the status of the stream to\n UPDATING. After the update is complete, Kinesis Data Streams sets the\n status of the stream back to ACTIVE. Updating or applying encryption\n normally takes a few seconds to complete, but it can take minutes. You can continue to\n read and write data to your stream while its status is UPDATING. Once the\n status of the stream is ACTIVE, encryption begins for records written to\n the stream.
API Limits: You can successfully apply a new Amazon Web Services KMS key for\n server-side encryption 25 times in a rolling 24-hour period.
\nNote: It can take up to 5 seconds after the stream is in an ACTIVE status\n before all records written to the stream are encrypted. After you enable encryption, you\n can verify that encryption is applied by inspecting the API response from\n PutRecord or PutRecords.
The GUID for the customer-managed AWS KMS key to use for encryption. This value can\n be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either\n an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key\n owned by Kinesis Data Streams by specifying the alias\n aws/kinesis.
Key ARN example:\n arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012\n
Alias ARN example:\n arn:aws:kms:us-east-1:123456789012:alias/MyAliasName\n
Globally unique key ID example:\n 12345678-1234-1234-1234-123456789012\n
Alias name example: alias/MyAliasName\n
Master key owned by Kinesis Data Streams:\n alias/aws/kinesis\n
The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.\n This value can be a globally unique identifier, a fully specified Amazon Resource Name\n (ARN) to either an alias or a key, or an alias name prefixed by \"alias/\".You can also\n use a master key owned by Kinesis Data Streams by specifying the alias\n aws/kinesis.
Key ARN example:\n arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012\n
Alias ARN example:\n arn:aws:kms:us-east-1:123456789012:alias/MyAliasName\n
Globally unique key ID example:\n 12345678-1234-1234-1234-123456789012\n
Alias name example: alias/MyAliasName\n
Master key owned by Kinesis Data Streams:\n alias/aws/kinesis\n
The starting position in the data stream from which to start streaming.
" } }, "com.amazonaws.kinesis#StopStreamEncryption": { @@ -2680,7 +2749,7 @@ } ], "traits": { - "smithy.api#documentation": "Disables server-side encryption for a specified stream.
\nStopping encryption is an asynchronous operation. Upon receiving the request,\n Kinesis Data Streams returns immediately and sets the status of the stream to\n UPDATING. After the update is complete, Kinesis Data Streams sets the\n status of the stream back to ACTIVE. Stopping encryption normally takes a\n few seconds to complete, but it can take minutes. You can continue to read and write\n data to your stream while its status is UPDATING. Once the status of the\n stream is ACTIVE, records written to the stream are no longer encrypted by\n Kinesis Data Streams.
API Limits: You can successfully disable server-side encryption 25 times in a\n rolling 24-hour period.
\nNote: It can take up to 5 seconds after the stream is in an ACTIVE\n status before all records written to the stream are no longer subject to encryption.\n After you disabled encryption, you can verify that encryption is not applied by\n inspecting the API response from PutRecord or\n PutRecords.
Disables server-side encryption for a specified stream.
\nStopping encryption is an asynchronous operation. Upon receiving the request, Kinesis\n Data Streams returns immediately and sets the status of the stream to\n UPDATING. After the update is complete, Kinesis Data Streams sets the\n status of the stream back to ACTIVE. Stopping encryption normally takes a\n few seconds to complete, but it can take minutes. You can continue to read and write\n data to your stream while its status is UPDATING. Once the status of the\n stream is ACTIVE, records written to the stream are no longer encrypted by\n Kinesis Data Streams.
API Limits: You can successfully disable server-side encryption 25 times in a rolling\n 24-hour period.
\nNote: It can take up to 5 seconds after the stream is in an ACTIVE status\n before all records written to the stream are no longer subject to encryption. After you\n disabled encryption, you can verify that encryption is not applied by inspecting the API\n response from PutRecord or PutRecords.
The GUID for the customer-managed AWS KMS key to use for encryption. This value can\n be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either\n an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key\n owned by Kinesis Data Streams by specifying the alias\n aws/kinesis.
Key ARN example:\n arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012\n
Alias ARN example:\n arn:aws:kms:us-east-1:123456789012:alias/MyAliasName\n
Globally unique key ID example:\n 12345678-1234-1234-1234-123456789012\n
Alias name example: alias/MyAliasName\n
Master key owned by Kinesis Data Streams:\n alias/aws/kinesis\n
The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.\n This value can be a globally unique identifier, a fully specified Amazon Resource Name\n (ARN) to either an alias or a key, or an alias name prefixed by \"alias/\".You can also\n use a master key owned by Kinesis Data Streams by specifying the alias\n aws/kinesis.
Key ARN example:\n arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012\n
Alias ARN example:\n arn:aws:kms:us-east-1:123456789012:alias/MyAliasName\n
Globally unique key ID example:\n 12345678-1234-1234-1234-123456789012\n
Alias name example: alias/MyAliasName\n
Master key owned by Kinesis Data Streams:\n alias/aws/kinesis\n
Specifies the capacity mode to which you want to set your data stream. Currently, in\n Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.
" + } + }, "Shards": { "target": "com.amazonaws.kinesis#ShardList", "traits": { @@ -2781,13 +2856,13 @@ "EncryptionType": { "target": "com.amazonaws.kinesis#EncryptionType", "traits": { - "smithy.api#documentation": "The server-side encryption type used on the stream. This parameter can be one of\n the following values:
\n\n NONE: Do not encrypt the records in the stream.
\n KMS: Use server-side encryption on the records in the stream\n using a customer-managed AWS KMS key.
The server-side encryption type used on the stream. This parameter can be one of the\n following values:
\n\n NONE: Do not encrypt the records in the stream.
\n KMS: Use server-side encryption on the records in the stream\n using a customer-managed Amazon Web Services KMS key.
The GUID for the customer-managed AWS KMS key to use for encryption. This value can\n be a globally unique identifier, a fully specified ARN to either an alias or a key, or\n an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Data\n Streams by specifying the alias aws/kinesis.
Key ARN example:\n arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012\n
Alias ARN example:\n arn:aws:kms:us-east-1:123456789012:alias/MyAliasName\n
Globally unique key ID example:\n 12345678-1234-1234-1234-123456789012\n
Alias name example: alias/MyAliasName\n
Master key owned by Kinesis Data Streams:\n alias/aws/kinesis\n
The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.\n This value can be a globally unique identifier, a fully specified ARN to either an alias\n or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by\n Kinesis Data Streams by specifying the alias aws/kinesis.
Key ARN example:\n arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012\n
Alias ARN example:\n arn:aws:kms:us-east-1:123456789012:alias/MyAliasName\n
Globally unique key ID example:\n 12345678-1234-1234-1234-123456789012\n
Alias name example: alias/MyAliasName\n
Master key owned by Kinesis Data Streams:\n alias/aws/kinesis\n
Specifies the capacity mode to which you want to set your data stream. Currently, in\n Kinesis Data Streams, you can choose between an on-demand ycapacity mode and a provisioned capacity mode for your data streams.
" + } + }, "RetentionPeriodHours": { "target": "com.amazonaws.kinesis#RetentionPeriodHours", "traits": { @@ -2849,7 +2930,7 @@ "KeyId": { "target": "com.amazonaws.kinesis#KeyId", "traits": { - "smithy.api#documentation": "The GUID for the customer-managed AWS KMS key to use for encryption. This value can\n be a globally unique identifier, a fully specified ARN to either an alias or a key, or\n an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Data\n Streams by specifying the alias aws/kinesis.
Key ARN example:\n arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012\n
Alias ARN example: \n arn:aws:kms:us-east-1:123456789012:alias/MyAliasName\n
Globally unique key ID example:\n 12345678-1234-1234-1234-123456789012\n
Alias name example: alias/MyAliasName\n
Master key owned by Kinesis Data Streams:\n alias/aws/kinesis\n
The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.\n This value can be a globally unique identifier, a fully specified ARN to either an alias\n or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by\n Kinesis Data Streams by specifying the alias aws/kinesis.
Key ARN example:\n arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012\n
Alias ARN example: \n arn:aws:kms:us-east-1:123456789012:alias/MyAliasName\n
Globally unique key ID example:\n 12345678-1234-1234-1234-123456789012\n
Alias name example: alias/MyAliasName\n
Master key owned by Kinesis Data Streams:\n alias/aws/kinesis\n
Represents the output for DescribeStreamSummary\n
" } }, + "com.amazonaws.kinesis#StreamMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PROVISIONED", + "name": "PROVISIONED" + }, + { + "value": "ON_DEMAND", + "name": "ON_DEMAND" + } + ] + } + }, + "com.amazonaws.kinesis#StreamModeDetails": { + "type": "structure", + "members": { + "StreamMode": { + "target": "com.amazonaws.kinesis#StreamMode", + "traits": { + "smithy.api#documentation": "Specifies the capacity mode to which you want to set your data stream. Currently, in\n Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the capacity mode to which you want to set your data stream. Currently, in\n Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.
" + } + }, "com.amazonaws.kinesis#StreamName": { "type": "string", "traits": { @@ -2877,7 +2988,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "[a-zA-Z0-9_.-]+" + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" } }, "com.amazonaws.kinesis#StreamNameList": { @@ -2932,7 +3043,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation establishes an HTTP/2 connection between the consumer you specify in\n the ConsumerARN parameter and the shard you specify in the\n ShardId parameter. After the connection is successfully established,\n Kinesis Data Streams pushes records from the shard to the consumer over this connection.\n Before you call this operation, call RegisterStreamConsumer to\n register the consumer with Kinesis Data Streams.
When the SubscribeToShard call succeeds, your consumer starts receiving\n events of type SubscribeToShardEvent over the HTTP/2 connection for up\n to 5 minutes, after which time you need to call SubscribeToShard again to\n renew the subscription if you want to continue to receive records.
You can make one call to SubscribeToShard per second per registered\n consumer per shard. For example, if you have a 4000 shard stream and two registered\n stream consumers, you can make one SubscribeToShard request per second for\n each combination of shard and registered consumer, allowing you to subscribe both\n consumers to all 4000 shards in one second.
If you call SubscribeToShard again with the same ConsumerARN\n and ShardId within 5 seconds of a successful call, you'll get a\n ResourceInUseException. If you call SubscribeToShard 5\n seconds or more after a successful call, the first connection will expire and the second\n call will take over the subscription.
For an example of how to use this operations, see Enhanced Fan-Out\n Using the Kinesis Data Streams API.
" + "smithy.api#documentation": "This operation establishes an HTTP/2 connection between the consumer you specify in\n the ConsumerARN parameter and the shard you specify in the\n ShardId parameter. After the connection is successfully established,\n Kinesis Data Streams pushes records from the shard to the consumer over this connection.\n Before you call this operation, call RegisterStreamConsumer to\n register the consumer with Kinesis Data Streams.
When the SubscribeToShard call succeeds, your consumer starts receiving\n events of type SubscribeToShardEvent over the HTTP/2 connection for up\n to 5 minutes, after which time you need to call SubscribeToShard again to\n renew the subscription if you want to continue to receive records.
You can make one call to SubscribeToShard per second per registered\n consumer per shard. For example, if you have a 4000 shard stream and two registered\n stream consumers, you can make one SubscribeToShard request per second for\n each combination of shard and registered consumer, allowing you to subscribe both\n consumers to all 4000 shards in one second.
If you call SubscribeToShard again with the same ConsumerARN\n and ShardId within 5 seconds of a successful call, you'll get a\n ResourceInUseException. If you call SubscribeToShard 5\n seconds or more after a successful call, the second call takes over the subscription and\n the previous connection expires or fails with a\n ResourceInUseException.
For an example of how to use this operations, see Enhanced Fan-Out\n Using the Kinesis Data Streams API.
" } }, "com.amazonaws.kinesis#SubscribeToShardEvent": { @@ -2960,7 +3071,10 @@ } }, "ChildShards": { - "target": "com.amazonaws.kinesis#ChildShardList" + "target": "com.amazonaws.kinesis#ChildShardList", + "traits": { + "smithy.api#documentation": "The list of the child shards of the current shard, returned only at the end of the\n current shard.
" + } } }, "traits": { @@ -3032,7 +3146,7 @@ "StartingPosition": { "target": "com.amazonaws.kinesis#StartingPosition", "traits": { - "smithy.api#documentation": "", + "smithy.api#documentation": "The starting position in the data stream from which to start streaming.
", "smithy.api#required": {} } } @@ -3063,7 +3177,7 @@ "Value": { "target": "com.amazonaws.kinesis#TagValue", "traits": { - "smithy.api#documentation": "An optional string, typically used to describe or define the tag. Maximum length:\n 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - %\n @
" + "smithy.api#documentation": "An optional string, typically used to describe or define the tag. Maximum length: 256\n characters. Valid characters: Unicode letters, digits, white space, _ . / = + - %\n @
" } } }, @@ -3151,10 +3265,13 @@ }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { - "smithy.api#documentation": "Updates the shard count of the specified stream to the specified number of\n shards.
\nUpdating the shard count is an asynchronous operation. Upon receiving the request,\n Kinesis Data Streams returns immediately and sets the status of the stream to\n UPDATING. After the update is complete, Kinesis Data Streams sets the\n status of the stream back to ACTIVE. Depending on the size of the stream,\n the scaling action could take a few minutes to complete. You can continue to read and\n write data to your stream while its status is UPDATING.
To update the shard count, Kinesis Data Streams performs splits or merges on\n individual shards. This can cause short-lived shards to be created, in addition to the\n final shards. These short-lived shards count towards your total shard limit for your\n account in the Region.
\nWhen using this operation, we recommend that you specify a target shard count that\n is a multiple of 25% (25%, 50%, 75%, 100%). You can specify any target value within your\n shard limit. However, if you specify a target that isn't a multiple of 25%, the scaling\n action might take longer to complete.
\nThis operation has the following default limits. By default, you cannot do the\n following:
\nScale more than ten times per rolling 24-hour period per stream
\nScale up to more than double your current shard count for a\n stream
\nScale down below half your current shard count for a stream
\nScale up to more than 500 shards in a stream
\nScale a stream with more than 500 shards down unless the result is less\n than 500 shards
\nScale up to more than the shard limit for your account
\nFor the default limits for an AWS account, see Streams Limits in the\n Amazon Kinesis Data Streams Developer Guide. To request an\n increase in the call rate limit, the shard limit for this API, or your overall shard\n limit, use the limits form.
" + "smithy.api#documentation": "Updates the shard count of the specified stream to the specified number of\n shards.
\nUpdating the shard count is an asynchronous operation. Upon receiving the request,\n Kinesis Data Streams returns immediately and sets the status of the stream to\n UPDATING. After the update is complete, Kinesis Data Streams sets the\n status of the stream back to ACTIVE. Depending on the size of the stream,\n the scaling action could take a few minutes to complete. You can continue to read and\n write data to your stream while its status is UPDATING.
To update the shard count, Kinesis Data Streams performs splits or merges on\n individual shards. This can cause short-lived shards to be created, in addition to the\n final shards. These short-lived shards count towards your total shard limit for your\n account in the Region.
\nWhen using this operation, we recommend that you specify a target shard count that is\n a multiple of 25% (25%, 50%, 75%, 100%). You can specify any target value within your\n shard limit. However, if you specify a target that isn't a multiple of 25%, the scaling\n action might take longer to complete.
\nThis operation has the following default limits. By default, you cannot do the\n following:
\nScale more than ten times per rolling 24-hour period per stream
\nScale up to more than double your current shard count for a stream
\nScale down below half your current shard count for a stream
\nScale up to more than 10000 shards in a stream
\nScale a stream with more than 10000 shards down unless the result is less than\n 10000 shards
\nScale up to more than the shard limit for your account
\nFor the default limits for an Amazon Web Services account, see Streams\n Limits in the Amazon Kinesis Data Streams Developer\n Guide. To request an increase in the call rate limit, the shard limit for\n this API, or your overall shard limit, use the limits form.
" } }, "com.amazonaws.kinesis#UpdateShardCountInput": { @@ -3170,7 +3287,7 @@ "TargetShardCount": { "target": "com.amazonaws.kinesis#PositiveIntegerObject", "traits": { - "smithy.api#documentation": "The new number of shards. This value has the following default limits. By default,\n you cannot do the following:
\nSet this value to more than double your current shard count for a\n stream.
\nSet this value below half your current shard count for a stream.
\nSet this value to more than 500 shards in a stream (the default limit for\n shard count per stream is 500 per account per region), unless you request a\n limit increase.
\nScale a stream with more than 500 shards down unless you set this value to\n less than 500 shards.
\nThe new number of shards. This value has the following default limits. By default, you\n cannot do the following:
\nSet this value to more than double your current shard count for a\n stream.
\nSet this value below half your current shard count for a stream.
\nSet this value to more than 10000 shards in a stream (the default limit for\n shard count per stream is 10000 per account per region), unless you request a\n limit increase.
\nScale a stream with more than 10000 shards down unless you set this value to\n less than 10000 shards.
\nUpdates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you\n can choose between an on-demand capacity mode and a\n provisioned capacity mode for your data stream.\n
" + } + }, + "com.amazonaws.kinesis#UpdateStreamModeInput": { + "type": "structure", + "members": { + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", + "traits": { + "smithy.api#documentation": "Specifies the ARN of the data stream whose capacity mode you want to update.
", + "smithy.api#required": {} + } + }, + "StreamModeDetails": { + "target": "com.amazonaws.kinesis#StreamModeDetails", + "traits": { + "smithy.api#documentation": "Specifies the capacity mode to which you want to set your data stream. Currently, in\n Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.kinesis#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.kinesis#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "\n \n
", + "smithy.api#error": "client" + } } } } diff --git a/aws/sdk/aws-models/lakeformation.json b/aws/sdk/aws-models/lakeformation.json index 35f1a1610b4871a54745d8947a9a476ef8addc7e..e1563a317bb8df096ced16b51a571c337fa304c4 100644 --- a/aws/sdk/aws-models/lakeformation.json +++ b/aws/sdk/aws-models/lakeformation.json @@ -31,6 +31,21 @@ "shapes": { "com.amazonaws.lakeformation#AWSLakeFormation": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "LakeFormation", + "arnNamespace": "lakeformation", + "cloudFormationName": "LakeFormation", + "cloudTrailEventSource": "lakeformation.amazonaws.com", + "endpointPrefix": "lakeformation" + }, + "aws.auth#sigv4": { + "name": "lakeformation" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Defines the public endpoint for the Lake Formation service.
", + "smithy.api#title": "AWS Lake Formation" + }, "version": "2017-03-31", "operations": [ { @@ -42,18 +57,39 @@ { "target": "com.amazonaws.lakeformation#BatchRevokePermissions" }, + { + "target": "com.amazonaws.lakeformation#CancelTransaction" + }, + { + "target": "com.amazonaws.lakeformation#CommitTransaction" + }, + { + "target": "com.amazonaws.lakeformation#CreateDataCellsFilter" + }, { "target": "com.amazonaws.lakeformation#CreateLFTag" }, + { + "target": "com.amazonaws.lakeformation#DeleteDataCellsFilter" + }, { "target": "com.amazonaws.lakeformation#DeleteLFTag" }, + { + "target": "com.amazonaws.lakeformation#DeleteObjectsOnCancel" + }, { "target": "com.amazonaws.lakeformation#DeregisterResource" }, { "target": "com.amazonaws.lakeformation#DescribeResource" }, + { + "target": "com.amazonaws.lakeformation#DescribeTransaction" + }, + { + "target": "com.amazonaws.lakeformation#ExtendTransaction" + }, { "target": "com.amazonaws.lakeformation#GetDataLakeSettings" }, @@ -63,12 +99,30 @@ { "target": "com.amazonaws.lakeformation#GetLFTag" }, + { + "target": "com.amazonaws.lakeformation#GetQueryState" + }, + { + "target": "com.amazonaws.lakeformation#GetQueryStatistics" + }, { "target": "com.amazonaws.lakeformation#GetResourceLFTags" }, + { + "target": "com.amazonaws.lakeformation#GetTableObjects" + }, + { + "target": "com.amazonaws.lakeformation#GetWorkUnitResults" + }, + { + "target": "com.amazonaws.lakeformation#GetWorkUnits" + }, { "target": "com.amazonaws.lakeformation#GrantPermissions" }, + { + "target": "com.amazonaws.lakeformation#ListDataCellsFilter" + }, { "target": "com.amazonaws.lakeformation#ListLFTags" }, @@ -78,6 +132,12 @@ { "target": "com.amazonaws.lakeformation#ListResources" }, + { + "target": "com.amazonaws.lakeformation#ListTableStorageOptimizers" + }, + { + "target": "com.amazonaws.lakeformation#ListTransactions" + }, { "target": "com.amazonaws.lakeformation#PutDataLakeSettings" }, @@ -96,28 +156,25 @@ { "target": "com.amazonaws.lakeformation#SearchTablesByLFTags" }, + { + "target": "com.amazonaws.lakeformation#StartQueryPlanning" + }, + { + "target": "com.amazonaws.lakeformation#StartTransaction" + }, { "target": "com.amazonaws.lakeformation#UpdateLFTag" }, { "target": "com.amazonaws.lakeformation#UpdateResource" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "LakeFormation", - "arnNamespace": "lakeformation", - "cloudFormationName": "LakeFormation", - "cloudTrailEventSource": "lakeformation.amazonaws.com", - "endpointPrefix": "lakeformation" }, - "aws.auth#sigv4": { - "name": "lakeformation" + { + "target": "com.amazonaws.lakeformation#UpdateTableObjects" }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Defines the public endpoint for the AWS Lake Formation service.
", - "smithy.api#title": "AWS Lake Formation" - } + { + "target": "com.amazonaws.lakeformation#UpdateTableStorageOptimizer" + } + ] }, "com.amazonaws.lakeformation#AccessDeniedException": { "type": "structure", @@ -131,7 +188,8 @@ }, "traits": { "smithy.api#documentation": "Access to a resource was denied.
", - "smithy.api#error": "client" + "smithy.api#error": "client", + "smithy.api#httpError": 403 } }, "com.amazonaws.lakeformation#AddLFTagsToResource": { @@ -163,7 +221,12 @@ } ], "traits": { - "smithy.api#documentation": "Attaches one or more tags to an existing resource.
" + "smithy.api#documentation": "Attaches one or more LF-tags to an existing resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/AddLFTagsToResource", + "code": 200 + } } }, "com.amazonaws.lakeformation#AddLFTagsToResourceRequest": { @@ -172,20 +235,20 @@ "CatalogId": { "target": "com.amazonaws.lakeformation#CatalogIdString", "traits": { - "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.
" + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
" } }, "Resource": { "target": "com.amazonaws.lakeformation#Resource", "traits": { - "smithy.api#documentation": "The resource to which to attach a tag.
", + "smithy.api#documentation": "The database, table, or column resource to which to attach an LF-tag.
", "smithy.api#required": {} } }, "LFTags": { "target": "com.amazonaws.lakeformation#LFTagsList", "traits": { - "smithy.api#documentation": "The tags to attach to the resource.
", + "smithy.api#documentation": "The LF-tags to attach to the resource.
", "smithy.api#required": {} } } @@ -202,6 +265,48 @@ } } }, + "com.amazonaws.lakeformation#AddObjectInput": { + "type": "structure", + "members": { + "Uri": { + "target": "com.amazonaws.lakeformation#URI", + "traits": { + "smithy.api#documentation": "The Amazon S3 location of the object.
", + "smithy.api#required": {} + } + }, + "ETag": { + "target": "com.amazonaws.lakeformation#ETagString", + "traits": { + "smithy.api#documentation": "The Amazon S3 ETag of the object. Returned by GetTableObjects for validation and used to identify changes to the underlying data.
The size of the Amazon S3 object in bytes.
", + "smithy.api#required": {} + } + }, + "PartitionValues": { + "target": "com.amazonaws.lakeformation#PartitionValuesList", + "traits": { + "smithy.api#documentation": "A list of partition values for the object. A value must be specified for each partition key associated with the table.
\n\tThe supported data types are integer, long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd HH:mm:ss\"), string and decimal.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A new object to add to the governed table.
" + } + }, + "com.amazonaws.lakeformation#AllRowsWildcard": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "A structure that you pass to indicate you want all rows in a filter.
" + } + }, "com.amazonaws.lakeformation#AlreadyExistsException": { "type": "structure", "members": { @@ -234,7 +339,12 @@ } ], "traits": { - "smithy.api#documentation": "Batch operation to grant permissions to the principal.
" + "smithy.api#documentation": "Batch operation to grant permissions to the principal.
", + "smithy.api#http": { + "method": "POST", + "uri": "/BatchGrantPermissions", + "code": 200 + } } }, "com.amazonaws.lakeformation#BatchGrantPermissionsRequest": { @@ -243,7 +353,7 @@ "CatalogId": { "target": "com.amazonaws.lakeformation#CatalogIdString", "traits": { - "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.
" + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
" } }, "Entries": { @@ -354,7 +464,12 @@ } ], "traits": { - "smithy.api#documentation": "Batch operation to revoke permissions from the principal.
" + "smithy.api#documentation": "Batch operation to revoke permissions from the principal.
", + "smithy.api#http": { + "method": "POST", + "uri": "/BatchRevokePermissions", + "code": 200 + } } }, "com.amazonaws.lakeformation#BatchRevokePermissionsRequest": { @@ -363,7 +478,7 @@ "CatalogId": { "target": "com.amazonaws.lakeformation#CatalogIdString", "traits": { - "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.
" + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
" } }, "Entries": { @@ -392,6 +507,62 @@ "smithy.api#box": {} } }, + "com.amazonaws.lakeformation#CancelTransaction": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#CancelTransactionRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#CancelTransactionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.lakeformation#EntityNotFoundException" + }, + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + }, + { + "target": "com.amazonaws.lakeformation#OperationTimeoutException" + }, + { + "target": "com.amazonaws.lakeformation#TransactionCommitInProgressException" + }, + { + "target": "com.amazonaws.lakeformation#TransactionCommittedException" + } + ], + "traits": { + "smithy.api#documentation": "Attempts to cancel the specified transaction. Returns an exception if the transaction was previously committed.
", + "smithy.api#http": { + "method": "POST", + "uri": "/CancelTransaction", + "code": 200 + } + } + }, + "com.amazonaws.lakeformation#CancelTransactionRequest": { + "type": "structure", + "members": { + "TransactionId": { + "target": "com.amazonaws.lakeformation#TransactionIdString", + "traits": { + "smithy.api#documentation": "The transaction to cancel.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lakeformation#CancelTransactionResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.lakeformation#CatalogIdString": { "type": "string", "traits": { @@ -399,7 +570,7 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" } }, "com.amazonaws.lakeformation#CatalogResource": { @@ -421,12 +592,12 @@ "LFTags": { "target": "com.amazonaws.lakeformation#LFTagsList", "traits": { - "smithy.api#documentation": "The tags attached to a column resource.
" + "smithy.api#documentation": "The LF-tags attached to a column resource.
" } } }, "traits": { - "smithy.api#documentation": "A structure containing the name of a column resource and the tags attached to it.
" + "smithy.api#documentation": "A structure containing the name of a column resource and the LF-tags attached to it.
" } }, "com.amazonaws.lakeformation#ColumnLFTagsList": { @@ -455,6 +626,66 @@ "smithy.api#documentation": "A wildcard object, consisting of an optional list of excluded column names or indexes.
" } }, + "com.amazonaws.lakeformation#CommitTransaction": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#CommitTransactionRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#CommitTransactionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.lakeformation#EntityNotFoundException" + }, + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + }, + { + "target": "com.amazonaws.lakeformation#OperationTimeoutException" + }, + { + "target": "com.amazonaws.lakeformation#TransactionCanceledException" + } + ], + "traits": { + "smithy.api#documentation": "Attempts to commit the specified transaction. Returns an exception if the transaction was previously aborted. This API action is idempotent if called multiple times for the same transaction.
", + "smithy.api#http": { + "method": "POST", + "uri": "/CommitTransaction", + "code": 200 + } + } + }, + "com.amazonaws.lakeformation#CommitTransactionRequest": { + "type": "structure", + "members": { + "TransactionId": { + "target": "com.amazonaws.lakeformation#TransactionIdString", + "traits": { + "smithy.api#documentation": "The transaction to commit.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lakeformation#CommitTransactionResponse": { + "type": "structure", + "members": { + "TransactionStatus": { + "target": "com.amazonaws.lakeformation#TransactionStatus", + "traits": { + "smithy.api#documentation": "The status of the transaction.
" + } + } + } + }, "com.amazonaws.lakeformation#ComparisonOperator": { "type": "string", "traits": { @@ -521,6 +752,62 @@ "smithy.api#error": "client" } }, + "com.amazonaws.lakeformation#CreateDataCellsFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#CreateDataCellsFilterRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#CreateDataCellsFilterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#AccessDeniedException" + }, + { + "target": "com.amazonaws.lakeformation#AlreadyExistsException" + }, + { + "target": "com.amazonaws.lakeformation#EntityNotFoundException" + }, + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + }, + { + "target": "com.amazonaws.lakeformation#OperationTimeoutException" + }, + { + "target": "com.amazonaws.lakeformation#ResourceNumberLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a data cell filter to allow one to grant access to certain columns on certain rows.
", + "smithy.api#http": { + "method": "POST", + "uri": "/CreateDataCellsFilter", + "code": 200 + } + } + }, + "com.amazonaws.lakeformation#CreateDataCellsFilterRequest": { + "type": "structure", + "members": { + "TableData": { + "target": "com.amazonaws.lakeformation#DataCellsFilter", + "traits": { + "smithy.api#documentation": "A DataCellsFilter structure containing information about the data cells filter.
Creates a tag with the specified name and values.
" + "smithy.api#documentation": "Creates an LF-tag with the specified name and values.
", + "smithy.api#http": { + "method": "POST", + "uri": "/CreateLFTag", + "code": 200 + } } }, "com.amazonaws.lakeformation#CreateLFTagRequest": { @@ -559,13 +851,13 @@ "CatalogId": { "target": "com.amazonaws.lakeformation#CatalogIdString", "traits": { - "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.
" + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
" } }, "TagKey": { "target": "com.amazonaws.lakeformation#LFTagKey", "traits": { - "smithy.api#documentation": "The key-name for the tag.
", + "smithy.api#documentation": "The key-name for the LF-tag.
", "smithy.api#required": {} } }, @@ -582,13 +874,105 @@ "type": "structure", "members": {} }, - "com.amazonaws.lakeformation#DataLakePrincipal": { + "com.amazonaws.lakeformation#DataCellsFilter": { "type": "structure", "members": { - "DataLakePrincipalIdentifier": { - "target": "com.amazonaws.lakeformation#DataLakePrincipalString", + "TableCatalogId": { + "target": "com.amazonaws.lakeformation#CatalogIdString", + "traits": { + "smithy.api#documentation": "The ID of the catalog to which the table belongs.
", + "smithy.api#required": {} + } + }, + "DatabaseName": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { + "smithy.api#documentation": "A database in the Glue Data Catalog.
", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { + "smithy.api#documentation": "A table in the database.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { + "smithy.api#documentation": "The name given by the user to the data filter cell.
", + "smithy.api#required": {} + } + }, + "RowFilter": { + "target": "com.amazonaws.lakeformation#RowFilter", + "traits": { + "smithy.api#documentation": "A PartiQL predicate.
" + } + }, + "ColumnNames": { + "target": "com.amazonaws.lakeformation#ColumnNames", + "traits": { + "smithy.api#documentation": "A list of column names.
" + } + }, + "ColumnWildcard": { + "target": "com.amazonaws.lakeformation#ColumnWildcard", "traits": { - "smithy.api#documentation": "An identifier for the AWS Lake Formation principal.
" + "smithy.api#documentation": "A wildcard with exclusions.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that describes certain columns on certain rows.
" + } + }, + "com.amazonaws.lakeformation#DataCellsFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.lakeformation#DataCellsFilter" + } + }, + "com.amazonaws.lakeformation#DataCellsFilterResource": { + "type": "structure", + "members": { + "TableCatalogId": { + "target": "com.amazonaws.lakeformation#CatalogIdString", + "traits": { + "smithy.api#documentation": "The ID of the catalog to which the table belongs.
" + } + }, + "DatabaseName": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { + "smithy.api#documentation": "A database in the Glue Data Catalog.
" + } + }, + "TableName": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { + "smithy.api#documentation": "The name of the table.
" + } + }, + "Name": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { + "smithy.api#documentation": "The name of the data cells filter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure for a data cells filter resource.
" + } + }, + "com.amazonaws.lakeformation#DataLakePrincipal": { + "type": "structure", + "members": { + "DataLakePrincipalIdentifier": { + "target": "com.amazonaws.lakeformation#DataLakePrincipalString", + "traits": { + "smithy.api#documentation": "An identifier for the Lake Formation principal.
" } } }, @@ -662,30 +1046,30 @@ "DataLakeAdmins": { "target": "com.amazonaws.lakeformation#DataLakePrincipalList", "traits": { - "smithy.api#documentation": "A list of AWS Lake Formation principals. Supported principals are IAM users or IAM roles.
" + "smithy.api#documentation": "A list of Lake Formation principals. Supported principals are IAM users or IAM roles.
" } }, "CreateDatabaseDefaultPermissions": { "target": "com.amazonaws.lakeformation#PrincipalPermissionsList", "traits": { - "smithy.api#documentation": "A structure representing a list of up to three principal permissions entries for default create database permissions.
" + "smithy.api#documentation": "Specifies whether access control on newly created database is managed by Lake Formation permissions or exclusively by IAM permissions. You can override this default setting when you create a database.
\n\t \nA null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting \"Use only IAM access control,\" and is for backward compatibility with the Glue permission model implemented by IAM permissions.
\n\t\n\tThe only permitted values are an empty array or an array that contains a single JSON object that grants ALL to IAM_ALLOWED_PRINCIPALS.
\n\nFor more information, see Changing the Default Security Settings for Your Data Lake.
" } }, "CreateTableDefaultPermissions": { "target": "com.amazonaws.lakeformation#PrincipalPermissionsList", "traits": { - "smithy.api#documentation": "A structure representing a list of up to three principal permissions entries for default create table permissions.
" + "smithy.api#documentation": "Specifies whether access control on newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.
\n\t \nA null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting \"Use only IAM access control,\" and is for backward compatibility with the Glue permission model implemented by IAM permissions.
\n\t\n\tThe only permitted values are an empty array or an array that contains a single JSON object that grants ALL to IAM_ALLOWED_PRINCIPALS.
\n \nFor more information, see Changing the Default Security Settings for Your Data Lake.
" } }, "TrustedResourceOwners": { "target": "com.amazonaws.lakeformation#TrustedResourceOwners", "traits": { - "smithy.api#documentation": "A list of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs). The user ARNs can be logged in the resource owner's AWS CloudTrail log.
\n\t\n\tYou may want to specify this property when you are in a high-trust boundary, such as the same team or company.
" + "smithy.api#documentation": "A list of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs). The user ARNs can be logged in the resource owner's CloudTrail log.
\n\t\n\tYou may want to specify this property when you are in a high-trust boundary, such as the same team or company.
" } } }, "traits": { - "smithy.api#documentation": "A structure representing a list of AWS Lake Formation principals designated as data lake administrators and lists of principal permission entries for default create database and default create table permissions.
" + "smithy.api#documentation": "A structure representing a list of Lake Formation principals designated as data lake administrators and lists of principal permission entries for default create database and default create table permissions.
" } }, "com.amazonaws.lakeformation#DataLocationResource": { @@ -694,7 +1078,7 @@ "CatalogId": { "target": "com.amazonaws.lakeformation#CatalogIdString", "traits": { - "smithy.api#documentation": "The identifier for the Data Catalog where the location is registered with AWS Lake Formation. By default, it is the account ID of the caller.
" + "smithy.api#documentation": "The identifier for the Data Catalog where the location is registered with Lake Formation. By default, it is the account ID of the caller.
" } }, "ResourceArn": { @@ -736,6 +1120,79 @@ "smithy.api#documentation": "A structure for the database object.
" } }, + "com.amazonaws.lakeformation#DateTime": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.lakeformation#DeleteDataCellsFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#DeleteDataCellsFilterRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#DeleteDataCellsFilterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#AccessDeniedException" + }, + { + "target": "com.amazonaws.lakeformation#EntityNotFoundException" + }, + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + }, + { + "target": "com.amazonaws.lakeformation#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a data cell filter.
", + "smithy.api#http": { + "method": "POST", + "uri": "/DeleteDataCellsFilter", + "code": 200 + } + } + }, + "com.amazonaws.lakeformation#DeleteDataCellsFilterRequest": { + "type": "structure", + "members": { + "TableCatalogId": { + "target": "com.amazonaws.lakeformation#CatalogIdString", + "traits": { + "smithy.api#documentation": "The ID of the catalog to which the table belongs.
" + } + }, + "DatabaseName": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { + "smithy.api#documentation": "A database in the Glue Data Catalog.
" + } + }, + "TableName": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { + "smithy.api#documentation": "A table in the database.
" + } + }, + "Name": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { + "smithy.api#documentation": "The name given by the user to the data filter cell.
" + } + } + } + }, + "com.amazonaws.lakeformation#DeleteDataCellsFilterResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.lakeformation#DeleteLFTag": { "type": "operation", "input": { @@ -762,7 +1219,12 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified tag key name. If the attribute key does not exist or the tag does not exist, then the operation will not do anything. If the attribute key exists, then the operation checks if any resources are tagged with this attribute key, if yes, the API throws a 400 Exception with the message \"Delete not allowed\" as the tag key is still attached with resources. You can consider untagging resources with this tag key.
" + "smithy.api#documentation": "Deletes the specified LF-tag key name. If the attribute key does not exist or the LF-tag does not exist, then the operation will not do anything. If the attribute key exists, then the operation checks if any resources are tagged with this attribute key, if yes, the API throws a 400 Exception with the message \"Delete not allowed\" as the LF-tag key is still attached with resources. You can consider untagging resources with this LF-tag key.
", + "smithy.api#http": { + "method": "POST", + "uri": "/DeleteLFTag", + "code": 200 + } } }, "com.amazonaws.lakeformation#DeleteLFTagRequest": { @@ -771,13 +1233,13 @@ "CatalogId": { "target": "com.amazonaws.lakeformation#CatalogIdString", "traits": { - "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.
" + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
" } }, "TagKey": { "target": "com.amazonaws.lakeformation#LFTagKey", "traits": { - "smithy.api#documentation": "The key-name for the tag to delete.
", + "smithy.api#documentation": "The key-name for the LF-tag to delete.
", "smithy.api#required": {} } } @@ -787,6 +1249,119 @@ "type": "structure", "members": {} }, + "com.amazonaws.lakeformation#DeleteObjectInput": { + "type": "structure", + "members": { + "Uri": { + "target": "com.amazonaws.lakeformation#URI", + "traits": { + "smithy.api#documentation": "The Amazon S3 location of the object to delete.
", + "smithy.api#required": {} + } + }, + "ETag": { + "target": "com.amazonaws.lakeformation#ETagString", + "traits": { + "smithy.api#documentation": "The Amazon S3 ETag of the object. Returned by GetTableObjects for validation and used to identify changes to the underlying data.
A list of partition values for the object. A value must be specified for each partition key associated with the governed table.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object to delete from the governed table.
" + } + }, + "com.amazonaws.lakeformation#DeleteObjectsOnCancel": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#DeleteObjectsOnCancelRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#DeleteObjectsOnCancelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.lakeformation#EntityNotFoundException" + }, + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + }, + { + "target": "com.amazonaws.lakeformation#OperationTimeoutException" + }, + { + "target": "com.amazonaws.lakeformation#ResourceNotReadyException" + }, + { + "target": "com.amazonaws.lakeformation#TransactionCanceledException" + }, + { + "target": "com.amazonaws.lakeformation#TransactionCommittedException" + } + ], + "traits": { + "smithy.api#documentation": "For a specific governed table, provides a list of Amazon S3 objects that will be written during the current transaction and that can be automatically deleted\n if the transaction is canceled. Without this call, no Amazon S3 objects are automatically deleted when a transaction cancels.\n
\n\n The Glue ETL library function write_dynamic_frame.from_catalog() includes an option to automatically \n call DeleteObjectsOnCancel before writes. For more information, see \n Rolling Back Amazon S3 Writes.\n
The Glue data catalog that contains the governed table. Defaults to the current account ID.
" + } + }, + "DatabaseName": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { + "smithy.api#documentation": "The database that contains the governed table.
", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { + "smithy.api#documentation": "The name of the governed table.
", + "smithy.api#required": {} + } + }, + "TransactionId": { + "target": "com.amazonaws.lakeformation#TransactionIdString", + "traits": { + "smithy.api#documentation": "ID of the transaction that the writes occur in.
", + "smithy.api#required": {} + } + }, + "Objects": { + "target": "com.amazonaws.lakeformation#VirtualObjectList", + "traits": { + "smithy.api#documentation": "A list of VirtualObject structures, which indicates the Amazon S3 objects to be deleted if the transaction cancels.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lakeformation#DeleteObjectsOnCancelResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.lakeformation#DeregisterResource": { "type": "operation", "input": { @@ -810,7 +1385,12 @@ } ], "traits": { - "smithy.api#documentation": "Deregisters the resource as managed by the Data Catalog.
\n\t\nWhen you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role.
" + "smithy.api#documentation": "Deregisters the resource as managed by the Data Catalog.
\n\t\nWhen you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role.
", + "smithy.api#http": { + "method": "POST", + "uri": "/DeregisterResource", + "code": 200 + } } }, "com.amazonaws.lakeformation#DeregisterResourceRequest": { @@ -852,7 +1432,12 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the current data access role for the given resource registered in AWS Lake Formation.
" + "smithy.api#documentation": "Retrieves the current data access role for the given resource registered in Lake Formation.
", + "smithy.api#http": { + "method": "POST", + "uri": "/DescribeResource", + "code": 200 + } } }, "com.amazonaws.lakeformation#DescribeResourceRequest": { @@ -873,7 +1458,61 @@ "ResourceInfo": { "target": "com.amazonaws.lakeformation#ResourceInfo", "traits": { - "smithy.api#documentation": "A structure containing information about an AWS Lake Formation resource.
" + "smithy.api#documentation": "A structure containing information about an Lake Formation resource.
" + } + } + } + }, + "com.amazonaws.lakeformation#DescribeTransaction": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#DescribeTransactionRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#DescribeTransactionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#EntityNotFoundException" + }, + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + }, + { + "target": "com.amazonaws.lakeformation#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the details of a single transaction.
", + "smithy.api#http": { + "method": "POST", + "uri": "/DescribeTransaction", + "code": 200 + } + } + }, + "com.amazonaws.lakeformation#DescribeTransactionRequest": { + "type": "structure", + "members": { + "TransactionId": { + "target": "com.amazonaws.lakeformation#TransactionIdString", + "traits": { + "smithy.api#documentation": "The transaction for which to return status.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lakeformation#DescribeTransactionResponse": { + "type": "structure", + "members": { + "TransactionDescription": { + "target": "com.amazonaws.lakeformation#TransactionDescription", + "traits": { + "smithy.api#documentation": "Returns a TransactionDescription object containing information about the transaction.
A resource share ARN for a catalog resource shared through AWS Resource Access Manager (AWS RAM).
" + "smithy.api#documentation": "A resource share ARN for a catalog resource shared through RAM.
" } } }, "traits": { - "smithy.api#documentation": "A structure containing the additional details to be returned in the AdditionalDetails attribute of PrincipalResourcePermissions.
If a catalog resource is shared through AWS Resource Access Manager (AWS RAM), then there will exist a corresponding RAM resource share ARN.
" + "smithy.api#documentation": "A structure containing the additional details to be returned in the AdditionalDetails attribute of PrincipalResourcePermissions.
If a catalog resource is shared through Resource Access Manager (RAM), then there will exist a corresponding RAM resource share ARN.
" + } + }, + "com.amazonaws.lakeformation#ETagString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\p{L}\\p{N}\\p{P}]*$" } }, "com.amazonaws.lakeformation#EntityNotFoundException": { @@ -937,6 +1586,51 @@ "smithy.api#documentation": "Contains details about an error.
" } }, + "com.amazonaws.lakeformation#ErrorMessageString": { + "type": "string" + }, + "com.amazonaws.lakeformation#ExecutionStatistics": { + "type": "structure", + "members": { + "AverageExecutionTimeMillis": { + "target": "com.amazonaws.lakeformation#NumberOfMilliseconds", + "traits": { + "smithy.api#documentation": "The average time the request took to be executed.
" + } + }, + "DataScannedBytes": { + "target": "com.amazonaws.lakeformation#NumberOfBytes", + "traits": { + "smithy.api#documentation": "The amount of data that was scanned in bytes.
" + } + }, + "WorkUnitsExecutedCount": { + "target": "com.amazonaws.lakeformation#NumberOfItems", + "traits": { + "smithy.api#documentation": "The number of work units executed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Statistics related to the processing of a query statement.
" + } + }, + "com.amazonaws.lakeformation#ExpiredException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.lakeformation#MessageString", + "traits": { + "smithy.api#documentation": "A message describing the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an error where the query request expired.
", + "smithy.api#error": "client", + "smithy.api#httpError": 410 + } + }, "com.amazonaws.lakeformation#Expression": { "type": "list", "member": { @@ -949,10 +1643,65 @@ } } }, - "com.amazonaws.lakeformation#FieldNameString": { - "type": "string", - "traits": { - "smithy.api#enum": [ + "com.amazonaws.lakeformation#ExtendTransaction": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#ExtendTransactionRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#ExtendTransactionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#EntityNotFoundException" + }, + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + }, + { + "target": "com.amazonaws.lakeformation#OperationTimeoutException" + }, + { + "target": "com.amazonaws.lakeformation#TransactionCanceledException" + }, + { + "target": "com.amazonaws.lakeformation#TransactionCommitInProgressException" + }, + { + "target": "com.amazonaws.lakeformation#TransactionCommittedException" + } + ], + "traits": { + "smithy.api#documentation": "Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted.
\n\t\n\tWrite transactions that remain idle for a long period are automatically aborted unless explicitly extended.
", + "smithy.api#http": { + "method": "POST", + "uri": "/ExtendTransaction", + "code": 200 + } + } + }, + "com.amazonaws.lakeformation#ExtendTransactionRequest": { + "type": "structure", + "members": { + "TransactionId": { + "target": "com.amazonaws.lakeformation#TransactionIdString", + "traits": { + "smithy.api#documentation": "The transaction to extend.
" + } + } + } + }, + "com.amazonaws.lakeformation#ExtendTransactionResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.lakeformation#FieldNameString": { + "type": "string", + "traits": { + "smithy.api#enum": [ { "value": "RESOURCE_ARN", "name": "RESOURCE_ARN" @@ -1026,7 +1775,12 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
" + "smithy.api#documentation": "Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
", + "smithy.api#http": { + "method": "POST", + "uri": "/GetDataLakeSettings", + "code": 200 + } } }, "com.amazonaws.lakeformation#GetDataLakeSettingsRequest": { @@ -1035,7 +1789,7 @@ "CatalogId": { "target": "com.amazonaws.lakeformation#CatalogIdString", "traits": { - "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.
" + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
" } } } @@ -1046,7 +1800,7 @@ "DataLakeSettings": { "target": "com.amazonaws.lakeformation#DataLakeSettings", "traits": { - "smithy.api#documentation": "A structure representing a list of AWS Lake Formation principals designated as data lake administrators.
" + "smithy.api#documentation": "A structure representing a list of Lake Formation principals designated as data lake administrators.
" } } } @@ -1075,6 +1829,11 @@ ], "traits": { "smithy.api#documentation": "Returns the Lake Formation permissions for a specified table or database resource located\n at a path in Amazon S3. GetEffectivePermissionsForPath will not return databases and tables if the catalog is encrypted.
The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.
" + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
" } }, "ResourceArn": { @@ -1155,7 +1914,12 @@ } ], "traits": { - "smithy.api#documentation": "Returns a tag definition.
" + "smithy.api#documentation": "Returns an LF-tag definition.
", + "smithy.api#http": { + "method": "POST", + "uri": "/GetLFTag", + "code": 200 + } } }, "com.amazonaws.lakeformation#GetLFTagRequest": { @@ -1164,13 +1928,13 @@ "CatalogId": { "target": "com.amazonaws.lakeformation#CatalogIdString", "traits": { - "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.
" + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
" } }, "TagKey": { "target": "com.amazonaws.lakeformation#LFTagKey", "traits": { - "smithy.api#documentation": "The key-name for the tag.
", + "smithy.api#documentation": "The key-name for the LF-tag.
", "smithy.api#required": {} } } @@ -1182,13 +1946,13 @@ "CatalogId": { "target": "com.amazonaws.lakeformation#CatalogIdString", "traits": { - "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.
" + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
" } }, "TagKey": { "target": "com.amazonaws.lakeformation#LFTagKey", "traits": { - "smithy.api#documentation": "The key-name for the tag.
" + "smithy.api#documentation": "The key-name for the LF-tag.
" } }, "TagValues": { @@ -1199,6 +1963,163 @@ } } }, + "com.amazonaws.lakeformation#GetQueryState": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#GetQueryStateRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#GetQueryStateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#AccessDeniedException" + }, + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the state of a query previously submitted. Clients are expected to poll GetQueryState to monitor the current state of the planning before retrieving the work units. A query state is only visible to the principal that made the initial call to StartQueryPlanning.
The ID of the plan query operation.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lakeformation#GetQueryStateRequestQueryIdString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + } + } + }, + "com.amazonaws.lakeformation#GetQueryStateResponse": { + "type": "structure", + "members": { + "Error": { + "target": "com.amazonaws.lakeformation#ErrorMessageString", + "traits": { + "smithy.api#documentation": "An error message when the operation fails.
" + } + }, + "State": { + "target": "com.amazonaws.lakeformation#QueryStateString", + "traits": { + "smithy.api#documentation": "The state of a query previously submitted. The possible states are:
\n\t\n\tPENDING: the query is pending.
\nWORKUNITS_AVAILABLE: some work units are ready for retrieval and execution.
\nFINISHED: the query planning finished successfully, and all work units are ready for retrieval and execution.
\nERROR: an error occurred with the query, such as an invalid query ID or a backend error.
\nA structure for the output.
" + } + }, + "com.amazonaws.lakeformation#GetQueryStatistics": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#GetQueryStatisticsRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#GetQueryStatisticsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#AccessDeniedException" + }, + { + "target": "com.amazonaws.lakeformation#ExpiredException" + }, + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + }, + { + "target": "com.amazonaws.lakeformation#StatisticsNotReadyYetException" + }, + { + "target": "com.amazonaws.lakeformation#ThrottledException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves statistics on the planning and execution of a query.
", + "smithy.api#endpoint": { + "hostPrefix": "query-" + }, + "smithy.api#http": { + "method": "POST", + "uri": "/GetQueryStatistics", + "code": 200 + } + } + }, + "com.amazonaws.lakeformation#GetQueryStatisticsRequest": { + "type": "structure", + "members": { + "QueryId": { + "target": "com.amazonaws.lakeformation#GetQueryStatisticsRequestQueryIdString", + "traits": { + "smithy.api#documentation": "The ID of the plan query operation.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lakeformation#GetQueryStatisticsRequestQueryIdString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + } + } + }, + "com.amazonaws.lakeformation#GetQueryStatisticsResponse": { + "type": "structure", + "members": { + "ExecutionStatistics": { + "target": "com.amazonaws.lakeformation#ExecutionStatistics", + "traits": { + "smithy.api#documentation": "An ExecutionStatistics structure containing execution statistics.
A PlanningStatistics structure containing query planning statistics.
The time that the query was submitted.
" + } + } + } + }, "com.amazonaws.lakeformation#GetResourceLFTags": { "type": "operation", "input": { @@ -1228,7 +2149,12 @@ } ], "traits": { - "smithy.api#documentation": "Returns the tags applied to a resource.
" + "smithy.api#documentation": "Returns the LF-tags applied to a resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/GetResourceLFTags", + "code": 200 + } } }, "com.amazonaws.lakeformation#GetResourceLFTagsRequest": { @@ -1237,20 +2163,20 @@ "CatalogId": { "target": "com.amazonaws.lakeformation#CatalogIdString", "traits": { - "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.
" + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
" } }, "Resource": { "target": "com.amazonaws.lakeformation#Resource", "traits": { - "smithy.api#documentation": "The resource for which you want to return tags.
", + "smithy.api#documentation": "The database, table, or column resource for which you want to return LF-tags.
", "smithy.api#required": {} } }, "ShowAssignedLFTags": { "target": "com.amazonaws.lakeformation#BooleanNullable", "traits": { - "smithy.api#documentation": "Indicates whether to show the assigned tags.
" + "smithy.api#documentation": "Indicates whether to show the assigned LF-tags.
" } } } @@ -1261,131 +2187,452 @@ "LFTagOnDatabase": { "target": "com.amazonaws.lakeformation#LFTagsList", "traits": { - "smithy.api#documentation": "A list of tags applied to a database resource.
" + "smithy.api#documentation": "A list of LF-tags applied to a database resource.
" } }, "LFTagsOnTable": { "target": "com.amazonaws.lakeformation#LFTagsList", "traits": { - "smithy.api#documentation": "A list of tags applied to a table resource.
" + "smithy.api#documentation": "A list of LF-tags applied to a table resource.
" } }, "LFTagsOnColumns": { "target": "com.amazonaws.lakeformation#ColumnLFTagsList", "traits": { - "smithy.api#documentation": "A list of tags applied to a column resource.
" - } - } - } - }, - "com.amazonaws.lakeformation#GlueEncryptionException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.lakeformation#MessageString", - "traits": { - "smithy.api#documentation": "A message describing the problem.
" + "smithy.api#documentation": "A list of LF-tags applied to a column resource.
" } } - }, - "traits": { - "smithy.api#documentation": "An encryption operation failed.
", - "smithy.api#error": "client" } }, - "com.amazonaws.lakeformation#GrantPermissions": { + "com.amazonaws.lakeformation#GetTableObjects": { "type": "operation", "input": { - "target": "com.amazonaws.lakeformation#GrantPermissionsRequest" + "target": "com.amazonaws.lakeformation#GetTableObjectsRequest" }, "output": { - "target": "com.amazonaws.lakeformation#GrantPermissionsResponse" + "target": "com.amazonaws.lakeformation#GetTableObjectsResponse" }, "errors": [ { - "target": "com.amazonaws.lakeformation#ConcurrentModificationException" + "target": "com.amazonaws.lakeformation#EntityNotFoundException" }, { - "target": "com.amazonaws.lakeformation#EntityNotFoundException" + "target": "com.amazonaws.lakeformation#InternalServiceException" }, { "target": "com.amazonaws.lakeformation#InvalidInputException" + }, + { + "target": "com.amazonaws.lakeformation#OperationTimeoutException" + }, + { + "target": "com.amazonaws.lakeformation#ResourceNotReadyException" + }, + { + "target": "com.amazonaws.lakeformation#TransactionCanceledException" + }, + { + "target": "com.amazonaws.lakeformation#TransactionCommittedException" } ], "traits": { - "smithy.api#documentation": "Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
\n\tFor information about permissions, see Security and Access Control to Metadata and Data.
" + "smithy.api#documentation": "Returns the set of Amazon S3 objects that make up the specified governed table. A transaction ID or timestamp can be specified for time-travel queries.
", + "smithy.api#http": { + "method": "POST", + "uri": "/GetTableObjects", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } } }, - "com.amazonaws.lakeformation#GrantPermissionsRequest": { + "com.amazonaws.lakeformation#GetTableObjectsRequest": { "type": "structure", "members": { "CatalogId": { "target": "com.amazonaws.lakeformation#CatalogIdString", "traits": { - "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.
" + "smithy.api#documentation": "The catalog containing the governed table. Defaults to the caller’s account.
" } }, - "Principal": { - "target": "com.amazonaws.lakeformation#DataLakePrincipal", + "DatabaseName": { + "target": "com.amazonaws.lakeformation#NameString", "traits": { - "smithy.api#documentation": "The principal to be granted the permissions on the resource. Supported principals are IAM users or IAM roles, and they are defined by their principal type and their ARN.
\n\tNote that if you define a resource with a particular ARN, then later delete, and recreate a resource with that same ARN, the resource maintains the permissions already granted.
", + "smithy.api#documentation": "The database containing the governed table.
", "smithy.api#required": {} } }, - "Resource": { - "target": "com.amazonaws.lakeformation#Resource", + "TableName": { + "target": "com.amazonaws.lakeformation#NameString", "traits": { - "smithy.api#documentation": "The resource to which permissions are to be granted. Resources in AWS Lake Formation are the Data Catalog, databases, and tables.
", + "smithy.api#documentation": "The governed table for which to retrieve objects.
", "smithy.api#required": {} } }, - "Permissions": { - "target": "com.amazonaws.lakeformation#PermissionList", + "TransactionId": { + "target": "com.amazonaws.lakeformation#TransactionIdString", "traits": { - "smithy.api#documentation": "The permissions granted to the principal on the resource. AWS Lake Formation defines privileges to grant and revoke access to metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. AWS Lake Formation requires that each principal be authorized to perform a specific task on AWS Lake Formation resources.
", - "smithy.api#required": {} + "smithy.api#documentation": "The transaction ID at which to read the governed table contents. If this transaction has aborted, an error is returned. If not set, defaults to the most recent committed transaction. Cannot be specified along with QueryAsOfTime.
Indicates a list of the granted permissions that the principal may pass to other users. These permissions may only be a subset of the permissions granted in the Privileges.
The time as of when to read the governed table contents. If not set, the most recent transaction commit time is used. Cannot be specified along with TransactionId.
A predicate to filter the objects returned based on the partition keys defined in the governed table.
\n\tThe comparison operators supported are: =, >, <, >=, <=
\nThe logical operators supported are: AND
\nThe data types supported are integer, long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd HH:mm:ss\"), string and decimal.
\nSpecifies how many values to return in a page.
" + } + }, + "NextToken": { + "target": "com.amazonaws.lakeformation#TokenString", + "traits": { + "smithy.api#documentation": "A continuation token if this is not the first call to retrieve these objects.
" } } } }, - "com.amazonaws.lakeformation#GrantPermissionsResponse": { + "com.amazonaws.lakeformation#GetTableObjectsResponse": { "type": "structure", - "members": {} - }, - "com.amazonaws.lakeformation#IAMRoleArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "arn:aws:iam::[0-9]*:role/.*" + "members": { + "Objects": { + "target": "com.amazonaws.lakeformation#PartitionedTableObjectsList", + "traits": { + "smithy.api#documentation": "A list of objects organized by partition keys.
" + } + }, + "NextToken": { + "target": "com.amazonaws.lakeformation#TokenString", + "traits": { + "smithy.api#documentation": "A continuation token indicating whether additional data is available.
" + } + } } }, - "com.amazonaws.lakeformation#Identifier": { - "type": "string", + "com.amazonaws.lakeformation#GetWorkUnitResults": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#GetWorkUnitResultsRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#GetWorkUnitResultsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#AccessDeniedException" + }, + { + "target": "com.amazonaws.lakeformation#ExpiredException" + }, + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + }, + { + "target": "com.amazonaws.lakeformation#ThrottledException" + } + ], "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 + "smithy.api#documentation": "Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
", + "smithy.api#endpoint": { + "hostPrefix": "data-" + }, + "smithy.api#http": { + "method": "POST", + "uri": "/GetWorkUnitResults", + "code": 200 } } }, - "com.amazonaws.lakeformation#InternalServiceException": { + "com.amazonaws.lakeformation#GetWorkUnitResultsRequest": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.lakeformation#MessageString", + "QueryId": { + "target": "com.amazonaws.lakeformation#GetWorkUnitResultsRequestQueryIdString", "traits": { - "smithy.api#documentation": "A message describing the problem.
" + "smithy.api#documentation": "The ID of the plan query operation for which to get results.
", + "smithy.api#required": {} + } + }, + "WorkUnitId": { + "target": "com.amazonaws.lakeformation#GetWorkUnitResultsRequestWorkUnitIdLong", + "traits": { + "smithy.api#documentation": "The work unit ID for which to get results. Value generated by enumerating WorkUnitIdMin to WorkUnitIdMax (inclusive) from the WorkUnitRange in the output of GetWorkUnits.
A work token used to query the execution service. Token output from GetWorkUnits.
Rows returned from the GetWorkUnitResults operation as a stream of Apache Arrow v1.0 messages.
A structure for the output.
" + } + }, + "com.amazonaws.lakeformation#GetWorkUnits": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#GetWorkUnitsRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#GetWorkUnitsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#AccessDeniedException" + }, + { + "target": "com.amazonaws.lakeformation#ExpiredException" + }, + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + }, + { + "target": "com.amazonaws.lakeformation#WorkUnitsNotReadyYetException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the work units generated by the StartQueryPlanning operation.
A continuation token, if this is a continuation call.
" + } + }, + "PageSize": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The size of each page to get in the Amazon Web Services service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the Amazon Web Services service, retrieving fewer items in each call. This can help prevent the Amazon Web Services service calls from timing out.
" + } + }, + "QueryId": { + "target": "com.amazonaws.lakeformation#GetWorkUnitsRequestQueryIdString", + "traits": { + "smithy.api#documentation": "The ID of the plan query operation.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lakeformation#GetWorkUnitsRequestQueryIdString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + } + } + }, + "com.amazonaws.lakeformation#GetWorkUnitsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.lakeformation#Token", + "traits": { + "smithy.api#documentation": "A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
" + } + }, + "QueryId": { + "target": "com.amazonaws.lakeformation#QueryIdString", + "traits": { + "smithy.api#documentation": "The ID of the plan query operation.
", + "smithy.api#required": {} + } + }, + "WorkUnitRanges": { + "target": "com.amazonaws.lakeformation#WorkUnitRangeList", + "traits": { + "smithy.api#documentation": "A WorkUnitRangeList object that specifies the valid range of work unit IDs for querying the execution service.
A structure for the output.
" + } + }, + "com.amazonaws.lakeformation#GlueEncryptionException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.lakeformation#MessageString", + "traits": { + "smithy.api#documentation": "A message describing the problem.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An encryption operation failed.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.lakeformation#GrantPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#GrantPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#GrantPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.lakeformation#EntityNotFoundException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + } + ], + "traits": { + "smithy.api#documentation": "Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
\n\tFor information about permissions, see Security and Access Control to Metadata and Data.
", + "smithy.api#http": { + "method": "POST", + "uri": "/GrantPermissions", + "code": 200 + } + } + }, + "com.amazonaws.lakeformation#GrantPermissionsRequest": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.lakeformation#CatalogIdString", + "traits": { + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
" + } + }, + "Principal": { + "target": "com.amazonaws.lakeformation#DataLakePrincipal", + "traits": { + "smithy.api#documentation": "The principal to be granted the permissions on the resource. Supported principals are IAM users or IAM roles, and they are defined by their principal type and their ARN.
\n\tNote that if you define a resource with a particular ARN, then later delete, and recreate a resource with that same ARN, the resource maintains the permissions already granted.
", + "smithy.api#required": {} + } + }, + "Resource": { + "target": "com.amazonaws.lakeformation#Resource", + "traits": { + "smithy.api#documentation": "The resource to which permissions are to be granted. Resources in Lake Formation are the Data Catalog, databases, and tables.
", + "smithy.api#required": {} + } + }, + "Permissions": { + "target": "com.amazonaws.lakeformation#PermissionList", + "traits": { + "smithy.api#documentation": "The permissions granted to the principal on the resource. Lake Formation defines privileges to grant and revoke access to metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. Lake Formation requires that each principal be authorized to perform a specific task on Lake Formation resources.
", + "smithy.api#required": {} + } + }, + "PermissionsWithGrantOption": { + "target": "com.amazonaws.lakeformation#PermissionList", + "traits": { + "smithy.api#documentation": "Indicates a list of the granted permissions that the principal may pass to other users. These permissions may only be a subset of the permissions granted in the Privileges.
A message describing the problem.
" } } }, "traits": { "smithy.api#documentation": "An internal service error occurred.
", - "smithy.api#error": "server" + "smithy.api#error": "server", + "smithy.api#httpError": 500 } }, "com.amazonaws.lakeformation#InvalidInputException": { @@ -1400,7 +2647,8 @@ }, "traits": { "smithy.api#documentation": "The input provided was not valid.
", - "smithy.api#error": "client" + "smithy.api#error": "client", + "smithy.api#httpError": 400 } }, "com.amazonaws.lakeformation#LFTag": { @@ -1409,7 +2657,7 @@ "TagKey": { "target": "com.amazonaws.lakeformation#LFTagKey", "traits": { - "smithy.api#documentation": "The key-name for the tag.
", + "smithy.api#documentation": "The key-name for the LF-tag.
", "smithy.api#required": {} } }, @@ -1422,7 +2670,7 @@ } }, "traits": { - "smithy.api#documentation": "A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns not tagged 'PII' of tables tagged 'Prod'.
" + "smithy.api#documentation": "A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'.
" } }, "com.amazonaws.lakeformation#LFTagError": { @@ -1431,13 +2679,13 @@ "LFTag": { "target": "com.amazonaws.lakeformation#LFTagPair", "traits": { - "smithy.api#documentation": "The key-name of the tag.
" + "smithy.api#documentation": "The key-name of the LF-tag.
" } }, "Error": { "target": "com.amazonaws.lakeformation#ErrorDetail", "traits": { - "smithy.api#documentation": "An error that occurred with the attachment or detachment of the tag.
" + "smithy.api#documentation": "An error that occurred with the attachment or detachment of the LF-tag.
" } } }, @@ -1467,13 +2715,13 @@ "CatalogId": { "target": "com.amazonaws.lakeformation#CatalogIdString", "traits": { - "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.
" + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
" } }, "TagKey": { "target": "com.amazonaws.lakeformation#NameString", "traits": { - "smithy.api#documentation": "The key-name for the tag.
", + "smithy.api#documentation": "The key-name for the LF-tag.
", "smithy.api#required": {} } }, @@ -1486,7 +2734,7 @@ } }, "traits": { - "smithy.api#documentation": "A structure containing a tag key and values for a resource.
" + "smithy.api#documentation": "A structure containing an LF-tag key and values for a resource.
" } }, "com.amazonaws.lakeformation#LFTagPair": { @@ -1495,13 +2743,13 @@ "CatalogId": { "target": "com.amazonaws.lakeformation#CatalogIdString", "traits": { - "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.
" + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
" } }, "TagKey": { "target": "com.amazonaws.lakeformation#LFTagKey", "traits": { - "smithy.api#documentation": "The key-name for the tag.
", + "smithy.api#documentation": "The key-name for the LF-tag.
", "smithy.api#required": {} } }, @@ -1514,7 +2762,7 @@ } }, "traits": { - "smithy.api#documentation": "A structure containing a tag key-value pair.
" + "smithy.api#documentation": "A structure containing an LF-tag key-value pair.
" } }, "com.amazonaws.lakeformation#LFTagPolicyResource": { @@ -1523,26 +2771,26 @@ "CatalogId": { "target": "com.amazonaws.lakeformation#CatalogIdString", "traits": { - "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.
" + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
" } }, "ResourceType": { "target": "com.amazonaws.lakeformation#ResourceType", "traits": { - "smithy.api#documentation": "The resource type for which the tag policy applies.
", + "smithy.api#documentation": "The resource type for which the LF-tag policy applies.
", "smithy.api#required": {} } }, "Expression": { "target": "com.amazonaws.lakeformation#Expression", "traits": { - "smithy.api#documentation": "A list of tag conditions that apply to the resource's tag policy.
", + "smithy.api#documentation": "A list of LF-tag conditions that apply to the resource's LF-tag policy.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A structure containing a list of tag conditions that apply to a resource's tag policy.
" + "smithy.api#documentation": "A structure containing a list of LF-tag conditions that apply to a resource's LF-tag policy.
" } }, "com.amazonaws.lakeformation#LFTagValue": { @@ -1570,17 +2818,17 @@ "com.amazonaws.lakeformation#LastModifiedTimestamp": { "type": "timestamp" }, - "com.amazonaws.lakeformation#ListLFTags": { + "com.amazonaws.lakeformation#ListDataCellsFilter": { "type": "operation", "input": { - "target": "com.amazonaws.lakeformation#ListLFTagsRequest" + "target": "com.amazonaws.lakeformation#ListDataCellsFilterRequest" }, "output": { - "target": "com.amazonaws.lakeformation#ListLFTagsResponse" + "target": "com.amazonaws.lakeformation#ListDataCellsFilterResponse" }, "errors": [ { - "target": "com.amazonaws.lakeformation#EntityNotFoundException" + "target": "com.amazonaws.lakeformation#AccessDeniedException" }, { "target": "com.amazonaws.lakeformation#InternalServiceException" @@ -1593,64 +2841,75 @@ } ], "traits": { - "smithy.api#documentation": "Lists tags that the requester has permission to view.
" + "smithy.api#documentation": "Lists all the data cell filters on a table.
", + "smithy.api#http": { + "method": "POST", + "uri": "/ListDataCellsFilter", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DataCellsFilters", + "pageSize": "MaxResults" + } } }, - "com.amazonaws.lakeformation#ListLFTagsRequest": { + "com.amazonaws.lakeformation#ListDataCellsFilterRequest": { "type": "structure", "members": { - "CatalogId": { - "target": "com.amazonaws.lakeformation#CatalogIdString", + "Table": { + "target": "com.amazonaws.lakeformation#TableResource", "traits": { - "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.
" + "smithy.api#documentation": "A table in the Glue Data Catalog.
" } }, - "ResourceShareType": { - "target": "com.amazonaws.lakeformation#ResourceShareType", + "NextToken": { + "target": "com.amazonaws.lakeformation#Token", "traits": { - "smithy.api#documentation": "If resource share type is ALL, returns both in-account tags and shared tags that the requester has permission to view. If resource share type is FOREIGN, returns all share tags that the requester can view. If no resource share type is passed, lists tags in the given catalog ID that the requester has permission to view.
A continuation token, if this is a continuation call.
" } }, "MaxResults": { "target": "com.amazonaws.lakeformation#PageSize", "traits": { - "smithy.api#documentation": "The maximum number of results to return.
" - } - }, - "NextToken": { - "target": "com.amazonaws.lakeformation#Token", - "traits": { - "smithy.api#documentation": "A continuation token, if this is not the first call to retrieve this list.
" + "smithy.api#documentation": "The maximum size of the response.
" } } } }, - "com.amazonaws.lakeformation#ListLFTagsResponse": { + "com.amazonaws.lakeformation#ListDataCellsFilterResponse": { "type": "structure", "members": { - "LFTags": { - "target": "com.amazonaws.lakeformation#LFTagsList", + "DataCellsFilters": { + "target": "com.amazonaws.lakeformation#DataCellsFilterList", "traits": { - "smithy.api#documentation": "A list of tags that the requested has permission to view.
" + "smithy.api#documentation": "A list of DataCellFilter structures.
A continuation token, present if the current list segment is not the last.
" + "smithy.api#documentation": "A continuation token, if not all requested data cell filters have been returned.
" } } } }, - "com.amazonaws.lakeformation#ListPermissions": { + "com.amazonaws.lakeformation#ListLFTags": { "type": "operation", "input": { - "target": "com.amazonaws.lakeformation#ListPermissionsRequest" + "target": "com.amazonaws.lakeformation#ListLFTagsRequest" }, "output": { - "target": "com.amazonaws.lakeformation#ListPermissionsResponse" + "target": "com.amazonaws.lakeformation#ListLFTagsResponse" }, "errors": [ + { + "target": "com.amazonaws.lakeformation#AccessDeniedException" + }, + { + "target": "com.amazonaws.lakeformation#EntityNotFoundException" + }, { "target": "com.amazonaws.lakeformation#InternalServiceException" }, @@ -1662,32 +2921,117 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.
\n\tThis operation returns only those permissions that have been explicitly granted.
\n\tFor information about permissions, see Security and Access Control to Metadata and Data.
", + "smithy.api#documentation": "Lists LF-tags that the requester has permission to view.
", + "smithy.api#http": { + "method": "POST", + "uri": "/ListLFTags", + "code": 200 + }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "LFTags", "pageSize": "MaxResults" } } }, - "com.amazonaws.lakeformation#ListPermissionsRequest": { + "com.amazonaws.lakeformation#ListLFTagsRequest": { "type": "structure", "members": { "CatalogId": { "target": "com.amazonaws.lakeformation#CatalogIdString", "traits": { - "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.
" + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
" } }, - "Principal": { - "target": "com.amazonaws.lakeformation#DataLakePrincipal", + "ResourceShareType": { + "target": "com.amazonaws.lakeformation#ResourceShareType", "traits": { - "smithy.api#documentation": "Specifies a principal to filter the permissions returned.
" + "smithy.api#documentation": "If resource share type is ALL, returns both in-account LF-tags and shared LF-tags that the requester has permission to view. If resource share type is FOREIGN, returns all share LF-tags that the requester can view. If no resource share type is passed, lists LF-tags in the given catalog ID that the requester has permission to view.
The maximum number of results to return.
" + } + }, + "NextToken": { + "target": "com.amazonaws.lakeformation#Token", + "traits": { + "smithy.api#documentation": "A continuation token, if this is not the first call to retrieve this list.
" + } + } + } + }, + "com.amazonaws.lakeformation#ListLFTagsResponse": { + "type": "structure", + "members": { + "LFTags": { + "target": "com.amazonaws.lakeformation#LFTagsList", + "traits": { + "smithy.api#documentation": "A list of LF-tags that the requested has permission to view.
" + } + }, + "NextToken": { + "target": "com.amazonaws.lakeformation#Token", + "traits": { + "smithy.api#documentation": "A continuation token, present if the current list segment is not the last.
" + } + } + } + }, + "com.amazonaws.lakeformation#ListPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#ListPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#ListPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + }, + { + "target": "com.amazonaws.lakeformation#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.
\n\tThis operation returns only those permissions that have been explicitly granted.
\n\tFor information about permissions, see Security and Access Control to Metadata and Data.
", + "smithy.api#http": { + "method": "POST", + "uri": "/ListPermissions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.lakeformation#ListPermissionsRequest": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.lakeformation#CatalogIdString", + "traits": { + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
" + } + }, + "Principal": { + "target": "com.amazonaws.lakeformation#DataLakePrincipal", + "traits": { + "smithy.api#documentation": "Specifies a principal to filter the permissions returned.
" + } + }, + "ResourceType": { + "target": "com.amazonaws.lakeformation#DataLakeResourceType", + "traits": { "smithy.api#documentation": "Specifies a resource type to filter the permissions returned.
" } }, @@ -1708,6 +3052,12 @@ "traits": { "smithy.api#documentation": "The maximum number of results to return.
" } + }, + "IncludeRelated": { + "target": "com.amazonaws.lakeformation#TrueFalseString", + "traits": { + "smithy.api#documentation": "Indicates that related permissions should be included in the results.
" + } } } }, @@ -1749,6 +3099,11 @@ ], "traits": { "smithy.api#documentation": "Lists the resources registered to be managed by the Data Catalog.
", + "smithy.api#http": { + "method": "POST", + "uri": "/ListResources", + "code": 200 + }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1796,6 +3151,181 @@ } } }, + "com.amazonaws.lakeformation#ListTableStorageOptimizers": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#ListTableStorageOptimizersRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#ListTableStorageOptimizersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#AccessDeniedException" + }, + { + "target": "com.amazonaws.lakeformation#EntityNotFoundException" + }, + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the configuration of all storage optimizers associated with a specified table.
", + "smithy.api#http": { + "method": "POST", + "uri": "/ListTableStorageOptimizers", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.lakeformation#ListTableStorageOptimizersRequest": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.lakeformation#CatalogIdString", + "traits": { + "smithy.api#documentation": "The Catalog ID of the table.
" + } + }, + "DatabaseName": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { + "smithy.api#documentation": "Name of the database where the table is present.
", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { + "smithy.api#documentation": "Name of the table.
", + "smithy.api#required": {} + } + }, + "StorageOptimizerType": { + "target": "com.amazonaws.lakeformation#OptimizerType", + "traits": { + "smithy.api#documentation": "The specific type of storage optimizers to list. The supported value is compaction.
The number of storage optimizers to return on each call.
" + } + }, + "NextToken": { + "target": "com.amazonaws.lakeformation#Token", + "traits": { + "smithy.api#documentation": "A continuation token, if this is a continuation call.
" + } + } + } + }, + "com.amazonaws.lakeformation#ListTableStorageOptimizersResponse": { + "type": "structure", + "members": { + "StorageOptimizerList": { + "target": "com.amazonaws.lakeformation#StorageOptimizerList", + "traits": { + "smithy.api#documentation": "A list of the storage optimizers associated with a table.
" + } + }, + "NextToken": { + "target": "com.amazonaws.lakeformation#Token", + "traits": { + "smithy.api#documentation": "A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
" + } + } + } + }, + "com.amazonaws.lakeformation#ListTransactions": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#ListTransactionsRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#ListTransactionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + }, + { + "target": "com.amazonaws.lakeformation#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "Returns metadata about transactions and their status. To prevent the response from growing indefinitely, only uncommitted transactions and those available for time-travel queries are returned.
\n\tThis operation can help you identify uncommitted transactions or to get information about transactions.
", + "smithy.api#http": { + "method": "POST", + "uri": "/ListTransactions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.lakeformation#ListTransactionsRequest": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.lakeformation#CatalogIdString", + "traits": { + "smithy.api#documentation": "The catalog for which to list transactions. Defaults to the account ID of the caller.
" + } + }, + "StatusFilter": { + "target": "com.amazonaws.lakeformation#TransactionStatusFilter", + "traits": { + "smithy.api#documentation": " A filter indicating the status of transactions to return. Options are ALL | COMPLETED | COMMITTED | ABORTED | ACTIVE. The default is ALL.
The maximum number of transactions to return in a single call.
" + } + }, + "NextToken": { + "target": "com.amazonaws.lakeformation#TokenString", + "traits": { + "smithy.api#documentation": "A continuation token if this is not the first call to retrieve transactions.
" + } + } + } + }, + "com.amazonaws.lakeformation#ListTransactionsResponse": { + "type": "structure", + "members": { + "Transactions": { + "target": "com.amazonaws.lakeformation#TransactionDescriptionList", + "traits": { + "smithy.api#documentation": "A list of transactions. The record for each transaction is a TransactionDescription object.
A continuation token indicating whether additional data is available.
" + } + } + } + }, "com.amazonaws.lakeformation#MessageString": { "type": "string" }, @@ -1806,7 +3336,7 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" } }, "com.amazonaws.lakeformation#NullableBoolean": { @@ -1815,6 +3345,18 @@ "smithy.api#box": {} } }, + "com.amazonaws.lakeformation#NumberOfBytes": { + "type": "long" + }, + "com.amazonaws.lakeformation#NumberOfItems": { + "type": "long" + }, + "com.amazonaws.lakeformation#NumberOfMilliseconds": { + "type": "long" + }, + "com.amazonaws.lakeformation#ObjectSize": { + "type": "long" + }, "com.amazonaws.lakeformation#OperationTimeoutException": { "type": "structure", "members": { @@ -1830,6 +3372,25 @@ "smithy.api#error": "client" } }, + "com.amazonaws.lakeformation#OptimizerType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "COMPACTION", + "name": "COMPACTION" + }, + { + "value": "GARBAGE_COLLECTION", + "name": "GARBAGE_COLLECTION" + }, + { + "value": "ALL", + "name": "GENERIC" + } + ] + } + }, "com.amazonaws.lakeformation#PageSize": { "type": "integer", "traits": { @@ -1840,25 +3401,72 @@ } } }, - "com.amazonaws.lakeformation#Permission": { + "com.amazonaws.lakeformation#PartitionObjects": { + "type": "structure", + "members": { + "PartitionValues": { + "target": "com.amazonaws.lakeformation#PartitionValuesList", + "traits": { + "smithy.api#documentation": "A list of partition values.
" + } + }, + "Objects": { + "target": "com.amazonaws.lakeformation#TableObjectList", + "traits": { + "smithy.api#documentation": "A list of table objects
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure containing a list of partition values and table objects.
" + } + }, + "com.amazonaws.lakeformation#PartitionValueString": { "type": "string", "traits": { - "smithy.api#enum": [ - { - "value": "ALL", - "name": "ALL" - }, - { - "value": "SELECT", - "name": "SELECT" - }, - { - "value": "ALTER", - "name": "ALTER" - }, - { - "value": "DROP", - "name": "DROP" + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.lakeformation#PartitionValuesList": { + "type": "list", + "member": { + "target": "com.amazonaws.lakeformation#PartitionValueString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.lakeformation#PartitionedTableObjectsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lakeformation#PartitionObjects" + } + }, + "com.amazonaws.lakeformation#Permission": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALL", + "name": "ALL" + }, + { + "value": "SELECT", + "name": "SELECT" + }, + { + "value": "ALTER", + "name": "ALTER" + }, + { + "value": "DROP", + "name": "DROP" }, { "value": "DELETE", @@ -1913,6 +3521,48 @@ "target": "com.amazonaws.lakeformation#Permission" } }, + "com.amazonaws.lakeformation#PlanningStatistics": { + "type": "structure", + "members": { + "EstimatedDataToScanBytes": { + "target": "com.amazonaws.lakeformation#NumberOfBytes", + "traits": { + "smithy.api#documentation": "An estimate of the data that was scanned in bytes.
" + } + }, + "PlanningTimeMillis": { + "target": "com.amazonaws.lakeformation#NumberOfMilliseconds", + "traits": { + "smithy.api#documentation": "The time that it took to process the request.
" + } + }, + "QueueTimeMillis": { + "target": "com.amazonaws.lakeformation#NumberOfMilliseconds", + "traits": { + "smithy.api#documentation": "The time the request was in queue to be processed.
" + } + }, + "WorkUnitsGeneratedCount": { + "target": "com.amazonaws.lakeformation#NumberOfItems", + "traits": { + "smithy.api#documentation": "The number of work units generated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Statistics related to the processing of a query statement.
" + } + }, + "com.amazonaws.lakeformation#PredicateString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, "com.amazonaws.lakeformation#PrincipalPermissions": { "type": "structure", "members": { @@ -2000,7 +3650,12 @@ } ], "traits": { - "smithy.api#documentation": "Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation. For more information on admin privileges, see Granting Lake Formation Permissions.
\n\t\n\tThis API replaces the current list of data lake admins with the new list being passed. To add an admin, fetch the current list and add the new admin to that list and pass that list in this API.
" + "smithy.api#documentation": "Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation. For more information on admin privileges, see Granting Lake Formation Permissions.
\n\t\n\tThis API replaces the current list of data lake admins with the new list being passed. To add an admin, fetch the current list and add the new admin to that list and pass that list in this API.
", + "smithy.api#http": { + "method": "POST", + "uri": "/PutDataLakeSettings", + "code": 200 + } } }, "com.amazonaws.lakeformation#PutDataLakeSettingsRequest": { @@ -2009,13 +3664,13 @@ "CatalogId": { "target": "com.amazonaws.lakeformation#CatalogIdString", "traits": { - "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.
" + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
" } }, "DataLakeSettings": { "target": "com.amazonaws.lakeformation#DataLakeSettings", "traits": { - "smithy.api#documentation": "A structure representing a list of AWS Lake Formation principals designated as data lake administrators.
", + "smithy.api#documentation": "A structure representing a list of Lake Formation principals designated as data lake administrators.
", "smithy.api#required": {} } } @@ -2025,6 +3680,93 @@ "type": "structure", "members": {} }, + "com.amazonaws.lakeformation#QueryIdString": { + "type": "string" + }, + "com.amazonaws.lakeformation#QueryParameterMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.lakeformation#QueryPlanningContext": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.lakeformation#CatalogIdString", + "traits": { + "smithy.api#documentation": "The ID of the Data Catalog where the partition in question resides. If none is provided, the Amazon Web Services account ID is used by default.
" + } + }, + "DatabaseName": { + "target": "com.amazonaws.lakeformation#QueryPlanningContextDatabaseNameString", + "traits": { + "smithy.api#documentation": "The database containing the table.
", + "smithy.api#required": {} + } + }, + "QueryAsOfTime": { + "target": "com.amazonaws.lakeformation#Timestamp", + "traits": { + "smithy.api#documentation": "The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.
A map consisting of key-value pairs.
" + } + }, + "TransactionId": { + "target": "com.amazonaws.lakeformation#TransactionIdString", + "traits": { + "smithy.api#documentation": "The transaction ID at which to read the table contents. If this transaction is not committed, the read will be treated as part of that transaction and will see its writes. If this transaction has aborted, an error will be returned. If not set, defaults to the most recent committed transaction. Cannot be specified along with QueryAsOfTime.
A structure containing information about the query plan.
" + } + }, + "com.amazonaws.lakeformation#QueryPlanningContextDatabaseNameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" + } + }, + "com.amazonaws.lakeformation#QueryStateString": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "WORKUNITS_AVAILABLE", + "name": "WORKUNITS_AVAILABLE" + }, + { + "value": "ERROR", + "name": "ERROR" + }, + { + "value": "FINISHED", + "name": "FINISHED" + }, + { + "value": "EXPIRED", + "name": "EXPIRED" + } + ] + } + }, "com.amazonaws.lakeformation#RAMResourceShareArn": { "type": "string" }, @@ -2037,9 +3779,15 @@ "target": "com.amazonaws.lakeformation#RegisterResourceResponse" }, "errors": [ + { + "target": "com.amazonaws.lakeformation#AccessDeniedException" + }, { "target": "com.amazonaws.lakeformation#AlreadyExistsException" }, + { + "target": "com.amazonaws.lakeformation#EntityNotFoundException" + }, { "target": "com.amazonaws.lakeformation#InternalServiceException" }, @@ -2048,10 +3796,18 @@ }, { "target": "com.amazonaws.lakeformation#OperationTimeoutException" + }, + { + "target": "com.amazonaws.lakeformation#ResourceNumberLimitExceededException" } ], "traits": { - "smithy.api#documentation": "Registers the resource as managed by the Data Catalog.
\n\t\n\tTo add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.
\n\nThe following request registers a new location and gives AWS Lake Formation permission to use the service-linked role to access that location.
\n\n\n ResourceArn = arn:aws:s3:::my-bucket\nUseServiceLinkedRole = true\n
If UseServiceLinkedRole is not set to true, you must provide or set the RoleArn:
\n arn:aws:iam::12345:role/my-data-access-role\n
Registers the resource as managed by the Data Catalog.
\n\t\nTo add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.
\n\nThe following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location.
\n\n\n ResourceArn = arn:aws:s3:::my-bucket\nUseServiceLinkedRole = true\n
If UseServiceLinkedRole is not set to true, you must provide or set the RoleArn:
\n arn:aws:iam::12345:role/my-data-access-role\n
Designates an AWS Identity and Access Management (IAM) service-linked role by registering this role with the Data Catalog. A service-linked role is a unique type of IAM role that is linked directly to Lake Formation.
\n \nFor more information, see Using Service-Linked Roles for Lake Formation.
" + "smithy.api#documentation": "Designates an Identity and Access Management (IAM) service-linked role by registering this role with the Data Catalog. A service-linked role is a unique type of IAM role that is linked directly to Lake Formation.
\n \nFor more information, see Using Service-Linked Roles for Lake Formation.
" } }, "RoleArn": { @@ -2114,7 +3870,12 @@ } ], "traits": { - "smithy.api#documentation": "Removes a tag from the resource. Only database, table, or tableWithColumns resource are allowed. To tag columns, use the column inclusion list in tableWithColumns to specify column input.
Removes an LF-tag from the resource. Only database, table, or tableWithColumns resource are allowed. To tag columns, use the column inclusion list in tableWithColumns to specify column input.
The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.
" + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
" } }, "Resource": { "target": "com.amazonaws.lakeformation#Resource", "traits": { - "smithy.api#documentation": "The resource where you want to remove a tag.
", + "smithy.api#documentation": "The database, table, or column resource where you want to remove an LF-tag.
", "smithy.api#required": {} } }, "LFTags": { "target": "com.amazonaws.lakeformation#LFTagsList", "traits": { - "smithy.api#documentation": "The tags to be removed from the resource.
", + "smithy.api#documentation": "The LF-tags to be removed from the resource.
", "smithy.api#required": {} } } @@ -2159,7 +3920,7 @@ "Catalog": { "target": "com.amazonaws.lakeformation#CatalogResource", "traits": { - "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.
" + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
" } }, "Database": { @@ -2186,16 +3947,22 @@ "smithy.api#documentation": "The location of an Amazon S3 path where permissions are granted or revoked.
" } }, + "DataCellsFilter": { + "target": "com.amazonaws.lakeformation#DataCellsFilterResource", + "traits": { + "smithy.api#documentation": "A data cell filter.
" + } + }, "LFTag": { "target": "com.amazonaws.lakeformation#LFTagKeyResource", "traits": { - "smithy.api#documentation": "The tag key and values attached to a resource.
" + "smithy.api#documentation": "The LF-tag key and values attached to a resource.
" } }, "LFTagPolicy": { "target": "com.amazonaws.lakeformation#LFTagPolicyResource", "traits": { - "smithy.api#documentation": "A list of tag conditions that define a resource's tag policy.
" + "smithy.api#documentation": "A list of LF-tag conditions that define a resource's LF-tag policy.
" } } }, @@ -2229,7 +3996,7 @@ } }, "traits": { - "smithy.api#documentation": "A structure containing information about an AWS Lake Formation resource.
" + "smithy.api#documentation": "A structure containing information about an Lake Formation resource.
" } }, "com.amazonaws.lakeformation#ResourceInfoList": { @@ -2238,6 +4005,22 @@ "target": "com.amazonaws.lakeformation#ResourceInfo" } }, + "com.amazonaws.lakeformation#ResourceNotReadyException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.lakeformation#MessageString", + "traits": { + "smithy.api#documentation": "A message describing the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an error related to a resource which is not ready for a transaction.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.lakeformation#ResourceNumberLimitExceededException": { "type": "structure", "members": { @@ -2289,6 +4072,15 @@ ] } }, + "com.amazonaws.lakeformation#Result": { + "type": "string" + }, + "com.amazonaws.lakeformation#ResultStream": { + "type": "blob", + "traits": { + "smithy.api#streaming": {} + } + }, "com.amazonaws.lakeformation#RevokePermissions": { "type": "operation", "input": { @@ -2309,7 +4101,12 @@ } ], "traits": { - "smithy.api#documentation": "Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
" + "smithy.api#documentation": "Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
", + "smithy.api#http": { + "method": "POST", + "uri": "/RevokePermissions", + "code": 200 + } } }, "com.amazonaws.lakeformation#RevokePermissionsRequest": { @@ -2318,7 +4115,7 @@ "CatalogId": { "target": "com.amazonaws.lakeformation#CatalogIdString", "traits": { - "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.
" + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
" } }, "Principal": { @@ -2354,6 +4151,26 @@ "type": "structure", "members": {} }, + "com.amazonaws.lakeformation#RowFilter": { + "type": "structure", + "members": { + "FilterExpression": { + "target": "com.amazonaws.lakeformation#PredicateString", + "traits": { + "smithy.api#documentation": "A filter expression.
" + } + }, + "AllRowsWildcard": { + "target": "com.amazonaws.lakeformation#AllRowsWildcard", + "traits": { + "smithy.api#documentation": "A wildcard for all rows.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A PartiQL predicate.
" + } + }, "com.amazonaws.lakeformation#SearchDatabasesByLFTags": { "type": "operation", "input": { @@ -2383,7 +4200,18 @@ } ], "traits": { - "smithy.api#documentation": "This operation allows a search on DATABASE resources by TagCondition. This operation is used by admins who want to grant user permissions on certain TagConditions. Before making a grant, the admin can use SearchDatabasesByTags to find all resources where the given TagConditions are valid to verify whether the returned resources can be shared.
This operation allows a search on DATABASE resources by TagCondition. This operation is used by admins who want to grant user permissions on certain TagConditions. Before making a grant, the admin can use SearchDatabasesByTags to find all resources where the given TagConditions are valid to verify whether the returned resources can be shared.
The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.
" + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
" } }, "Expression": { @@ -2428,7 +4256,7 @@ "DatabaseList": { "target": "com.amazonaws.lakeformation#DatabaseLFTagsList", "traits": { - "smithy.api#documentation": "A list of databases that meet the tag conditions.
" + "smithy.api#documentation": "A list of databases that meet the LF-tag conditions.
" } } } @@ -2462,7 +4290,18 @@ } ], "traits": { - "smithy.api#documentation": "This operation allows a search on TABLE resources by LFTags. This will be used by admins who want to grant user permissions on certain LFTags. Before making a grant, the admin can use SearchTablesByLFTags to find all resources where the given LFTags are valid to verify whether the returned resources can be shared.
This operation allows a search on TABLE resources by LFTags. This will be used by admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can use SearchTablesByLFTags to find all resources where the given LFTags are valid to verify whether the returned resources can be shared.
The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.
" + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
" } }, "Expression": { @@ -2507,78 +4346,327 @@ "TableList": { "target": "com.amazonaws.lakeformation#TableLFTagsList", "traits": { - "smithy.api#documentation": "A list of tables that meet the tag conditions.
" + "smithy.api#documentation": "A list of tables that meet the LF-tag conditions.
" } } } }, - "com.amazonaws.lakeformation#StringValue": { - "type": "string" - }, - "com.amazonaws.lakeformation#StringValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.lakeformation#StringValue" - } - }, - "com.amazonaws.lakeformation#TableLFTagsList": { - "type": "list", - "member": { - "target": "com.amazonaws.lakeformation#TaggedTable" + "com.amazonaws.lakeformation#StartQueryPlanning": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#StartQueryPlanningRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#StartQueryPlanningResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#AccessDeniedException" + }, + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + }, + { + "target": "com.amazonaws.lakeformation#ThrottledException" + } + ], + "traits": { + "smithy.api#documentation": "Submits a request to process a query statement.
\n\t\n\tThis operation generates work units that can be retrieved with the GetWorkUnits operation as soon as the query state is WORKUNITS_AVAILABLE or FINISHED.
The identifier for the Data Catalog. By default, it is the account ID of the caller.
" - } - }, - "DatabaseName": { - "target": "com.amazonaws.lakeformation#NameString", - "traits": { - "smithy.api#documentation": "The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
", + "smithy.api#documentation": "A structure containing information about the query plan.
", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.lakeformation#NameString", + "QueryString": { + "target": "com.amazonaws.lakeformation#SyntheticStartQueryPlanningRequestQueryString", "traits": { - "smithy.api#documentation": "The name of the table.
" + "smithy.api#documentation": "A PartiQL query statement used as an input to the planner service.
", + "smithy.api#required": {} } - }, - "TableWildcard": { - "target": "com.amazonaws.lakeformation#TableWildcard", + } + } + }, + "com.amazonaws.lakeformation#StartQueryPlanningResponse": { + "type": "structure", + "members": { + "QueryId": { + "target": "com.amazonaws.lakeformation#QueryIdString", "traits": { - "smithy.api#documentation": "A wildcard object representing every table under a database.
\n\nAt least one of TableResource$Name or TableResource$TableWildcard is required.
The ID of the plan query operation can be used to fetch the actual work unit descriptors that are produced as the result of the operation. The ID is also used to get the query state and as an input to the Execute operation.
A structure for the table object. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.
" + "smithy.api#documentation": "A structure for the output.
" } }, - "com.amazonaws.lakeformation#TableWildcard": { - "type": "structure", - "members": {}, + "com.amazonaws.lakeformation#StartTransaction": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#StartTransactionRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#StartTransactionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#OperationTimeoutException" + } + ], "traits": { - "smithy.api#documentation": "A wildcard object representing every table under a database.
" + "smithy.api#documentation": "Starts a new transaction and returns its transaction ID. Transaction IDs are opaque objects that you can use to identify a transaction.
", + "smithy.api#http": { + "method": "POST", + "uri": "/StartTransaction", + "code": 200 + } } }, - "com.amazonaws.lakeformation#TableWithColumnsResource": { + "com.amazonaws.lakeformation#StartTransactionRequest": { "type": "structure", "members": { - "CatalogId": { - "target": "com.amazonaws.lakeformation#CatalogIdString", + "TransactionType": { + "target": "com.amazonaws.lakeformation#TransactionType", "traits": { - "smithy.api#documentation": "The identifier for the Data Catalog. By default, it is the account ID of the caller.
" + "smithy.api#documentation": "Indicates whether this transaction should be read only or read and write. Writes made using a read-only transaction ID will be rejected. Read-only transactions do not need to be committed.
" } - }, - "DatabaseName": { - "target": "com.amazonaws.lakeformation#NameString", - "traits": { + } + } + }, + "com.amazonaws.lakeformation#StartTransactionResponse": { + "type": "structure", + "members": { + "TransactionId": { + "target": "com.amazonaws.lakeformation#TransactionIdString", + "traits": { + "smithy.api#documentation": "An opaque identifier for the transaction.
" + } + } + } + }, + "com.amazonaws.lakeformation#StatisticsNotReadyYetException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.lakeformation#MessageString", + "traits": { + "smithy.api#documentation": "A message describing the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an error related to statistics not being ready.
", + "smithy.api#error": "client", + "smithy.api#httpError": 420 + } + }, + "com.amazonaws.lakeformation#StorageOptimizer": { + "type": "structure", + "members": { + "StorageOptimizerType": { + "target": "com.amazonaws.lakeformation#OptimizerType", + "traits": { + "smithy.api#documentation": "The specific type of storage optimizer. The supported value is compaction.
A map of the storage optimizer configuration. Currently contains only one key-value pair: is_enabled indicates true or false for acceleration.
A message that contains information about any error (if present).
\n\t\n\tWhen an acceleration result has an enabled status, the error message is empty.
\n\tWhen an acceleration result has a disabled status, the message describes an error or simply indicates \"disabled by the user\".
" + } + }, + "Warnings": { + "target": "com.amazonaws.lakeformation#MessageString", + "traits": { + "smithy.api#documentation": "A message that contains information about any warnings (if present).
" + } + }, + "LastRunDetails": { + "target": "com.amazonaws.lakeformation#MessageString", + "traits": { + "smithy.api#documentation": "When an acceleration result has an enabled status, contains the details of the last job run.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure describing the configuration and details of a storage optimizer.
" + } + }, + "com.amazonaws.lakeformation#StorageOptimizerConfig": { + "type": "map", + "key": { + "target": "com.amazonaws.lakeformation#StorageOptimizerConfigKey" + }, + "value": { + "target": "com.amazonaws.lakeformation#StorageOptimizerConfigValue" + } + }, + "com.amazonaws.lakeformation#StorageOptimizerConfigKey": { + "type": "string" + }, + "com.amazonaws.lakeformation#StorageOptimizerConfigMap": { + "type": "map", + "key": { + "target": "com.amazonaws.lakeformation#OptimizerType" + }, + "value": { + "target": "com.amazonaws.lakeformation#StorageOptimizerConfig" + } + }, + "com.amazonaws.lakeformation#StorageOptimizerConfigValue": { + "type": "string" + }, + "com.amazonaws.lakeformation#StorageOptimizerList": { + "type": "list", + "member": { + "target": "com.amazonaws.lakeformation#StorageOptimizer" + } + }, + "com.amazonaws.lakeformation#StringValue": { + "type": "string" + }, + "com.amazonaws.lakeformation#StringValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.lakeformation#StringValue" + } + }, + "com.amazonaws.lakeformation#SyntheticGetWorkUnitResultsRequestWorkUnitTokenString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.lakeformation#SyntheticStartQueryPlanningRequestQueryString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.lakeformation#TableLFTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lakeformation#TaggedTable" + } + }, + "com.amazonaws.lakeformation#TableObject": { + "type": "structure", + "members": { + "Uri": { + "target": "com.amazonaws.lakeformation#URI", + "traits": { + "smithy.api#documentation": "The Amazon S3 location of the object.
" + } + }, + "ETag": { + "target": "com.amazonaws.lakeformation#ETagString", + "traits": { + "smithy.api#documentation": "The Amazon S3 ETag of the object. Returned by GetTableObjects for validation and used to identify changes to the underlying data.
The size of the Amazon S3 object in bytes.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the details of a governed table.
" + } + }, + "com.amazonaws.lakeformation#TableObjectList": { + "type": "list", + "member": { + "target": "com.amazonaws.lakeformation#TableObject" + } + }, + "com.amazonaws.lakeformation#TableResource": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.lakeformation#CatalogIdString", + "traits": { + "smithy.api#documentation": "The identifier for the Data Catalog. By default, it is the account ID of the caller.
" + } + }, + "DatabaseName": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { + "smithy.api#documentation": "The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { + "smithy.api#documentation": "The name of the table.
" + } + }, + "TableWildcard": { + "target": "com.amazonaws.lakeformation#TableWildcard", + "traits": { + "smithy.api#documentation": "A wildcard object representing every table under a database.
\n\nAt least one of TableResource$Name or TableResource$TableWildcard is required.
A structure for the table object. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.
" + } + }, + "com.amazonaws.lakeformation#TableWildcard": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "A wildcard object representing every table under a database.
" + } + }, + "com.amazonaws.lakeformation#TableWithColumnsResource": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.lakeformation#CatalogIdString", + "traits": { + "smithy.api#documentation": "The identifier for the Data Catalog. By default, it is the account ID of the caller.
" + } + }, + "DatabaseName": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { "smithy.api#documentation": "The name of the database for the table with columns resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
", "smithy.api#required": {} } @@ -2625,18 +4713,18 @@ "Database": { "target": "com.amazonaws.lakeformation#DatabaseResource", "traits": { - "smithy.api#documentation": "A database that has tags attached to it.
" + "smithy.api#documentation": "A database that has LF-tags attached to it.
" } }, "LFTags": { "target": "com.amazonaws.lakeformation#LFTagsList", "traits": { - "smithy.api#documentation": "A list of tags attached to the database.
" + "smithy.api#documentation": "A list of LF-tags attached to the database.
" } } }, "traits": { - "smithy.api#documentation": "A structure describing a database resource with tags.
" + "smithy.api#documentation": "A structure describing a database resource with LF-tags.
" } }, "com.amazonaws.lakeformation#TaggedTable": { @@ -2645,41 +4733,253 @@ "Table": { "target": "com.amazonaws.lakeformation#TableResource", "traits": { - "smithy.api#documentation": "A table that has tags attached to it.
" + "smithy.api#documentation": "A table that has LF-tags attached to it.
" } }, "LFTagOnDatabase": { "target": "com.amazonaws.lakeformation#LFTagsList", "traits": { - "smithy.api#documentation": "A list of tags attached to the database where the table resides.
" + "smithy.api#documentation": "A list of LF-tags attached to the database where the table resides.
" } }, "LFTagsOnTable": { "target": "com.amazonaws.lakeformation#LFTagsList", "traits": { - "smithy.api#documentation": "A list of tags attached to the table.
" + "smithy.api#documentation": "A list of LF-tags attached to the table.
" } }, "LFTagsOnColumns": { "target": "com.amazonaws.lakeformation#ColumnLFTagsList", "traits": { - "smithy.api#documentation": "A list of tags attached to columns in the table.
" + "smithy.api#documentation": "A list of LF-tags attached to columns in the table.
" } } }, "traits": { - "smithy.api#documentation": "A structure describing a table resource with tags.
" + "smithy.api#documentation": "A structure describing a table resource with LF-tags.
" } }, + "com.amazonaws.lakeformation#ThrottledException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.lakeformation#MessageString", + "traits": { + "smithy.api#documentation": "A message describing the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an error where the query request was throttled.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": { + "throttling": true + } + } + }, + "com.amazonaws.lakeformation#Timestamp": { + "type": "timestamp" + }, "com.amazonaws.lakeformation#Token": { "type": "string" }, + "com.amazonaws.lakeformation#TokenString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.lakeformation#TransactionCanceledException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.lakeformation#MessageString", + "traits": { + "smithy.api#documentation": "A message describing the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an error related to a transaction that was cancelled.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.lakeformation#TransactionCommitInProgressException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.lakeformation#MessageString", + "traits": { + "smithy.api#documentation": "A message describing the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an error related to a transaction commit that was in progress.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.lakeformation#TransactionCommittedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.lakeformation#MessageString", + "traits": { + "smithy.api#documentation": "A message describing the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an error where the specified transaction has already been committed and cannot be used for UpdateTableObjects.
The ID of the transaction.
" + } + }, + "TransactionStatus": { + "target": "com.amazonaws.lakeformation#TransactionStatus", + "traits": { + "smithy.api#documentation": "A status of ACTIVE, COMMITTED, or ABORTED.
" + } + }, + "TransactionStartTime": { + "target": "com.amazonaws.lakeformation#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the transaction started.
" + } + }, + "TransactionEndTime": { + "target": "com.amazonaws.lakeformation#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the transaction committed or aborted, if it is not currently active.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains information about a transaction.
" + } + }, + "com.amazonaws.lakeformation#TransactionDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.lakeformation#TransactionDescription" + } + }, + "com.amazonaws.lakeformation#TransactionIdString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\p{L}\\p{N}\\p{P}]*$" + } + }, + "com.amazonaws.lakeformation#TransactionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "COMMITTED", + "name": "COMMITTED" + }, + { + "value": "ABORTED", + "name": "ABORTED" + }, + { + "value": "COMMIT_IN_PROGRESS", + "name": "COMMIT_IN_PROGRESS" + } + ] + } + }, + "com.amazonaws.lakeformation#TransactionStatusFilter": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALL", + "name": "ALL" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "COMMITTED", + "name": "COMMITTED" + }, + { + "value": "ABORTED", + "name": "ABORTED" + } + ] + } + }, + "com.amazonaws.lakeformation#TransactionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "READ_AND_WRITE", + "name": "READ_AND_WRITE" + }, + { + "value": "READ_ONLY", + "name": "READ_ONLY" + } + ] + } + }, + "com.amazonaws.lakeformation#TrueFalseString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" + } + }, "com.amazonaws.lakeformation#TrustedResourceOwners": { "type": "list", "member": { "target": "com.amazonaws.lakeformation#CatalogIdString" } }, + "com.amazonaws.lakeformation#URI": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, "com.amazonaws.lakeformation#UpdateLFTag": { "type": "operation", "input": { @@ -2709,7 +5009,12 @@ } ], "traits": { - "smithy.api#documentation": "Updates the list of possible values for the specified tag key. If the tag does not exist, the operation throws an EntityNotFoundException. The values in the delete key values will be deleted from list of possible values. If any value in the delete key values is attached to a resource, then API errors out with a 400 Exception - \"Update not allowed\". Untag the attribute before deleting the tag key's value.
" + "smithy.api#documentation": "Updates the list of possible values for the specified LF-tag key. If the LF-tag does not exist, the operation throws an EntityNotFoundException. The values in the delete key values will be deleted from list of possible values. If any value in the delete key values is attached to a resource, then API errors out with a 400 Exception - \"Update not allowed\". Untag the attribute before deleting the LF-tag key's value.
", + "smithy.api#http": { + "method": "POST", + "uri": "/UpdateLFTag", + "code": 200 + } } }, "com.amazonaws.lakeformation#UpdateLFTagRequest": { @@ -2718,26 +5023,26 @@ "CatalogId": { "target": "com.amazonaws.lakeformation#CatalogIdString", "traits": { - "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.
" + "smithy.api#documentation": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
" } }, "TagKey": { "target": "com.amazonaws.lakeformation#LFTagKey", "traits": { - "smithy.api#documentation": "The key-name for the tag for which to add or delete values.
", + "smithy.api#documentation": "The key-name for the LF-tag for which to add or delete values.
", "smithy.api#required": {} } }, "TagValuesToDelete": { "target": "com.amazonaws.lakeformation#TagValueList", "traits": { - "smithy.api#documentation": "A list of tag values to delete from the tag.
" + "smithy.api#documentation": "A list of LF-tag values to delete from the LF-tag.
" } }, "TagValuesToAdd": { "target": "com.amazonaws.lakeformation#TagValueList", "traits": { - "smithy.api#documentation": "A list of tag values to add from the tag.
" + "smithy.api#documentation": "A list of LF-tag values to add from the LF-tag.
" } } } @@ -2769,7 +5074,12 @@ } ], "traits": { - "smithy.api#documentation": "Updates the data access role used for vending access to the given (registered) resource in AWS Lake Formation.
" + "smithy.api#documentation": "Updates the data access role used for vending access to the given (registered) resource in Lake Formation.
", + "smithy.api#http": { + "method": "POST", + "uri": "/UpdateResource", + "code": 200 + } } }, "com.amazonaws.lakeformation#UpdateResourceRequest": { @@ -2778,7 +5088,7 @@ "RoleArn": { "target": "com.amazonaws.lakeformation#IAMRoleArn", "traits": { - "smithy.api#documentation": "The new role to use for the given resource registered in AWS Lake Formation.
", + "smithy.api#documentation": "The new role to use for the given resource registered in Lake Formation.
", "smithy.api#required": {} } }, @@ -2794,6 +5104,291 @@ "com.amazonaws.lakeformation#UpdateResourceResponse": { "type": "structure", "members": {} + }, + "com.amazonaws.lakeformation#UpdateTableObjects": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#UpdateTableObjectsRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#UpdateTableObjectsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.lakeformation#EntityNotFoundException" + }, + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + }, + { + "target": "com.amazonaws.lakeformation#OperationTimeoutException" + }, + { + "target": "com.amazonaws.lakeformation#ResourceNotReadyException" + }, + { + "target": "com.amazonaws.lakeformation#TransactionCanceledException" + }, + { + "target": "com.amazonaws.lakeformation#TransactionCommitInProgressException" + }, + { + "target": "com.amazonaws.lakeformation#TransactionCommittedException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the manifest of Amazon S3 objects that make up the specified governed table.
", + "smithy.api#http": { + "method": "POST", + "uri": "/UpdateTableObjects", + "code": 200 + } + } + }, + "com.amazonaws.lakeformation#UpdateTableObjectsRequest": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.lakeformation#CatalogIdString", + "traits": { + "smithy.api#documentation": "The catalog containing the governed table to update. Defaults to the caller’s account ID.
" + } + }, + "DatabaseName": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { + "smithy.api#documentation": "The database containing the governed table to update.
", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { + "smithy.api#documentation": "The governed table to update.
", + "smithy.api#required": {} + } + }, + "TransactionId": { + "target": "com.amazonaws.lakeformation#TransactionIdString", + "traits": { + "smithy.api#documentation": "The transaction at which to do the write.
", + "smithy.api#required": {} + } + }, + "WriteOperations": { + "target": "com.amazonaws.lakeformation#WriteOperationList", + "traits": { + "smithy.api#documentation": "A list of WriteOperation objects that define an object to add to or delete from the manifest for a governed table.
Updates the configuration of the storage optimizers for a table.
", + "smithy.api#http": { + "method": "POST", + "uri": "/UpdateTableStorageOptimizer", + "code": 200 + } + } + }, + "com.amazonaws.lakeformation#UpdateTableStorageOptimizerRequest": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.lakeformation#CatalogIdString", + "traits": { + "smithy.api#documentation": "The Catalog ID of the table.
" + } + }, + "DatabaseName": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { + "smithy.api#documentation": "Name of the database where the table is present.
", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.lakeformation#NameString", + "traits": { + "smithy.api#documentation": "Name of the table for which to enable the storage optimizer.
", + "smithy.api#required": {} + } + }, + "StorageOptimizerConfig": { + "target": "com.amazonaws.lakeformation#StorageOptimizerConfigMap", + "traits": { + "smithy.api#documentation": "Name of the table for which to enable the storage optimizer.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lakeformation#UpdateTableStorageOptimizerResponse": { + "type": "structure", + "members": { + "Result": { + "target": "com.amazonaws.lakeformation#Result", + "traits": { + "smithy.api#documentation": "A response indicating the success of failure of the operation.
" + } + } + } + }, + "com.amazonaws.lakeformation#VirtualObject": { + "type": "structure", + "members": { + "Uri": { + "target": "com.amazonaws.lakeformation#URI", + "traits": { + "smithy.api#documentation": "The path to the Amazon S3 object. Must start with s3://
", + "smithy.api#required": {} + } + }, + "ETag": { + "target": "com.amazonaws.lakeformation#ETagString", + "traits": { + "smithy.api#documentation": "The ETag of the Amazon S3 object.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that defines an Amazon S3 object to be deleted if a transaction cancels, provided that \n VirtualPut was called before writing the object.
Defines the maximum work unit ID in the range. The maximum value is inclusive.
", + "smithy.api#required": {} + } + }, + "WorkUnitIdMin": { + "target": "com.amazonaws.lakeformation#WorkUnitIdLong", + "traits": { + "smithy.api#documentation": "Defines the minimum work unit ID in the range.
", + "smithy.api#required": {} + } + }, + "WorkUnitToken": { + "target": "com.amazonaws.lakeformation#WorkUnitTokenString", + "traits": { + "smithy.api#documentation": "A work token used to query the execution service.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the valid range of work unit IDs for querying the execution service.
" + } + }, + "com.amazonaws.lakeformation#WorkUnitRangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.lakeformation#WorkUnitRange" + } + }, + "com.amazonaws.lakeformation#WorkUnitTokenString": { + "type": "string" + }, + "com.amazonaws.lakeformation#WorkUnitsNotReadyYetException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.lakeformation#MessageString", + "traits": { + "smithy.api#documentation": "A message describing the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an error related to work units not being ready.
", + "smithy.api#error": "client", + "smithy.api#httpError": 420 + } + }, + "com.amazonaws.lakeformation#WriteOperation": { + "type": "structure", + "members": { + "AddObject": { + "target": "com.amazonaws.lakeformation#AddObjectInput", + "traits": { + "smithy.api#documentation": "A new object to add to the governed table.
" + } + }, + "DeleteObject": { + "target": "com.amazonaws.lakeformation#DeleteObjectInput", + "traits": { + "smithy.api#documentation": "An object to delete from the governed table.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines an object to add to or delete from a governed table.
" + } + }, + "com.amazonaws.lakeformation#WriteOperationList": { + "type": "list", + "member": { + "target": "com.amazonaws.lakeformation#WriteOperation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } } } } diff --git a/aws/sdk/aws-models/lambda.json b/aws/sdk/aws-models/lambda.json index 35ae666b5e44b8ee92734442b2751e4b797bda8c..29e177920e12c5fe732ba3899e79d0dde5cad2ec 100644 --- a/aws/sdk/aws-models/lambda.json +++ b/aws/sdk/aws-models/lambda.json @@ -1070,6 +1070,12 @@ "smithy.api#documentation": "The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation\n (6 MB).
\n\n Amazon Kinesis - Default 100. Max 10,000.
\n\n Amazon DynamoDB Streams - Default 100. Max 1,000.
\n\n Amazon Simple Queue Service - Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
\n\n Amazon Managed Streaming for Apache Kafka - Default 100. Max 10,000.
\n\n Self-Managed Apache Kafka - Default 100. Max 10,000.
\n\n Amazon MQ (ActiveMQ and RabbitMQ) - Default 100. Max 10,000.
\n(Streams and Amazon SQS) An object that defines the filter criteria that\n determine whether Lambda should process an event. For more information, see Lambda event filtering.
" + } + }, "MaximumBatchingWindowInSeconds": { "target": "com.amazonaws.lambda#MaximumBatchingWindowInSeconds", "traits": { @@ -1151,7 +1157,7 @@ "FunctionResponseTypes": { "target": "com.amazonaws.lambda#FunctionResponseTypeList", "traits": { - "smithy.api#documentation": "(Streams only) A list of current response type enums applied to the event source mapping.
" + "smithy.api#documentation": "(Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
" } } } @@ -1215,7 +1221,7 @@ "Runtime": { "target": "com.amazonaws.lambda#Runtime", "traits": { - "smithy.api#documentation": "The identifier of the function's runtime.
" + "smithy.api#documentation": "The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. \n
" } }, "Role": { @@ -1228,7 +1234,7 @@ "Handler": { "target": "com.amazonaws.lambda#Handler", "traits": { - "smithy.api#documentation": "The name of the method within your code that Lambda calls to execute your function. The format includes the\n file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information,\n see Programming Model.
" + "smithy.api#documentation": "The name of the method within your code that Lambda calls to execute your function. \nHandler is required if the deployment package is a .zip file archive. The format includes the\n file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information,\n see Programming Model.
" } }, "Code": { @@ -2133,6 +2139,12 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the event source.
" } }, + "FilterCriteria": { + "target": "com.amazonaws.lambda#FilterCriteria", + "traits": { + "smithy.api#documentation": "(Streams and Amazon SQS) An object that defines the filter criteria that\n determine whether Lambda should process an event. For more information, see Lambda event filtering.
" + } + }, "FunctionArn": { "target": "com.amazonaws.lambda#FunctionArn", "traits": { @@ -2307,6 +2319,40 @@ } } }, + "com.amazonaws.lambda#Filter": { + "type": "structure", + "members": { + "Pattern": { + "target": "com.amazonaws.lambda#Pattern", + "traits": { + "smithy.api#documentation": "\n A filter pattern. For more information on the syntax of a filter pattern, see\n \n Filter rule syntax.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n A structure within a FilterCriteria object that defines an event filtering pattern.\n
\n A list of filters.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n An object that contains the filters for an event source.\n
" + } + }, + "com.amazonaws.lambda#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Filter" + } + }, "com.amazonaws.lambda#FunctionArn": { "type": "string", "traits": { @@ -5656,6 +5702,16 @@ } } }, + "com.amazonaws.lambda#Pattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + }, + "smithy.api#pattern": ".*" + } + }, "com.amazonaws.lambda#PolicyLengthExceededException": { "type": "structure", "members": { @@ -7529,6 +7585,12 @@ "smithy.api#documentation": "The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation\n (6 MB).
\n\n Amazon Kinesis - Default 100. Max 10,000.
\n\n Amazon DynamoDB Streams - Default 100. Max 1,000.
\n\n Amazon Simple Queue Service - Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
\n\n Amazon Managed Streaming for Apache Kafka - Default 100. Max 10,000.
\n\n Self-Managed Apache Kafka - Default 100. Max 10,000.
\n\n Amazon MQ (ActiveMQ and RabbitMQ) - Default 100. Max 10,000.
\n(Streams and Amazon SQS) An object that defines the filter criteria that\n determine whether Lambda should process an event. For more information, see Lambda event filtering.
" + } + }, "MaximumBatchingWindowInSeconds": { "target": "com.amazonaws.lambda#MaximumBatchingWindowInSeconds", "traits": { @@ -7580,7 +7642,7 @@ "FunctionResponseTypes": { "target": "com.amazonaws.lambda#FunctionResponseTypeList", "traits": { - "smithy.api#documentation": "(Streams only) A list of current response type enums applied to the event source mapping.
" + "smithy.api#documentation": "(Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
" } } } @@ -7767,7 +7829,7 @@ "Handler": { "target": "com.amazonaws.lambda#Handler", "traits": { - "smithy.api#documentation": "The name of the method within your code that Lambda calls to execute your function. The format includes the\n file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information,\n see Programming Model.
" + "smithy.api#documentation": "The name of the method within your code that Lambda calls to execute your function. \nHandler is required if the deployment package is a .zip file archive. The format includes the\n file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information,\n see Programming Model.
" } }, "Description": { @@ -7803,7 +7865,7 @@ "Runtime": { "target": "com.amazonaws.lambda#Runtime", "traits": { - "smithy.api#documentation": "The identifier of the function's runtime.
" + "smithy.api#documentation": "The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. \n
" } }, "DeadLetterConfig": { diff --git a/aws/sdk/aws-models/macie2.json b/aws/sdk/aws-models/macie2.json index cf6d872cccee3ecde4e7e6784de91a08c56b62c9..1259896679e6fe42e5cd80038a58fffeaa4ecf86 100644 --- a/aws/sdk/aws-models/macie2.json +++ b/aws/sdk/aws-models/macie2.json @@ -191,19 +191,19 @@ "status": { "target": "com.amazonaws.macie2#AdminStatus", "traits": { - "smithy.api#documentation": "The current status of the account as the delegated administrator of Amazon Macie for the organization.
", + "smithy.api#documentation": "The current status of the account as the delegated Amazon Macie administrator account for the organization.
", "smithy.api#jsonName": "status" } } }, "traits": { - "smithy.api#documentation": "Provides information about the delegated Amazon Macie administrator account for an Amazon Web Services organization.
" + "smithy.api#documentation": "Provides information about the delegated Amazon Macie administrator account for an organization in Organizations.
" } }, "com.amazonaws.macie2#AdminStatus": { "type": "string", "traits": { - "smithy.api#documentation": "The current status of an account as the delegated Amazon Macie administrator account for an Amazon Web Services organization. Possible values are:
", + "smithy.api#documentation": "The current status of an account as the delegated Amazon Macie administrator account for an organization in Organizations. Possible values are:
", "smithy.api#enum": [ { "value": "ENABLED", @@ -1433,7 +1433,7 @@ "description": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "A custom description of the custom data identifier. The description can contain as many as 512 characters.
We strongly recommend that you avoid including any sensitive data in the description of a custom data identifier. Other users of your account might be able to see the identifier's description, depending on the actions that they're allowed to perform in Amazon Macie.
", + "smithy.api#documentation": "A custom description of the custom data identifier. The description can contain as many as 512 characters.
We strongly recommend that you avoid including any sensitive data in the description of a custom data identifier. Other users of your account might be able to see this description, depending on the actions that they're allowed to perform in Amazon Macie.
", "smithy.api#jsonName": "description" } }, @@ -1461,7 +1461,7 @@ "name": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "A custom name for the custom data identifier. The name can contain as many as 128 characters.
We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see the identifier's name, depending on the actions that they're allowed to perform in Amazon Macie.
", + "smithy.api#documentation": "A custom name for the custom data identifier. The name can contain as many as 128 characters.
We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see this name, depending on the actions that they're allowed to perform in Amazon Macie.
", "smithy.api#jsonName": "name" } }, @@ -1562,7 +1562,7 @@ "description": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "A custom description of the filter. The description can contain as many as 512 characters.
We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users of your account might be able to see the filter's description, depending on the actions that they're allowed to perform in Amazon Macie.
", + "smithy.api#documentation": "A custom description of the filter. The description can contain as many as 512 characters.
We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users of your account might be able to see this description, depending on the actions that they're allowed to perform in Amazon Macie.
", "smithy.api#jsonName": "description" } }, @@ -1577,7 +1577,7 @@ "name": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.
We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users of your account might be able to see the filter's name, depending on the actions that they're allowed to perform in Amazon Macie.
", + "smithy.api#documentation": "A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.
We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users of your account might be able to see this name, depending on the actions that they're allowed to perform in Amazon Macie.
", "smithy.api#jsonName": "name", "smithy.api#required": {} } @@ -1671,14 +1671,14 @@ "disableEmailNotification": { "target": "com.amazonaws.macie2#__boolean", "traits": { - "smithy.api#documentation": "Specifies whether to send an email notification to the root user of each account that the invitation will be sent to. This notification is in addition to an alert that the root user receives in Personal Health Dashboard. To send an email notification to the root user of each account, set this value to true.
", + "smithy.api#documentation": "Specifies whether to send the invitation as an email message. If this value is false, Amazon Macie sends the invitation (as an email message) to the email address that you specified for the recipient's account when you associated the account with your account. The default value is false.
", "smithy.api#jsonName": "disableEmailNotification" } }, "message": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "A custom message to include in the invitation. Amazon Macie adds this message to the standard content that it sends for an invitation.
", + "smithy.api#documentation": "Custom text to include in the email message that contains the invitation. The text can contain as many as 80 alphanumeric characters.
", "smithy.api#jsonName": "message" } } @@ -2782,7 +2782,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the Amazon Macie configuration settings for an Amazon Web Services organization.
", + "smithy.api#documentation": "Retrieves the Amazon Macie configuration settings for an organization in Organizations.
", "smithy.api#http": { "method": "GET", "uri": "/admin/configuration", @@ -2800,14 +2800,14 @@ "autoEnable": { "target": "com.amazonaws.macie2#__boolean", "traits": { - "smithy.api#documentation": "Specifies whether Amazon Macie is enabled automatically for accounts that are added to the Amazon Web Services organization.
", + "smithy.api#documentation": "Specifies whether Amazon Macie is enabled automatically for accounts that are added to the organization.
", "smithy.api#jsonName": "autoEnable" } }, "maxAccountLimitReached": { "target": "com.amazonaws.macie2#__boolean", "traits": { - "smithy.api#documentation": "Specifies whether the maximum number of Amazon Macie member accounts are part of the Amazon Web Services organization.
", + "smithy.api#documentation": "Specifies whether the maximum number of Amazon Macie member accounts are part of the organization.
", "smithy.api#jsonName": "maxAccountLimitReached" } } @@ -2845,7 +2845,7 @@ } ], "traits": { - "smithy.api#documentation": "Disables an Amazon Macie account and deletes Macie resources for the account.
", + "smithy.api#documentation": "Disables Amazon Macie and deletes all settings and resources for a Macie account.
", "smithy.api#http": { "method": "DELETE", "uri": "/macie", @@ -2893,7 +2893,7 @@ } ], "traits": { - "smithy.api#documentation": "Disables an account as the delegated Amazon Macie administrator account for an Amazon Web Services organization.
", + "smithy.api#documentation": "Disables an account as the delegated Amazon Macie administrator account for an organization in Organizations.
", "smithy.api#http": { "method": "DELETE", "uri": "/admin", @@ -3208,7 +3208,7 @@ } ], "traits": { - "smithy.api#documentation": "Designates an account as the delegated Amazon Macie administrator account for an Amazon Web Services organization.
", + "smithy.api#documentation": "Designates an account as the delegated Amazon Macie administrator account for an organization in Organizations.
", "smithy.api#http": { "method": "POST", "uri": "/admin", @@ -3767,7 +3767,7 @@ "administrator": { "target": "com.amazonaws.macie2#Invitation", "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID for the administrator account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.
", + "smithy.api#documentation": "The Amazon Web Services account ID for the administrator account. If the accounts are associated by an Amazon Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.
", "smithy.api#jsonName": "administrator" } } @@ -3805,7 +3805,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves (queries) aggregated statistical data for all the S3 buckets that Amazon Macie monitors and analyzes.
", + "smithy.api#documentation": "Retrieves (queries) aggregated statistical data about S3 buckets that Amazon Macie monitors and analyzes.
", "smithy.api#http": { "method": "POST", "uri": "/datasources/s3/statistics", @@ -4560,28 +4560,28 @@ "findingPublishingFrequency": { "target": "com.amazonaws.macie2#FindingPublishingFrequency", "traits": { - "smithy.api#documentation": "The frequency with which Macie publishes updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).
", + "smithy.api#documentation": "The frequency with which Amazon Macie publishes updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).
", "smithy.api#jsonName": "findingPublishingFrequency" } }, "serviceRole": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service-linked role that allows Macie to monitor and analyze data in Amazon Web Services resources for the account.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service-linked role that allows Amazon Macie to monitor and analyze data in Amazon Web Services resources for the account.
", "smithy.api#jsonName": "serviceRole" } }, "status": { "target": "com.amazonaws.macie2#MacieStatus", "traits": { - "smithy.api#documentation": "The current status of the Macie account. Possible values are: PAUSED, the account is enabled but all Macie activities are suspended (paused) for the account; and, ENABLED, the account is enabled and all Macie activities are enabled for the account.
", + "smithy.api#documentation": "The current status of the Amazon Macie account. Possible values are: PAUSED, the account is enabled but all Macie activities are suspended (paused) for the account; and, ENABLED, the account is enabled and all Macie activities are enabled for the account.
", "smithy.api#jsonName": "status" } }, "updatedAt": { "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the Macie account.
", + "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the Amazon Macie account.
", "smithy.api#jsonName": "updatedAt" } } @@ -4730,7 +4730,7 @@ "invitedAt": { "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie invitation hasn't been sent to the account.
", + "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if an invitation hasn't been sent to the account.
", "smithy.api#jsonName": "invitedAt" } }, @@ -5058,7 +5058,7 @@ "invitationId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The unique identifier for the invitation. Amazon Macie uses this identifier to validate the inviter account with the invitee account.
", + "smithy.api#documentation": "The unique identifier for the invitation.
", "smithy.api#jsonName": "invitationId" } }, @@ -5072,13 +5072,13 @@ "relationshipStatus": { "target": "com.amazonaws.macie2#RelationshipStatus", "traits": { - "smithy.api#documentation": "The status of the relationship between the account that sent the invitation (inviter account) and the account that received the invitation (invitee account).
", + "smithy.api#documentation": "The status of the relationship between the account that sent the invitation and the account that received the invitation.
", "smithy.api#jsonName": "relationshipStatus" } } }, "traits": { - "smithy.api#documentation": "Provides information about an Amazon Macie membership invitation that was received by an account.
" + "smithy.api#documentation": "Provides information about an Amazon Macie membership invitation.
" } }, "com.amazonaws.macie2#IpAddressDetails": { @@ -6275,7 +6275,7 @@ "members": { "target": "com.amazonaws.macie2#__listOfMember", "traits": { - "smithy.api#documentation": "An array of objects, one for each account that's associated with the administrator account and meets the criteria specified by the onlyAssociated request parameter.
", + "smithy.api#documentation": "An array of objects, one for each account that's associated with the administrator account and meets the criteria specified in the request.
", "smithy.api#jsonName": "members" } }, @@ -6320,7 +6320,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves information about the delegated Amazon Macie administrator account for an Amazon Web Services organization.
", + "smithy.api#documentation": "Retrieves information about the delegated Amazon Macie administrator account for an organization in Organizations.
", "smithy.api#http": { "method": "GET", "uri": "/admin", @@ -6825,7 +6825,7 @@ "invitedAt": { "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie invitation hasn't been sent to the account.
", + "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if an invitation hasn't been sent to the account.
", "smithy.api#jsonName": "invitedAt" } }, @@ -7262,7 +7262,7 @@ "com.amazonaws.macie2#RelationshipStatus": { "type": "string", "traits": { - "smithy.api#documentation": "The current status of the relationship between an account and an associated Amazon Macie administrator account (inviter account). Possible values are:
", + "smithy.api#documentation": "The current status of the relationship between an account and an associated Amazon Macie administrator account. Possible values are:
", "smithy.api#enum": [ { "value": "Enabled", @@ -8318,7 +8318,7 @@ "severity": { "target": "com.amazonaws.macie2#DataIdentifierSeverity", "traits": { - "smithy.api#documentation": "The severity to assign to a finding if the number of occurrences is greater than or equal to the specified threshold (occurrencesThreshold) and, if applicable, is less than the threshold for the next consecutive severity level for the custom data identifier.
", + "smithy.api#documentation": "The severity to assign to a finding: if the number of occurrences is greater than or equal to the specified threshold (occurrencesThreshold); and, if applicable, the number of occurrences is less than the threshold for the next consecutive severity level for the custom data identifier, moving from LOW to HIGH.
", "smithy.api#jsonName": "severity", "smithy.api#required": {} } @@ -9036,7 +9036,7 @@ "description": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "A custom description of the filter. The description can contain as many as 512 characters.
We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users might be able to see the filter's description, depending on the actions that they're allowed to perform in Amazon Macie.
", + "smithy.api#documentation": "A custom description of the filter. The description can contain as many as 512 characters.
We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users might be able to see this description, depending on the actions that they're allowed to perform in Amazon Macie.
", "smithy.api#jsonName": "description" } }, @@ -9058,7 +9058,7 @@ "name": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.
We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users might be able to see the filter's name, depending on the actions that they're allowed to perform in Amazon Macie.
", + "smithy.api#documentation": "A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.
We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users might be able to see this name, depending on the actions that they're allowed to perform in Amazon Macie.
", "smithy.api#jsonName": "name" } }, @@ -9130,7 +9130,7 @@ } ], "traits": { - "smithy.api#documentation": "Suspends or re-enables an Amazon Macie account, or updates the configuration settings for a Macie account.
", + "smithy.api#documentation": "Suspends or re-enables Amazon Macie, or updates the configuration settings for a Macie account.
", "smithy.api#http": { "method": "PATCH", "uri": "/macie", @@ -9258,7 +9258,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the Amazon Macie configuration settings for an Amazon Web Services organization.
", + "smithy.api#documentation": "Updates the Amazon Macie configuration settings for an organization in Organizations.
", "smithy.api#http": { "method": "PATCH", "uri": "/admin/configuration", @@ -9272,7 +9272,7 @@ "autoEnable": { "target": "com.amazonaws.macie2#__boolean", "traits": { - "smithy.api#documentation": "Specifies whether to enable Amazon Macie automatically for each account, when the account is added to the Amazon Web Services organization.
", + "smithy.api#documentation": "Specifies whether to enable Amazon Macie automatically for an account when the account is added to the organization in Organizations.
", "smithy.api#jsonName": "autoEnable", "smithy.api#required": {} } diff --git a/aws/sdk/aws-models/medialive.json b/aws/sdk/aws-models/medialive.json index 7fc428af15ee063fde448832d5c80bca8494319d..e2445bfe279234044fdb2ca6e64ec656b7da0607 100644 --- a/aws/sdk/aws-models/medialive.json +++ b/aws/sdk/aws-models/medialive.json @@ -11709,6 +11709,13 @@ "smithy.api#jsonName": "networkInputSettings" } }, + "Scte35Pid": { + "target": "com.amazonaws.medialive#__integerMin32Max8191", + "traits": { + "smithy.api#documentation": "PID from which to read SCTE-35 messages. If left undefined, EML will select the first SCTE-35 PID found in the input.", + "smithy.api#jsonName": "scte35Pid" + } + }, "Smpte2038DataPreference": { "target": "com.amazonaws.medialive#Smpte2038DataPreference", "traits": { @@ -13964,6 +13971,21 @@ }, "com.amazonaws.medialive#MediaLive": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "MediaLive", + "arnNamespace": "medialive", + "cloudFormationName": "MediaLive", + "cloudTrailEventSource": "medialive.amazonaws.com", + "endpointPrefix": "medialive" + }, + "aws.auth#sigv4": { + "name": "medialive" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "API for AWS Elemental MediaLive", + "smithy.api#title": "AWS Elemental MediaLive" + }, "version": "2017-10-14", "operations": [ { @@ -14137,22 +14159,7 @@ { "target": "com.amazonaws.medialive#UpdateReservation" } - ], - "traits": { - "aws.api#service": { - "sdkId": "MediaLive", - "arnNamespace": "medialive", - "cloudFormationName": "MediaLive", - "cloudTrailEventSource": "medialive.amazonaws.com", - "endpointPrefix": "medialive" - }, - "aws.auth#sigv4": { - "name": "medialive" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "API for AWS Elemental MediaLive", - "smithy.api#title": "AWS Elemental MediaLive" - } + ] }, "com.amazonaws.medialive#MediaPackageGroupSettings": { "type": "structure", @@ -20847,6 +20854,16 @@ } } }, + "com.amazonaws.medialive#__integerMin32Max8191": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Placeholder documentation for __integerMin32Max8191", + "smithy.api#range": { + "min": 32, + "max": 8191 + } + } + }, "com.amazonaws.medialive#__integerMin4Max20": { "type": "integer", "traits": { diff --git a/aws/sdk/aws-models/mgn.json b/aws/sdk/aws-models/mgn.json index 9086d21137b1c600d03fb7e869cfb2844bb63007..5043d8a4eba1574ad3b31f907930ed94b11defab 100644 --- a/aws/sdk/aws-models/mgn.json +++ b/aws/sdk/aws-models/mgn.json @@ -46,35 +46,6 @@ }, "com.amazonaws.mgn#ApplicationMigrationService": { "type": "service", - "version": "2020-02-26", - "operations": [ - { - "target": "com.amazonaws.mgn#InitializeService" - }, - { - "target": "com.amazonaws.mgn#ListTagsForResource" - }, - { - "target": "com.amazonaws.mgn#TagResource" - }, - { - "target": "com.amazonaws.mgn#UntagResource" - } - ], - "resources": [ - { - "target": "com.amazonaws.mgn#AccountResource" - }, - { - "target": "com.amazonaws.mgn#JobResource" - }, - { - "target": "com.amazonaws.mgn#ReplicationConfigurationTemplateResource" - }, - { - "target": "com.amazonaws.mgn#SourceServerResource" - } - ], "traits": { "aws.api#service": { "sdkId": "mgn", @@ -103,7 +74,39 @@ }, "smithy.api#documentation": "The Application Migration Service service.
", "smithy.api#title": "Application Migration Service" - } + }, + "version": "2020-02-26", + "operations": [ + { + "target": "com.amazonaws.mgn#InitializeService" + }, + { + "target": "com.amazonaws.mgn#ListTagsForResource" + }, + { + "target": "com.amazonaws.mgn#TagResource" + }, + { + "target": "com.amazonaws.mgn#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.mgn#AccountResource" + }, + { + "target": "com.amazonaws.mgn#JobResource" + }, + { + "target": "com.amazonaws.mgn#ReplicationConfigurationTemplateResource" + }, + { + "target": "com.amazonaws.mgn#SourceServerResource" + }, + { + "target": "com.amazonaws.mgn#VcenterClientResource" + } + ] }, "com.amazonaws.mgn#BoundedString": { "type": "string", @@ -459,6 +462,14 @@ { "value": "FAILED_TO_START_DATA_TRANSFER", "name": "FAILED_TO_START_DATA_TRANSFER" + }, + { + "value": "UNSUPPORTED_VM_CONFIGURATION", + "name": "UNSUPPORTED_VM_CONFIGURATION" + }, + { + "value": "LAST_SNAPSHOT_JOB_FAILED", + "name": "LAST_SNAPSHOT_JOB_FAILED" } ] } @@ -501,6 +512,12 @@ "traits": { "smithy.api#documentation": "Error in obtaining data replication info.
" } + }, + "lastSnapshotDateTime": { + "target": "com.amazonaws.mgn#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "Request to query data replication last snapshot time.
" + } } }, "traits": { @@ -730,6 +747,14 @@ { "value": "DISCONNECTED", "name": "DISCONNECTED" + }, + { + "value": "PENDING_SNAPSHOT_SHIPPING", + "name": "PENDING_SNAPSHOT_SHIPPING" + }, + { + "value": "SHIPPING_SNAPSHOT", + "name": "SHIPPING_SNAPSHOT" } ] } @@ -869,6 +894,44 @@ "type": "structure", "members": {} }, + "com.amazonaws.mgn#DeleteVcenterClient": { + "type": "operation", + "input": { + "target": "com.amazonaws.mgn#DeleteVcenterClientRequest" + }, + "errors": [ + { + "target": "com.amazonaws.mgn#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mgn#UninitializedAccountException" + }, + { + "target": "com.amazonaws.mgn#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a single vCenter client by ID.
", + "smithy.api#http": { + "method": "POST", + "uri": "/DeleteVcenterClient", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mgn#DeleteVcenterClientRequest": { + "type": "structure", + "members": { + "vcenterClientID": { + "target": "com.amazonaws.mgn#VcenterClientID", + "traits": { + "smithy.api#documentation": "ID of resource to be deleted.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.mgn#DescribeJobLogItems": { "type": "operation", "input": { @@ -1199,6 +1262,18 @@ "traits": { "smithy.api#documentation": "Request to filter Source Servers list by archived.
" } + }, + "replicationTypes": { + "target": "com.amazonaws.mgn#ReplicationTypes", + "traits": { + "smithy.api#documentation": "Request to filter Source Servers list by replication type.
" + } + }, + "lifeCycleStates": { + "target": "com.amazonaws.mgn#LifeCycleStates", + "traits": { + "smithy.api#documentation": "Request to filter Source Servers list by life cycle states.
" + } } }, "traits": { @@ -1234,6 +1309,77 @@ } } }, + "com.amazonaws.mgn#DescribeVcenterClients": { + "type": "operation", + "input": { + "target": "com.amazonaws.mgn#DescribeVcenterClientsRequest" + }, + "output": { + "target": "com.amazonaws.mgn#DescribeVcenterClientsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mgn#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mgn#UninitializedAccountException" + }, + { + "target": "com.amazonaws.mgn#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all vCenter clients.
", + "smithy.api#http": { + "method": "GET", + "uri": "/DescribeVcenterClients", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "items", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mgn#DescribeVcenterClientsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.mgn#StrictlyPositiveInteger", + "traits": { + "smithy.api#documentation": "Maximum results to be returned in DescribeVcenterClients.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.mgn#PaginationToken", + "traits": { + "smithy.api#documentation": "Next pagination token to be provided for DescribeVcenterClients.
", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.mgn#DescribeVcenterClientsResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.mgn#VcenterClientList", + "traits": { + "smithy.api#documentation": "List of items returned by DescribeVcenterClients.
" + } + }, + "nextToken": { + "target": "com.amazonaws.mgn#PaginationToken", + "traits": { + "smithy.api#documentation": "Next pagination token returned from DescribeVcenterClients.
" + } + } + } + }, "com.amazonaws.mgn#DisconnectFromService": { "type": "operation", "input": { @@ -1509,6 +1655,12 @@ "traits": { "smithy.api#documentation": "AWS Instance ID identification hint.
" } + }, + "vmPath": { + "target": "com.amazonaws.mgn#BoundedString", + "traits": { + "smithy.api#documentation": "vCenter VM path identification hint.
" + } } }, "traits": { @@ -2246,10 +2398,26 @@ { "value": "DISCONNECTED", "name": "DISCONNECTED" + }, + { + "value": "DISCOVERED", + "name": "DISCOVERED" } ] } }, + "com.amazonaws.mgn#LifeCycleStates": { + "type": "list", + "member": { + "target": "com.amazonaws.mgn#LifeCycleState" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, "com.amazonaws.mgn#ListTagsForResource": { "type": "operation", "input": { @@ -2823,6 +2991,33 @@ } } }, + "com.amazonaws.mgn#ReplicationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AGENT_BASED", + "name": "AGENT_BASED" + }, + { + "value": "SNAPSHOT_SHIPPING", + "name": "SNAPSHOT_SHIPPING" + } + ] + } + }, + "com.amazonaws.mgn#ReplicationTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.mgn#ReplicationType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, "com.amazonaws.mgn#ResourceNotFoundException": { "type": "structure", "members": { @@ -2901,6 +3096,46 @@ "smithy.api#pattern": "^sg-[0-9a-fA-F]{8,}$" } }, + "com.amazonaws.mgn#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.mgn#LargeBoundedString" + }, + "code": { + "target": "com.amazonaws.mgn#LargeBoundedString" + }, + "resourceId": { + "target": "com.amazonaws.mgn#LargeBoundedString", + "traits": { + "smithy.api#documentation": "Exceeded the service quota resource Id.
" + } + }, + "resourceType": { + "target": "com.amazonaws.mgn#LargeBoundedString", + "traits": { + "smithy.api#documentation": "Exceeded the service quota resource type.
" + } + }, + "serviceCode": { + "target": "com.amazonaws.mgn#LargeBoundedString", + "traits": { + "smithy.api#documentation": "Exceeded the service quota service code.
" + } + }, + "quotaCode": { + "target": "com.amazonaws.mgn#LargeBoundedString", + "traits": { + "smithy.api#documentation": "Exceeded the service quota code.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request could not be completed because its exceeded the service quota.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, "com.amazonaws.mgn#SmallBoundedString": { "type": "string", "traits": { @@ -3016,6 +3251,18 @@ "traits": { "smithy.api#documentation": "Source server properties.
" } + }, + "replicationType": { + "target": "com.amazonaws.mgn#ReplicationType", + "traits": { + "smithy.api#documentation": "Source server replication type.
" + } + }, + "vcenterClientID": { + "target": "com.amazonaws.mgn#VcenterClientID", + "traits": { + "smithy.api#documentation": "Source server vCenter client id.
" + } } }, "traits": { @@ -3071,11 +3318,17 @@ { "target": "com.amazonaws.mgn#RetryDataReplication" }, + { + "target": "com.amazonaws.mgn#StartReplication" + }, { "target": "com.amazonaws.mgn#UpdateLaunchConfiguration" }, { "target": "com.amazonaws.mgn#UpdateReplicationConfiguration" + }, + { + "target": "com.amazonaws.mgn#UpdateSourceServerReplicationType" } ], "collectionOperations": [ @@ -3173,6 +3426,52 @@ } } }, + "com.amazonaws.mgn#StartReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.mgn#StartReplicationRequest" + }, + "output": { + "target": "com.amazonaws.mgn#SourceServer" + }, + "errors": [ + { + "target": "com.amazonaws.mgn#ConflictException" + }, + { + "target": "com.amazonaws.mgn#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mgn#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.mgn#UninitializedAccountException" + }, + { + "target": "com.amazonaws.mgn#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Starts replication on source server by ID.
", + "smithy.api#http": { + "method": "POST", + "uri": "/StartReplication", + "code": 200 + } + } + }, + "com.amazonaws.mgn#StartReplicationRequest": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.mgn#SourceServerID", + "traits": { + "smithy.api#documentation": "ID of source server on which to start replication.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.mgn#StartTest": { "type": "operation", "input": { @@ -3871,6 +4170,56 @@ } } }, + "com.amazonaws.mgn#UpdateSourceServerReplicationType": { + "type": "operation", + "input": { + "target": "com.amazonaws.mgn#UpdateSourceServerReplicationTypeRequest" + }, + "output": { + "target": "com.amazonaws.mgn#SourceServer" + }, + "errors": [ + { + "target": "com.amazonaws.mgn#ConflictException" + }, + { + "target": "com.amazonaws.mgn#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mgn#UninitializedAccountException" + }, + { + "target": "com.amazonaws.mgn#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates source server Replication Type by ID.
", + "smithy.api#http": { + "method": "POST", + "uri": "/UpdateSourceServerReplicationType", + "code": 200 + } + } + }, + "com.amazonaws.mgn#UpdateSourceServerReplicationTypeRequest": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.mgn#SourceServerID", + "traits": { + "smithy.api#documentation": "ID of source server on which to update replication type.
", + "smithy.api#required": {} + } + }, + "replicationType": { + "target": "com.amazonaws.mgn#ReplicationType", + "traits": { + "smithy.api#documentation": "Replication type to which to update source server.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.mgn#ValidationException": { "type": "structure", "members": { @@ -3947,6 +4296,100 @@ } ] } + }, + "com.amazonaws.mgn#VcenterClient": { + "type": "structure", + "members": { + "vcenterClientID": { + "target": "com.amazonaws.mgn#VcenterClientID", + "traits": { + "smithy.api#documentation": "ID of vCenter client.
" + } + }, + "arn": { + "target": "com.amazonaws.mgn#ARN", + "traits": { + "smithy.api#documentation": "Arn of vCenter client.
" + } + }, + "hostname": { + "target": "com.amazonaws.mgn#BoundedString", + "traits": { + "smithy.api#documentation": "Hostname of vCenter client .
" + } + }, + "vcenterUUID": { + "target": "com.amazonaws.mgn#BoundedString", + "traits": { + "smithy.api#documentation": "Vcenter UUID of vCenter client.
" + } + }, + "datacenterName": { + "target": "com.amazonaws.mgn#BoundedString", + "traits": { + "smithy.api#documentation": "Datacenter name of vCenter client.
" + } + }, + "lastSeenDatetime": { + "target": "com.amazonaws.mgn#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "Last seen time of vCenter client.
" + } + }, + "sourceServerTags": { + "target": "com.amazonaws.mgn#TagsMap", + "traits": { + "smithy.api#documentation": "Tags for Source Server of vCenter client.
" + } + }, + "tags": { + "target": "com.amazonaws.mgn#TagsMap", + "traits": { + "smithy.api#documentation": "Tags for vCenter client.
" + } + } + }, + "traits": { + "smithy.api#documentation": "vCenter client.
" + } + }, + "com.amazonaws.mgn#VcenterClientID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 21, + "max": 21 + }, + "smithy.api#pattern": "^vcc-[0-9a-zA-Z]{17}$" + } + }, + "com.amazonaws.mgn#VcenterClientList": { + "type": "list", + "member": { + "target": "com.amazonaws.mgn#VcenterClient" + } + }, + "com.amazonaws.mgn#VcenterClientResource": { + "type": "resource", + "identifiers": { + "vcenterClientID": { + "target": "com.amazonaws.mgn#VcenterClientID" + } + }, + "delete": { + "target": "com.amazonaws.mgn#DeleteVcenterClient" + }, + "list": { + "target": "com.amazonaws.mgn#DescribeVcenterClients" + }, + "traits": { + "aws.api#arn": { + "template": "vcenter-client/{vcenterClientID}", + "absolute": false, + "noAccount": false, + "noRegion": false + } + } } } } diff --git a/aws/sdk/aws-models/migration-hub-refactor-spaces.json b/aws/sdk/aws-models/migration-hub-refactor-spaces.json new file mode 100644 index 0000000000000000000000000000000000000000..1798283eb67903f7573e1913c9326e781a095009 --- /dev/null +++ b/aws/sdk/aws-models/migration-hub-refactor-spaces.json @@ -0,0 +1,4351 @@ +{ + "smithy": "1.0", + "shapes": { + "com.amazonaws.migrationhubrefactorspaces#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.migrationhubrefactorspaces#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The user does not have sufficient access to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.migrationhubrefactorspaces#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^\\d{12}$" + } + }, + "com.amazonaws.migrationhubrefactorspaces#AdditionalDetails": { + "type": "map", + "key": { + "target": "com.amazonaws.migrationhubrefactorspaces#AdditionalDetailsKey" + }, + "value": { + "target": "com.amazonaws.migrationhubrefactorspaces#AdditionalDetailsValue" + } + }, + "com.amazonaws.migrationhubrefactorspaces#AdditionalDetailsKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#AdditionalDetailsValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#ApiGatewayEndpointType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "REGIONAL", + "name": "REGIONAL" + }, + { + "value": "PRIVATE", + "name": "PRIVATE" + } + ] + } + }, + "com.amazonaws.migrationhubrefactorspaces#ApiGatewayId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 10 + }, + "smithy.api#pattern": "^[a-z0-9]{10}$" + } + }, + "com.amazonaws.migrationhubrefactorspaces#ApiGatewayProxyConfig": { + "type": "structure", + "members": { + "ProxyUrl": { + "target": "com.amazonaws.migrationhubrefactorspaces#Uri", + "traits": { + "smithy.api#documentation": "The endpoint URL of the API Gateway proxy.
" + } + }, + "ApiGatewayId": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApiGatewayId", + "traits": { + "smithy.api#documentation": "The resource ID of the API Gateway for the proxy.
" + } + }, + "VpcLinkId": { + "target": "com.amazonaws.migrationhubrefactorspaces#VpcLinkId", + "traits": { + "smithy.api#documentation": "The VpcLink ID of the API Gateway proxy.
The Amazon Resource Name (ARN) of the Network Load Balancer configured by the API Gateway proxy.
" + } + }, + "NlbName": { + "target": "com.amazonaws.migrationhubrefactorspaces#NlbName", + "traits": { + "smithy.api#documentation": "The name of the Network Load Balancer that is configured by the API Gateway proxy.
" + } + }, + "EndpointType": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApiGatewayEndpointType", + "traits": { + "smithy.api#documentation": "The type of API Gateway endpoint created.
" + } + }, + "StageName": { + "target": "com.amazonaws.migrationhubrefactorspaces#StageName", + "traits": { + "smithy.api#documentation": "The name of the API Gateway stage. The name defaults to prod.
A wrapper object holding the Amazon API Gateway proxy configuration.
" + } + }, + "com.amazonaws.migrationhubrefactorspaces#ApiGatewayProxyInput": { + "type": "structure", + "members": { + "EndpointType": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApiGatewayEndpointType", + "traits": { + "smithy.api#documentation": "The type of endpoint to use for the API Gateway proxy. If no value is specified in\n the request, the value is set to REGIONAL by default.
If the value is set to PRIVATE in the request, this creates a private API\n endpoint that is isolated from the public internet. The private endpoint can only be accessed\n by using Amazon Virtual Private Cloud (Amazon VPC) endpoints for Amazon API Gateway that\n have been granted access.
The name of the API Gateway stage. The name defaults to prod.
A wrapper object holding the Amazon API Gateway endpoint input.
" + } + }, + "com.amazonaws.migrationhubrefactorspaces#ApiGatewayProxySummary": { + "type": "structure", + "members": { + "ProxyUrl": { + "target": "com.amazonaws.migrationhubrefactorspaces#Uri", + "traits": { + "smithy.api#documentation": "The endpoint URL of the API Gateway proxy.
" + } + }, + "ApiGatewayId": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApiGatewayId", + "traits": { + "smithy.api#documentation": "The resource ID of the API Gateway for the proxy.
" + } + }, + "VpcLinkId": { + "target": "com.amazonaws.migrationhubrefactorspaces#VpcLinkId", + "traits": { + "smithy.api#documentation": "The VpcLink ID of the API Gateway proxy.
The Amazon Resource Name (ARN) of the Network Load Balancer configured by the API Gateway proxy.
" + } + }, + "NlbName": { + "target": "com.amazonaws.migrationhubrefactorspaces#NlbName", + "traits": { + "smithy.api#documentation": "The name of the Network Load Balancer that is configured by the API Gateway proxy.
" + } + }, + "EndpointType": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApiGatewayEndpointType", + "traits": { + "smithy.api#documentation": "The type of API Gateway endpoint created.
" + } + }, + "StageName": { + "target": "com.amazonaws.migrationhubrefactorspaces#StageName", + "traits": { + "smithy.api#documentation": "The name of the API Gateway stage. The name defaults to prod.
A wrapper object holding the Amazon API Gateway proxy summary.
" + } + }, + "com.amazonaws.migrationhubrefactorspaces#ApplicationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 14, + "max": 14 + }, + "smithy.api#pattern": "^app-[0-9A-Za-z]{10}$" + } + }, + "com.amazonaws.migrationhubrefactorspaces#ApplicationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^(?!app-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$" + } + }, + "com.amazonaws.migrationhubrefactorspaces#ApplicationState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "DELETING", + "name": "DELETING" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "UPDATING", + "name": "UPDATING" + } + ] + } + }, + "com.amazonaws.migrationhubrefactorspaces#ApplicationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationSummary" + } + }, + "com.amazonaws.migrationhubrefactorspaces#ApplicationSummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationName", + "traits": { + "smithy.api#documentation": "The name of the application.
" + } + }, + "Arn": { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceArn", + "traits": { + "smithy.api#documentation": "he Amazon Resource Name (ARN) of the application.
" + } + }, + "OwnerAccountId": { + "target": "com.amazonaws.migrationhubrefactorspaces#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the application owner.
" + } + }, + "CreatedByAccountId": { + "target": "com.amazonaws.migrationhubrefactorspaces#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the application creator.
" + } + }, + "ApplicationId": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the application.
" + } + }, + "EnvironmentId": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The unique identifier of the environment.
" + } + }, + "VpcId": { + "target": "com.amazonaws.migrationhubrefactorspaces#VpcId", + "traits": { + "smithy.api#documentation": "The ID of the virtual private cloud (VPC).
" + } + }, + "ProxyType": { + "target": "com.amazonaws.migrationhubrefactorspaces#ProxyType", + "traits": { + "smithy.api#documentation": "The proxy type of the proxy created within the application.
" + } + }, + "ApiGatewayProxy": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApiGatewayProxySummary", + "traits": { + "smithy.api#documentation": "The endpoint URL of the Amazon API Gateway proxy.
" + } + }, + "State": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationState", + "traits": { + "smithy.api#documentation": "The current state of the application.
" + } + }, + "Tags": { + "target": "com.amazonaws.migrationhubrefactorspaces#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the application.
" + } + }, + "Error": { + "target": "com.amazonaws.migrationhubrefactorspaces#ErrorResponse", + "traits": { + "smithy.api#documentation": "Any error associated with the application resource.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the application was last updated.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the application is created.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The list of ApplicationSummary objects.
The ID of the resource.
", + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.migrationhubrefactorspaces#String", + "traits": { + "smithy.api#documentation": "The type of resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Updating or deleting a resource can cause an inconsistent state.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.migrationhubrefactorspaces#CreateApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubrefactorspaces#CreateApplicationRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubrefactorspaces#CreateApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubrefactorspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ConflictException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Amazon Web Services Migration Hub Refactor Spaces application. The account that owns the environment also owns the\n applications created inside the environment, regardless of the account that creates the\n application. Refactor Spaces provisions the Amazon API Gateway and Network Load Balancer for\n the application proxy inside your account.
", + "smithy.api#http": { + "method": "POST", + "uri": "/environments/{EnvironmentIdentifier}/applications", + "code": 200 + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#CreateApplicationRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationName", + "traits": { + "smithy.api#documentation": "The name to use for the application.
", + "smithy.api#required": {} + } + }, + "EnvironmentIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The unique identifier of the environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.migrationhubrefactorspaces#VpcId", + "traits": { + "smithy.api#documentation": "The ID of the virtual private cloud (VPC).
", + "smithy.api#required": {} + } + }, + "ProxyType": { + "target": "com.amazonaws.migrationhubrefactorspaces#ProxyType", + "traits": { + "smithy.api#documentation": "The proxy type of the proxy created within the application.
", + "smithy.api#required": {} + } + }, + "ApiGatewayProxy": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApiGatewayProxyInput", + "traits": { + "smithy.api#documentation": "A wrapper object holding the API Gateway endpoint type and stage name for the\n proxy.
" + } + }, + "Tags": { + "target": "com.amazonaws.migrationhubrefactorspaces#TagMap", + "traits": { + "smithy.api#documentation": "The tags to assign to the application. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.migrationhubrefactorspaces#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#CreateApplicationResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationName", + "traits": { + "smithy.api#documentation": "The name of the application.
" + } + }, + "Arn": { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is \narn:aws:refactor-spaces:region:account-id:resource-type/resource-id\n . For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n Amazon Web Services General Reference.
The Amazon Web Services account ID of the application owner.
" + } + }, + "CreatedByAccountId": { + "target": "com.amazonaws.migrationhubrefactorspaces#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of application creator.
" + } + }, + "ApplicationId": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the application.
" + } + }, + "EnvironmentId": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environment in which the application is created.
" + } + }, + "VpcId": { + "target": "com.amazonaws.migrationhubrefactorspaces#VpcId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon VPC.
" + } + }, + "ProxyType": { + "target": "com.amazonaws.migrationhubrefactorspaces#ProxyType", + "traits": { + "smithy.api#documentation": "The proxy type of the proxy created within the application.
" + } + }, + "ApiGatewayProxy": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApiGatewayProxyInput", + "traits": { + "smithy.api#documentation": "A wrapper object holding the API Gateway endpoint type and stage name for the\n proxy.
" + } + }, + "State": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationState", + "traits": { + "smithy.api#documentation": "The current state of the application.
" + } + }, + "Tags": { + "target": "com.amazonaws.migrationhubrefactorspaces#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the application. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the application was last updated.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the application is created.
" + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#CreateEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubrefactorspaces#CreateEnvironmentRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubrefactorspaces#CreateEnvironmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubrefactorspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ConflictException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Amazon Web Services Migration Hub Refactor Spaces environment. The caller owns the environment resource, and they\n are referred to as the environment owner. The environment owner has\n cross-account visibility and control of Refactor Spaces resources that are added to the environment\n by other accounts that the environment is shared with. When creating an environment, Refactor Spaces\n provisions a transit gateway in your account.
", + "smithy.api#http": { + "method": "POST", + "uri": "/environments", + "code": 200 + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#CreateEnvironmentRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentName", + "traits": { + "smithy.api#documentation": "The name of the environment.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.migrationhubrefactorspaces#Description", + "traits": { + "smithy.api#documentation": "The description of the environment.
" + } + }, + "NetworkFabricType": { + "target": "com.amazonaws.migrationhubrefactorspaces#NetworkFabricType", + "traits": { + "smithy.api#documentation": "The network fabric type of the environment.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.migrationhubrefactorspaces#TagMap", + "traits": { + "smithy.api#documentation": "The tags to assign to the environment. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.migrationhubrefactorspaces#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#CreateEnvironmentResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentName", + "traits": { + "smithy.api#documentation": "The name of the environment.
" + } + }, + "Arn": { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the environment.
" + } + }, + "Description": { + "target": "com.amazonaws.migrationhubrefactorspaces#Description", + "traits": { + "smithy.api#documentation": "A description of the environment.
" + } + }, + "EnvironmentId": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The unique identifier of the environment.
" + } + }, + "NetworkFabricType": { + "target": "com.amazonaws.migrationhubrefactorspaces#NetworkFabricType", + "traits": { + "smithy.api#documentation": "The network fabric type of the environment.
" + } + }, + "OwnerAccountId": { + "target": "com.amazonaws.migrationhubrefactorspaces#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of environment owner.
" + } + }, + "State": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentState", + "traits": { + "smithy.api#documentation": "The current state of the environment.
" + } + }, + "Tags": { + "target": "com.amazonaws.migrationhubrefactorspaces#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the created environment. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair..
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the environment was last updated.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the environment is created.
" + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#CreateRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubrefactorspaces#CreateRouteRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubrefactorspaces#CreateRouteResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubrefactorspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ConflictException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Amazon Web Services Migration Hub Refactor Spaces route. The account owner of the service resource is always the\n environment owner, regardless of which account creates the route. Routes target a service in\n the application. If an application does not have any routes, then the first route must be\n created as a DEFAULT\n RouteType.
When you create a route, Refactor Spaces configures the Amazon API Gateway to send traffic\n to the target service as follows:
\nIf the service has a URL endpoint, and the endpoint resolves to a private IP address,\n Refactor Spaces routes traffic using the API Gateway VPC link.
\nIf the service has a URL endpoint, and the endpoint resolves to a public IP address,\n Refactor Spaces routes traffic over the public internet.
\nIf the service has an Lambda function endpoint, then Refactor Spaces uses\n the API Gateway\n Lambda integration.
\nA health check is performed on the service when the route is created. If the health check\n fails, the route transitions to FAILED, and no traffic is sent to the service.
For Lambda functions, the Lambda function state is checked. If\n the function is not active, the function configuration is updated so that Lambda\n resources are provisioned. If the Lambda state is Failed, then the\n route creation fails. For more information, see the GetFunctionConfiguration's State response parameter in the Lambda Developer Guide.
For public URLs, a connection is opened to the public endpoint. If the URL is not reachable,\n the health check fails. For private URLs, a target group is created and the target group\n health check is run.
\nThe HealthCheckProtocol, HealthCheckPort, and\n HealthCheckPath are the same protocol, port, and path specified in the URL or\n health URL, if used. All other settings use the default values, as described in Health checks\n for your target groups. The health check is considered successful if at least one\n target within the target group transitions to a healthy state.
The ID of the environment in which the route is created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ApplicationIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application within which the route is being created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ServiceIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceId", + "traits": { + "smithy.api#documentation": "The ID of the service in which the route is created. Traffic that matches this route is\n forwarded to this service.
", + "smithy.api#required": {} + } + }, + "RouteType": { + "target": "com.amazonaws.migrationhubrefactorspaces#RouteType", + "traits": { + "smithy.api#documentation": "The route type of the route. DEFAULT indicates that all traffic that does not\n match another route is forwarded to the default route. Applications must have a default route\n before any other routes can be created. URI_PATH indicates a route that is based\n on a URI path.
The configuration for the URI path route type.
" + } + }, + "Tags": { + "target": "com.amazonaws.migrationhubrefactorspaces#TagMap", + "traits": { + "smithy.api#documentation": "The tags to assign to the route. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair..
" + } + }, + "ClientToken": { + "target": "com.amazonaws.migrationhubrefactorspaces#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#CreateRouteResponse": { + "type": "structure", + "members": { + "RouteId": { + "target": "com.amazonaws.migrationhubrefactorspaces#RouteId", + "traits": { + "smithy.api#documentation": "The unique identifier of the route.
" + } + }, + "Arn": { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the route. The format for this ARN is \narn:aws:refactor-spaces:region:account-id:resource-type/resource-id\n . For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n Amazon Web Services General Reference.
The Amazon Web Services account ID of the route owner.
" + } + }, + "CreatedByAccountId": { + "target": "com.amazonaws.migrationhubrefactorspaces#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the route creator.
" + } + }, + "RouteType": { + "target": "com.amazonaws.migrationhubrefactorspaces#RouteType", + "traits": { + "smithy.api#documentation": "The route type of the route.
" + } + }, + "ServiceId": { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceId", + "traits": { + "smithy.api#documentation": "The ID of service in which the rute iscreated. Traffic that matches this route is\n forwarded to this service.
" + } + }, + "ApplicationId": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application in which the route is created.
" + } + }, + "UriPathRoute": { + "target": "com.amazonaws.migrationhubrefactorspaces#UriPathRouteInput", + "traits": { + "smithy.api#documentation": "onfiguration for the URI path route type.
" + } + }, + "State": { + "target": "com.amazonaws.migrationhubrefactorspaces#RouteState", + "traits": { + "smithy.api#documentation": "he current state of the route.
" + } + }, + "Tags": { + "target": "com.amazonaws.migrationhubrefactorspaces#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the created route. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the route was last updated.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the route is created.
" + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#CreateService": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubrefactorspaces#CreateServiceRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubrefactorspaces#CreateServiceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubrefactorspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ConflictException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Amazon Web Services Migration Hub Refactor Spaces service. The account owner of the service is always the\n environment owner, regardless of which account in the environment creates the service.\n Services have either a URL endpoint in a virtual private cloud (VPC), or a Lambda\n function endpoint.
\nIf an Amazon Web Services resourceis launched in a service VPC, and you want it to be\n accessible to all of an environment’s services with VPCs and routes, apply the\n RefactorSpacesSecurityGroup to the resource. Alternatively, to add more\n cross-account constraints, apply your own security group.
The name of the service.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.migrationhubrefactorspaces#Description", + "traits": { + "smithy.api#documentation": "The description of the service.
" + } + }, + "EnvironmentIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environment in which the service is created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ApplicationIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application which the service is created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.migrationhubrefactorspaces#VpcId", + "traits": { + "smithy.api#documentation": "The ID of the VPC.
" + } + }, + "EndpointType": { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceEndpointType", + "traits": { + "smithy.api#documentation": "The type of endpoint to use for the service. The type can be a URL in a VPC or an Lambda function.
", + "smithy.api#required": {} + } + }, + "UrlEndpoint": { + "target": "com.amazonaws.migrationhubrefactorspaces#UrlEndpointInput", + "traits": { + "smithy.api#documentation": "The configuration for the URL endpoint type.
" + } + }, + "LambdaEndpoint": { + "target": "com.amazonaws.migrationhubrefactorspaces#LambdaEndpointInput", + "traits": { + "smithy.api#documentation": "The configuration for the Lambda endpoint type.
" + } + }, + "Tags": { + "target": "com.amazonaws.migrationhubrefactorspaces#TagMap", + "traits": { + "smithy.api#documentation": "The tags to assign to the service. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair..
" + } + }, + "ClientToken": { + "target": "com.amazonaws.migrationhubrefactorspaces#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#CreateServiceResponse": { + "type": "structure", + "members": { + "ServiceId": { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the service.
" + } + }, + "Name": { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceName", + "traits": { + "smithy.api#documentation": "The name of the service.
" + } + }, + "Arn": { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service.
" + } + }, + "OwnerAccountId": { + "target": "com.amazonaws.migrationhubrefactorspaces#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the service owner.
" + } + }, + "CreatedByAccountId": { + "target": "com.amazonaws.migrationhubrefactorspaces#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the service creator.
" + } + }, + "Description": { + "target": "com.amazonaws.migrationhubrefactorspaces#Description", + "traits": { + "smithy.api#documentation": "The description of the created service.
" + } + }, + "EnvironmentId": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The unique identifier of the environment.
" + } + }, + "ApplicationId": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application that the created service belongs to.
" + } + }, + "VpcId": { + "target": "com.amazonaws.migrationhubrefactorspaces#VpcId", + "traits": { + "smithy.api#documentation": "The ID of the VPC.
" + } + }, + "EndpointType": { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceEndpointType", + "traits": { + "smithy.api#documentation": "The endpoint type of the service.
" + } + }, + "UrlEndpoint": { + "target": "com.amazonaws.migrationhubrefactorspaces#UrlEndpointInput", + "traits": { + "smithy.api#documentation": "The configuration for the URL endpoint type.
" + } + }, + "LambdaEndpoint": { + "target": "com.amazonaws.migrationhubrefactorspaces#LambdaEndpointInput", + "traits": { + "smithy.api#documentation": "The configuration for the Lambda endpoint type.
" + } + }, + "State": { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceState", + "traits": { + "smithy.api#documentation": "The current state of the service.
" + } + }, + "Tags": { + "target": "com.amazonaws.migrationhubrefactorspaces#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the created service. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair..
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the service was last updated.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the service is created.
" + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#DeleteApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubrefactorspaces#DeleteApplicationRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubrefactorspaces#DeleteApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubrefactorspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ConflictException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an Amazon Web Services Migration Hub Refactor Spaces application. Before you can delete an application, you must first\n delete any services or routes within the application.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.migrationhubrefactorspaces#DeleteApplicationRequest": { + "type": "structure", + "members": { + "EnvironmentIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ApplicationIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#DeleteApplicationResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationName", + "traits": { + "smithy.api#documentation": "The name of the application.
" + } + }, + "Arn": { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application.
" + } + }, + "ApplicationId": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application.
" + } + }, + "EnvironmentId": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The unique identifier of the application’s environment.
" + } + }, + "State": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationState", + "traits": { + "smithy.api#documentation": "The current state of the application.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the environment was last updated.
" + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#DeleteEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubrefactorspaces#DeleteEnvironmentRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubrefactorspaces#DeleteEnvironmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubrefactorspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ConflictException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an Amazon Web Services Migration Hub Refactor Spaces environment. Before you can delete an environment, you must first\n delete any applications and services within the environment.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/environments/{EnvironmentIdentifier}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.migrationhubrefactorspaces#DeleteEnvironmentRequest": { + "type": "structure", + "members": { + "EnvironmentIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#DeleteEnvironmentResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentName", + "traits": { + "smithy.api#documentation": "The name of the environment.
" + } + }, + "Arn": { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the environment.
" + } + }, + "EnvironmentId": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The unique identifier of the environment.
" + } + }, + "State": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentState", + "traits": { + "smithy.api#documentation": "The current state of the environment.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the environment was last updated.
" + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubrefactorspaces#DeleteResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubrefactorspaces#DeleteResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubrefactorspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the resource policy set for the environment.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/resourcepolicy/{Identifier}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.migrationhubrefactorspaces#DeleteResourcePolicyRequest": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourcePolicyIdentifier", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the resource associated with the policy.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#DeleteResourcePolicyResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.migrationhubrefactorspaces#DeleteRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubrefactorspaces#DeleteRouteRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubrefactorspaces#DeleteRouteResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubrefactorspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ConflictException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an Amazon Web Services Migration Hub Refactor Spaces route.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}/routes/{RouteIdentifier}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.migrationhubrefactorspaces#DeleteRouteRequest": { + "type": "structure", + "members": { + "EnvironmentIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environment to delete the route from.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ApplicationIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application to delete the route from.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RouteIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#RouteId", + "traits": { + "smithy.api#documentation": "The ID of the route to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#DeleteRouteResponse": { + "type": "structure", + "members": { + "RouteId": { + "target": "com.amazonaws.migrationhubrefactorspaces#RouteId", + "traits": { + "smithy.api#documentation": "The ID of the route to delete.
" + } + }, + "Arn": { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the route.
" + } + }, + "ServiceId": { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceId", + "traits": { + "smithy.api#documentation": "The ID of the service that the route belongs to.
" + } + }, + "ApplicationId": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", + "traits": { + "smithy.api#documentation": "he ID of the application that the route belongs to.
" + } + }, + "State": { + "target": "com.amazonaws.migrationhubrefactorspaces#RouteState", + "traits": { + "smithy.api#documentation": "The current state of the route.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the route was last updated.
" + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#DeleteService": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubrefactorspaces#DeleteServiceRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubrefactorspaces#DeleteServiceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubrefactorspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ConflictException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an Amazon Web Services Migration Hub Refactor Spaces service.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}/services/{ServiceIdentifier}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.migrationhubrefactorspaces#DeleteServiceRequest": { + "type": "structure", + "members": { + "EnvironmentIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environment that the service is in.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ApplicationIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", + "traits": { + "smithy.api#documentation": "Deletes a Refactor Spaces service.
\nThe RefactorSpacesSecurityGroup security group must be removed from all\n Amazon Web Services resources in the virtual private cloud (VPC) prior to deleting a service with a URL\n endpoint in a VPC.
The ID of the service to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#DeleteServiceResponse": { + "type": "structure", + "members": { + "ServiceId": { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the service.
" + } + }, + "Name": { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceName", + "traits": { + "smithy.api#documentation": "The name of the service.
" + } + }, + "Arn": { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service.
" + } + }, + "EnvironmentId": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The unique identifier of the environment.
" + } + }, + "ApplicationId": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application that the service is in.
" + } + }, + "State": { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceState", + "traits": { + "smithy.api#documentation": "The current state of the service.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the service was last updated.
" + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_\\s\\.\\!\\*\\#\\@\\']+$" + } + }, + "com.amazonaws.migrationhubrefactorspaces#Ec2TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.migrationhubrefactorspaces#EnvironmentId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 14, + "max": 14 + }, + "smithy.api#pattern": "^env-[0-9A-Za-z]{10}$" + } + }, + "com.amazonaws.migrationhubrefactorspaces#EnvironmentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^(?!env-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$" + } + }, + "com.amazonaws.migrationhubrefactorspaces#EnvironmentState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "DELETING", + "name": "DELETING" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.migrationhubrefactorspaces#EnvironmentSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentSummary" + } + }, + "com.amazonaws.migrationhubrefactorspaces#EnvironmentSummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentName", + "traits": { + "smithy.api#documentation": "The name of the environment.
" + } + }, + "Arn": { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the environment.
" + } + }, + "Description": { + "target": "com.amazonaws.migrationhubrefactorspaces#Description", + "traits": { + "smithy.api#documentation": "A description of the environment.
" + } + }, + "EnvironmentId": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The unique identifier of the environment.
" + } + }, + "NetworkFabricType": { + "target": "com.amazonaws.migrationhubrefactorspaces#NetworkFabricType", + "traits": { + "smithy.api#documentation": "The network fabric type of the environment.
" + } + }, + "OwnerAccountId": { + "target": "com.amazonaws.migrationhubrefactorspaces#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the environment owner.
" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.migrationhubrefactorspaces#TransitGatewayId", + "traits": { + "smithy.api#documentation": "The ID of the transit gateway set up by the environment.
" + } + }, + "State": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentState", + "traits": { + "smithy.api#documentation": "The current state of the environment.
" + } + }, + "Tags": { + "target": "com.amazonaws.migrationhubrefactorspaces#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the environment.
" + } + }, + "Error": { + "target": "com.amazonaws.migrationhubrefactorspaces#ErrorResponse", + "traits": { + "smithy.api#documentation": "Any error associated with the environment resource.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the environment was last updated.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the environment is created.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary information for environments as a response to ListEnvironments.
The unique identifier of the environment.
" + } + }, + "VpcId": { + "target": "com.amazonaws.migrationhubrefactorspaces#VpcId", + "traits": { + "smithy.api#documentation": "The ID of the VPC.
" + } + }, + "AccountId": { + "target": "com.amazonaws.migrationhubrefactorspaces#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the virtual private cloud (VPC) owner.
" + } + }, + "CidrBlocks": { + "target": "com.amazonaws.migrationhubrefactorspaces#CidrBlocks", + "traits": { + "smithy.api#documentation": "The list of Amazon Virtual Private Cloud (Amazon VPC) CIDR blocks.
" + } + }, + "VpcName": { + "target": "com.amazonaws.migrationhubrefactorspaces#Ec2TagValue", + "traits": { + "smithy.api#documentation": "The name of the VPC at the time it is added to the environment.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the VPC was last updated by the environment.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the VPC is first added to the environment.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides summary information for the EnvironmentVpc resource as a response to\n ListEnvironmentVpc.
The error code associated with the error.
" + } + }, + "Message": { + "target": "com.amazonaws.migrationhubrefactorspaces#ErrorMessage", + "traits": { + "smithy.api#documentation": "The message associated with the error.
" + } + }, + "AccountId": { + "target": "com.amazonaws.migrationhubrefactorspaces#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the resource owner.
" + } + }, + "ResourceIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceIdentifier", + "traits": { + "smithy.api#documentation": "The ID of the resource.
" + } + }, + "ResourceType": { + "target": "com.amazonaws.migrationhubrefactorspaces#ErrorResourceType", + "traits": { + "smithy.api#documentation": "The type of resource.
" + } + }, + "AdditionalDetails": { + "target": "com.amazonaws.migrationhubrefactorspaces#AdditionalDetails", + "traits": { + "smithy.api#documentation": "Additional details about the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Error associated with a resource returned for a Get or List resource response.
" + } + }, + "com.amazonaws.migrationhubrefactorspaces#GetApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubrefactorspaces#GetApplicationRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubrefactorspaces#GetApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubrefactorspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets an Amazon Web Services Migration Hub Refactor Spaces application.
", + "smithy.api#http": { + "method": "GET", + "uri": "/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhubrefactorspaces#GetApplicationRequest": { + "type": "structure", + "members": { + "EnvironmentIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ApplicationIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#GetApplicationResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationName", + "traits": { + "smithy.api#documentation": "The name of the application.
" + } + }, + "Arn": { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application.
" + } + }, + "OwnerAccountId": { + "target": "com.amazonaws.migrationhubrefactorspaces#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the application owner.
" + } + }, + "CreatedByAccountId": { + "target": "com.amazonaws.migrationhubrefactorspaces#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the application creator.
" + } + }, + "ApplicationId": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the application.
" + } + }, + "EnvironmentId": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The unique identifier of the environment.
" + } + }, + "VpcId": { + "target": "com.amazonaws.migrationhubrefactorspaces#VpcId", + "traits": { + "smithy.api#documentation": "The ID of the virtual private cloud (VPC).
" + } + }, + "ProxyType": { + "target": "com.amazonaws.migrationhubrefactorspaces#ProxyType", + "traits": { + "smithy.api#documentation": "The proxy type of the proxy created within the application.
" + } + }, + "ApiGatewayProxy": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApiGatewayProxyConfig", + "traits": { + "smithy.api#documentation": "The endpoint URL of the API Gateway proxy.
" + } + }, + "State": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationState", + "traits": { + "smithy.api#documentation": "The current state of the application.
" + } + }, + "Tags": { + "target": "com.amazonaws.migrationhubrefactorspaces#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the application. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
" + } + }, + "Error": { + "target": "com.amazonaws.migrationhubrefactorspaces#ErrorResponse", + "traits": { + "smithy.api#documentation": "Any error associated with the application resource.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the application was last updated.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the application is created.
" + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#GetEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubrefactorspaces#GetEnvironmentRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubrefactorspaces#GetEnvironmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubrefactorspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets an Amazon Web Services Migration Hub Refactor Spaces environment.
", + "smithy.api#http": { + "method": "GET", + "uri": "/environments/{EnvironmentIdentifier}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhubrefactorspaces#GetEnvironmentRequest": { + "type": "structure", + "members": { + "EnvironmentIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#GetEnvironmentResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentName", + "traits": { + "smithy.api#documentation": "The name of the environment.
" + } + }, + "Arn": { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the environment.
" + } + }, + "Description": { + "target": "com.amazonaws.migrationhubrefactorspaces#Description", + "traits": { + "smithy.api#documentation": "The description of the environment.
" + } + }, + "EnvironmentId": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The unique identifier of the environment.
" + } + }, + "NetworkFabricType": { + "target": "com.amazonaws.migrationhubrefactorspaces#NetworkFabricType", + "traits": { + "smithy.api#documentation": "The network fabric type of the environment.
" + } + }, + "OwnerAccountId": { + "target": "com.amazonaws.migrationhubrefactorspaces#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the environment owner.
" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.migrationhubrefactorspaces#TransitGatewayId", + "traits": { + "smithy.api#documentation": "The ID of the transit gateway set up by the environment.
" + } + }, + "State": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentState", + "traits": { + "smithy.api#documentation": "The current state of the environment.
" + } + }, + "Tags": { + "target": "com.amazonaws.migrationhubrefactorspaces#TagMap", + "traits": { + "smithy.api#documentation": "The tags to assign to the environment. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
" + } + }, + "Error": { + "target": "com.amazonaws.migrationhubrefactorspaces#ErrorResponse", + "traits": { + "smithy.api#documentation": "Any error associated with the environment resource.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the environment was last updated.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the environment is created.
" + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#GetResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubrefactorspaces#GetResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubrefactorspaces#GetResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubrefactorspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the resource-based permission policy that is set for the given environment.
", + "smithy.api#http": { + "method": "GET", + "uri": "/resourcepolicy/{Identifier}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhubrefactorspaces#GetResourcePolicyRequest": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourcePolicyIdentifier", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource associated with the policy.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#GetResourcePolicyResponse": { + "type": "structure", + "members": { + "Policy": { + "target": "com.amazonaws.migrationhubrefactorspaces#PolicyString", + "traits": { + "smithy.api#documentation": "A JSON-formatted string for an Amazon Web Services resource-based policy.
" + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#GetRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubrefactorspaces#GetRouteRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubrefactorspaces#GetRouteResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubrefactorspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets an Amazon Web Services Migration Hub Refactor Spaces route.
", + "smithy.api#http": { + "method": "GET", + "uri": "/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}/routes/{RouteIdentifier}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhubrefactorspaces#GetRouteRequest": { + "type": "structure", + "members": { + "EnvironmentIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ApplicationIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RouteIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#RouteId", + "traits": { + "smithy.api#documentation": "The ID of the route.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#GetRouteResponse": { + "type": "structure", + "members": { + "RouteId": { + "target": "com.amazonaws.migrationhubrefactorspaces#RouteId", + "traits": { + "smithy.api#documentation": "The unique identifier of the route.
\n\n DEFAULT: All traffic that does not match another route is\n forwarded to the default route. Applications must have a default route before any other routes\n can be created.
\n\n URI_PATH: A route that is based on a URI path.
" + } + }, + "Arn": { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the route.
" + } + }, + "OwnerAccountId": { + "target": "com.amazonaws.migrationhubrefactorspaces#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the route owner.
" + } + }, + "CreatedByAccountId": { + "target": "com.amazonaws.migrationhubrefactorspaces#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the route creator.
" + } + }, + "RouteType": { + "target": "com.amazonaws.migrationhubrefactorspaces#RouteType", + "traits": { + "smithy.api#documentation": "The type of route.
" + } + }, + "ServiceId": { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the service.
" + } + }, + "ApplicationId": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application that the route belongs to.
" + } + }, + "EnvironmentId": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "Unique identifier of the environment.
" + } + }, + "SourcePath": { + "target": "com.amazonaws.migrationhubrefactorspaces#UriPath", + "traits": { + "smithy.api#documentation": "The path to use to match traffic. Paths must start with / and are relative to\n the base of the application.
A list of HTTP methods to match. An empty list matches all values. If a method is present,\n only HTTP requests using that method are forwarded to this route’s service.
" + } + }, + "IncludeChildPaths": { + "target": "com.amazonaws.migrationhubrefactorspaces#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether to match all subpaths of the given source path. If this value is\n false, requests must match the source path exactly before they are forwarded to\n this route's service.
A mapping of Amazon API Gateway path resources to resource IDs.
" + } + }, + "State": { + "target": "com.amazonaws.migrationhubrefactorspaces#RouteState", + "traits": { + "smithy.api#documentation": "The current state of the route.
" + } + }, + "Tags": { + "target": "com.amazonaws.migrationhubrefactorspaces#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the route. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
" + } + }, + "Error": { + "target": "com.amazonaws.migrationhubrefactorspaces#ErrorResponse", + "traits": { + "smithy.api#documentation": "Any error associated with the route resource.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the route was last updated.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the route is created.
" + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#GetService": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubrefactorspaces#GetServiceRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubrefactorspaces#GetServiceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubrefactorspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets an Amazon Web Services Migration Hub Refactor Spaces service.
", + "smithy.api#http": { + "method": "GET", + "uri": "/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}/services/{ServiceIdentifier}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhubrefactorspaces#GetServiceRequest": { + "type": "structure", + "members": { + "EnvironmentIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ApplicationIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ServiceIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceId", + "traits": { + "smithy.api#documentation": "The ID of the service.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#GetServiceResponse": { + "type": "structure", + "members": { + "ServiceId": { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the service.
" + } + }, + "Name": { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceName", + "traits": { + "smithy.api#documentation": "The name of the service.
" + } + }, + "Arn": { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service.
" + } + }, + "OwnerAccountId": { + "target": "com.amazonaws.migrationhubrefactorspaces#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the service owner.
" + } + }, + "CreatedByAccountId": { + "target": "com.amazonaws.migrationhubrefactorspaces#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the service creator.
" + } + }, + "Description": { + "target": "com.amazonaws.migrationhubrefactorspaces#Description", + "traits": { + "smithy.api#documentation": "The description of the service.
" + } + }, + "EnvironmentId": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The unique identifier of the environment.
" + } + }, + "ApplicationId": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application.
" + } + }, + "VpcId": { + "target": "com.amazonaws.migrationhubrefactorspaces#VpcId", + "traits": { + "smithy.api#documentation": "The ID of the virtual private cloud (VPC).
" + } + }, + "EndpointType": { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceEndpointType", + "traits": { + "smithy.api#documentation": "The endpoint type of the service.
" + } + }, + "UrlEndpoint": { + "target": "com.amazonaws.migrationhubrefactorspaces#UrlEndpointConfig", + "traits": { + "smithy.api#documentation": "The configuration for the URL endpoint type.
\nThe Url isthe URL of the endpoint type.
\nThe HealthUrl is the health check URL of the endpoint\n type.
" + } + }, + "LambdaEndpoint": { + "target": "com.amazonaws.migrationhubrefactorspaces#LambdaEndpointConfig", + "traits": { + "smithy.api#documentation": "The configuration for the Lambda endpoint type.
\nThe Arn is the Amazon Resource Name (ARN) of the Lambda function associated with this service.
" + } + }, + "State": { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceState", + "traits": { + "smithy.api#documentation": "The current state of the service.
" + } + }, + "Tags": { + "target": "com.amazonaws.migrationhubrefactorspaces#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the service. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
" + } + }, + "Error": { + "target": "com.amazonaws.migrationhubrefactorspaces#ErrorResponse", + "traits": { + "smithy.api#documentation": "Any error associated with the service resource.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the service was last updated.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the service is created.
" + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#HttpMethod": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DELETE", + "name": "DELETE" + }, + { + "value": "GET", + "name": "GET" + }, + { + "value": "HEAD", + "name": "HEAD" + }, + { + "value": "OPTIONS", + "name": "OPTIONS" + }, + { + "value": "PATCH", + "name": "PATCH" + }, + { + "value": "POST", + "name": "POST" + }, + { + "value": "PUT", + "name": "PUT" + } + ] + } + }, + "com.amazonaws.migrationhubrefactorspaces#HttpMethods": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubrefactorspaces#HttpMethod" + } + }, + "com.amazonaws.migrationhubrefactorspaces#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.migrationhubrefactorspaces#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An unexpected error occurred while processing the request.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.migrationhubrefactorspaces#InvalidResourcePolicyException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.migrationhubrefactorspaces#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The resource policy is not valid.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.migrationhubrefactorspaces#LambdaArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:\n(\\$LATEST|[a-zA-Z0-9-_]+))?$" + } + }, + "com.amazonaws.migrationhubrefactorspaces#LambdaEndpointConfig": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.migrationhubrefactorspaces#LambdaArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda endpoint.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for the Lambda endpoint type.
" + } + }, + "com.amazonaws.migrationhubrefactorspaces#LambdaEndpointInput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.migrationhubrefactorspaces#LambdaArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda endpoint.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input for the Lambda endpoint type.
" + } + }, + "com.amazonaws.migrationhubrefactorspaces#LambdaEndpointSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.migrationhubrefactorspaces#LambdaArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda endpoint.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary for the Lambda endpoint type.
" + } + }, + "com.amazonaws.migrationhubrefactorspaces#ListApplications": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubrefactorspaces#ListApplicationsRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubrefactorspaces#ListApplicationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubrefactorspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ConflictException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment.
", + "smithy.api#http": { + "method": "GET", + "uri": "/environments/{EnvironmentIdentifier}/applications", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ApplicationSummaryList", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhubrefactorspaces#ListApplicationsRequest": { + "type": "structure", + "members": { + "EnvironmentIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.migrationhubrefactorspaces#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.migrationhubrefactorspaces#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return with a single call. To retrieve the remaining\n results, make another call with the returned nextToken value.
The list of ApplicationSummary objects.
The token for the next page of results.
" + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#ListEnvironmentVpcs": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubrefactorspaces#ListEnvironmentVpcsRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubrefactorspaces#ListEnvironmentVpcsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubrefactorspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all the virtual private clouds (VPCs) that are part of an Amazon Web Services Migration Hub Refactor Spaces environment.
", + "smithy.api#http": { + "method": "GET", + "uri": "/environments/{EnvironmentIdentifier}/vpcs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "EnvironmentVpcList", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhubrefactorspaces#ListEnvironmentVpcsRequest": { + "type": "structure", + "members": { + "EnvironmentIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.migrationhubrefactorspaces#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.migrationhubrefactorspaces#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return with a single call. To retrieve the remaining\n results, make another call with the returned nextToken value.
The list of EnvironmentVpc objects.
The token for the next page of results.
" + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#ListEnvironments": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubrefactorspaces#ListEnvironmentsRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubrefactorspaces#ListEnvironmentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubrefactorspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller\n account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/environments", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "EnvironmentSummaryList", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhubrefactorspaces#ListEnvironmentsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.migrationhubrefactorspaces#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.migrationhubrefactorspaces#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return with a single call. To retrieve the remaining\n results, make another call with the returned nextToken value.
The list of EnvironmentSummary objects.
The token for the next page of results.
" + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#ListRoutes": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubrefactorspaces#ListRoutesRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubrefactorspaces#ListRoutesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubrefactorspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ConflictException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application.
", + "smithy.api#http": { + "method": "GET", + "uri": "/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}/routes", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "RouteSummaryList", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhubrefactorspaces#ListRoutesRequest": { + "type": "structure", + "members": { + "EnvironmentIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ApplicationIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.migrationhubrefactorspaces#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.migrationhubrefactorspaces#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return with a single call. To retrieve the remaining\n results, make another call with the returned nextToken value.
The list of RouteSummary objects.
The token for the next page of results.
" + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#ListServices": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubrefactorspaces#ListServicesRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubrefactorspaces#ListServicesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubrefactorspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ConflictException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application.
", + "smithy.api#http": { + "method": "GET", + "uri": "/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}/services", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ServiceSummaryList", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhubrefactorspaces#ListServicesRequest": { + "type": "structure", + "members": { + "EnvironmentIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ApplicationIdentifier": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.migrationhubrefactorspaces#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.migrationhubrefactorspaces#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return with a single call. To retrieve the remaining\n results, make another call with the returned nextToken value.
The list of ServiceSummary objects.
The token for the next page of results.
" + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubrefactorspaces#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubrefactorspaces#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubrefactorspaces#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the tags of a resource. The caller account must be the same as the resource’s\n OwnerAccountId. Listing tags in other accounts is not supported.
The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.migrationhubrefactorspaces#TagMap", + "traits": { + "smithy.api#documentation": "The list of tags assigned to the resource.
" + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#NetworkFabricType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TRANSIT_GATEWAY", + "name": "TRANSIT_GATEWAY" + } + ] + } + }, + "com.amazonaws.migrationhubrefactorspaces#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[a-zA-Z0-9/\\+\\=]{0,2048}$" + } + }, + "com.amazonaws.migrationhubrefactorspaces#NlbArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:elasticloadbalancing:[a-zA-Z0-9\\-]+:\\w{12}:[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, + "com.amazonaws.migrationhubrefactorspaces#NlbName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^(?!internal-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+.*[^-]$" + } + }, + "com.amazonaws.migrationhubrefactorspaces#PathResourceToId": { + "type": "map", + "key": { + "target": "com.amazonaws.migrationhubrefactorspaces#PathResourceToIdKey" + }, + "value": { + "target": "com.amazonaws.migrationhubrefactorspaces#PathResourceToIdValue" + } + }, + "com.amazonaws.migrationhubrefactorspaces#PathResourceToIdKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#PathResourceToIdValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 10 + }, + "smithy.api#pattern": "^[a-z0-9]{10}$" + } + }, + "com.amazonaws.migrationhubrefactorspaces#PolicyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300000 + }, + "smithy.api#pattern": "^.*\\S.*$" + } + }, + "com.amazonaws.migrationhubrefactorspaces#ProxyType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "API_GATEWAY", + "name": "API_GATEWAY" + } + ] + } + }, + "com.amazonaws.migrationhubrefactorspaces#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubrefactorspaces#PutResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubrefactorspaces#PutResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubrefactorspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#InvalidResourcePolicyException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Attaches a resource-based permission policy to the Amazon Web Services Migration Hub Refactor Spaces environment. The policy\n must contain the same actions and condition statements as the\n arn:aws:ram::aws:permission/AWSRAMDefaultPermissionRefactorSpacesEnvironment\n permission in Resource Access Manager. The policy must not contain new lines or blank lines.
The Amazon Resource Name (ARN) of the resource to which the policy is being attached.\n
", + "smithy.api#required": {} + } + }, + "Policy": { + "target": "com.amazonaws.migrationhubrefactorspaces#PolicyString", + "traits": { + "smithy.api#documentation": "A JSON-formatted string for an Amazon Web Services resource-based policy.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#PutResourcePolicyResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.migrationhubrefactorspaces#RefactorSpaces": { + "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Migration Hub Refactor Spaces", + "arnNamespace": "refactor-spaces", + "cloudFormationName": "RefactorSpaces", + "cloudTrailEventSource": "refactor-spaces.amazonaws.com", + "endpointPrefix": "refactor-spaces" + }, + "aws.auth#sigv4": { + "name": "refactor-spaces" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "content-type" + ], + "additionalExposedHeaders": [ + "date", + "x-amz-apigw-id", + "x-amzn-trace-id", + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-errormessage" + ] + }, + "smithy.api#documentation": "This API reference provides descriptions, syntax, and other details about each of the\n actions and data types for Amazon Web Services Migration Hub Refactor Spaces (Refactor Spaces). The topic for each action shows the API\n request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to\n access an API that is tailored to the programming language or platform that you're using. For\n more information, see Amazon Web Services SDKs.
", + "smithy.api#title": "AWS Migration Hub Refactor Spaces" + }, + "version": "2021-10-26", + "operations": [ + { + "target": "com.amazonaws.migrationhubrefactorspaces#CreateApplication" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#CreateEnvironment" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#CreateRoute" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#CreateService" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#DeleteApplication" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#DeleteEnvironment" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#DeleteResourcePolicy" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#DeleteRoute" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#DeleteService" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#GetApplication" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#GetEnvironment" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#GetResourcePolicy" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#GetRoute" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#GetService" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ListApplications" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ListEnvironments" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ListEnvironmentVpcs" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ListRoutes" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ListServices" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ListTagsForResource" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#PutResourcePolicy" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#TagResource" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#UntagResource" + } + ] + }, + "com.amazonaws.migrationhubrefactorspaces#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:refactor-spaces:[a-zA-Z0-9\\-]+:\\w{12}:[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, + "com.amazonaws.migrationhubrefactorspaces#ResourceIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "(^(env|svc|pxy|rte|app)-([0-9A-Za-z]{10}$))" + } + }, + "com.amazonaws.migrationhubrefactorspaces#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.migrationhubrefactorspaces#String", + "traits": { + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.migrationhubrefactorspaces#String", + "traits": { + "smithy.api#documentation": "The ID of the resource.
", + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.migrationhubrefactorspaces#String", + "traits": { + "smithy.api#documentation": "The type of resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request references a resource that does not exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.migrationhubrefactorspaces#ResourcePolicyIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:refactor-spaces:[a-zA-Z0-9\\-]+:\\w{12}:[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, + "com.amazonaws.migrationhubrefactorspaces#RetryAfterSeconds": { + "type": "integer" + }, + "com.amazonaws.migrationhubrefactorspaces#RouteActivationState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVE", + "name": "ACTIVE" + } + ] + } + }, + "com.amazonaws.migrationhubrefactorspaces#RouteId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 14, + "max": 14 + }, + "smithy.api#pattern": "^rte-[0-9A-Za-z]{10}$" + } + }, + "com.amazonaws.migrationhubrefactorspaces#RouteState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "DELETING", + "name": "DELETING" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "UPDATING", + "name": "UPDATING" + }, + { + "value": "INACTIVE", + "name": "INACTIVE" + } + ] + } + }, + "com.amazonaws.migrationhubrefactorspaces#RouteSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubrefactorspaces#RouteSummary" + } + }, + "com.amazonaws.migrationhubrefactorspaces#RouteSummary": { + "type": "structure", + "members": { + "RouteId": { + "target": "com.amazonaws.migrationhubrefactorspaces#RouteId", + "traits": { + "smithy.api#documentation": "The unique identifier of the route.
" + } + }, + "Arn": { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the route.
" + } + }, + "OwnerAccountId": { + "target": "com.amazonaws.migrationhubrefactorspaces#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the route owner.
" + } + }, + "CreatedByAccountId": { + "target": "com.amazonaws.migrationhubrefactorspaces#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the route creator.
" + } + }, + "RouteType": { + "target": "com.amazonaws.migrationhubrefactorspaces#RouteType", + "traits": { + "smithy.api#documentation": "The route type of the route.
" + } + }, + "ServiceId": { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the service.
" + } + }, + "ApplicationId": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the application.
" + } + }, + "EnvironmentId": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The unique identifier of the environment.
" + } + }, + "SourcePath": { + "target": "com.amazonaws.migrationhubrefactorspaces#UriPath", + "traits": { + "smithy.api#documentation": "The path to use to match traffic. Paths must start with / and are relative to\n the base of the application.
A list of HTTP methods to match. An empty list matches all values. If a method is present,\n only HTTP requests using that method are forwarded to this route’s service.
" + } + }, + "IncludeChildPaths": { + "target": "com.amazonaws.migrationhubrefactorspaces#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether to match all subpaths of the given source path. If this value is\n false, requests must match the source path exactly before they are forwarded to\n this route's service.
A mapping of Amazon API Gateway path resources to resource IDs.
" + } + }, + "State": { + "target": "com.amazonaws.migrationhubrefactorspaces#RouteState", + "traits": { + "smithy.api#documentation": "The current state of the route.
" + } + }, + "Tags": { + "target": "com.amazonaws.migrationhubrefactorspaces#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the route.
" + } + }, + "Error": { + "target": "com.amazonaws.migrationhubrefactorspaces#ErrorResponse", + "traits": { + "smithy.api#documentation": "Any error associated with the route resource.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the route was last updated.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the route is created.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary information for the routes as a response to ListRoutes.
The ID of the resource.
", + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.migrationhubrefactorspaces#String", + "traits": { + "smithy.api#documentation": "The type of resource.
", + "smithy.api#required": {} + } + }, + "QuotaCode": { + "target": "com.amazonaws.migrationhubrefactorspaces#String", + "traits": { + "smithy.api#documentation": "Service quota requirement to identify originating quota. Reached throttling quota\n exception.
" + } + }, + "ServiceCode": { + "target": "com.amazonaws.migrationhubrefactorspaces#String", + "traits": { + "smithy.api#documentation": "Service quota requirement to identify originating service. Reached throttling quota\n exception service code.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request would cause a service quota to be exceeded.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.migrationhubrefactorspaces#ServiceState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "DELETING", + "name": "DELETING" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.migrationhubrefactorspaces#ServiceSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceSummary" + } + }, + "com.amazonaws.migrationhubrefactorspaces#ServiceSummary": { + "type": "structure", + "members": { + "ServiceId": { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the service.
" + } + }, + "Name": { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceName", + "traits": { + "smithy.api#documentation": "The name of the service.
" + } + }, + "Arn": { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service.
" + } + }, + "OwnerAccountId": { + "target": "com.amazonaws.migrationhubrefactorspaces#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the service owner.
" + } + }, + "CreatedByAccountId": { + "target": "com.amazonaws.migrationhubrefactorspaces#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the service creator.
" + } + }, + "Description": { + "target": "com.amazonaws.migrationhubrefactorspaces#Description", + "traits": { + "smithy.api#documentation": "A description of the service.
" + } + }, + "EnvironmentId": { + "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", + "traits": { + "smithy.api#documentation": "The unique identifier of the environment.
" + } + }, + "ApplicationId": { + "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", + "traits": { + "smithy.api#documentation": "The unique identifier of the application.
" + } + }, + "VpcId": { + "target": "com.amazonaws.migrationhubrefactorspaces#VpcId", + "traits": { + "smithy.api#documentation": "The ID of the virtual private cloud (VPC).
" + } + }, + "EndpointType": { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceEndpointType", + "traits": { + "smithy.api#documentation": "The endpoint type of the service.
" + } + }, + "UrlEndpoint": { + "target": "com.amazonaws.migrationhubrefactorspaces#UrlEndpointSummary", + "traits": { + "smithy.api#documentation": "The summary of the configuration for the URL endpoint type.
" + } + }, + "LambdaEndpoint": { + "target": "com.amazonaws.migrationhubrefactorspaces#LambdaEndpointSummary", + "traits": { + "smithy.api#documentation": "A summary of the configuration for the Lambda endpoint type.
" + } + }, + "State": { + "target": "com.amazonaws.migrationhubrefactorspaces#ServiceState", + "traits": { + "smithy.api#documentation": "The current state of the service.
" + } + }, + "Tags": { + "target": "com.amazonaws.migrationhubrefactorspaces#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the service.
" + } + }, + "Error": { + "target": "com.amazonaws.migrationhubrefactorspaces#ErrorResponse", + "traits": { + "smithy.api#documentation": "Any error associated with the service resource.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the service was last updated.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that indicates when the service is created.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary for the service as a response to ListServices.
Removes the tags of a given resource. Tags are metadata which can be used to manage a\n resource. To tag a resource, the caller account must be the same as the resource’s\n OwnerAccountId. Tagging resources in other accounts is not supported.
Amazon Web Services Migration Hub Refactor Spaces does not propagate tags to orchestrated resources, such as an\n environment’s transit gateway.
\nThe Amazon Resource Name (ARN) of the resource
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.migrationhubrefactorspaces#TagMap", + "traits": { + "smithy.api#documentation": "The new or modified tags for the resource.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.migrationhubrefactorspaces#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.migrationhubrefactorspaces#String", + "traits": { + "smithy.api#required": {} + } + }, + "QuotaCode": { + "target": "com.amazonaws.migrationhubrefactorspaces#String", + "traits": { + "smithy.api#documentation": "Service quota requirement to identify originating quota. Reached throttling quota\n exception.
" + } + }, + "ServiceCode": { + "target": "com.amazonaws.migrationhubrefactorspaces#String", + "traits": { + "smithy.api#documentation": "Service quota requirement to identify originating service. Reached throttling quota\n exception service code.
" + } + }, + "RetryAfterSeconds": { + "target": "com.amazonaws.migrationhubrefactorspaces#RetryAfterSeconds", + "traits": { + "smithy.api#documentation": "The number of seconds to wait before retrying.
", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "Request was denied because the request was throttled.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.migrationhubrefactorspaces#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.migrationhubrefactorspaces#TransitGatewayId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 21, + "max": 21 + }, + "smithy.api#pattern": "^tgw-[-a-f0-9]{17}$" + } + }, + "com.amazonaws.migrationhubrefactorspaces#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubrefactorspaces#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubrefactorspaces#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubrefactorspaces#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubrefactorspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Adds to or modifies the tags of the given resource. Tags are metadata which can be used to\n manage a resource. To untag a resource, the caller account must be the same as the resource’s\n OwnerAccountId. Untagging resources across accounts is not supported.
The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.migrationhubrefactorspaces#TagKeys", + "traits": { + "smithy.api#documentation": "The list of keys of the tags to be removed from the resource.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhubrefactorspaces#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.migrationhubrefactorspaces#Uri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^https?://[-a-zA-Z0-9+\\x38@#/%?=~_|!:,.;]*[-a-zA-Z0-9+\\x38@#/%=~_|]$" + } + }, + "com.amazonaws.migrationhubrefactorspaces#UriPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(/[a-zA-Z0-9._-]+)+$" + } + }, + "com.amazonaws.migrationhubrefactorspaces#UriPathRouteInput": { + "type": "structure", + "members": { + "SourcePath": { + "target": "com.amazonaws.migrationhubrefactorspaces#UriPath", + "traits": { + "smithy.api#documentation": "The path to use to match traffic. Paths must start with / and are relative to\n the base of the application.
Indicates whether traffic is forwarded to this route’s service after the route is created.
", + "smithy.api#required": {} + } + }, + "Methods": { + "target": "com.amazonaws.migrationhubrefactorspaces#HttpMethods", + "traits": { + "smithy.api#documentation": "A list of HTTP methods to match. An empty list matches all values. If a method is present,\n only HTTP requests using that method are forwarded to this route’s service.
" + } + }, + "IncludeChildPaths": { + "target": "com.amazonaws.migrationhubrefactorspaces#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether to match all subpaths of the given source path. If this value is\n false, requests must match the source path exactly before they are forwarded to\n this route's service.
The configuration for the URI path route type.
" + } + }, + "com.amazonaws.migrationhubrefactorspaces#UrlEndpointConfig": { + "type": "structure", + "members": { + "Url": { + "target": "com.amazonaws.migrationhubrefactorspaces#Uri", + "traits": { + "smithy.api#documentation": "The HTTP URL endpoint.
" + } + }, + "HealthUrl": { + "target": "com.amazonaws.migrationhubrefactorspaces#Uri", + "traits": { + "smithy.api#documentation": "The health check URL of the URL endpoint type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for the URL endpoint type.
" + } + }, + "com.amazonaws.migrationhubrefactorspaces#UrlEndpointInput": { + "type": "structure", + "members": { + "Url": { + "target": "com.amazonaws.migrationhubrefactorspaces#Uri", + "traits": { + "smithy.api#documentation": "The URL to route traffic to. The URL must be an rfc3986-formatted URL. If the\n host is a domain name, the name must be resolvable over the public internet. If the scheme is\n https, the top level domain of the host must be listed in the IANA root zone database.
The health check URL of the URL endpoint type. If the URL is a public endpoint, the\n HealthUrl must also be a public endpoint. If the URL is a private endpoint\n inside a virtual private cloud (VPC), the health URL must also be a private endpoint, and the\n host must be the same as the URL.
The configuration for the URL endpoint type.
" + } + }, + "com.amazonaws.migrationhubrefactorspaces#UrlEndpointSummary": { + "type": "structure", + "members": { + "Url": { + "target": "com.amazonaws.migrationhubrefactorspaces#Uri", + "traits": { + "smithy.api#documentation": " The URL to route traffic to. The URL must be an rfc3986-formatted URL. If the\n host is a domain name, the name must be resolvable over the public internet. If the scheme is\n https, the top level domain of the host must be listed in the IANA root zone database.
The health check URL of the URL endpoint type. If the URL is a public endpoint, the\n HealthUrl must also be a public endpoint. If the URL is a private endpoint\n inside a virtual private cloud (VPC), the health URL must also be a private endpoint, and the\n host must be the same as the URL.
The summary of the configuration for the URL endpoint type.
" + } + }, + "com.amazonaws.migrationhubrefactorspaces#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.migrationhubrefactorspaces#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input does not satisfy the constraints specified by an Amazon Web Service.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.migrationhubrefactorspaces#VpcId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 21 + }, + "smithy.api#pattern": "^vpc-[-a-f0-9]{8}([-a-f0-9]{9})?$" + } + }, + "com.amazonaws.migrationhubrefactorspaces#VpcLinkId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 10 + }, + "smithy.api#pattern": "^[a-z0-9]{10}$" + } + } + } +} diff --git a/aws/sdk/aws-models/migrationhubstrategy.json b/aws/sdk/aws-models/migrationhubstrategy.json new file mode 100644 index 0000000000000000000000000000000000000000..a851ec291f4bffea76c4bd642f37cfe3bf21c029 --- /dev/null +++ b/aws/sdk/aws-models/migrationhubstrategy.json @@ -0,0 +1,3999 @@ +{ + "smithy": "1.0", + "shapes": { + "com.amazonaws.migrationhubstrategy#AWSMigrationHubStrategyRecommendation": { + "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "MigrationHubStrategy", + "arnNamespace": "awsmigrationhubstrategyrecommendation", + "cloudFormationName": "AWSMigrationHubStrategyRecommendation", + "cloudTrailEventSource": "migrationhub-strategy.amazonaws.com", + "endpointPrefix": "migrationhub-strategy" + }, + "aws.auth#sigv4": { + "name": "migrationhub-strategy" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "This API reference provides descriptions, syntax, and other details about each of the\n actions and data types for Migration Hub Strategy Recommendations (Strategy Recommendations). The topic for each action shows the API\n request parameters and the response. Alternatively, you can use one of the AWS SDKs to access\n an API that is tailored to the programming language or platform that you're using. For more\n information, see AWS SDKs.
", + "smithy.api#title": "Migration Hub Strategy Recommendations" + }, + "version": "2020-02-19", + "operations": [ + { + "target": "com.amazonaws.migrationhubstrategy#GetApplicationComponentDetails" + }, + { + "target": "com.amazonaws.migrationhubstrategy#GetApplicationComponentStrategies" + }, + { + "target": "com.amazonaws.migrationhubstrategy#GetAssessment" + }, + { + "target": "com.amazonaws.migrationhubstrategy#GetImportFileTask" + }, + { + "target": "com.amazonaws.migrationhubstrategy#GetPortfolioPreferences" + }, + { + "target": "com.amazonaws.migrationhubstrategy#GetPortfolioSummary" + }, + { + "target": "com.amazonaws.migrationhubstrategy#GetRecommendationReportDetails" + }, + { + "target": "com.amazonaws.migrationhubstrategy#GetServerDetails" + }, + { + "target": "com.amazonaws.migrationhubstrategy#GetServerStrategies" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ListApplicationComponents" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ListCollectors" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ListImportFileTask" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ListServers" + }, + { + "target": "com.amazonaws.migrationhubstrategy#PutPortfolioPreferences" + }, + { + "target": "com.amazonaws.migrationhubstrategy#StartAssessment" + }, + { + "target": "com.amazonaws.migrationhubstrategy#StartImportFileTask" + }, + { + "target": "com.amazonaws.migrationhubstrategy#StartRecommendationReportGeneration" + }, + { + "target": "com.amazonaws.migrationhubstrategy#StopAssessment" + }, + { + "target": "com.amazonaws.migrationhubstrategy#UpdateApplicationComponentConfig" + }, + { + "target": "com.amazonaws.migrationhubstrategy#UpdateServerConfig" + } + ] + }, + "com.amazonaws.migrationhubstrategy#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The AWS user account does not have permission to perform the action. Check the\n AWS Identity and Access Management (IAM) policy associated with this account.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.migrationhubstrategy#AntipatternReportStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "SUCCESS", + "name": "SUCCESS" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#AntipatternSeveritySummary": { + "type": "structure", + "members": { + "severity": { + "target": "com.amazonaws.migrationhubstrategy#Severity", + "traits": { + "smithy.api#documentation": "\n Contains the severity of anti-patterns.\n
" + } + }, + "count": { + "target": "com.amazonaws.migrationhubstrategy#Integer", + "traits": { + "smithy.api#documentation": "\n Contains the count of anti-patterns.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Contains the summary of anti-patterns and their severity.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#AppType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DotNetFramework", + "name": "dotNetFramework" + }, + { + "value": "Java", + "name": "java" + }, + { + "value": "SQLServer", + "name": "sqlServer" + }, + { + "value": "IIS", + "name": "IIS" + }, + { + "value": "Oracle", + "name": "oracle" + }, + { + "value": "Other", + "name": "other" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#ApplicationComponentCriteria": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NOT_DEFINED", + "name": "NOT_DEFINED" + }, + { + "value": "APP_NAME", + "name": "APP_NAME" + }, + { + "value": "SERVER_ID", + "name": "SERVER_ID" + }, + { + "value": "APP_TYPE", + "name": "APP_TYPE" + }, + { + "value": "STRATEGY", + "name": "STRATEGY" + }, + { + "value": "DESTINATION", + "name": "DESTINATION" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#ApplicationComponentDetail": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhubstrategy#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the application component.
" + } + }, + "name": { + "target": "com.amazonaws.migrationhubstrategy#ResourceName", + "traits": { + "smithy.api#documentation": "The name of application component.
" + } + }, + "recommendationSet": { + "target": "com.amazonaws.migrationhubstrategy#RecommendationSet", + "traits": { + "smithy.api#documentation": "The top recommendation set for the application component.
" + } + }, + "analysisStatus": { + "target": "com.amazonaws.migrationhubstrategy#SrcCodeOrDbAnalysisStatus", + "traits": { + "smithy.api#documentation": "The status of analysis, if the application component has source code or an associated\n database.
" + } + }, + "statusMessage": { + "target": "com.amazonaws.migrationhubstrategy#StatusMessage", + "traits": { + "smithy.api#documentation": "A detailed description of the analysis status and any failure message.
" + } + }, + "listAntipatternSeveritySummary": { + "target": "com.amazonaws.migrationhubstrategy#ListAntipatternSeveritySummary", + "traits": { + "smithy.api#documentation": "A list of anti-pattern severity summaries.
" + } + }, + "databaseConfigDetail": { + "target": "com.amazonaws.migrationhubstrategy#DatabaseConfigDetail", + "traits": { + "smithy.api#documentation": "Configuration details for the database associated with the application component.
" + } + }, + "sourceCodeRepositories": { + "target": "com.amazonaws.migrationhubstrategy#SourceCodeRepositories", + "traits": { + "smithy.api#documentation": "Details about the source code repository associated with the application component.\n
" + } + }, + "appType": { + "target": "com.amazonaws.migrationhubstrategy#AppType", + "traits": { + "smithy.api#documentation": "The type of application component.
" + } + }, + "resourceSubType": { + "target": "com.amazonaws.migrationhubstrategy#ResourceSubType", + "traits": { + "smithy.api#documentation": "The application component subtype.
" + } + }, + "inclusionStatus": { + "target": "com.amazonaws.migrationhubstrategy#InclusionStatus", + "traits": { + "smithy.api#documentation": "Indicates whether the application component has been included for server recommendation\n or not.
" + } + }, + "antipatternReportS3Object": { + "target": "com.amazonaws.migrationhubstrategy#S3Object", + "traits": { + "smithy.api#documentation": "The S3 bucket name and the Amazon S3 key name for the anti-pattern report.
" + } + }, + "antipatternReportStatus": { + "target": "com.amazonaws.migrationhubstrategy#AntipatternReportStatus", + "traits": { + "smithy.api#documentation": "The status of the anti-pattern report generation.
" + } + }, + "antipatternReportStatusMessage": { + "target": "com.amazonaws.migrationhubstrategy#StatusMessage", + "traits": { + "smithy.api#documentation": "The status message for the anti-pattern.
" + } + }, + "osVersion": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "OS version.
" + } + }, + "osDriver": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "OS driver.
" + } + }, + "lastAnalyzedTimestamp": { + "target": "com.amazonaws.migrationhubstrategy#TimeStamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the application component was assessed.
" + } + }, + "associatedServerId": { + "target": "com.amazonaws.migrationhubstrategy#ServerId", + "traits": { + "smithy.api#documentation": "The ID of the server that the application component is running on.
" + } + }, + "moreServerAssociationExists": { + "target": "com.amazonaws.migrationhubstrategy#Boolean", + "traits": { + "smithy.api#documentation": "Set to true if the application component is running on multiple servers.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains detailed information about an application component.
" + } + }, + "com.amazonaws.migrationhubstrategy#ApplicationComponentDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#ApplicationComponentDetail" + } + }, + "com.amazonaws.migrationhubstrategy#ApplicationComponentId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 44 + }, + "smithy.api#pattern": "[0-9a-zA-Z-]+" + } + }, + "com.amazonaws.migrationhubstrategy#ApplicationComponentStrategies": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#ApplicationComponentStrategy" + } + }, + "com.amazonaws.migrationhubstrategy#ApplicationComponentStrategy": { + "type": "structure", + "members": { + "recommendation": { + "target": "com.amazonaws.migrationhubstrategy#RecommendationSet", + "traits": { + "smithy.api#documentation": "Strategy recommendation for the application component.
" + } + }, + "status": { + "target": "com.amazonaws.migrationhubstrategy#StrategyRecommendation", + "traits": { + "smithy.api#documentation": "The recommendation status of a strategy for an application component.
" + } + }, + "isPreferred": { + "target": "com.amazonaws.migrationhubstrategy#Boolean", + "traits": { + "smithy.api#documentation": "Set to true if the recommendation is set as preferred.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a strategy recommendation for an application component.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#ApplicationComponentSummary": { + "type": "structure", + "members": { + "appType": { + "target": "com.amazonaws.migrationhubstrategy#AppType", + "traits": { + "smithy.api#documentation": "\n Contains the name of application types.\n
" + } + }, + "count": { + "target": "com.amazonaws.migrationhubstrategy#Integer", + "traits": { + "smithy.api#documentation": "\n Contains the count of application type.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Contains the summary of application components.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#ApplicationPreferences": { + "type": "structure", + "members": { + "managementPreference": { + "target": "com.amazonaws.migrationhubstrategy#ManagementPreference", + "traits": { + "smithy.api#documentation": "\n Application preferences that you specify to prefer managed environment.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Application preferences that you specify.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#AssessmentStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "COMPLETE", + "name": "COMPLETE" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "STOPPED", + "name": "STOPPED" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#AssessmentSummary": { + "type": "structure", + "members": { + "listServerStrategySummary": { + "target": "com.amazonaws.migrationhubstrategy#ListStrategySummary", + "traits": { + "smithy.api#documentation": "\n List of ServerStrategySummary.\n
" + } + }, + "listApplicationComponentStrategySummary": { + "target": "com.amazonaws.migrationhubstrategy#ListStrategySummary", + "traits": { + "smithy.api#documentation": "\n List of ApplicationComponentStrategySummary.\n
" + } + }, + "listAntipatternSeveritySummary": { + "target": "com.amazonaws.migrationhubstrategy#ListAntipatternSeveritySummary", + "traits": { + "smithy.api#documentation": "\n List of AntipatternSeveritySummary.\n
" + } + }, + "listApplicationComponentSummary": { + "target": "com.amazonaws.migrationhubstrategy#ListApplicationComponentSummary", + "traits": { + "smithy.api#documentation": "\n List of ApplicationComponentSummary.\n
" + } + }, + "listServerSummary": { + "target": "com.amazonaws.migrationhubstrategy#ListServerSummary", + "traits": { + "smithy.api#documentation": "\n List of ServerSummary.\n
" + } + }, + "antipatternReportS3Object": { + "target": "com.amazonaws.migrationhubstrategy#S3Object", + "traits": { + "smithy.api#documentation": "\n The Amazon S3 object containing the anti-pattern report.\n
" + } + }, + "antipatternReportStatus": { + "target": "com.amazonaws.migrationhubstrategy#AntipatternReportStatus", + "traits": { + "smithy.api#documentation": "\n The status of the anti-pattern report.\n
" + } + }, + "antipatternReportStatusMessage": { + "target": "com.amazonaws.migrationhubstrategy#StatusMessage", + "traits": { + "smithy.api#documentation": "\n The status message of the anti-pattern report.\n
" + } + }, + "lastAnalyzedTimestamp": { + "target": "com.amazonaws.migrationhubstrategy#TimeStamp", + "traits": { + "smithy.api#documentation": "\n The time the assessment was performed.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Contains the summary of the assessment results.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#AssociatedApplication": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "\n Name of the application as defined in Application Discovery Service.\n
" + } + }, + "id": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "\n ID of the application as defined in Application Discovery Service.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Object containing details about applications as defined in Application Discovery Service.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#AssociatedApplications": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#AssociatedApplication" + } + }, + "com.amazonaws.migrationhubstrategy#AssociatedServerIDs": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#String" + } + }, + "com.amazonaws.migrationhubstrategy#AsyncTaskId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 52 + }, + "smithy.api#pattern": "[0-9a-z-:]+" + } + }, + "com.amazonaws.migrationhubstrategy#AwsManagedResources": { + "type": "structure", + "members": { + "targetDestination": { + "target": "com.amazonaws.migrationhubstrategy#AwsManagedTargetDestinations", + "traits": { + "smithy.api#documentation": "\n The choice of application destination that you specify.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n Object containing the choice of application destination that you specify.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#AwsManagedTargetDestination": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "None specified", + "name": "NONE_SPECIFIED" + }, + { + "value": "AWS Elastic BeanStalk", + "name": "AWS_ELASTIC_BEANSTALK" + }, + { + "value": "AWS Fargate", + "name": "AWS_FARGATE" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#AwsManagedTargetDestinations": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#AwsManagedTargetDestination" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.migrationhubstrategy#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.migrationhubstrategy#BusinessGoals": { + "type": "structure", + "members": { + "speedOfMigration": { + "target": "com.amazonaws.migrationhubstrategy#BusinessGoalsInteger", + "traits": { + "smithy.api#documentation": "\n Business goal to achieve migration at a fast pace.\n
" + } + }, + "reduceOperationalOverheadWithManagedServices": { + "target": "com.amazonaws.migrationhubstrategy#BusinessGoalsInteger", + "traits": { + "smithy.api#documentation": "\n Business goal to reduce the operational overhead on the team by moving into managed services.\n
" + } + }, + "modernizeInfrastructureWithCloudNativeTechnologies": { + "target": "com.amazonaws.migrationhubstrategy#BusinessGoalsInteger", + "traits": { + "smithy.api#documentation": "\n Business goal to modernize infrastructure by moving to cloud native technologies.\n
" + } + }, + "licenseCostReduction": { + "target": "com.amazonaws.migrationhubstrategy#BusinessGoalsInteger", + "traits": { + "smithy.api#documentation": "\n Business goal to reduce license costs.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Business goals that you specify.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#BusinessGoalsInteger": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.migrationhubstrategy#Collector": { + "type": "structure", + "members": { + "collectorId": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "\n The ID of the collector.\n
" + } + }, + "ipAddress": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "\n IP address of the server that is hosting the collector.\n
" + } + }, + "hostName": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "\n Hostname of the server that is hosting the collector.\n
" + } + }, + "collectorHealth": { + "target": "com.amazonaws.migrationhubstrategy#CollectorHealth", + "traits": { + "smithy.api#documentation": "\n Indicates the health of a collector.\n
" + } + }, + "collectorVersion": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "\n Current version of the collector that is running in the environment that you specify.\n
" + } + }, + "registeredTimeStamp": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "\n Time when the collector registered with the service.\n
" + } + }, + "lastActivityTimeStamp": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "\n Time when the collector last pinged the service.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Process data collector that runs in the environment that you specify.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#CollectorHealth": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "COLLECTOR_HEALTHY", + "name": "COLLECTOR_HEALTHY" + }, + { + "value": "COLLECTOR_UNHEALTHY", + "name": "COLLECTOR_UNHEALTHY" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#Collectors": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#Collector" + } + }, + "com.amazonaws.migrationhubstrategy#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n Exception to indicate that there is an ongoing task when a new task is created. \n Return when once the existing tasks are complete.\n
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.migrationhubstrategy#DataCollectionDetails": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.migrationhubstrategy#AssessmentStatus", + "traits": { + "smithy.api#documentation": "The status of the assessment.
" + } + }, + "servers": { + "target": "com.amazonaws.migrationhubstrategy#Integer", + "traits": { + "smithy.api#documentation": "The total number of servers in the assessment.
" + } + }, + "failed": { + "target": "com.amazonaws.migrationhubstrategy#Integer", + "traits": { + "smithy.api#documentation": "The number of failed servers in the assessment.
" + } + }, + "success": { + "target": "com.amazonaws.migrationhubstrategy#Integer", + "traits": { + "smithy.api#documentation": "The number of successful servers in the assessment.
" + } + }, + "inProgress": { + "target": "com.amazonaws.migrationhubstrategy#Integer", + "traits": { + "smithy.api#documentation": " The number of servers with the assessment status IN_PROGESS.
The start time of assessment.
" + } + }, + "completionTime": { + "target": "com.amazonaws.migrationhubstrategy#TimeStamp", + "traits": { + "smithy.api#documentation": "The time the assessment completes.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Detailed information about an assessment.
" + } + }, + "com.amazonaws.migrationhubstrategy#DataSourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ApplicationDiscoveryService", + "name": "ADS" + }, + { + "value": "MPA", + "name": "MPA" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#DatabaseConfigDetail": { + "type": "structure", + "members": { + "secretName": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "\n AWS Secrets Manager key that holds the credentials that you use to connect to a database.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Configuration information used for assessing databases.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#DatabaseManagementPreference": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWS-managed", + "name": "AWS_MANAGED" + }, + { + "value": "Self-manage", + "name": "SELF_MANAGE" + }, + { + "value": "No preference", + "name": "NO_PREFERENCE" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#DatabaseMigrationPreference": { + "type": "union", + "members": { + "heterogeneous": { + "target": "com.amazonaws.migrationhubstrategy#Heterogeneous", + "traits": { + "smithy.api#documentation": "Indicates whether you are interested in moving from one type of database to another. For\n example, from SQL Server to Amazon Aurora MySQL-Compatible Edition.
" + } + }, + "homogeneous": { + "target": "com.amazonaws.migrationhubstrategy#Homogeneous", + "traits": { + "smithy.api#documentation": "Indicates whether you are interested in moving to the same type of database into AWS.\n For example, from SQL Server in your environment to SQL Server on AWS.
" + } + }, + "noPreference": { + "target": "com.amazonaws.migrationhubstrategy#NoDatabaseMigrationPreference", + "traits": { + "smithy.api#documentation": "\n Indicated that you do not prefer heterogeneous or homogeneous.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Preferences for migrating a database to AWS.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#DatabasePreferences": { + "type": "structure", + "members": { + "databaseManagementPreference": { + "target": "com.amazonaws.migrationhubstrategy#DatabaseManagementPreference", + "traits": { + "smithy.api#documentation": "Specifies whether you're interested in self-managed databases or databases managed by\n AWS.
" + } + }, + "databaseMigrationPreference": { + "target": "com.amazonaws.migrationhubstrategy#DatabaseMigrationPreference", + "traits": { + "smithy.api#documentation": "\n Specifies your preferred migration path.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Preferences on managing your databases on AWS.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#GetApplicationComponentDetails": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubstrategy#GetApplicationComponentDetailsRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubstrategy#GetApplicationComponentDetailsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubstrategy#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves details about an application component.
", + "smithy.api#http": { + "method": "GET", + "uri": "/get-applicationcomponent-details/{applicationComponentId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhubstrategy#GetApplicationComponentDetailsRequest": { + "type": "structure", + "members": { + "applicationComponentId": { + "target": "com.amazonaws.migrationhubstrategy#ApplicationComponentId", + "traits": { + "smithy.api#documentation": "The ID of the application component. The ID is unique within an AWS account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhubstrategy#GetApplicationComponentDetailsResponse": { + "type": "structure", + "members": { + "applicationComponentDetail": { + "target": "com.amazonaws.migrationhubstrategy#ApplicationComponentDetail", + "traits": { + "smithy.api#documentation": "Detailed information about an application component.
" + } + }, + "associatedApplications": { + "target": "com.amazonaws.migrationhubstrategy#AssociatedApplications", + "traits": { + "smithy.api#documentation": "The associated application group as defined in AWS Application Discovery Service.
" + } + }, + "moreApplicationResource": { + "target": "com.amazonaws.migrationhubstrategy#Boolean", + "traits": { + "smithy.api#documentation": "Set to true if the application component belongs to more than one application group.\n
" + } + }, + "associatedServerIds": { + "target": "com.amazonaws.migrationhubstrategy#AssociatedServerIDs", + "traits": { + "smithy.api#documentation": "A list of the IDs of the servers on which the application component is running.
" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#GetApplicationComponentStrategies": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubstrategy#GetApplicationComponentStrategiesRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubstrategy#GetApplicationComponentStrategiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubstrategy#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of all the recommended strategies and tools for an application component\n running on a server.
", + "smithy.api#http": { + "method": "GET", + "uri": "/get-applicationcomponent-strategies/{applicationComponentId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhubstrategy#GetApplicationComponentStrategiesRequest": { + "type": "structure", + "members": { + "applicationComponentId": { + "target": "com.amazonaws.migrationhubstrategy#ApplicationComponentId", + "traits": { + "smithy.api#documentation": "The ID of the application component. The ID is unique within an AWS account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhubstrategy#GetApplicationComponentStrategiesResponse": { + "type": "structure", + "members": { + "applicationComponentStrategies": { + "target": "com.amazonaws.migrationhubstrategy#ApplicationComponentStrategies", + "traits": { + "smithy.api#documentation": "A list of application component strategy recommendations.
" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#GetAssessment": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubstrategy#GetAssessmentRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubstrategy#GetAssessmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubstrategy#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the status of an on-going assessment.
", + "smithy.api#http": { + "method": "GET", + "uri": "/get-assessment/{id}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhubstrategy#GetAssessmentRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhubstrategy#AsyncTaskId", + "traits": { + "smithy.api#documentation": " The assessmentid returned by StartAssessment.
The ID for the specific assessment task.
" + } + }, + "dataCollectionDetails": { + "target": "com.amazonaws.migrationhubstrategy#DataCollectionDetails", + "traits": { + "smithy.api#documentation": "Detailed information about the assessment.
" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#GetImportFileTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubstrategy#GetImportFileTaskRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubstrategy#GetImportFileTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubstrategy#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the details about a specific import task.
", + "smithy.api#http": { + "method": "GET", + "uri": "/get-import-file-task/{id}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhubstrategy#GetImportFileTaskRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "The ID of the import file task. This ID is returned in the response of\n StartImportFileTask.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhubstrategy#GetImportFileTaskResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": " The import file task id returned in the response of StartImportFileTask.
Status of import file task.
" + } + }, + "startTime": { + "target": "com.amazonaws.migrationhubstrategy#TimeStamp", + "traits": { + "smithy.api#documentation": "Start time of the import task.
" + } + }, + "inputS3Bucket": { + "target": "com.amazonaws.migrationhubstrategy#importS3Bucket", + "traits": { + "smithy.api#documentation": "The S3 bucket where import file is located.
" + } + }, + "inputS3Key": { + "target": "com.amazonaws.migrationhubstrategy#importS3Key", + "traits": { + "smithy.api#documentation": "The Amazon S3 key name of the import file.
" + } + }, + "statusReportS3Bucket": { + "target": "com.amazonaws.migrationhubstrategy#importS3Bucket", + "traits": { + "smithy.api#documentation": "The S3 bucket name for status report of import task.
" + } + }, + "statusReportS3Key": { + "target": "com.amazonaws.migrationhubstrategy#importS3Key", + "traits": { + "smithy.api#documentation": "The Amazon S3 key name for status report of import task. The report contains details about\n whether each record imported successfully or why it did not.
" + } + }, + "completionTime": { + "target": "com.amazonaws.migrationhubstrategy#TimeStamp", + "traits": { + "smithy.api#documentation": "The time that the import task completed.
" + } + }, + "numberOfRecordsSuccess": { + "target": "com.amazonaws.migrationhubstrategy#Integer", + "traits": { + "smithy.api#documentation": "The number of records successfully imported.
" + } + }, + "numberOfRecordsFailed": { + "target": "com.amazonaws.migrationhubstrategy#Integer", + "traits": { + "smithy.api#documentation": "The number of records that failed to be imported.
" + } + }, + "importName": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "The name of the import task given in StartImportFileTask.
" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#GetPortfolioPreferences": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubstrategy#GetPortfolioPreferencesRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubstrategy#GetPortfolioPreferencesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubstrategy#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves your migration and modernization preferences.
", + "smithy.api#http": { + "method": "GET", + "uri": "/get-portfolio-preferences", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhubstrategy#GetPortfolioPreferencesRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.migrationhubstrategy#GetPortfolioPreferencesResponse": { + "type": "structure", + "members": { + "prioritizeBusinessGoals": { + "target": "com.amazonaws.migrationhubstrategy#PrioritizeBusinessGoals", + "traits": { + "smithy.api#documentation": "The rank of business goals based on priority.
" + } + }, + "applicationPreferences": { + "target": "com.amazonaws.migrationhubstrategy#ApplicationPreferences", + "traits": { + "smithy.api#documentation": "The transformation preferences for non-database applications.
" + } + }, + "databasePreferences": { + "target": "com.amazonaws.migrationhubstrategy#DatabasePreferences", + "traits": { + "smithy.api#documentation": "The transformation preferences for database applications.
" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#GetPortfolioSummary": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubstrategy#GetPortfolioSummaryRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubstrategy#GetPortfolioSummaryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubstrategy#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves overall summary including the number of servers to rehost and the overall\n number of anti-patterns.
", + "smithy.api#http": { + "method": "GET", + "uri": "/get-portfolio-summary", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhubstrategy#GetPortfolioSummaryRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.migrationhubstrategy#GetPortfolioSummaryResponse": { + "type": "structure", + "members": { + "assessmentSummary": { + "target": "com.amazonaws.migrationhubstrategy#AssessmentSummary", + "traits": { + "smithy.api#documentation": "An assessment summary for the portfolio including the number of servers to rehost and the\n overall number of anti-patterns.
" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#GetRecommendationReportDetails": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubstrategy#GetRecommendationReportDetailsRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubstrategy#GetRecommendationReportDetailsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubstrategy#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves detailed information about the specified recommendation report.
", + "smithy.api#http": { + "method": "GET", + "uri": "/get-recommendation-report-details/{id}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhubstrategy#GetRecommendationReportDetailsRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhubstrategy#RecommendationTaskId", + "traits": { + "smithy.api#documentation": " The recommendation report generation task id returned by \n StartRecommendationReportGeneration.
The ID of the recommendation report generation task. See the response of StartRecommendationReportGeneration.
" + } + }, + "recommendationReportDetails": { + "target": "com.amazonaws.migrationhubstrategy#RecommendationReportDetails", + "traits": { + "smithy.api#documentation": "Detailed information about the recommendation report.
" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#GetServerDetails": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubstrategy#GetServerDetailsRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubstrategy#GetServerDetailsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubstrategy#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves detailed information about a specified server.
", + "smithy.api#http": { + "method": "GET", + "uri": "/get-server-details/{serverId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "associatedApplications", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhubstrategy#GetServerDetailsRequest": { + "type": "structure", + "members": { + "serverId": { + "target": "com.amazonaws.migrationhubstrategy#ServerId", + "traits": { + "smithy.api#documentation": "The ID of the server.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.migrationhubstrategy#NextToken", + "traits": { + "smithy.api#documentation": " The token from a previous call that you use to retrieve the next set of results. For example, \nif a previous call to this action returned 100 items, but you set maxResults to 10. You'll receive a set of 10 results along\n with a token. You then use the returned token to retrieve the next set of 10.
The maximum number of items to include in the response. The maximum value is 100.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#GetServerDetailsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "The token you use to retrieve the next set of results, or null if there are no more results.
" + } + }, + "serverDetail": { + "target": "com.amazonaws.migrationhubstrategy#ServerDetail", + "traits": { + "smithy.api#documentation": "Detailed information about the server.
" + } + }, + "associatedApplications": { + "target": "com.amazonaws.migrationhubstrategy#AssociatedApplications", + "traits": { + "smithy.api#documentation": "The associated application group the server belongs to, as defined in AWS Application Discovery Service.\n
" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#GetServerStrategies": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubstrategy#GetServerStrategiesRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubstrategy#GetServerStrategiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubstrategy#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves recommended strategies and tools for the specified server.
", + "smithy.api#http": { + "method": "GET", + "uri": "/get-server-strategies/{serverId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhubstrategy#GetServerStrategiesRequest": { + "type": "structure", + "members": { + "serverId": { + "target": "com.amazonaws.migrationhubstrategy#ServerId", + "traits": { + "smithy.api#documentation": "The ID of the server.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.migrationhubstrategy#GetServerStrategiesResponse": { + "type": "structure", + "members": { + "serverStrategies": { + "target": "com.amazonaws.migrationhubstrategy#ServerStrategies", + "traits": { + "smithy.api#documentation": "A list of strategy recommendations for the server.
" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#Group": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.migrationhubstrategy#GroupName", + "traits": { + "smithy.api#documentation": "\n The key of the specific import group.\n
" + } + }, + "value": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "\n The value of the specific import group.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The object containing information about distinct imports or groups for Strategy Recommendations.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#GroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#Group" + } + }, + "com.amazonaws.migrationhubstrategy#GroupName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ExternalId", + "name": "EXTERNAL_ID" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#Heterogeneous": { + "type": "structure", + "members": { + "targetDatabaseEngine": { + "target": "com.amazonaws.migrationhubstrategy#HeterogeneousTargetDatabaseEngines", + "traits": { + "smithy.api#documentation": "\n The target database engine for heterogeneous database migration preference.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n The object containing details about heterogeneous database preferences.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#HeterogeneousTargetDatabaseEngine": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "None specified", + "name": "NONE_SPECIFIED" + }, + { + "value": "Amazon Aurora", + "name": "AMAZON_AURORA" + }, + { + "value": "AWS PostgreSQL", + "name": "AWS_POSTGRESQL" + }, + { + "value": "MySQL", + "name": "MYSQL" + }, + { + "value": "Microsoft SQL Server", + "name": "MICROSOFT_SQL_SERVER" + }, + { + "value": "Oracle Database", + "name": "ORACLE_DATABASE" + }, + { + "value": "MariaDB", + "name": "MARIA_DB" + }, + { + "value": "SAP", + "name": "SAP" + }, + { + "value": "Db2 LUW", + "name": "DB2_LUW" + }, + { + "value": "MongoDB", + "name": "MONGO_DB" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#HeterogeneousTargetDatabaseEngines": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#HeterogeneousTargetDatabaseEngine" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.migrationhubstrategy#Homogeneous": { + "type": "structure", + "members": { + "targetDatabaseEngine": { + "target": "com.amazonaws.migrationhubstrategy#HomogeneousTargetDatabaseEngines", + "traits": { + "smithy.api#documentation": "\n The target database engine for homogeneous database migration preferences.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The object containing details about homogeneous database preferences.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#HomogeneousTargetDatabaseEngine": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "None specified", + "name": "NONE_SPECIFIED" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#HomogeneousTargetDatabaseEngines": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#HomogeneousTargetDatabaseEngine" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.migrationhubstrategy#IPAddress": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 15 + }, + "smithy.api#pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$" + } + }, + "com.amazonaws.migrationhubstrategy#ImportFileTaskInformation": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "The ID of the import file task.
" + } + }, + "status": { + "target": "com.amazonaws.migrationhubstrategy#ImportFileTaskStatus", + "traits": { + "smithy.api#documentation": "Status of import file task.
" + } + }, + "startTime": { + "target": "com.amazonaws.migrationhubstrategy#TimeStamp", + "traits": { + "smithy.api#documentation": "Start time of the import task.
" + } + }, + "inputS3Bucket": { + "target": "com.amazonaws.migrationhubstrategy#importS3Bucket", + "traits": { + "smithy.api#documentation": "The S3 bucket where the import file is located.
" + } + }, + "inputS3Key": { + "target": "com.amazonaws.migrationhubstrategy#importS3Key", + "traits": { + "smithy.api#documentation": "The Amazon S3 key name of the import file.
" + } + }, + "statusReportS3Bucket": { + "target": "com.amazonaws.migrationhubstrategy#importS3Bucket", + "traits": { + "smithy.api#documentation": "The S3 bucket name for status report of import task.
" + } + }, + "statusReportS3Key": { + "target": "com.amazonaws.migrationhubstrategy#importS3Key", + "traits": { + "smithy.api#documentation": "The Amazon S3 key name for status report of import task. The report contains details about\n whether each record imported successfully or why it did not.
" + } + }, + "completionTime": { + "target": "com.amazonaws.migrationhubstrategy#TimeStamp", + "traits": { + "smithy.api#documentation": "The time that the import task completes.
" + } + }, + "numberOfRecordsSuccess": { + "target": "com.amazonaws.migrationhubstrategy#Integer", + "traits": { + "smithy.api#documentation": "The number of records successfully imported.
" + } + }, + "numberOfRecordsFailed": { + "target": "com.amazonaws.migrationhubstrategy#Integer", + "traits": { + "smithy.api#documentation": "The number of records that failed to be imported.
" + } + }, + "importName": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": " The name of the import task given in StartImportFileTask.
Information about the import file tasks you request.
" + } + }, + "com.amazonaws.migrationhubstrategy#ImportFileTaskStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ImportInProgress", + "name": "IMPORT_IN_PROGRESS" + }, + { + "value": "ImportFailed", + "name": "IMPORT_FAILED" + }, + { + "value": "ImportPartialSuccess", + "name": "IMPORT_PARTIAL_SUCCESS" + }, + { + "value": "ImportSuccess", + "name": "IMPORT_SUCCESS" + }, + { + "value": "DeleteInProgress", + "name": "DELETE_IN_PROGRESS" + }, + { + "value": "DeleteFailed", + "name": "DELETE_FAILED" + }, + { + "value": "DeletePartialSuccess", + "name": "DELETE_PARTIAL_SUCCESS" + }, + { + "value": "DeleteSuccess", + "name": "DELETE_SUCCESS" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#InclusionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "excludeFromAssessment", + "name": "EXCLUDE_FROM_RECOMMENDATION" + }, + { + "value": "includeInAssessment", + "name": "INCLUDE_IN_RECOMMENDATION" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#Integer": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.migrationhubstrategy#InterfaceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.migrationhubstrategy#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.migrationhubstrategy#errorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The server experienced an internal error. Try again.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.migrationhubstrategy#ListAntipatternSeveritySummary": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#AntipatternSeveritySummary" + } + }, + "com.amazonaws.migrationhubstrategy#ListApplicationComponentSummary": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#ApplicationComponentSummary" + } + }, + "com.amazonaws.migrationhubstrategy#ListApplicationComponents": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubstrategy#ListApplicationComponentsRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubstrategy#ListApplicationComponentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubstrategy#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ServiceLinkedRoleLockClientException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of all the application components (processes).
", + "smithy.api#http": { + "method": "POST", + "uri": "/list-applicationcomponents", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "applicationComponentInfos", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.migrationhubstrategy#ListApplicationComponentsRequest": { + "type": "structure", + "members": { + "applicationComponentCriteria": { + "target": "com.amazonaws.migrationhubstrategy#ApplicationComponentCriteria", + "traits": { + "smithy.api#documentation": "Criteria for filtering the list of application components.
" + } + }, + "filterValue": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": " Specify the value based on the application component criteria type. For example, if\n applicationComponentCriteria is set to SERVER_ID and\n filterValue is set to server1, then ListApplicationComponents returns all the application components running on\n server1.
Specifies whether to sort by ascending (ASC) or descending\n (DESC) order.
The group ID specified in to filter on.
" + } + }, + "nextToken": { + "target": "com.amazonaws.migrationhubstrategy#NextToken", + "traits": { + "smithy.api#documentation": " The token from a previous call that you use to retrieve the next set of results. For example, \nif a previous call to this action returned 100 items, but you set maxResults to 10. You'll receive a set of 10 results along\n with a token. You then use the returned token to retrieve the next set of 10.
The maximum number of items to include in the response. The maximum value is 100.
" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#ListApplicationComponentsResponse": { + "type": "structure", + "members": { + "applicationComponentInfos": { + "target": "com.amazonaws.migrationhubstrategy#ApplicationComponentDetails", + "traits": { + "smithy.api#documentation": "The list of application components with detailed information about each component.\n
" + } + }, + "nextToken": { + "target": "com.amazonaws.migrationhubstrategy#NextToken", + "traits": { + "smithy.api#documentation": "The token you use to retrieve the next set of results, or null if there are no more results.
" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#ListCollectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubstrategy#ListCollectorsRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubstrategy#ListCollectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubstrategy#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of all the installed collectors.
", + "smithy.api#http": { + "method": "GET", + "uri": "/list-collectors", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "Collectors", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhubstrategy#ListCollectorsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.migrationhubstrategy#NextToken", + "traits": { + "smithy.api#documentation": " The token from a previous call that you use to retrieve the next set of results. For example, \nif a previous call to this action returned 100 items, but you set maxResults to 10. You'll receive a set of 10 results along\n with a token. You then use the returned token to retrieve the next set of 10.
The maximum number of items to include in the response. The maximum value is 100.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#ListCollectorsResponse": { + "type": "structure", + "members": { + "Collectors": { + "target": "com.amazonaws.migrationhubstrategy#Collectors", + "traits": { + "smithy.api#documentation": "The list of all the installed collectors.
" + } + }, + "nextToken": { + "target": "com.amazonaws.migrationhubstrategy#NextToken", + "traits": { + "smithy.api#documentation": "The token you use to retrieve the next set of results, or null if there are no more results.
" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#ListImportFileTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubstrategy#ListImportFileTaskRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubstrategy#ListImportFileTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubstrategy#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of all the imports performed.
", + "smithy.api#http": { + "method": "GET", + "uri": "/list-import-file-task", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "taskInfos", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhubstrategy#ListImportFileTaskInformation": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#ImportFileTaskInformation" + } + }, + "com.amazonaws.migrationhubstrategy#ListImportFileTaskRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": " The token from a previous call that you use to retrieve the next set of results. For example, \nif a previous call to this action returned 100 items, but you set maxResults to 10. You'll receive a set of 10 results along\n with a token. You then use the returned token to retrieve the next set of 10.
The total number of items to return. The maximum value is 100.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#ListImportFileTaskResponse": { + "type": "structure", + "members": { + "taskInfos": { + "target": "com.amazonaws.migrationhubstrategy#ListImportFileTaskInformation", + "traits": { + "smithy.api#documentation": "Lists information about the files you import.
" + } + }, + "nextToken": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "The token you use to retrieve the next set of results, or null if there are no more results.
" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#ListServerSummary": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#ServerSummary" + } + }, + "com.amazonaws.migrationhubstrategy#ListServers": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubstrategy#ListServersRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubstrategy#ListServersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubstrategy#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of all the servers.
", + "smithy.api#http": { + "method": "POST", + "uri": "/list-servers", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "serverInfos", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.migrationhubstrategy#ListServersRequest": { + "type": "structure", + "members": { + "serverCriteria": { + "target": "com.amazonaws.migrationhubstrategy#ServerCriteria", + "traits": { + "smithy.api#documentation": "Criteria for filtering servers.
" + } + }, + "filterValue": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": " Specifies the filter value, which is based on the type of server criteria. For example,\n if serverCriteria is OS_NAME, and the filterValue is\n equal to WindowsServer, then ListServers returns all of the servers\n matching the OS name WindowsServer.
Specifies whether to sort by ascending (ASC) or descending\n (DESC) order.
Specifies the group ID to filter on.
" + } + }, + "nextToken": { + "target": "com.amazonaws.migrationhubstrategy#NextToken", + "traits": { + "smithy.api#documentation": " The token from a previous call that you use to retrieve the next set of results. For example, \nif a previous call to this action returned 100 items, but you set maxResults to 10. You'll receive a set of 10 results along\n with a token. You then use the returned token to retrieve the next set of 10.
The maximum number of items to include in the response. The maximum value is 100.
" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#ListServersResponse": { + "type": "structure", + "members": { + "serverInfos": { + "target": "com.amazonaws.migrationhubstrategy#ServerDetails", + "traits": { + "smithy.api#documentation": "The list of servers with detailed information about each server.
" + } + }, + "nextToken": { + "target": "com.amazonaws.migrationhubstrategy#NextToken", + "traits": { + "smithy.api#documentation": "The token you use to retrieve the next set of results, or null if there are no more results.
" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#ListStrategySummary": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#StrategySummary" + } + }, + "com.amazonaws.migrationhubstrategy#Location": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": ".*\\S.*" + } + }, + "com.amazonaws.migrationhubstrategy#MacAddress": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 17 + }, + "smithy.api#pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})|([0-9a-fA-F]{4}\\\\.[0-9a-fA-F]{4}\\\\.[0-9a-fA-F]{4})$”$" + } + }, + "com.amazonaws.migrationhubstrategy#ManagementPreference": { + "type": "union", + "members": { + "awsManagedResources": { + "target": "com.amazonaws.migrationhubstrategy#AwsManagedResources", + "traits": { + "smithy.api#documentation": "\n Indicates interest in solutions that are managed by AWS.\n
" + } + }, + "selfManageResources": { + "target": "com.amazonaws.migrationhubstrategy#SelfManageResources", + "traits": { + "smithy.api#documentation": "\n Indicates interest in managing your own resources on AWS.\n
" + } + }, + "noPreference": { + "target": "com.amazonaws.migrationhubstrategy#NoManagementPreference", + "traits": { + "smithy.api#documentation": "\n No specific preference.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Preferences for migrating an application to AWS.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#MaxResult": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.migrationhubstrategy#NetMask": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.migrationhubstrategy#NetworkInfo": { + "type": "structure", + "members": { + "interfaceName": { + "target": "com.amazonaws.migrationhubstrategy#InterfaceName", + "traits": { + "smithy.api#documentation": "\n Information about the name of the interface of the server for which the assessment was run.\n
", + "smithy.api#required": {} + } + }, + "ipAddress": { + "target": "com.amazonaws.migrationhubstrategy#IPAddress", + "traits": { + "smithy.api#documentation": "\n Information about the IP address of the server for which the assessment was run.\n
", + "smithy.api#required": {} + } + }, + "macAddress": { + "target": "com.amazonaws.migrationhubstrategy#MacAddress", + "traits": { + "smithy.api#documentation": "\n Information about the MAC address of the server for which the assessment was run.\n
", + "smithy.api#required": {} + } + }, + "netMask": { + "target": "com.amazonaws.migrationhubstrategy#NetMask", + "traits": { + "smithy.api#documentation": "\n Information about the subnet mask of the server for which the assessment was run.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n Information about the server's network for which the assessment was run.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#NetworkInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#NetworkInfo" + } + }, + "com.amazonaws.migrationhubstrategy#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": ".*\\S.*" + } + }, + "com.amazonaws.migrationhubstrategy#NoDatabaseMigrationPreference": { + "type": "structure", + "members": { + "targetDatabaseEngine": { + "target": "com.amazonaws.migrationhubstrategy#TargetDatabaseEngines", + "traits": { + "smithy.api#documentation": "\n The target database engine for database migration preference that you specify.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The object containing details about database migration preferences, when you have no\n particular preference.
" + } + }, + "com.amazonaws.migrationhubstrategy#NoManagementPreference": { + "type": "structure", + "members": { + "targetDestination": { + "target": "com.amazonaws.migrationhubstrategy#NoPreferenceTargetDestinations", + "traits": { + "smithy.api#documentation": "\n The choice of application destination that you specify.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n Object containing the choice of application destination that you specify.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#NoPreferenceTargetDestination": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "None specified", + "name": "NONE_SPECIFIED" + }, + { + "value": "AWS Elastic BeanStalk", + "name": "AWS_ELASTIC_BEANSTALK" + }, + { + "value": "AWS Fargate", + "name": "AWS_FARGATE" + }, + { + "value": "Amazon Elastic Cloud Compute (EC2)", + "name": "AMAZON_ELASTIC_CLOUD_COMPUTE" + }, + { + "value": "Amazon Elastic Container Service (ECS)", + "name": "AMAZON_ELASTIC_CONTAINER_SERVICE" + }, + { + "value": "Amazon Elastic Kubernetes Service (EKS)", + "name": "AMAZON_ELASTIC_KUBERNETES_SERVICE" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#NoPreferenceTargetDestinations": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#NoPreferenceTargetDestination" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.migrationhubstrategy#OSInfo": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.migrationhubstrategy#OSType", + "traits": { + "smithy.api#documentation": "\n Information about the type of operating system.\n
" + } + }, + "version": { + "target": "com.amazonaws.migrationhubstrategy#OSVersion", + "traits": { + "smithy.api#documentation": "\n Information about the version of operating system.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Information about the operating system.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#OSType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LINUX", + "name": "LINUX" + }, + { + "value": "WINDOWS", + "name": "WINDOWS" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#OSVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": ".*\\S.*" + } + }, + "com.amazonaws.migrationhubstrategy#OutputFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Excel", + "name": "Excel" + }, + { + "value": "Json", + "name": "Json" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#PrioritizeBusinessGoals": { + "type": "structure", + "members": { + "businessGoals": { + "target": "com.amazonaws.migrationhubstrategy#BusinessGoals", + "traits": { + "smithy.api#documentation": "\n Rank of business goals based on priority.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Rank of business goals based on priority.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#PutPortfolioPreferences": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubstrategy#PutPortfolioPreferencesRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubstrategy#PutPortfolioPreferencesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubstrategy#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ConflictException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Saves the specified migration and modernization preferences.
", + "smithy.api#http": { + "method": "POST", + "uri": "/put-portfolio-preferences", + "code": 200 + } + } + }, + "com.amazonaws.migrationhubstrategy#PutPortfolioPreferencesRequest": { + "type": "structure", + "members": { + "prioritizeBusinessGoals": { + "target": "com.amazonaws.migrationhubstrategy#PrioritizeBusinessGoals", + "traits": { + "smithy.api#documentation": "The rank of the business goals based on priority.
" + } + }, + "applicationPreferences": { + "target": "com.amazonaws.migrationhubstrategy#ApplicationPreferences", + "traits": { + "smithy.api#documentation": "The transformation preferences for non-database applications.
" + } + }, + "databasePreferences": { + "target": "com.amazonaws.migrationhubstrategy#DatabasePreferences", + "traits": { + "smithy.api#documentation": "The transformation preferences for database applications.
" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#PutPortfolioPreferencesResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.migrationhubstrategy#RecommendationReportDetails": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.migrationhubstrategy#RecommendationReportStatus", + "traits": { + "smithy.api#documentation": "\n The status of the recommendation report generation task.\n
" + } + }, + "statusMessage": { + "target": "com.amazonaws.migrationhubstrategy#RecommendationReportStatusMessage", + "traits": { + "smithy.api#documentation": "\n The status message for recommendation report generation.\n
" + } + }, + "startTime": { + "target": "com.amazonaws.migrationhubstrategy#RecommendationReportTimeStamp", + "traits": { + "smithy.api#documentation": "\n The time that the recommendation report generation task starts.\n
" + } + }, + "completionTime": { + "target": "com.amazonaws.migrationhubstrategy#RecommendationReportTimeStamp", + "traits": { + "smithy.api#documentation": "\n The time that the recommendation report generation task completes.\n
" + } + }, + "s3Bucket": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "\n The S3 bucket where the report file is located.\n
" + } + }, + "s3Keys": { + "target": "com.amazonaws.migrationhubstrategy#S3Keys", + "traits": { + "smithy.api#documentation": "\n The Amazon S3 key name of the report file.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Contains detailed information about a recommendation report.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#RecommendationReportStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "SUCCESS", + "name": "SUCCESS" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#RecommendationReportStatusMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": ".*\\S.*" + } + }, + "com.amazonaws.migrationhubstrategy#RecommendationReportTimeStamp": { + "type": "timestamp" + }, + "com.amazonaws.migrationhubstrategy#RecommendationSet": { + "type": "structure", + "members": { + "transformationTool": { + "target": "com.amazonaws.migrationhubstrategy#TransformationTool", + "traits": { + "smithy.api#documentation": "\n The target destination for the recommendation set.\n
" + } + }, + "targetDestination": { + "target": "com.amazonaws.migrationhubstrategy#TargetDestination", + "traits": { + "smithy.api#documentation": "\n The recommended target destination.\n
" + } + }, + "strategy": { + "target": "com.amazonaws.migrationhubstrategy#Strategy", + "traits": { + "smithy.api#documentation": "\n The recommended strategy.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Contains a recommendation set.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#RecommendationTaskId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 52 + }, + "smithy.api#pattern": "[0-9a-z-:]+" + } + }, + "com.amazonaws.migrationhubstrategy#ResourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 44 + }, + "smithy.api#pattern": "^[0-9a-b]+" + } + }, + "com.amazonaws.migrationhubstrategy#ResourceName": { + "type": "string" + }, + "com.amazonaws.migrationhubstrategy#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.migrationhubstrategy#errorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The specified ID in the request is not found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.migrationhubstrategy#ResourceSubType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Database", + "name": "DATABASE" + }, + { + "value": "Process", + "name": "PROCESS" + }, + { + "value": "DatabaseProcess", + "name": "DATABASE_PROCESS" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#RunTimeAssessmentStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "dataCollectionTaskToBeScheduled", + "name": "DC_TO_BE_SCHEDULED" + }, + { + "value": "dataCollectionTaskScheduled", + "name": "DC_REQ_SENT" + }, + { + "value": "dataCollectionTaskStarted", + "name": "DC_STARTED" + }, + { + "value": "dataCollectionTaskStopped", + "name": "DC_STOPPED" + }, + { + "value": "dataCollectionTaskSuccess", + "name": "DC_SUCCESS" + }, + { + "value": "dataCollectionTaskFailed", + "name": "DC_FAILED" + }, + { + "value": "dataCollectionTaskPartialSuccess", + "name": "DC_PARTIAL_SUCCESS" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#S3Bucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "[0-9a-z]+[0-9a-z\\.\\-]*[0-9a-z]+" + } + }, + "com.amazonaws.migrationhubstrategy#S3Key": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": ".*\\S.*" + } + }, + "com.amazonaws.migrationhubstrategy#S3Keys": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#String" + } + }, + "com.amazonaws.migrationhubstrategy#S3Object": { + "type": "structure", + "members": { + "s3Bucket": { + "target": "com.amazonaws.migrationhubstrategy#S3Bucket", + "traits": { + "smithy.api#documentation": "The S3 bucket name.
" + } + }, + "s3key": { + "target": "com.amazonaws.migrationhubstrategy#S3Key", + "traits": { + "smithy.api#documentation": "The Amazon S3 key name.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the S3 bucket name and the Amazon S3 key name.
" + } + }, + "com.amazonaws.migrationhubstrategy#SecretsManagerKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": ".*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.migrationhubstrategy#SelfManageResources": { + "type": "structure", + "members": { + "targetDestination": { + "target": "com.amazonaws.migrationhubstrategy#SelfManageTargetDestinations", + "traits": { + "smithy.api#documentation": "Self-managed resources target destination.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Self-managed resources.
" + } + }, + "com.amazonaws.migrationhubstrategy#SelfManageTargetDestination": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "None specified", + "name": "NONE_SPECIFIED" + }, + { + "value": "Amazon Elastic Cloud Compute (EC2)", + "name": "AMAZON_ELASTIC_CLOUD_COMPUTE" + }, + { + "value": "Amazon Elastic Container Service (ECS)", + "name": "AMAZON_ELASTIC_CONTAINER_SERVICE" + }, + { + "value": "Amazon Elastic Kubernetes Service (EKS)", + "name": "AMAZON_ELASTIC_KUBERNETES_SERVICE" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#SelfManageTargetDestinations": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#SelfManageTargetDestination" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.migrationhubstrategy#ServerCriteria": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NOT_DEFINED", + "name": "NOT_DEFINED" + }, + { + "value": "OS_NAME", + "name": "OS_NAME" + }, + { + "value": "STRATEGY", + "name": "STRATEGY" + }, + { + "value": "DESTINATION", + "name": "DESTINATION" + }, + { + "value": "SERVER_ID", + "name": "SERVER_ID" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#ServerDetail": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhubstrategy#ResourceId", + "traits": { + "smithy.api#documentation": "The server ID.
" + } + }, + "name": { + "target": "com.amazonaws.migrationhubstrategy#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the server.
" + } + }, + "recommendationSet": { + "target": "com.amazonaws.migrationhubstrategy#RecommendationSet", + "traits": { + "smithy.api#documentation": "A set of recommendations.
" + } + }, + "dataCollectionStatus": { + "target": "com.amazonaws.migrationhubstrategy#RunTimeAssessmentStatus", + "traits": { + "smithy.api#documentation": "The status of assessment for the server.
" + } + }, + "statusMessage": { + "target": "com.amazonaws.migrationhubstrategy#StatusMessage", + "traits": { + "smithy.api#documentation": "A message about the status of data collection, which contains detailed descriptions of\n any error messages.
" + } + }, + "listAntipatternSeveritySummary": { + "target": "com.amazonaws.migrationhubstrategy#ListAntipatternSeveritySummary", + "traits": { + "smithy.api#documentation": "A list of anti-pattern severity summaries.
" + } + }, + "systemInfo": { + "target": "com.amazonaws.migrationhubstrategy#SystemInfo", + "traits": { + "smithy.api#documentation": "System information about the server.
" + } + }, + "applicationComponentStrategySummary": { + "target": "com.amazonaws.migrationhubstrategy#ListStrategySummary", + "traits": { + "smithy.api#documentation": "A list of strategy summaries.
" + } + }, + "antipatternReportS3Object": { + "target": "com.amazonaws.migrationhubstrategy#S3Object", + "traits": { + "smithy.api#documentation": "The S3 bucket name and Amazon S3 key name for anti-pattern report.
" + } + }, + "antipatternReportStatus": { + "target": "com.amazonaws.migrationhubstrategy#AntipatternReportStatus", + "traits": { + "smithy.api#documentation": "The status of the anti-pattern report generation.
" + } + }, + "antipatternReportStatusMessage": { + "target": "com.amazonaws.migrationhubstrategy#StatusMessage", + "traits": { + "smithy.api#documentation": "A message about the status of the anti-pattern report generation.
" + } + }, + "serverType": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "The type of server.
" + } + }, + "lastAnalyzedTimestamp": { + "target": "com.amazonaws.migrationhubstrategy#TimeStamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the server was assessed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Detailed information about a server.
" + } + }, + "com.amazonaws.migrationhubstrategy#ServerDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#ServerDetail" + } + }, + "com.amazonaws.migrationhubstrategy#ServerId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 27 + }, + "smithy.api#pattern": ".*\\S.*" + } + }, + "com.amazonaws.migrationhubstrategy#ServerOsType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "WindowsServer", + "name": "windowsServer" + }, + { + "value": "AmazonLinux", + "name": "amazonLinux" + }, + { + "value": "EndOfSupportWindowsServer", + "name": "endOfSupportWindowsServer" + }, + { + "value": "Redhat", + "name": "redhat" + }, + { + "value": "Other", + "name": "other" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#ServerStrategies": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#ServerStrategy" + } + }, + "com.amazonaws.migrationhubstrategy#ServerStrategy": { + "type": "structure", + "members": { + "recommendation": { + "target": "com.amazonaws.migrationhubstrategy#RecommendationSet", + "traits": { + "smithy.api#documentation": "Strategy recommendation for the server.
" + } + }, + "status": { + "target": "com.amazonaws.migrationhubstrategy#StrategyRecommendation", + "traits": { + "smithy.api#documentation": "The recommendation status of the strategy for the server.
" + } + }, + "numberOfApplicationComponents": { + "target": "com.amazonaws.migrationhubstrategy#Integer", + "traits": { + "smithy.api#documentation": "The number of application components with this strategy recommendation running on the\n server.
" + } + }, + "isPreferred": { + "target": "com.amazonaws.migrationhubstrategy#Boolean", + "traits": { + "smithy.api#documentation": "Set to true if the recommendation is set as preferred.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a strategy recommendation for a server.
" + } + }, + "com.amazonaws.migrationhubstrategy#ServerSummary": { + "type": "structure", + "members": { + "ServerOsType": { + "target": "com.amazonaws.migrationhubstrategy#ServerOsType", + "traits": { + "smithy.api#documentation": "\n Type of operating system for the servers.\n
" + } + }, + "count": { + "target": "com.amazonaws.migrationhubstrategy#Integer", + "traits": { + "smithy.api#documentation": "\n Number of servers.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Object containing details about the servers imported by Application Discovery Service\n
" + } + }, + "com.amazonaws.migrationhubstrategy#ServiceLinkedRoleLockClientException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.migrationhubstrategy#errorMessage" + } + }, + "traits": { + "smithy.api#documentation": "\n Exception to indicate that the service-linked role (SLR) is locked.\n
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.migrationhubstrategy#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The AWS account has reached its quota of imports. Contact AWS Support to increase the\n quota for this account.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.migrationhubstrategy#Severity": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "MEDIUM", + "name": "MEDIUM" + }, + { + "value": "LOW", + "name": "LOW" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#SortOrder": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ASC", + "name": "ASC" + }, + { + "value": "DESC", + "name": "DESC" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#SourceCode": { + "type": "structure", + "members": { + "versionControl": { + "target": "com.amazonaws.migrationhubstrategy#VersionControl", + "traits": { + "smithy.api#documentation": "\n The type of repository to use for the source code.\n
" + } + }, + "sourceVersion": { + "target": "com.amazonaws.migrationhubstrategy#SourceVersion", + "traits": { + "smithy.api#documentation": "\n The branch of the source code.\n
" + } + }, + "location": { + "target": "com.amazonaws.migrationhubstrategy#Location", + "traits": { + "smithy.api#documentation": "\n The repository name for the source code.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Object containing source code information that is linked to an application component.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#SourceCodeList": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#SourceCode" + } + }, + "com.amazonaws.migrationhubstrategy#SourceCodeRepositories": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#SourceCodeRepository" + } + }, + "com.amazonaws.migrationhubstrategy#SourceCodeRepository": { + "type": "structure", + "members": { + "repository": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "\n The repository name for the source code.\n
" + } + }, + "branch": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "\n The branch of the source code.\n
" + } + }, + "versionControlType": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "\n The type of repository to use for the source code.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Object containing source code information that is linked to an application component.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#SourceVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 40 + }, + "smithy.api#pattern": ".*\\S.*" + } + }, + "com.amazonaws.migrationhubstrategy#SrcCodeOrDbAnalysisStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ANALYSIS_TO_BE_SCHEDULED", + "name": "ANALYSIS_TO_BE_SCHEDULED" + }, + { + "value": "ANALYSIS_STARTED", + "name": "ANALYSIS_STARTED" + }, + { + "value": "ANALYSIS_SUCCESS", + "name": "ANALYSIS_SUCCESS" + }, + { + "value": "ANALYSIS_FAILED", + "name": "ANALYSIS_FAILED" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#StartAssessment": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubstrategy#StartAssessmentRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubstrategy#StartAssessmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubstrategy#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Starts the assessment of an on-premises environment.
", + "smithy.api#http": { + "method": "POST", + "uri": "/start-assessment", + "code": 200 + } + } + }, + "com.amazonaws.migrationhubstrategy#StartAssessmentRequest": { + "type": "structure", + "members": { + "s3bucketForAnalysisData": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "\n The S3 bucket used by the collectors to send analysis data to the service.\n The bucket name must begin with migrationhub-strategy-.\n
\n The S3 bucket where all the reports generated by the service are stored.\n The bucket name must begin with migrationhub-strategy-.\n
\n The ID of the assessment.\n
" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#StartImportFileTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubstrategy#StartImportFileTaskRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubstrategy#StartImportFileTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubstrategy#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Starts a file import.
", + "smithy.api#http": { + "method": "POST", + "uri": "/start-import-file-task", + "code": 200 + } + } + }, + "com.amazonaws.migrationhubstrategy#StartImportFileTaskRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "A descriptive name for the request.
", + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "[a-zA-Z0-9_-]+", + "smithy.api#required": {} + } + }, + "S3Bucket": { + "target": "com.amazonaws.migrationhubstrategy#importS3Bucket", + "traits": { + "smithy.api#documentation": " The S3 bucket where the import file is located. The bucket name is required to begin with\n migrationhub-strategy-.
The Amazon S3 key name of the import file.
", + "smithy.api#required": {} + } + }, + "dataSourceType": { + "target": "com.amazonaws.migrationhubstrategy#DataSourceType", + "traits": { + "smithy.api#documentation": "Specifies the source that the servers are coming from. By default, Strategy Recommendations assumes that\n the servers specified in the import file are available in AWS Application Discovery Service.
" + } + }, + "groupId": { + "target": "com.amazonaws.migrationhubstrategy#GroupIds", + "traits": { + "smithy.api#documentation": "Groups the resources in the import file together with a unique name. This ID can be as\n filter in ListApplicationComponents and ListServers.
The S3 bucket where Strategy Recommendations uploads import results. The bucket name is required to\n begin with migrationhub-strategy-.
", + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "[0-9a-z]+[0-9a-z\\.\\-]*[0-9a-z]+" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#StartImportFileTaskResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "The ID for a specific import task. The ID is unique within an AWS account.
" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#StartRecommendationReportGeneration": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubstrategy#StartRecommendationReportGenerationRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubstrategy#StartRecommendationReportGenerationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubstrategy#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ConflictException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Starts generating a recommendation report.
", + "smithy.api#http": { + "method": "POST", + "uri": "/start-recommendation-report-generation", + "code": 200 + } + } + }, + "com.amazonaws.migrationhubstrategy#StartRecommendationReportGenerationRequest": { + "type": "structure", + "members": { + "outputFormat": { + "target": "com.amazonaws.migrationhubstrategy#OutputFormat", + "traits": { + "smithy.api#documentation": "The output format for the recommendation report file. The default format is Microsoft Excel.
" + } + }, + "groupIdFilter": { + "target": "com.amazonaws.migrationhubstrategy#GroupIds", + "traits": { + "smithy.api#documentation": "Groups the resources in the recommendation report with a unique name.
" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#StartRecommendationReportGenerationResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhubstrategy#RecommendationTaskId", + "traits": { + "smithy.api#documentation": "The ID of the recommendation report generation task.
" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#StatusMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": ".*\\S.*" + } + }, + "com.amazonaws.migrationhubstrategy#StopAssessment": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubstrategy#StopAssessmentRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubstrategy#StopAssessmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubstrategy#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Stops the assessment of an on-premises environment.
", + "smithy.api#http": { + "method": "POST", + "uri": "/stop-assessment", + "code": 200 + } + } + }, + "com.amazonaws.migrationhubstrategy#StopAssessmentRequest": { + "type": "structure", + "members": { + "assessmentId": { + "target": "com.amazonaws.migrationhubstrategy#AsyncTaskId", + "traits": { + "smithy.api#documentation": " The assessmentId returned by StartAssessment.
\n Type of transformation. For example, Rehost, Replatform, and so on.\n
" + } + }, + "toolName": { + "target": "com.amazonaws.migrationhubstrategy#TransformationToolName", + "traits": { + "smithy.api#documentation": "\n The name of the tool that can be used to transform an application component using this strategy.\n
" + } + }, + "targetDestination": { + "target": "com.amazonaws.migrationhubstrategy#TargetDestination", + "traits": { + "smithy.api#documentation": "\n Destination information about where the application component can migrate to. For example, EC2, ECS, and so on.\n
\n Indicates if a specific strategy is preferred for the application component.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Information about all the available strategy options for migrating and modernizing an application component.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#StrategyRecommendation": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "recommended", + "name": "RECOMMENDED" + }, + { + "value": "viableOption", + "name": "VIABLE_OPTION" + }, + { + "value": "notRecommended", + "name": "NOT_RECOMMENDED" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#StrategySummary": { + "type": "structure", + "members": { + "strategy": { + "target": "com.amazonaws.migrationhubstrategy#Strategy", + "traits": { + "smithy.api#documentation": "\n The name of recommended strategy.\n
" + } + }, + "count": { + "target": "com.amazonaws.migrationhubstrategy#Integer", + "traits": { + "smithy.api#documentation": "\n The count of recommendations per strategy.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Object containing the summary of the strategy recommendations.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#String": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": ".*\\S.*" + } + }, + "com.amazonaws.migrationhubstrategy#SystemInfo": { + "type": "structure", + "members": { + "osInfo": { + "target": "com.amazonaws.migrationhubstrategy#OSInfo", + "traits": { + "smithy.api#documentation": "\n Operating system corresponding to a server.\n
" + } + }, + "fileSystemType": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "\n File system type for the server.\n
" + } + }, + "networkInfoList": { + "target": "com.amazonaws.migrationhubstrategy#NetworkInfoList", + "traits": { + "smithy.api#documentation": "\n Networking information related to a server.\n
" + } + }, + "cpuArchitecture": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "\n CPU architecture type for the server.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Information about the server that hosts application components.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#TargetDatabaseEngine": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "None specified", + "name": "NONE_SPECIFIED" + }, + { + "value": "Amazon Aurora", + "name": "AMAZON_AURORA" + }, + { + "value": "AWS PostgreSQL", + "name": "AWS_POSTGRESQL" + }, + { + "value": "MySQL", + "name": "MYSQL" + }, + { + "value": "Microsoft SQL Server", + "name": "MICROSOFT_SQL_SERVER" + }, + { + "value": "Oracle Database", + "name": "ORACLE_DATABASE" + }, + { + "value": "MariaDB", + "name": "MARIA_DB" + }, + { + "value": "SAP", + "name": "SAP" + }, + { + "value": "Db2 LUW", + "name": "DB2_LUW" + }, + { + "value": "MongoDB", + "name": "MONGO_DB" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#TargetDatabaseEngines": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#TargetDatabaseEngine" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.migrationhubstrategy#TargetDestination": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "None specified", + "name": "NONE_SPECIFIED" + }, + { + "value": "AWS Elastic BeanStalk", + "name": "AWS_ELASTIC_BEANSTALK" + }, + { + "value": "AWS Fargate", + "name": "AWS_FARGATE" + }, + { + "value": "Amazon Elastic Cloud Compute (EC2)", + "name": "AMAZON_ELASTIC_CLOUD_COMPUTE" + }, + { + "value": "Amazon Elastic Container Service (ECS)", + "name": "AMAZON_ELASTIC_CONTAINER_SERVICE" + }, + { + "value": "Amazon Elastic Kubernetes Service (EKS)", + "name": "AMAZON_ELASTIC_KUBERNETES_SERVICE" + }, + { + "value": "Aurora MySQL", + "name": "AURORA_MYSQL" + }, + { + "value": "Aurora PostgreSQL", + "name": "AURORA_POSTGRESQL" + }, + { + "value": "Amazon Relational Database Service on MySQL", + "name": "AMAZON_RDS_MYSQL" + }, + { + "value": "Amazon Relational Database Service on PostgreSQL", + "name": "AMAZON_RDS_POSTGRESQL" + }, + { + "value": "Amazon DocumentDB", + "name": "AMAZON_DOCUMENTDB" + }, + { + "value": "Amazon DynamoDB", + "name": "AMAZON_DYNAMODB" + }, + { + "value": "Amazon Relational Database Service", + "name": "AMAZON_RDS" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.migrationhubstrategy#errorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.migrationhubstrategy#TimeStamp": { + "type": "timestamp" + }, + "com.amazonaws.migrationhubstrategy#TranformationToolDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": ".*\\S.*" + } + }, + "com.amazonaws.migrationhubstrategy#TranformationToolInstallationLink": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": ".*\\S.*" + } + }, + "com.amazonaws.migrationhubstrategy#TransformationTool": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.migrationhubstrategy#TransformationToolName", + "traits": { + "smithy.api#documentation": "\n Name of the tool. \n
" + } + }, + "description": { + "target": "com.amazonaws.migrationhubstrategy#TranformationToolDescription", + "traits": { + "smithy.api#documentation": "\n Description of the tool.\n
" + } + }, + "tranformationToolInstallationLink": { + "target": "com.amazonaws.migrationhubstrategy#TranformationToolInstallationLink", + "traits": { + "smithy.api#documentation": "\n URL for installing the tool.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Information of the transformation tool that can be used to migrate and modernize the application.\n
" + } + }, + "com.amazonaws.migrationhubstrategy#TransformationToolName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "App2Container", + "name": "APP2CONTAINER" + }, + { + "value": "Porting Assistant For .NET", + "name": "PORTING_ASSISTANT" + }, + { + "value": "End of Support Migration", + "name": "EMP" + }, + { + "value": "Windows Web Application Migration Assistant", + "name": "WWAMA" + }, + { + "value": "Application Migration Service", + "name": "MGN" + }, + { + "value": "Strategy Recommendation Support", + "name": "STRATEGY_RECOMMENDATION_SUPPORT" + }, + { + "value": "In Place Operating System Upgrade", + "name": "IN_PLACE_OS_UPGRADE" + }, + { + "value": "Schema Conversion Tool", + "name": "SCT" + }, + { + "value": "Database Migration Service", + "name": "DMS" + }, + { + "value": "Native SQL Server Backup/Restore", + "name": "NATIVE_SQL" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#UpdateApplicationComponentConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubstrategy#UpdateApplicationComponentConfigRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubstrategy#UpdateApplicationComponentConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubstrategy#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the configuration of an application component.
", + "smithy.api#http": { + "method": "POST", + "uri": "/update-applicationcomponent-config/", + "code": 200 + } + } + }, + "com.amazonaws.migrationhubstrategy#UpdateApplicationComponentConfigRequest": { + "type": "structure", + "members": { + "applicationComponentId": { + "target": "com.amazonaws.migrationhubstrategy#ApplicationComponentId", + "traits": { + "smithy.api#documentation": "The ID of the application component. The ID is unique within an AWS account.
", + "smithy.api#required": {} + } + }, + "inclusionStatus": { + "target": "com.amazonaws.migrationhubstrategy#InclusionStatus", + "traits": { + "smithy.api#documentation": "Indicates whether the application component has been included for server recommendation\n or not.
" + } + }, + "strategyOption": { + "target": "com.amazonaws.migrationhubstrategy#StrategyOption", + "traits": { + "smithy.api#documentation": "The preferred strategy options for the application component. Use values from the GetApplicationComponentStrategies response.
" + } + }, + "sourceCodeList": { + "target": "com.amazonaws.migrationhubstrategy#SourceCodeList", + "traits": { + "smithy.api#documentation": "The list of source code configurations to update for the application component.
" + } + }, + "secretsManagerKey": { + "target": "com.amazonaws.migrationhubstrategy#SecretsManagerKey", + "traits": { + "smithy.api#documentation": "Database credentials.
" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#UpdateApplicationComponentConfigResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.migrationhubstrategy#UpdateServerConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubstrategy#UpdateServerConfigRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubstrategy#UpdateServerConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubstrategy#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ThrottlingException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the configuration of the specified server.
", + "smithy.api#http": { + "method": "POST", + "uri": "/update-server-config/", + "code": 200 + } + } + }, + "com.amazonaws.migrationhubstrategy#UpdateServerConfigRequest": { + "type": "structure", + "members": { + "serverId": { + "target": "com.amazonaws.migrationhubstrategy#ServerId", + "traits": { + "smithy.api#documentation": "The ID of the server.
", + "smithy.api#required": {} + } + }, + "strategyOption": { + "target": "com.amazonaws.migrationhubstrategy#StrategyOption", + "traits": { + "smithy.api#documentation": "The preferred strategy options for the application component. See the response from GetServerStrategies.
" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#UpdateServerConfigResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.migrationhubstrategy#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.migrationhubstrategy#errorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The request body isn't valid.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.migrationhubstrategy#VersionControl": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "GITHUB", + "name": "GITHUB" + }, + { + "value": "GITHUB_ENTERPRISE", + "name": "GITHUB_ENTERPRISE" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#errorMessage": { + "type": "string" + }, + "com.amazonaws.migrationhubstrategy#importS3Bucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "[0-9a-z]+[0-9a-z\\.\\-]*[0-9a-z]+" + } + }, + "com.amazonaws.migrationhubstrategy#importS3Key": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": ".*\\S.*" + } + } + } +} diff --git a/aws/sdk/aws-models/models.lex.v2.json b/aws/sdk/aws-models/models.lex.v2.json index 14d15cb43f965fe9c3f17f3d0f139d9477b67581..b4dd730e102750e39c2d731d08a38a0ed6025ed7 100644 --- a/aws/sdk/aws-models/models.lex.v2.json +++ b/aws/sdk/aws-models/models.lex.v2.json @@ -192,6 +192,75 @@ } } }, + "com.amazonaws.lexmodelsv2#AssociatedTranscript": { + "type": "structure", + "members": { + "transcript": { + "target": "com.amazonaws.lexmodelsv2#Transcript", + "traits": { + "smithy.api#documentation": "The content of the transcript that meets the search filter criteria.\n For the JSON format of the transcript, see Output transcript\n format.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The object containing information that associates the recommended\n intent/slot type with a conversation.
" + } + }, + "com.amazonaws.lexmodelsv2#AssociatedTranscriptFilter": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lexmodelsv2#AssociatedTranscriptFilterName", + "traits": { + "smithy.api#documentation": "The name of the field to use for filtering. The allowed names are\n IntentId and SlotTypeId.
", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.lexmodelsv2#FilterValues", + "traits": { + "smithy.api#documentation": "The values to use to filter the transcript.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Filters to search for the associated transcript.
" + } + }, + "com.amazonaws.lexmodelsv2#AssociatedTranscriptFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "IntentId", + "name": "IntentId" + }, + { + "value": "SlotTypeId", + "name": "SlotTypeId" + } + ] + } + }, + "com.amazonaws.lexmodelsv2#AssociatedTranscriptFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#AssociatedTranscriptFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.lexmodelsv2#AssociatedTranscriptList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#AssociatedTranscript" + } + }, "com.amazonaws.lexmodelsv2#AttachmentTitle": { "type": "string", "traits": { @@ -785,6 +854,10 @@ { "value": "Importing", "name": "Importing" + }, + { + "value": "Processing", + "name": "Processing" } ] } @@ -839,6 +912,127 @@ "target": "com.amazonaws.lexmodelsv2#BotLocaleSummary" } }, + "com.amazonaws.lexmodelsv2#BotRecommendationResultStatistics": { + "type": "structure", + "members": { + "intents": { + "target": "com.amazonaws.lexmodelsv2#IntentStatistics", + "traits": { + "smithy.api#documentation": "Statistical information about about the intents associated with the\n bot recommendation results.
" + } + }, + "slotTypes": { + "target": "com.amazonaws.lexmodelsv2#SlotTypeStatistics", + "traits": { + "smithy.api#documentation": "Statistical information about the slot types associated with the bot\n recommendation results.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A statistical summary of the bot recommendation results.
" + } + }, + "com.amazonaws.lexmodelsv2#BotRecommendationResults": { + "type": "structure", + "members": { + "botLocaleExportUrl": { + "target": "com.amazonaws.lexmodelsv2#PresignedS3Url", + "traits": { + "smithy.api#documentation": "The presigned URL link of the recommended bot definition.
" + } + }, + "associatedTranscriptsUrl": { + "target": "com.amazonaws.lexmodelsv2#PresignedS3Url", + "traits": { + "smithy.api#documentation": "The presigned url link of the associated transcript.
" + } + }, + "statistics": { + "target": "com.amazonaws.lexmodelsv2#BotRecommendationResultStatistics", + "traits": { + "smithy.api#documentation": "The statistical summary of the bot recommendation results.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The object representing the URL of the bot definition, the URL of\n the associated transcript and a statistical summary of the bot\n recommendation results.
" + } + }, + "com.amazonaws.lexmodelsv2#BotRecommendationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Processing", + "name": "Processing" + }, + { + "value": "Deleting", + "name": "Deleting" + }, + { + "value": "Deleted", + "name": "Deleted" + }, + { + "value": "Downloading", + "name": "Downloading" + }, + { + "value": "Updating", + "name": "Updating" + }, + { + "value": "Available", + "name": "Available" + }, + { + "value": "Failed", + "name": "Failed" + } + ] + } + }, + "com.amazonaws.lexmodelsv2#BotRecommendationSummary": { + "type": "structure", + "members": { + "botRecommendationStatus": { + "target": "com.amazonaws.lexmodelsv2#BotRecommendationStatus", + "traits": { + "smithy.api#documentation": "The status of the bot recommendation.
\nIf the status is Failed, then the reasons for the failure are listed\n in the failureReasons field.
", + "smithy.api#required": {} + } + }, + "botRecommendationId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot recommendation to be\n updated.
", + "smithy.api#required": {} + } + }, + "creationDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp of the date and time that the bot recommendation was\n created.
" + } + }, + "lastUpdatedDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp of the date and time that the bot recommendation was\n last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of the bot recommendation.
" + } + }, + "com.amazonaws.lexmodelsv2#BotRecommendationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#BotRecommendationSummary" + } + }, "com.amazonaws.lexmodelsv2#BotSortAttribute": { "type": "string", "traits": { @@ -1547,6 +1741,12 @@ "smithy.api#documentation": "Configures conversation logging that saves audio, text, and metadata\n for the conversations with your users.
" } }, + "com.amazonaws.lexmodelsv2#Count": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.lexmodelsv2#CreateBot": { "type": "operation", "input": { @@ -3068,6 +3268,28 @@ "smithy.api#documentation": "By default, data stored by Amazon Lex is encrypted. The\n DataPrivacy structure provides settings that determine\n how Amazon Lex handles special cases of securing the data for your bot.\n
A timestamp indicating the start date for the date range\n filter.
", + "smithy.api#required": {} + } + }, + "endDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp indicating the end date for the date range\n filter.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The object used for specifying the data range that the customer\n wants Amazon Lex to read through in the input transcripts.
" + } + }, "com.amazonaws.lexmodelsv2#DeleteBot": { "type": "operation", "input": { @@ -4539,88 +4761,227 @@ } } }, - "com.amazonaws.lexmodelsv2#DescribeBotRequest": { + "com.amazonaws.lexmodelsv2#DescribeBotRecommendation": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#DescribeBotRecommendationRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#DescribeBotRecommendationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Provides metadata information about a bot recommendation. This\n information will enable you to get a description on the request inputs,\n to download associated transcripts after processing is complete, and to\n download intents and slot-types generated by the bot\n recommendation.
", + "smithy.api#http": { + "method": "GET", + "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}", + "code": 200 + } + } + }, + "com.amazonaws.lexmodelsv2#DescribeBotRecommendationRequest": { "type": "structure", "members": { "botId": { "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The unique identifier of the bot to describe.
", + "smithy.api#documentation": "The unique identifier of the bot associated with the bot\n recommendation.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot associated with the bot\n recommendation.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale of the bot recommendation\n to describe. The string must match one of the supported locales. For\n more information, see Supported languages.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "botRecommendationId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The identifier of the bot recommendation to describe.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, - "com.amazonaws.lexmodelsv2#DescribeBotResponse": { + "com.amazonaws.lexmodelsv2#DescribeBotRecommendationResponse": { "type": "structure", "members": { "botId": { "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The unique identifier of the bot.
" - } - }, - "botName": { - "target": "com.amazonaws.lexmodelsv2#Name", - "traits": { - "smithy.api#documentation": "The name of the bot.
" + "smithy.api#documentation": "The identifier of the bot associated with the bot\n recommendation.
" } }, - "description": { - "target": "com.amazonaws.lexmodelsv2#Description", + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", "traits": { - "smithy.api#documentation": "The description of the bot.
" + "smithy.api#documentation": "The version of the bot associated with the bot\n recommendation.
" } }, - "roleArn": { - "target": "com.amazonaws.lexmodelsv2#RoleArn", + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that has permission to\n access the bot.
" + "smithy.api#documentation": "The identifier of the language and locale of the bot recommendation\n to describe.
" } }, - "dataPrivacy": { - "target": "com.amazonaws.lexmodelsv2#DataPrivacy", + "botRecommendationStatus": { + "target": "com.amazonaws.lexmodelsv2#BotRecommendationStatus", "traits": { - "smithy.api#documentation": "Settings for managing data privacy of the bot and its conversations\n with users.
" + "smithy.api#documentation": "The status of the bot recommendation. If the status is Failed, then\n the reasons for the failure are listed in the failureReasons field.\n
" } }, - "idleSessionTTLInSeconds": { - "target": "com.amazonaws.lexmodelsv2#SessionTTL", + "botRecommendationId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The maximum time in seconds that Amazon Lex retains the data gathered in\n a conversation.
" + "smithy.api#documentation": "The identifier of the bot recommendation being described.
" } }, - "botStatus": { - "target": "com.amazonaws.lexmodelsv2#BotStatus", + "failureReasons": { + "target": "com.amazonaws.lexmodelsv2#FailureReasons", "traits": { - "smithy.api#documentation": "The current status of the bot. When the status is\n Available the bot is ready to be used in conversations\n with users.
If botRecommendationStatus is Failed, Amazon Lex explains why.
" } }, "creationDateTime": { "target": "com.amazonaws.lexmodelsv2#Timestamp", "traits": { - "smithy.api#documentation": "A timestamp of the date and time that the bot was created.
" + "smithy.api#documentation": "The date and time that the bot recommendation was created.
" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.lexmodelsv2#Timestamp", "traits": { - "smithy.api#documentation": "A timestamp of the date and time that the bot was last\n updated.
" + "smithy.api#documentation": "The date and time that the bot recommendation was last\n updated.
" + } + }, + "transcriptSourceSetting": { + "target": "com.amazonaws.lexmodelsv2#TranscriptSourceSetting", + "traits": { + "smithy.api#documentation": "The object representing the Amazon S3 bucket containing the transcript,\n as well as the associated metadata.
" + } + }, + "encryptionSetting": { + "target": "com.amazonaws.lexmodelsv2#EncryptionSetting", + "traits": { + "smithy.api#documentation": "The object representing the passwords that were used to encrypt the\n data related to the bot recommendation results, as well as the KMS key\n ARN used to encrypt the associated metadata.
" + } + }, + "botRecommendationResults": { + "target": "com.amazonaws.lexmodelsv2#BotRecommendationResults", + "traits": { + "smithy.api#documentation": "The object representing the URL of the bot definition, the URL of\n the associated transcript and a statistical summary of the bot\n recommendation results.
" } } } }, - "com.amazonaws.lexmodelsv2#DescribeBotVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.lexmodelsv2#DescribeBotVersionRequest" - }, - "output": { - "target": "com.amazonaws.lexmodelsv2#DescribeBotVersionResponse" - }, - "errors": [ - { + "com.amazonaws.lexmodelsv2#DescribeBotRequest": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot to describe.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lexmodelsv2#DescribeBotResponse": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot.
" + } + }, + "botName": { + "target": "com.amazonaws.lexmodelsv2#Name", + "traits": { + "smithy.api#documentation": "The name of the bot.
" + } + }, + "description": { + "target": "com.amazonaws.lexmodelsv2#Description", + "traits": { + "smithy.api#documentation": "The description of the bot.
" + } + }, + "roleArn": { + "target": "com.amazonaws.lexmodelsv2#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that has permission to\n access the bot.
" + } + }, + "dataPrivacy": { + "target": "com.amazonaws.lexmodelsv2#DataPrivacy", + "traits": { + "smithy.api#documentation": "Settings for managing data privacy of the bot and its conversations\n with users.
" + } + }, + "idleSessionTTLInSeconds": { + "target": "com.amazonaws.lexmodelsv2#SessionTTL", + "traits": { + "smithy.api#documentation": "The maximum time in seconds that Amazon Lex retains the data gathered in\n a conversation.
" + } + }, + "botStatus": { + "target": "com.amazonaws.lexmodelsv2#BotStatus", + "traits": { + "smithy.api#documentation": "The current status of the bot. When the status is\n Available the bot is ready to be used in conversations\n with users.
A timestamp of the date and time that the bot was created.
" + } + }, + "lastUpdatedDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp of the date and time that the bot was last\n updated.
" + } + } + } + }, + "com.amazonaws.lexmodelsv2#DescribeBotVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#DescribeBotVersionRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#DescribeBotVersionResponse" + }, + "errors": [ + { "target": "com.amazonaws.lexmodelsv2#InternalServerException" }, { @@ -5652,6 +6013,32 @@ ] } }, + "com.amazonaws.lexmodelsv2#EncryptionSetting": { + "type": "structure", + "members": { + "kmsKeyArn": { + "target": "com.amazonaws.lexmodelsv2#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The KMS key ARN used to encrypt the metadata associated with the bot\n recommendation.
" + } + }, + "botLocaleExportPassword": { + "target": "com.amazonaws.lexmodelsv2#FilePassword", + "traits": { + "smithy.api#documentation": "The password used to encrypt the recommended bot recommendation\n file.
" + } + }, + "associatedTranscriptsPassword": { + "target": "com.amazonaws.lexmodelsv2#FilePassword", + "traits": { + "smithy.api#documentation": "The password used to encrypt the associated transcript file.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The object representing the passwords that were used to encrypt the\n data related to the bot recommendation, as well as the KMS key ARN used\n to encrypt the associated metadata.
" + } + }, "com.amazonaws.lexmodelsv2#ExceptionMessage": { "type": "string" }, @@ -5857,6 +6244,16 @@ "target": "com.amazonaws.lexmodelsv2#FailureReason" } }, + "com.amazonaws.lexmodelsv2#FilePassword": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.lexmodelsv2#FilterValue": { "type": "string", "traits": { @@ -6487,6 +6884,20 @@ "smithy.api#documentation": "Specifies attributes for sorting a list of intents.
" } }, + "com.amazonaws.lexmodelsv2#IntentStatistics": { + "type": "structure", + "members": { + "discoveredIntentCount": { + "target": "com.amazonaws.lexmodelsv2#Count", + "traits": { + "smithy.api#documentation": "The number of recommended intents associated with the bot\n recommendation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The object that contains the statistical summary of recommended\n intents associated with the bot recommendation.
" + } + }, "com.amazonaws.lexmodelsv2#IntentSummary": { "type": "structure", "members": { @@ -6735,6 +7146,9 @@ { "target": "com.amazonaws.lexmodelsv2#DescribeBotLocale" }, + { + "target": "com.amazonaws.lexmodelsv2#DescribeBotRecommendation" + }, { "target": "com.amazonaws.lexmodelsv2#DescribeBotVersion" }, @@ -6765,6 +7179,9 @@ { "target": "com.amazonaws.lexmodelsv2#ListBotLocales" }, + { + "target": "com.amazonaws.lexmodelsv2#ListBotRecommendations" + }, { "target": "com.amazonaws.lexmodelsv2#ListBots" }, @@ -6786,6 +7203,9 @@ { "target": "com.amazonaws.lexmodelsv2#ListIntents" }, + { + "target": "com.amazonaws.lexmodelsv2#ListRecommendedIntents" + }, { "target": "com.amazonaws.lexmodelsv2#ListSlots" }, @@ -6795,6 +7215,12 @@ { "target": "com.amazonaws.lexmodelsv2#ListTagsForResource" }, + { + "target": "com.amazonaws.lexmodelsv2#SearchAssociatedTranscripts" + }, + { + "target": "com.amazonaws.lexmodelsv2#StartBotRecommendation" + }, { "target": "com.amazonaws.lexmodelsv2#StartImport" }, @@ -6813,6 +7239,9 @@ { "target": "com.amazonaws.lexmodelsv2#UpdateBotLocale" }, + { + "target": "com.amazonaws.lexmodelsv2#UpdateBotRecommendation" + }, { "target": "com.amazonaws.lexmodelsv2#UpdateExport" }, @@ -6830,6 +7259,20 @@ } ] }, + "com.amazonaws.lexmodelsv2#LexTranscriptFilter": { + "type": "structure", + "members": { + "dateRangeFilter": { + "target": "com.amazonaws.lexmodelsv2#DateRangeFilter", + "traits": { + "smithy.api#documentation": "The object that contains a date range filter that will be applied to\n the transcript. Specify this object if you want Amazon Lex to only read the\n files that are within the date range.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The object that contains transcript filter details that are\n associated with a bot recommendation.
" + } + }, "com.amazonaws.lexmodelsv2#ListAggregatedUtterances": { "type": "operation", "input": { @@ -7188,6 +7631,118 @@ } } }, + "com.amazonaws.lexmodelsv2#ListBotRecommendations": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#ListBotRecommendationsRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#ListBotRecommendationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get a list of bot recommendations that meet the specified\n criteria.
", + "smithy.api#http": { + "method": "POST", + "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.lexmodelsv2#ListBotRecommendationsRequest": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot that contains the bot\n recommendation list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot that contains the bot recommendation\n list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale of the bot recommendation\n list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.lexmodelsv2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of bot recommendations to return in each page of\n results. If there are fewer results than the max page size, only the\n actual number of results are returned.
" + } + }, + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", + "traits": { + "smithy.api#documentation": "If the response from the ListBotRecommendation operation contains\n more results than specified in the maxResults parameter, a token is\n returned in the response. Use that token in the nextToken parameter to\n return the next page of results.
" + } + } + } + }, + "com.amazonaws.lexmodelsv2#ListBotRecommendationsResponse": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot that contains the bot\n recommendation list.
" + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot that contains the bot recommendation\n list.
" + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale of the bot recommendation\n list.
" + } + }, + "botRecommendationSummaries": { + "target": "com.amazonaws.lexmodelsv2#BotRecommendationSummaryList", + "traits": { + "smithy.api#documentation": "Summary information for the bot recommendations that meet the filter\n specified in this request. The length of the list is specified in the\n maxResults parameter of the request. If there are more bot\n recommendations available, the nextToken field contains a token to get\n the next page of results.
" + } + }, + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", + "traits": { + "smithy.api#documentation": "A token that indicates whether there are more results to return in a\n response to the ListBotRecommendations operation. If the nextToken\n field is present, you send the contents as the nextToken parameter of a\n ListBotRecommendations operation request to get the next page of\n results.
" + } + } + } + }, "com.amazonaws.lexmodelsv2#ListBotVersions": { "type": "operation", "input": { @@ -7870,18 +8425,21 @@ } } }, - "com.amazonaws.lexmodelsv2#ListSlotTypes": { + "com.amazonaws.lexmodelsv2#ListRecommendedIntents": { "type": "operation", "input": { - "target": "com.amazonaws.lexmodelsv2#ListSlotTypesRequest" + "target": "com.amazonaws.lexmodelsv2#ListRecommendedIntentsRequest" }, "output": { - "target": "com.amazonaws.lexmodelsv2#ListSlotTypesResponse" + "target": "com.amazonaws.lexmodelsv2#ListRecommendedIntentsResponse" }, "errors": [ { "target": "com.amazonaws.lexmodelsv2#InternalServerException" }, + { + "target": "com.amazonaws.lexmodelsv2#ResourceNotFoundException" + }, { "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" }, @@ -7893,10 +8451,10 @@ } ], "traits": { - "smithy.api#documentation": "Gets a list of slot types that match the specified criteria.
", + "smithy.api#documentation": "Gets a list of recommended intents provided by the bot\n recommendation that you can use in your bot.
", "smithy.api#http": { "method": "POST", - "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes", + "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/intents", "code": 200 }, "smithy.api#paginated": { @@ -7906,21 +8464,21 @@ } } }, - "com.amazonaws.lexmodelsv2#ListSlotTypesRequest": { + "com.amazonaws.lexmodelsv2#ListRecommendedIntentsRequest": { "type": "structure", "members": { "botId": { "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The unique identifier of the bot that contains the slot\n types.
", + "smithy.api#documentation": "The unique identifier of the bot associated with the recommended\n intents.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "botVersion": { - "target": "com.amazonaws.lexmodelsv2#BotVersion", + "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", "traits": { - "smithy.api#documentation": "The version of the bot that contains the slot type.
", + "smithy.api#documentation": "The version of the bot that contains the recommended intents.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7928,21 +8486,147 @@ "localeId": { "target": "com.amazonaws.lexmodelsv2#LocaleId", "traits": { - "smithy.api#documentation": "The identifier of the language and locale of the slot types to list.\n The string must match one of the supported locales. For more\n information, see Supported languages.
", + "smithy.api#documentation": "The identifier of the language and locale of the recommended\n intents.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "sortBy": { - "target": "com.amazonaws.lexmodelsv2#SlotTypeSortBy", + "botRecommendationId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "Determines the sort order for the response from the\n ListSlotTypes operation. You can choose to sort by the\n slot type name or last updated date in either ascending or descending\n order.
The identifier of the bot recommendation that contains the\n recommended intents.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "filters": { - "target": "com.amazonaws.lexmodelsv2#SlotTypeFilters", + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", "traits": { - "smithy.api#documentation": "Provides the specification of a filter used to limit the slot types\n in the response to only those that match the filter specification. You\n can only specify one filter and only one string to filter on.
" + "smithy.api#documentation": "If the response from the ListRecommendedIntents operation contains\n more results than specified in the maxResults parameter, a token is\n returned in the response. Use that token in the nextToken parameter to\n return the next page of results.
" + } + }, + "maxResults": { + "target": "com.amazonaws.lexmodelsv2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of bot recommendations to return in each page of\n results. If there are fewer results than the max page size, only the\n actual number of results are returned.
" + } + } + } + }, + "com.amazonaws.lexmodelsv2#ListRecommendedIntentsResponse": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot associated with the recommended\n intent.
" + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot that contains the intent.
" + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale of the intents to list.\n The string must match one of the supported locales. For more\n information, see Supported languages.
" + } + }, + "botRecommendationId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The identifier of the bot recommendation that contains the\n recommended intent.
" + } + }, + "summaryList": { + "target": "com.amazonaws.lexmodelsv2#RecommendedIntentSummaryList", + "traits": { + "smithy.api#documentation": "Summary information for the intents that meet the filter criteria\n specified in the request. The length of the list is specified in the\n maxResults parameter of the request. If there are more intents\n available, the nextToken field contains a token to get the next page of\n results.
" + } + }, + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", + "traits": { + "smithy.api#documentation": "A token that indicates whether there are more results to return in a\n response to the ListRecommendedIntents operation. If the nextToken\n field is present, you send the contents as the nextToken parameter of a\n ListRecommendedIntents operation request to get the next page of\n results.
" + } + } + } + }, + "com.amazonaws.lexmodelsv2#ListSlotTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#ListSlotTypesRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#ListSlotTypesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a list of slot types that match the specified criteria.
", + "smithy.api#http": { + "method": "POST", + "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.lexmodelsv2#ListSlotTypesRequest": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot that contains the slot\n types.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#BotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot that contains the slot type.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale of the slot types to list.\n The string must match one of the supported locales. For more\n information, see Supported languages.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sortBy": { + "target": "com.amazonaws.lexmodelsv2#SlotTypeSortBy", + "traits": { + "smithy.api#documentation": "Determines the sort order for the response from the\n ListSlotTypes operation. You can choose to sort by the\n slot type name or last updated date in either ascending or descending\n order.
Provides the specification of a filter used to limit the slot types\n in the response to only those that match the filter specification. You\n can only specify one filter and only one string to filter on.
" } }, "maxResults": { @@ -8223,6 +8907,10 @@ { "value": "FailOnConflict", "name": "FailOnConflict" + }, + { + "value": "Append", + "name": "Append" } ] } @@ -8334,6 +9022,16 @@ "smithy.api#pattern": "^([0-9a-zA-Z][_-]?)+$" } }, + "com.amazonaws.lexmodelsv2#NextIndex": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 10000000 + } + } + }, "com.amazonaws.lexmodelsv2#NextToken": { "type": "string" }, @@ -8377,6 +9075,27 @@ ] } }, + "com.amazonaws.lexmodelsv2#ObjectPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^[\\/]?+[a-zA-Z0-9!_.*'()-]+(\\/[a-zA-Z0-9!_.*'()-]+)*$" + } + }, + "com.amazonaws.lexmodelsv2#ObjectPrefixes": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#ObjectPrefix" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, "com.amazonaws.lexmodelsv2#Operation": { "type": "string", "traits": { @@ -8434,6 +9153,20 @@ } } }, + "com.amazonaws.lexmodelsv2#PathFormat": { + "type": "structure", + "members": { + "objectPrefixes": { + "target": "com.amazonaws.lexmodelsv2#ObjectPrefixes", + "traits": { + "smithy.api#documentation": "A list of Amazon S3 prefixes that points to sub-folders in the Amazon S3\n bucket. Specify this list if you only want Lex to read the files under\n this set of sub-folders.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The object that contains a path format that will be applied when\n Amazon Lex reads the transcript file in the bucket you provide. Specify this\n object if you only want Lex to read a subset of files in your Amazon S3\n bucket.
" + } + }, "com.amazonaws.lexmodelsv2#PlainTextMessage": { "type": "structure", "members": { @@ -8598,6 +9331,38 @@ } } }, + "com.amazonaws.lexmodelsv2#RecommendedIntentSummary": { + "type": "structure", + "members": { + "intentId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of a recommended intent associated with the\n bot recommendation.
" + } + }, + "intentName": { + "target": "com.amazonaws.lexmodelsv2#Name", + "traits": { + "smithy.api#documentation": "The name of a recommended intent associated with the bot\n recommendation.
" + } + }, + "sampleUtterancesCount": { + "target": "com.amazonaws.lexmodelsv2#SampleUtterancesCount", + "traits": { + "smithy.api#documentation": "The count of sample utterances of a recommended intent that is\n associated with a bot recommendation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains a summary of a recommended intent.
" + } + }, + "com.amazonaws.lexmodelsv2#RecommendedIntentSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#RecommendedIntentSummary" + } + }, "com.amazonaws.lexmodelsv2#RegexPattern": { "type": "string", "traits": { @@ -8730,6 +9495,56 @@ "smithy.api#documentation": "Specifies an Amazon S3 bucket for logging audio conversations
" } }, + "com.amazonaws.lexmodelsv2#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.lexmodelsv2#S3BucketTranscriptSource": { + "type": "structure", + "members": { + "s3BucketName": { + "target": "com.amazonaws.lexmodelsv2#S3BucketName", + "traits": { + "smithy.api#documentation": "The name of the bucket containing the transcript and the associated\n metadata.
", + "smithy.api#required": {} + } + }, + "pathFormat": { + "target": "com.amazonaws.lexmodelsv2#PathFormat", + "traits": { + "smithy.api#documentation": "The object that contains a path format that will be applied when\n Amazon Lex reads the transcript file in the bucket you provide. Specify this\n object if you only want Lex to read a subset of files in your Amazon S3\n bucket.
" + } + }, + "transcriptFormat": { + "target": "com.amazonaws.lexmodelsv2#TranscriptFormat", + "traits": { + "smithy.api#documentation": "The format of the transcript content. Currently, Genie only supports\n the Amazon Lex transcript format.
", + "smithy.api#required": {} + } + }, + "transcriptFilter": { + "target": "com.amazonaws.lexmodelsv2#TranscriptFilter", + "traits": { + "smithy.api#documentation": "The object that contains the filter which will be applied when Amazon Lex\n reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to\n read only a subset of the Amazon S3 bucket based on the filter you\n provide.
" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.lexmodelsv2#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The ARN of the KMS key that customer use to encrypt their Amazon S3\n bucket. Only use this field if your bucket is encrypted using a\n customer managed KMS key.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The object representing the Amazon S3 bucket containing the transcript,\n as well as the associated metadata.
" + } + }, "com.amazonaws.lexmodelsv2#SSMLMessage": { "type": "structure", "members": { @@ -8769,6 +9584,12 @@ "smithy.api#documentation": "A sample utterance that invokes an intent or respond to a slot\n elicitation prompt.
" } }, + "com.amazonaws.lexmodelsv2#SampleUtterancesCount": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.lexmodelsv2#SampleUtterancesList": { "type": "list", "member": { @@ -8790,6 +9611,164 @@ "smithy.api#documentation": "Defines one of the values for a slot type.
" } }, + "com.amazonaws.lexmodelsv2#SearchAssociatedTranscripts": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#SearchAssociatedTranscriptsRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#SearchAssociatedTranscriptsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Search for associated transcripts that meet the specified\n criteria.
", + "smithy.api#http": { + "method": "POST", + "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/associatedtranscripts", + "code": 200 + } + } + }, + "com.amazonaws.lexmodelsv2#SearchAssociatedTranscriptsRequest": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot associated with the transcripts\n that you are searching.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#BotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot containing the transcripts that you are\n searching.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale of the transcripts to\n search. The string must match one of the supported locales. For more\n information, see Supported languages\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "botRecommendationId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot recommendation associated with the\n transcripts to search.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "searchOrder": { + "target": "com.amazonaws.lexmodelsv2#SearchOrder", + "traits": { + "smithy.api#documentation": "How SearchResults are ordered. Valid values are Ascending or\n Descending. The default is Descending.
" + } + }, + "filters": { + "target": "com.amazonaws.lexmodelsv2#AssociatedTranscriptFilters", + "traits": { + "smithy.api#documentation": "A list of filter objects.
", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.lexmodelsv2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of bot recommendations to return in each page of\n results. If there are fewer results than the max page size, only the\n actual number of results are returned.
" + } + }, + "nextIndex": { + "target": "com.amazonaws.lexmodelsv2#NextIndex", + "traits": { + "smithy.api#documentation": "If the response from the SearchAssociatedTranscriptsRequest\n operation contains more results than specified in the maxResults\n parameter, an index is returned in the response. Use that index in the\n nextIndex parameter to return the next page of results.
" + } + } + } + }, + "com.amazonaws.lexmodelsv2#SearchAssociatedTranscriptsResponse": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot associated with the transcripts\n that you are searching.
" + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#BotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot containing the transcripts that you are\n searching.
" + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale of the transcripts to\n search. The string must match one of the supported locales. For more\n information, see Supported languages\n
" + } + }, + "botRecommendationId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot recommendation associated with the\n transcripts to search.
" + } + }, + "nextIndex": { + "target": "com.amazonaws.lexmodelsv2#NextIndex", + "traits": { + "smithy.api#documentation": "A index that indicates whether there are more results to return in a\n response to the SearchAssociatedTranscripts operation. If the nextIndex\n field is present, you send the contents as the nextIndex parameter of a\n SearchAssociatedTranscriptsRequest operation to get the next page of\n results.
" + } + }, + "associatedTranscripts": { + "target": "com.amazonaws.lexmodelsv2#AssociatedTranscriptList", + "traits": { + "smithy.api#documentation": "The object that contains the associated transcript that meet the\n criteria you specified.
" + } + }, + "totalResults": { + "target": "com.amazonaws.lexmodelsv2#MaxResults", + "traits": { + "smithy.api#documentation": "The total number of transcripts returned by the search.
" + } + } + } + }, + "com.amazonaws.lexmodelsv2#SearchOrder": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Ascending", + "name": "Ascending" + }, + { + "value": "Descending", + "name": "Descending" + } + ] + } + }, "com.amazonaws.lexmodelsv2#SentimentAnalysisSettings": { "type": "structure", "members": { @@ -9203,13 +10182,27 @@ "order": { "target": "com.amazonaws.lexmodelsv2#SortOrder", "traits": { - "smithy.api#documentation": "The order to sort the list. You can say ascending or\n descending.
", - "smithy.api#required": {} + "smithy.api#documentation": "The order to sort the list. You can say ascending or\n descending.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies attributes for sorting a list of slot types.
" + } + }, + "com.amazonaws.lexmodelsv2#SlotTypeStatistics": { + "type": "structure", + "members": { + "discoveredSlotTypeCount": { + "target": "com.amazonaws.lexmodelsv2#Count", + "traits": { + "smithy.api#documentation": "The number of recommended slot types associated with the bot\n recommendation.
" } } }, "traits": { - "smithy.api#documentation": "Specifies attributes for sorting a list of slot types.
" + "smithy.api#documentation": "The object that contains the statistical summary of the recommended\n slot type associated with the bot recommendation.
" } }, "com.amazonaws.lexmodelsv2#SlotTypeSummary": { @@ -9390,6 +10383,141 @@ ] } }, + "com.amazonaws.lexmodelsv2#StartBotRecommendation": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#StartBotRecommendationRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#StartBotRecommendationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#ConflictException" + }, + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Use this to provide your transcript data, and to start the bot\n recommendation process.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations", + "code": 202 + } + } + }, + "com.amazonaws.lexmodelsv2#StartBotRecommendationRequest": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot containing the bot\n recommendation.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot containing the bot recommendation.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale of the bot recommendation\n to start. The string must match one of the supported locales. For more\n information, see Supported languages\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "transcriptSourceSetting": { + "target": "com.amazonaws.lexmodelsv2#TranscriptSourceSetting", + "traits": { + "smithy.api#documentation": "The object representing the Amazon S3 bucket containing the transcript,\n as well as the associated metadata.
", + "smithy.api#required": {} + } + }, + "encryptionSetting": { + "target": "com.amazonaws.lexmodelsv2#EncryptionSetting", + "traits": { + "smithy.api#documentation": "The object representing the passwords that will be used to encrypt\n the data related to the bot recommendation results, as well as the KMS\n key ARN used to encrypt the associated metadata.
" + } + } + } + }, + "com.amazonaws.lexmodelsv2#StartBotRecommendationResponse": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot containing the bot\n recommendation.
" + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot containing the bot recommendation.
" + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale of the bot recommendation\n to start. The string must match one of the supported locales. For more\n information, see Supported languages\n
" + } + }, + "botRecommendationStatus": { + "target": "com.amazonaws.lexmodelsv2#BotRecommendationStatus", + "traits": { + "smithy.api#documentation": "The status of the bot recommendation.
\nIf the status is Failed, then the reasons for the failure are listed\n in the failureReasons field.
" + } + }, + "botRecommendationId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The identifier of the bot recommendation that you have\n created.
" + } + }, + "creationDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp of the date and time that the bot recommendation was\n created.
" + } + }, + "transcriptSourceSetting": { + "target": "com.amazonaws.lexmodelsv2#TranscriptSourceSetting", + "traits": { + "smithy.api#documentation": "The object representing the Amazon S3 bucket containing the transcript,\n as well as the associated metadata.
" + } + }, + "encryptionSetting": { + "target": "com.amazonaws.lexmodelsv2#EncryptionSetting", + "traits": { + "smithy.api#documentation": "The object representing the passwords that were used to encrypt the\n data related to the bot recommendation results, as well as the KMS key\n ARN used to encrypt the associated metadata.
" + } + } + } + }, "com.amazonaws.lexmodelsv2#StartImport": { "type": "operation", "input": { @@ -9759,6 +10887,55 @@ "com.amazonaws.lexmodelsv2#Timestamp": { "type": "timestamp" }, + "com.amazonaws.lexmodelsv2#Transcript": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6000000 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.lexmodelsv2#TranscriptFilter": { + "type": "structure", + "members": { + "lexTranscriptFilter": { + "target": "com.amazonaws.lexmodelsv2#LexTranscriptFilter", + "traits": { + "smithy.api#documentation": "The object representing the filter that Amazon Lex will use to select the\n appropriate transcript when the transcript format is the Amazon Lex\n format.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The object representing the filter that Amazon Lex will use to select the\n appropriate transcript.
" + } + }, + "com.amazonaws.lexmodelsv2#TranscriptFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Lex", + "name": "Lex" + } + ] + } + }, + "com.amazonaws.lexmodelsv2#TranscriptSourceSetting": { + "type": "structure", + "members": { + "s3BucketTranscriptSource": { + "target": "com.amazonaws.lexmodelsv2#S3BucketTranscriptSource", + "traits": { + "smithy.api#documentation": "Indicates the setting of the Amazon S3 bucket where the transcript is\n stored.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Indicates the setting of the location where the transcript is\n stored.
" + } + }, "com.amazonaws.lexmodelsv2#UntagResource": { "type": "operation", "input": { @@ -10168,6 +11345,149 @@ } } }, + "com.amazonaws.lexmodelsv2#UpdateBotRecommendation": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#UpdateBotRecommendationRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#UpdateBotRecommendationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#ConflictException" + }, + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing bot recommendation request.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}", + "code": 202 + } + } + }, + "com.amazonaws.lexmodelsv2#UpdateBotRecommendationRequest": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot containing the bot recommendation\n to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot containing the bot recommendation to be\n updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale of the bot recommendation\n to update. The string must match one of the supported locales. For more\n information, see Supported languages\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "botRecommendationId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot recommendation to be\n updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "encryptionSetting": { + "target": "com.amazonaws.lexmodelsv2#EncryptionSetting", + "traits": { + "smithy.api#documentation": "The object representing the passwords that will be used to encrypt\n the data related to the bot recommendation results, as well as the KMS\n key ARN used to encrypt the associated metadata.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lexmodelsv2#UpdateBotRecommendationResponse": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot containing the bot recommendation\n that has been updated.
" + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot containing the bot recommendation that has\n been updated.
" + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale of the bot recommendation\n to update. The string must match one of the supported locales. For more\n information, see Supported languages\n
" + } + }, + "botRecommendationStatus": { + "target": "com.amazonaws.lexmodelsv2#BotRecommendationStatus", + "traits": { + "smithy.api#documentation": "The status of the bot recommendation.
\nIf the status is Failed, then the reasons for the failure are listed\n in the failureReasons field.
" + } + }, + "botRecommendationId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot recommendation to be\n updated.
" + } + }, + "creationDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp of the date and time that the bot recommendation was\n created.
" + } + }, + "lastUpdatedDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp of the date and time that the bot recommendation was\n last updated.
" + } + }, + "transcriptSourceSetting": { + "target": "com.amazonaws.lexmodelsv2#TranscriptSourceSetting", + "traits": { + "smithy.api#documentation": "The object representing the Amazon S3 bucket containing the transcript,\n as well as the associated metadata.
" + } + }, + "encryptionSetting": { + "target": "com.amazonaws.lexmodelsv2#EncryptionSetting", + "traits": { + "smithy.api#documentation": "The object representing the passwords that were used to encrypt the\n data related to the bot recommendation results, as well as the KMS key\n ARN used to encrypt the associated metadata.
" + } + } + } + }, "com.amazonaws.lexmodelsv2#UpdateBotRequest": { "type": "structure", "members": { diff --git a/aws/sdk/aws-models/opensearch.json b/aws/sdk/aws-models/opensearch.json index 1da3cb54d152f715d7a6b0b89dcd622a2842ac30..dceaa996590afd81bf6ddecd55e9fe784d8e7b80 100644 --- a/aws/sdk/aws-models/opensearch.json +++ b/aws/sdk/aws-models/opensearch.json @@ -1796,6 +1796,15 @@ ] } }, + "com.amazonaws.opensearch#DeploymentType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 128 + } + } + }, "com.amazonaws.opensearch#DescribeDomain": { "type": "operation", "input": { @@ -3182,6 +3191,29 @@ "smithy.api#box": {} } }, + "com.amazonaws.opensearch#DryRun": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.opensearch#DryRunResults": { + "type": "structure", + "members": { + "DeploymentType": { + "target": "com.amazonaws.opensearch#DeploymentType", + "traits": { + "smithy.api#documentation": "\n Specifies the way in which Amazon OpenSearch Service applies the update.\n Possible responses are Blue/Green (the update requires a blue/green deployment), DynamicUpdate (no blue/green required), Undetermined (the domain is undergoing an update and can't predict the deployment type; try again after the update is complete), and None (the request doesn't include any configuration changes).\n
Contains an optional message associated with the DryRunResults.
" + } + } + } + }, "com.amazonaws.opensearch#Duration": { "type": "structure", "members": { @@ -4575,6 +4607,15 @@ "smithy.api#documentation": "\n Maximum number of instances that can be instantiated for a given InstanceType.\n
" } }, + "com.amazonaws.opensearch#Message": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, "com.amazonaws.opensearch#MinimumInstanceCount": { "type": "integer", "traits": { @@ -6578,6 +6619,12 @@ "traits": { "smithy.api#documentation": "Specifies Auto-Tune options.
" } + }, + "DryRun": { + "target": "com.amazonaws.opensearch#DryRun", + "traits": { + "smithy.api#documentation": "This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation checks (DryRunResults) without actually applying the change.
The status of the updated domain.
", "smithy.api#required": {} } + }, + "DryRunResults": { + "target": "com.amazonaws.opensearch#DryRunResults", + "traits": { + "smithy.api#documentation": "Contains result of DryRun.
" + } } }, "traits": { diff --git a/aws/sdk/aws-models/outposts.json b/aws/sdk/aws-models/outposts.json index c6fc7f5066c334200336d9509e40bef9aa4ff439..4f9d5897a92a4ee27158971937ec0ed9566e0457 100644 --- a/aws/sdk/aws-models/outposts.json +++ b/aws/sdk/aws-models/outposts.json @@ -45,7 +45,7 @@ "com.amazonaws.outposts#AccountId": { "type": "string", "traits": { - "smithy.api#documentation": "The ID of the AWS account.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account.
", "smithy.api#length": { "min": 12, "max": 12 @@ -53,6 +53,130 @@ "smithy.api#pattern": "^\\d{12}$" } }, + "com.amazonaws.outposts#Address": { + "type": "structure", + "members": { + "ContactName": { + "target": "com.amazonaws.outposts#ContactName", + "traits": { + "smithy.api#documentation": "The name of the contact.
" + } + }, + "ContactPhoneNumber": { + "target": "com.amazonaws.outposts#ContactPhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number of the contact.
" + } + }, + "AddressLine1": { + "target": "com.amazonaws.outposts#AddressLine1", + "traits": { + "smithy.api#documentation": "The first line of the address.
", + "smithy.api#required": {} + } + }, + "AddressLine2": { + "target": "com.amazonaws.outposts#AddressLine2", + "traits": { + "smithy.api#documentation": "The second line of the address.
" + } + }, + "AddressLine3": { + "target": "com.amazonaws.outposts#AddressLine3", + "traits": { + "smithy.api#documentation": "The third line of the address.
" + } + }, + "City": { + "target": "com.amazonaws.outposts#City", + "traits": { + "smithy.api#documentation": "The city for the address.
", + "smithy.api#required": {} + } + }, + "StateOrRegion": { + "target": "com.amazonaws.outposts#StateOrRegion", + "traits": { + "smithy.api#documentation": "The state for the address.
", + "smithy.api#required": {} + } + }, + "DistrictOrCounty": { + "target": "com.amazonaws.outposts#DistrictOrCounty", + "traits": { + "smithy.api#documentation": "The district or county for the address.
" + } + }, + "PostalCode": { + "target": "com.amazonaws.outposts#PostalCode", + "traits": { + "smithy.api#documentation": "The postal code for the address.
", + "smithy.api#required": {} + } + }, + "CountryCode": { + "target": "com.amazonaws.outposts#CountryCode", + "traits": { + "smithy.api#documentation": "The ISO-3166 two-letter country code for the address.
", + "smithy.api#required": {} + } + }, + "Municipality": { + "target": "com.amazonaws.outposts#Municipality", + "traits": { + "smithy.api#documentation": "The municipality for the address.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Information about an address.\n
" + } + }, + "com.amazonaws.outposts#AddressLine1": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 180 + }, + "smithy.api#pattern": "^\\S[\\S ]*$" + } + }, + "com.amazonaws.outposts#AddressLine2": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 60 + }, + "smithy.api#pattern": "^\\S[\\S ]*$" + } + }, + "com.amazonaws.outposts#AddressLine3": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 60 + }, + "smithy.api#pattern": "^\\S[\\S ]*$" + } + }, + "com.amazonaws.outposts#AddressType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SHIPPING_ADDRESS", + "name": "SHIPPING_ADDRESS" + }, + { + "value": "OPERATING_ADDRESS", + "name": "OPERATING_ADDRESS" + } + ] + } + }, "com.amazonaws.outposts#Arn": { "type": "string", "traits": { @@ -109,6 +233,171 @@ } } }, + "com.amazonaws.outposts#CancelOrder": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#CancelOrderInput" + }, + "output": { + "target": "com.amazonaws.outposts#CancelOrderOutput" + }, + "errors": [ + { + "target": "com.amazonaws.outposts#AccessDeniedException" + }, + { + "target": "com.amazonaws.outposts#ConflictException" + }, + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + }, + { + "target": "com.amazonaws.outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Cancels an order for an Outpost. \n
", + "smithy.api#http": { + "method": "POST", + "uri": "/orders/{OrderId}/cancel", + "code": 200 + } + } + }, + "com.amazonaws.outposts#CancelOrderInput": { + "type": "structure", + "members": { + "OrderId": { + "target": "com.amazonaws.outposts#OrderId", + "traits": { + "smithy.api#documentation": "\n The ID of the order to cancel.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.outposts#CancelOrderOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.outposts#CatalogItem": { + "type": "structure", + "members": { + "CatalogItemId": { + "target": "com.amazonaws.outposts#SkuCode", + "traits": { + "smithy.api#documentation": "\n The ID of the catalog item.\n
" + } + }, + "ItemStatus": { + "target": "com.amazonaws.outposts#CatalogItemStatus", + "traits": { + "smithy.api#documentation": "\n The status of a catalog item.\n
" + } + }, + "EC2Capacities": { + "target": "com.amazonaws.outposts#EC2CapacityListDefinition", + "traits": { + "smithy.api#documentation": "\n Information about the EC2 capacity of an item.\n
" + } + }, + "PowerKva": { + "target": "com.amazonaws.outposts#CatalogItemPowerKva", + "traits": { + "smithy.api#documentation": "\n Information about the power draw of an item.\n
" + } + }, + "WeightLbs": { + "target": "com.amazonaws.outposts#CatalogItemWeightLbs", + "traits": { + "smithy.api#documentation": "The weight of the item in pounds.
" + } + }, + "SupportedUplinkGbps": { + "target": "com.amazonaws.outposts#SupportedUplinkGbpsListDefinition", + "traits": { + "smithy.api#documentation": "\n The uplink speed this catalog item requires for the \n connection to the Region.\n
" + } + }, + "SupportedStorage": { + "target": "com.amazonaws.outposts#SupportedStorageList", + "traits": { + "smithy.api#documentation": "\n The supported storage options for the catalog item.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a catalog item.
" + } + }, + "com.amazonaws.outposts#CatalogItemClass": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RACK", + "name": "RACK" + }, + { + "value": "SERVER", + "name": "SERVER" + } + ] + } + }, + "com.amazonaws.outposts#CatalogItemClassList": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#CatalogItemClass" + } + }, + "com.amazonaws.outposts#CatalogItemListDefinition": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#CatalogItem" + } + }, + "com.amazonaws.outposts#CatalogItemPowerKva": { + "type": "float", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.outposts#CatalogItemStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AVAILABLE", + "name": "AVAILABLE" + }, + { + "value": "DISCONTINUED", + "name": "DISCONTINUED" + } + ] + } + }, + "com.amazonaws.outposts#CatalogItemWeightLbs": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.outposts#City": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^\\S[\\S ]*$" + } + }, "com.amazonaws.outposts#ConflictException": { "type": "structure", "members": { @@ -134,6 +423,36 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.outposts#ContactName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^\\S[\\S ]*$" + } + }, + "com.amazonaws.outposts#ContactPhoneNumber": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#pattern": "^[\\S ]+$" + } + }, + "com.amazonaws.outposts#CountryCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + }, + "smithy.api#pattern": "^[A-Z]{2}$" + } + }, "com.amazonaws.outposts#CreateOrder": { "type": "operation", "input": { @@ -280,6 +599,12 @@ "traits": { "smithy.api#documentation": "The tags to apply to the Outpost.
" } + }, + "SupportedHardwareType": { + "target": "com.amazonaws.outposts#SupportedHardwareType", + "traits": { + "smithy.api#documentation": "\n The type of hardware for this Outpost.\n
" + } } } }, @@ -291,13 +616,13 @@ } } }, - "com.amazonaws.outposts#DeleteOutpost": { + "com.amazonaws.outposts#CreateSite": { "type": "operation", "input": { - "target": "com.amazonaws.outposts#DeleteOutpostInput" + "target": "com.amazonaws.outposts#CreateSiteInput" }, "output": { - "target": "com.amazonaws.outposts#DeleteOutpostOutput" + "target": "com.amazonaws.outposts#CreateSiteOutput" }, "errors": [ { @@ -310,37 +635,123 @@ "target": "com.amazonaws.outposts#InternalServerException" }, { - "target": "com.amazonaws.outposts#NotFoundException" + "target": "com.amazonaws.outposts#ServiceQuotaExceededException" }, { "target": "com.amazonaws.outposts#ValidationException" } ], "traits": { - "smithy.api#documentation": "Deletes the Outpost.
", + "smithy.api#documentation": "\n Creates a site for an Outpost.\n
", "smithy.api#http": { - "method": "DELETE", - "uri": "/outposts/{OutpostId}", + "method": "POST", + "uri": "/sites", "code": 200 } } }, - "com.amazonaws.outposts#DeleteOutpostInput": { + "com.amazonaws.outposts#CreateSiteInput": { "type": "structure", "members": { - "OutpostId": { - "target": "com.amazonaws.outposts#OutpostId", + "Name": { + "target": "com.amazonaws.outposts#SiteName", "traits": { - "smithy.api#documentation": "\n The ID of the Outpost.\n
", - "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Description": { + "target": "com.amazonaws.outposts#SiteDescription" + }, + "Notes": { + "target": "com.amazonaws.outposts#SiteNotes", + "traits": { + "smithy.api#documentation": "Additional information that you provide about site access requirements, electrician\n scheduling, personal protective equipment, or regulation of equipment materials that could\n affect your installation process.
" + } + }, + "Tags": { + "target": "com.amazonaws.outposts#TagMap", + "traits": { + "smithy.api#documentation": "\n The tags to apply to a site.\n
" + } + }, + "OperatingAddress": { + "target": "com.amazonaws.outposts#Address", + "traits": { + "smithy.api#documentation": "\n The location to install and power on the hardware. This address might be \n different from the shipping address.\n
" + } + }, + "ShippingAddress": { + "target": "com.amazonaws.outposts#Address", + "traits": { + "smithy.api#documentation": "\n The location to ship the hardware. This address might be different \n from the operating address.\n
" + } + }, + "RackPhysicalProperties": { + "target": "com.amazonaws.outposts#RackPhysicalProperties", + "traits": { + "smithy.api#documentation": "Information about the physical and logistical details for the rack at this site.\n For more information\n about hardware requirements for racks, see Network \n readiness checklist in the Amazon Web Services Outposts User Guide.\n
" + } } } }, - "com.amazonaws.outposts#DeleteOutpostOutput": { + "com.amazonaws.outposts#CreateSiteOutput": { "type": "structure", - "members": {} + "members": { + "Site": { + "target": "com.amazonaws.outposts#Site" + } + } + }, + "com.amazonaws.outposts#DeleteOutpost": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#DeleteOutpostInput" + }, + "output": { + "target": "com.amazonaws.outposts#DeleteOutpostOutput" + }, + "errors": [ + { + "target": "com.amazonaws.outposts#AccessDeniedException" + }, + { + "target": "com.amazonaws.outposts#ConflictException" + }, + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + }, + { + "target": "com.amazonaws.outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the Outpost.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/outposts/{OutpostId}", + "code": 200 + } + } + }, + "com.amazonaws.outposts#DeleteOutpostInput": { + "type": "structure", + "members": { + "OutpostId": { + "target": "com.amazonaws.outposts#OutpostId", + "traits": { + "smithy.api#documentation": "\n The ID of the Outpost.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.outposts#DeleteOutpostOutput": { + "type": "structure", + "members": {} }, "com.amazonaws.outposts#DeleteSite": { "type": "operation", @@ -392,6 +803,54 @@ "type": "structure", "members": {} }, + "com.amazonaws.outposts#DistrictOrCounty": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60 + }, + "smithy.api#pattern": "^\\S[\\S ]*$" + } + }, + "com.amazonaws.outposts#EC2Capacity": { + "type": "structure", + "members": { + "Family": { + "target": "com.amazonaws.outposts#Family", + "traits": { + "smithy.api#documentation": "\n The family of the EC2 capacity.\n
" + } + }, + "MaxSize": { + "target": "com.amazonaws.outposts#MaxSize", + "traits": { + "smithy.api#documentation": "\n The maximum size of the EC2 capacity.\n
" + } + }, + "Quantity": { + "target": "com.amazonaws.outposts#Quantity", + "traits": { + "smithy.api#documentation": "\n The quantity of the EC2 capacity.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about EC2 capacity.
" + } + }, + "com.amazonaws.outposts#EC2CapacityListDefinition": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#EC2Capacity" + } + }, + "com.amazonaws.outposts#EC2FamilyList": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#Family" + } + }, "com.amazonaws.outposts#ErrorMessage": { "type": "string", "traits": { @@ -402,6 +861,132 @@ "smithy.api#pattern": "^[\\S \\n]+$" } }, + "com.amazonaws.outposts#Family": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#pattern": "^[a-z0-9]+$" + } + }, + "com.amazonaws.outposts#FiberOpticCableType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SINGLE_MODE", + "name": "SINGLE_MODE" + }, + { + "value": "MULTI_MODE", + "name": "MULTI_MODE" + } + ] + } + }, + "com.amazonaws.outposts#GetCatalogItem": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#GetCatalogItemInput" + }, + "output": { + "target": "com.amazonaws.outposts#GetCatalogItemOutput" + }, + "errors": [ + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + }, + { + "target": "com.amazonaws.outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a catalog item.
", + "smithy.api#http": { + "method": "GET", + "uri": "/catalog/item/{CatalogItemId}", + "code": 200 + } + } + }, + "com.amazonaws.outposts#GetCatalogItemInput": { + "type": "structure", + "members": { + "CatalogItemId": { + "target": "com.amazonaws.outposts#SkuCode", + "traits": { + "smithy.api#documentation": "The ID of the catalog item.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.outposts#GetCatalogItemOutput": { + "type": "structure", + "members": { + "CatalogItem": { + "target": "com.amazonaws.outposts#CatalogItem", + "traits": { + "smithy.api#documentation": "Information about this catalog item.
" + } + } + } + }, + "com.amazonaws.outposts#GetOrder": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#GetOrderInput" + }, + "output": { + "target": "com.amazonaws.outposts#GetOrderOutput" + }, + "errors": [ + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + }, + { + "target": "com.amazonaws.outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets an order.
", + "smithy.api#http": { + "method": "GET", + "uri": "/orders/{OrderId}", + "code": 200 + } + } + }, + "com.amazonaws.outposts#GetOrderInput": { + "type": "structure", + "members": { + "OrderId": { + "target": "com.amazonaws.outposts#OrderId", + "traits": { + "smithy.api#documentation": "The ID of the order.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.outposts#GetOrderOutput": { + "type": "structure", + "members": { + "Order": { + "target": "com.amazonaws.outposts#Order" + } + } + }, "com.amazonaws.outposts#GetOutpost": { "type": "operation", "input": { @@ -530,43 +1115,165 @@ } } }, - "com.amazonaws.outposts#ISO8601Timestamp": { - "type": "timestamp" - }, - "com.amazonaws.outposts#InstanceType": { - "type": "string", - "traits": { - "smithy.api#documentation": "The instance type.
" - } - }, - "com.amazonaws.outposts#InstanceTypeItem": { - "type": "structure", - "members": { - "InstanceType": { - "target": "com.amazonaws.outposts#InstanceType" - } + "com.amazonaws.outposts#GetSite": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#GetSiteInput" + }, + "output": { + "target": "com.amazonaws.outposts#GetSiteOutput" }, + "errors": [ + { + "target": "com.amazonaws.outposts#AccessDeniedException" + }, + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + }, + { + "target": "com.amazonaws.outposts#ValidationException" + } + ], "traits": { - "smithy.api#documentation": "Information about an instance type.
" + "smithy.api#documentation": "\n Gets information about the specified Outpost site.\n
", + "smithy.api#http": { + "method": "GET", + "uri": "/sites/{SiteId}", + "code": 200 + } } }, - "com.amazonaws.outposts#InstanceTypeListDefinition": { - "type": "list", - "member": { - "target": "com.amazonaws.outposts#InstanceTypeItem" + "com.amazonaws.outposts#GetSiteAddress": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#GetSiteAddressInput" + }, + "output": { + "target": "com.amazonaws.outposts#GetSiteAddressOutput" }, + "errors": [ + { + "target": "com.amazonaws.outposts#AccessDeniedException" + }, + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + }, + { + "target": "com.amazonaws.outposts#ValidationException" + } + ], "traits": { - "smithy.api#documentation": "Information about the instance types.
" + "smithy.api#documentation": "\n Gets the site address.\n
", + "smithy.api#http": { + "method": "GET", + "uri": "/sites/{SiteId}/address", + "code": 200 + } } }, - "com.amazonaws.outposts#InternalServerException": { + "com.amazonaws.outposts#GetSiteAddressInput": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.outposts#ErrorMessage" - } - }, - "traits": { + "SiteId": { + "target": "com.amazonaws.outposts#SiteId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AddressType": { + "target": "com.amazonaws.outposts#AddressType", + "traits": { + "smithy.api#documentation": "The type of the address you request.
", + "smithy.api#httpQuery": "AddressType", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.outposts#GetSiteAddressOutput": { + "type": "structure", + "members": { + "SiteId": { + "target": "com.amazonaws.outposts#SiteId" + }, + "AddressType": { + "target": "com.amazonaws.outposts#AddressType", + "traits": { + "smithy.api#documentation": "The type of the address you receive.
" + } + }, + "Address": { + "target": "com.amazonaws.outposts#Address", + "traits": { + "smithy.api#documentation": "\n Information about the address.\n
" + } + } + } + }, + "com.amazonaws.outposts#GetSiteInput": { + "type": "structure", + "members": { + "SiteId": { + "target": "com.amazonaws.outposts#SiteId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.outposts#GetSiteOutput": { + "type": "structure", + "members": { + "Site": { + "target": "com.amazonaws.outposts#Site" + } + } + }, + "com.amazonaws.outposts#ISO8601Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.outposts#InstanceType": { + "type": "string", + "traits": { + "smithy.api#documentation": "The instance type.
" + } + }, + "com.amazonaws.outposts#InstanceTypeItem": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.outposts#InstanceType" + } + }, + "traits": { + "smithy.api#documentation": "Information about an instance type.
" + } + }, + "com.amazonaws.outposts#InstanceTypeListDefinition": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#InstanceTypeItem" + }, + "traits": { + "smithy.api#documentation": "Information about the instance types.
" + } + }, + "com.amazonaws.outposts#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.outposts#ErrorMessage" + } + }, + "traits": { "smithy.api#documentation": "An internal error has occurred.
", "smithy.api#error": "server", "smithy.api#httpError": 500 @@ -617,7 +1324,7 @@ } }, "Status": { - "target": "com.amazonaws.outposts#Status", + "target": "com.amazonaws.outposts#LineItemStatus", "traits": { "smithy.api#documentation": "The status of the line item.
" } @@ -680,6 +1387,213 @@ } } }, + "com.amazonaws.outposts#LineItemStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PREPARING", + "name": "PREPARING" + }, + { + "value": "BUILDING", + "name": "BUILDING" + }, + { + "value": "SHIPPED", + "name": "SHIPPED" + }, + { + "value": "DELIVERED", + "name": "DELIVERED" + }, + { + "value": "INSTALLING", + "name": "INSTALLING" + }, + { + "value": "INSTALLED", + "name": "INSTALLED" + }, + { + "value": "ERROR", + "name": "ERROR" + }, + { + "value": "CANCELLED", + "name": "CANCELLED" + } + ] + } + }, + "com.amazonaws.outposts#LineItemStatusCounts": { + "type": "map", + "key": { + "target": "com.amazonaws.outposts#LineItemStatus" + }, + "value": { + "target": "com.amazonaws.outposts#LineItemQuantity" + } + }, + "com.amazonaws.outposts#ListCatalogItems": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#ListCatalogItemsInput" + }, + "output": { + "target": "com.amazonaws.outposts#ListCatalogItemsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + }, + { + "target": "com.amazonaws.outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Use to create a list of every item in the catalog. Add filters to your request to return a\n more specific list of results. Use filters to match an item class, storage\n option, or EC2 family.
\nIf you specify multiple filters, the filters are joined with an AND, and\n the request returns only results that match all of the specified filters.
\n A filter for the class of items in the catalog.\n
\nFilter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.
\n A filter for the storage options of items in the catalog.\n
\nFilter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.
\n A filter for EC2 family options for items in the catalog.\n
\nFilter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.
Information about the catalog items.
" + } + }, + "NextToken": { + "target": "com.amazonaws.outposts#Token" + } + } + }, + "com.amazonaws.outposts#ListOrders": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#ListOrdersInput" + }, + "output": { + "target": "com.amazonaws.outposts#ListOrdersOutput" + }, + "errors": [ + { + "target": "com.amazonaws.outposts#AccessDeniedException" + }, + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + }, + { + "target": "com.amazonaws.outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Create a list of the Outpost orders for your Amazon Web Services account. You can filter your request by Outpost to \n return a more specific list of results.
", + "smithy.api#http": { + "method": "GET", + "uri": "/list-orders", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.outposts#ListOrdersInput": { + "type": "structure", + "members": { + "OutpostIdentifierFilter": { + "target": "com.amazonaws.outposts#OutpostIdentifier", + "traits": { + "smithy.api#documentation": "\n The ID or the Amazon Resource Name (ARN) of the Outpost.\n
", + "smithy.api#httpQuery": "OutpostIdentifierFilter" + } + }, + "NextToken": { + "target": "com.amazonaws.outposts#Token", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.outposts#MaxResults1000", + "traits": { + "smithy.api#httpQuery": "MaxResults" + } + } + } + }, + "com.amazonaws.outposts#ListOrdersOutput": { + "type": "structure", + "members": { + "Orders": { + "target": "com.amazonaws.outposts#OrderSummaryListDefinition", + "traits": { + "smithy.api#documentation": "\n Information about the orders. \n
" + } + }, + "NextToken": { + "target": "com.amazonaws.outposts#Token" + } + } + }, "com.amazonaws.outposts#ListOutposts": { "type": "operation", "input": { @@ -700,7 +1614,7 @@ } ], "traits": { - "smithy.api#documentation": "Create a list of the Outposts for your AWS account. Add filters to your request to return\n a more specific list of results. Use filters to match an Outpost lifecycle status,\n Availibility Zone (us-east-1a), and AZ ID (use1-az1).
If you specify multiple filters, the filters are joined with an AND, and the request returns only \n results that match all of the specified filters.
Create a list of the Outposts for your Amazon Web Services account. Add filters to your request to return\n a more specific list of results. Use filters to match an Outpost lifecycle status,\n Availability Zone (us-east-1a), and AZ ID (use1-az1).
If you specify multiple filters, the filters are joined with an AND, and the request returns only \n results that match all of the specified filters.
\n A filter for the lifecycle status of the Outpost. \n
\n Filter values are case sensitive. If you specify multiple values for a filter, the values\n are joined with an OR, and the request returns all results that match any of the\n specified values.
\n A filter for the lifecycle status of the Outpost. \n
\nFilter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.
A filter for the Availibility Zone (us-east-1a) of the Outpost.
Filter values are case sensitive. If you specify multiple values for a filter, the values\n are joined with an OR, and the request returns all results that match any of the\n specified values.
A filter for the Availability Zone (us-east-1a) of the Outpost.
Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.
\n A filter for the AZ IDs (use1-az1) of the Outpost.\n
Filter values are case sensitive. If you specify multiple values for a filter, the values\n are joined with an OR, and the request returns all results that match any of the\n specified values.
\n A filter for the AZ IDs (use1-az1) of the Outpost.\n
Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.
Lists the sites for the specified AWS account.
", + "smithy.api#documentation": "Lists the sites for your Amazon Web Services account.
", "smithy.api#http": { "method": "GET", "uri": "/sites", @@ -886,27 +1800,126 @@ } } }, - "com.amazonaws.outposts#NotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.outposts#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The specified request is not valid.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } + "com.amazonaws.outposts#MaxSize": { + "type": "string" }, - "com.amazonaws.outposts#Order": { - "type": "structure", - "members": { - "OutpostId": { - "target": "com.amazonaws.outposts#OutpostIdOnly", - "traits": { - "smithy.api#documentation": "\n The ID of the Outpost.\n
" - } + "com.amazonaws.outposts#MaximumSupportedWeightLbs": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NO_LIMIT", + "name": "NO_LIMIT" + }, + { + "value": "MAX_1400_LBS", + "name": "MAX_1400_LBS" + }, + { + "value": "MAX_1600_LBS", + "name": "MAX_1600_LBS" + }, + { + "value": "MAX_1800_LBS", + "name": "MAX_1800_LBS" + }, + { + "value": "MAX_2000_LBS", + "name": "MAX_2000_LBS" + } + ] + } + }, + "com.amazonaws.outposts#Municipality": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 180 + }, + "smithy.api#pattern": "^\\S[\\S ]*$" + } + }, + "com.amazonaws.outposts#NotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.outposts#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The specified request is not valid.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.outposts#OpticalStandard": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "OPTIC_10GBASE_SR", + "name": "OPTIC_10GBASE_SR" + }, + { + "value": "OPTIC_10GBASE_IR", + "name": "OPTIC_10GBASE_IR" + }, + { + "value": "OPTIC_10GBASE_LR", + "name": "OPTIC_10GBASE_LR" + }, + { + "value": "OPTIC_40GBASE_SR", + "name": "OPTIC_40GBASE_SR" + }, + { + "value": "OPTIC_40GBASE_ESR", + "name": "OPTIC_40GBASE_ESR" + }, + { + "value": "OPTIC_40GBASE_IR4_LR4L", + "name": "OPTIC_40GBASE_IR4_LR4L" + }, + { + "value": "OPTIC_40GBASE_LR4", + "name": "OPTIC_40GBASE_LR4" + }, + { + "value": "OPTIC_100GBASE_SR4", + "name": "OPTIC_100GBASE_SR4" + }, + { + "value": "OPTIC_100GBASE_CWDM4", + "name": "OPTIC_100GBASE_CWDM4" + }, + { + "value": "OPTIC_100GBASE_LR4", + "name": "OPTIC_100GBASE_LR4" + }, + { + "value": "OPTIC_100G_PSM4_MSA", + "name": "OPTIC_100G_PSM4_MSA" + }, + { + "value": "OPTIC_1000BASE_LX", + "name": "OPTIC_1000BASE_LX" + }, + { + "value": "OPTIC_1000BASE_SX", + "name": "OPTIC_1000BASE_SX" + } + ] + } + }, + "com.amazonaws.outposts#Order": { + "type": "structure", + "members": { + "OutpostId": { + "target": "com.amazonaws.outposts#OutpostIdOnly", + "traits": { + "smithy.api#documentation": "The ID of the Outpost in the order.
" + } }, "OrderId": { "target": "com.amazonaws.outposts#OrderId", @@ -917,7 +1930,7 @@ "Status": { "target": "com.amazonaws.outposts#OrderStatus", "traits": { - "smithy.api#documentation": "The status of the order
" + "smithy.api#documentation": "The status of the order.
\n\n PREPARING - Order is received and being prepared.
\n IN_PROGRESS - Order is either being built, shipped, or installed. To get more\n details, see the LineItem status.
\n COMPLETED - Order is complete.
\n CANCELLED - Order is cancelled.
\n ERROR - Customer should contact support.
The following status are deprecated: RECEIVED, PENDING,\n PROCESSING, INSTALLING, and FULFILLED.
\n The ID of the Outpost.\n
" + } + }, + "OrderId": { + "target": "com.amazonaws.outposts#OrderId", + "traits": { + "smithy.api#documentation": "\n The ID of the order.\n
" + } + }, + "OrderType": { + "target": "com.amazonaws.outposts#OrderType", + "traits": { + "smithy.api#documentation": "\n The type of order. \n
" + } + }, + "Status": { + "target": "com.amazonaws.outposts#OrderStatus", + "traits": { + "smithy.api#documentation": "The status of the order.
\n\n PREPARING - Order is received and is being prepared.
\n IN_PROGRESS - Order is either being built, shipped, or installed. For more\n information, see the LineItem status.
\n COMPLETED - Order is complete.
\n CANCELLED - Order is cancelled.
\n ERROR - Customer should contact support.
The following statuses are deprecated: RECEIVED, PENDING,\n PROCESSING, INSTALLING, and FULFILLED.
\n The status of all line items in the order. \n
" + } + }, + "OrderSubmissionDate": { + "target": "com.amazonaws.outposts#ISO8601Timestamp", + "traits": { + "smithy.api#documentation": "\n Submission date for the order. \n
" + } + }, + "OrderFulfilledDate": { + "target": "com.amazonaws.outposts#ISO8601Timestamp", + "traits": { + "smithy.api#documentation": "\n Fulfilment date for the order.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n A summary of line items in your order.\n
" + } + }, + "com.amazonaws.outposts#OrderSummaryListDefinition": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#OrderSummary" + } + }, + "com.amazonaws.outposts#OrderType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "OUTPOST", + "name": "OUTPOST" + }, + { + "value": "REPLACEMENT", + "name": "REPLACEMENT" } ] } @@ -996,7 +2096,7 @@ "OutpostId": { "target": "com.amazonaws.outposts#OutpostId", "traits": { - "smithy.api#documentation": "\n The ID of the Outpost.\n
" + "smithy.api#documentation": "The ID of the Outpost.
" } }, "OwnerId": { @@ -1031,6 +2131,12 @@ }, "SiteArn": { "target": "com.amazonaws.outposts#SiteArn" + }, + "SupportedHardwareType": { + "target": "com.amazonaws.outposts#SupportedHardwareType", + "traits": { + "smithy.api#documentation": "\n The hardware type. \n
" + } } }, "traits": { @@ -1102,26 +2208,65 @@ }, "com.amazonaws.outposts#OutpostsOlafService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Outposts", + "arnNamespace": "outposts", + "cloudFormationName": "Outposts", + "cloudTrailEventSource": "outposts.amazonaws.com", + "endpointPrefix": "outposts" + }, + "aws.auth#sigv4": { + "name": "outposts" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Amazon Web Services Outposts is a fully managed service that extends Amazon Web Services infrastructure, APIs, and tools\n to customer premises. By providing local access to Amazon Web Services managed infrastructure, Amazon Web Services Outposts\n enables customers to build and run applications on premises using the same programming\n interfaces as in Amazon Web Services Regions, while using local compute and storage resources for lower\n latency and local data processing needs.
", + "smithy.api#title": "AWS Outposts" + }, "version": "2019-12-03", "operations": [ + { + "target": "com.amazonaws.outposts#CancelOrder" + }, { "target": "com.amazonaws.outposts#CreateOrder" }, { "target": "com.amazonaws.outposts#CreateOutpost" }, + { + "target": "com.amazonaws.outposts#CreateSite" + }, { "target": "com.amazonaws.outposts#DeleteOutpost" }, { "target": "com.amazonaws.outposts#DeleteSite" }, + { + "target": "com.amazonaws.outposts#GetCatalogItem" + }, + { + "target": "com.amazonaws.outposts#GetOrder" + }, { "target": "com.amazonaws.outposts#GetOutpost" }, { "target": "com.amazonaws.outposts#GetOutpostInstanceTypes" }, + { + "target": "com.amazonaws.outposts#GetSite" + }, + { + "target": "com.amazonaws.outposts#GetSiteAddress" + }, + { + "target": "com.amazonaws.outposts#ListCatalogItems" + }, + { + "target": "com.amazonaws.outposts#ListOrders" + }, { "target": "com.amazonaws.outposts#ListOutposts" }, @@ -1136,28 +2281,22 @@ }, { "target": "com.amazonaws.outposts#UntagResource" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "Outposts", - "arnNamespace": "outposts", - "cloudFormationName": "Outposts", - "cloudTrailEventSource": "outposts.amazonaws.com", - "endpointPrefix": "outposts" }, - "aws.auth#sigv4": { - "name": "outposts" + { + "target": "com.amazonaws.outposts#UpdateSite" }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "AWS Outposts is a fully managed service that extends AWS infrastructure, APIs, and tools\n to customer premises. By providing local access to AWS managed infrastructure, AWS Outposts\n enables customers to build and run applications on premises using the same programming\n interfaces as in AWS Regions, while using local compute and storage resources for lower\n latency and local data processing needs.
", - "smithy.api#title": "AWS Outposts" - } + { + "target": "com.amazonaws.outposts#UpdateSiteAddress" + }, + { + "target": "com.amazonaws.outposts#UpdateSiteRackPhysicalProperties" + } + ] }, "com.amazonaws.outposts#OwnerId": { "type": "string", "traits": { - "smithy.api#documentation": "The AWS account ID of the Outpost owner.
", + "smithy.api#documentation": "The Amazon Web Services account ID of the Outpost owner.
", "smithy.api#length": { "min": 12, "max": 12 @@ -1195,63 +2334,244 @@ ] } }, - "com.amazonaws.outposts#ResourceType": { + "com.amazonaws.outposts#PostalCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#pattern": "^[a-zA-Z0-9 -]+$" + } + }, + "com.amazonaws.outposts#PowerConnector": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "OUTPOST", - "name": "OUTPOST" + "value": "L6_30P", + "name": "L6_30P" + }, + { + "value": "IEC309", + "name": "IEC309" + }, + { + "value": "AH530P7W", + "name": "AH530P7W" + }, + { + "value": "AH532P6W", + "name": "AH532P6W" } ] } }, - "com.amazonaws.outposts#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.outposts#ErrorMessage" - } - }, + "com.amazonaws.outposts#PowerDrawKva": { + "type": "string", "traits": { - "smithy.api#documentation": "You have exceeded a service quota.
", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.outposts#Site": { - "type": "structure", - "members": { - "SiteId": { - "target": "com.amazonaws.outposts#SiteId" - }, - "AccountId": { - "target": "com.amazonaws.outposts#AccountId" - }, - "Name": { - "target": "com.amazonaws.outposts#SiteName" - }, - "Description": { - "target": "com.amazonaws.outposts#SiteDescription" - }, - "Tags": { - "target": "com.amazonaws.outposts#TagMap", - "traits": { - "smithy.api#documentation": "The site tags.
" + "smithy.api#enum": [ + { + "value": "POWER_5_KVA", + "name": "POWER_5_KVA" + }, + { + "value": "POWER_10_KVA", + "name": "POWER_10_KVA" + }, + { + "value": "POWER_15_KVA", + "name": "POWER_15_KVA" } - }, - "SiteArn": { - "target": "com.amazonaws.outposts#SiteArn" - } - }, - "traits": { - "smithy.api#documentation": "Information about a site.
" + ] } }, - "com.amazonaws.outposts#SiteArn": { + "com.amazonaws.outposts#PowerFeedDrop": { "type": "string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the site.
", + "smithy.api#enum": [ + { + "value": "ABOVE_RACK", + "name": "ABOVE_RACK" + }, + { + "value": "BELOW_RACK", + "name": "BELOW_RACK" + } + ] + } + }, + "com.amazonaws.outposts#PowerPhase": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SINGLE_PHASE", + "name": "SINGLE_PHASE" + }, + { + "value": "THREE_PHASE", + "name": "THREE_PHASE" + } + ] + } + }, + "com.amazonaws.outposts#Quantity": { + "type": "string" + }, + "com.amazonaws.outposts#RackPhysicalProperties": { + "type": "structure", + "members": { + "PowerDrawKva": { + "target": "com.amazonaws.outposts#PowerDrawKva", + "traits": { + "smithy.api#documentation": "The power draw available at the hardware placement position for the rack.
" + } + }, + "PowerPhase": { + "target": "com.amazonaws.outposts#PowerPhase", + "traits": { + "smithy.api#documentation": "The power option that you can provide for hardware.
" + } + }, + "PowerConnector": { + "target": "com.amazonaws.outposts#PowerConnector", + "traits": { + "smithy.api#documentation": "The power connector for the hardware.
" + } + }, + "PowerFeedDrop": { + "target": "com.amazonaws.outposts#PowerFeedDrop", + "traits": { + "smithy.api#documentation": "The position of the power feed.
" + } + }, + "UplinkGbps": { + "target": "com.amazonaws.outposts#UplinkGbps", + "traits": { + "smithy.api#documentation": "The uplink speed the rack supports for the connection to the Region.
" + } + }, + "UplinkCount": { + "target": "com.amazonaws.outposts#UplinkCount", + "traits": { + "smithy.api#documentation": "The number of uplinks each Outpost network device.
" + } + }, + "FiberOpticCableType": { + "target": "com.amazonaws.outposts#FiberOpticCableType", + "traits": { + "smithy.api#documentation": "The type of fiber used to attach the Outpost to the network.
" + } + }, + "OpticalStandard": { + "target": "com.amazonaws.outposts#OpticalStandard", + "traits": { + "smithy.api#documentation": "The type of optical standard used to attach the Outpost to the network. This field is\n dependent on uplink speed, fiber type, and distance to the upstream device. For more information\n about networking requirements for racks, see Network \n in the Amazon Web Services Outposts User Guide.\n
" + } + }, + "MaximumSupportedWeightLbs": { + "target": "com.amazonaws.outposts#MaximumSupportedWeightLbs", + "traits": { + "smithy.api#documentation": "The maximum rack weight that this site can support. NO_LIMIT is over 2000 lbs\n (907 kg).
Information about the physical and logistical details for racks at sites.\n For more information\n about hardware requirements for racks, see Network \n readiness checklist in the Amazon Web Services Outposts User Guide.\n
" + } + }, + "com.amazonaws.outposts#ResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "OUTPOST", + "name": "OUTPOST" + }, + { + "value": "ORDER", + "name": "ORDER" + } + ] + } + }, + "com.amazonaws.outposts#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.outposts#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "You have exceeded a service quota.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.outposts#Site": { + "type": "structure", + "members": { + "SiteId": { + "target": "com.amazonaws.outposts#SiteId" + }, + "AccountId": { + "target": "com.amazonaws.outposts#AccountId" + }, + "Name": { + "target": "com.amazonaws.outposts#SiteName" + }, + "Description": { + "target": "com.amazonaws.outposts#SiteDescription" + }, + "Tags": { + "target": "com.amazonaws.outposts#TagMap", + "traits": { + "smithy.api#documentation": "The site tags.
" + } + }, + "SiteArn": { + "target": "com.amazonaws.outposts#SiteArn" + }, + "Notes": { + "target": "com.amazonaws.outposts#SiteNotes", + "traits": { + "smithy.api#documentation": "\n Notes about a site. \n
" + } + }, + "OperatingAddressCountryCode": { + "target": "com.amazonaws.outposts#CountryCode", + "traits": { + "smithy.api#documentation": "\n The ISO-3166 two-letter country code where the hardware is installed and powered on.\n
" + } + }, + "OperatingAddressStateOrRegion": { + "target": "com.amazonaws.outposts#StateOrRegion", + "traits": { + "smithy.api#documentation": "State or region where the hardware is installed and powered on.
" + } + }, + "OperatingAddressCity": { + "target": "com.amazonaws.outposts#City", + "traits": { + "smithy.api#documentation": "\n City where the hardware is installed and powered on.\n
" + } + }, + "RackPhysicalProperties": { + "target": "com.amazonaws.outposts#RackPhysicalProperties", + "traits": { + "smithy.api#documentation": "\n Information about the physical and logistical details for a rack at the site.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a site.
" + } + }, + "com.amazonaws.outposts#SiteArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the site.
", "smithy.api#length": { "min": 1, "max": 255 @@ -1292,6 +2612,16 @@ "smithy.api#pattern": "^[\\S ]+$" } }, + "com.amazonaws.outposts#SiteNotes": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + }, + "smithy.api#pattern": "^[\\S \\n]+$" + } + }, "com.amazonaws.outposts#SkuCode": { "type": "string", "traits": { @@ -1302,14 +2632,14 @@ "smithy.api#pattern": "^OR-[A-Z0-9]{7}$" } }, - "com.amazonaws.outposts#Status": { + "com.amazonaws.outposts#StateOrRegion": { "type": "string", "traits": { "smithy.api#length": { "min": 1, - "max": 1000 + "max": 50 }, - "smithy.api#pattern": "^[\\S ]+$" + "smithy.api#pattern": "^\\S[\\S ]*$" } }, "com.amazonaws.outposts#String": { @@ -1322,6 +2652,51 @@ "smithy.api#pattern": "^[\\S \\n]+$" } }, + "com.amazonaws.outposts#SupportedHardwareType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RACK", + "name": "RACK" + }, + { + "value": "SERVER", + "name": "SERVER" + } + ] + } + }, + "com.amazonaws.outposts#SupportedStorageEnum": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EBS", + "name": "EBS" + }, + { + "value": "S3", + "name": "S3" + } + ] + } + }, + "com.amazonaws.outposts#SupportedStorageList": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#SupportedStorageEnum" + } + }, + "com.amazonaws.outposts#SupportedUplinkGbps": { + "type": "integer" + }, + "com.amazonaws.outposts#SupportedUplinkGbpsListDefinition": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#SupportedUplinkGbps" + } + }, "com.amazonaws.outposts#TagKey": { "type": "string", "traits": { @@ -1485,6 +2860,327 @@ "type": "structure", "members": {} }, + "com.amazonaws.outposts#UpdateSite": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#UpdateSiteInput" + }, + "output": { + "target": "com.amazonaws.outposts#UpdateSiteOutput" + }, + "errors": [ + { + "target": "com.amazonaws.outposts#AccessDeniedException" + }, + { + "target": "com.amazonaws.outposts#ConflictException" + }, + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + }, + { + "target": "com.amazonaws.outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Updates the site. \n
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/sites/{SiteId}", + "code": 200 + } + } + }, + "com.amazonaws.outposts#UpdateSiteAddress": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#UpdateSiteAddressInput" + }, + "output": { + "target": "com.amazonaws.outposts#UpdateSiteAddressOutput" + }, + "errors": [ + { + "target": "com.amazonaws.outposts#AccessDeniedException" + }, + { + "target": "com.amazonaws.outposts#ConflictException" + }, + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + }, + { + "target": "com.amazonaws.outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Updates the site address. \n
\n\n To update a site address\n with an order IN_PROGRESS, you must wait for the order \n to complete or cancel the order. \n
You \n can update the operating address before you place an order at the \n site, or after all Outposts that belong to the site have been deactivated.\n
", + "smithy.api#http": { + "method": "PUT", + "uri": "/sites/{SiteId}/address", + "code": 200 + } + } + }, + "com.amazonaws.outposts#UpdateSiteAddressInput": { + "type": "structure", + "members": { + "SiteId": { + "target": "com.amazonaws.outposts#SiteId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AddressType": { + "target": "com.amazonaws.outposts#AddressType", + "traits": { + "smithy.api#documentation": "\n The type of the address.\n
", + "smithy.api#required": {} + } + }, + "Address": { + "target": "com.amazonaws.outposts#Address", + "traits": { + "smithy.api#documentation": "\n The address for the site.\n
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.outposts#UpdateSiteAddressOutput": { + "type": "structure", + "members": { + "AddressType": { + "target": "com.amazonaws.outposts#AddressType", + "traits": { + "smithy.api#documentation": "\n The type of the address.\n
" + } + }, + "Address": { + "target": "com.amazonaws.outposts#Address", + "traits": { + "smithy.api#documentation": "\n Information about an address. \n
" + } + } + } + }, + "com.amazonaws.outposts#UpdateSiteInput": { + "type": "structure", + "members": { + "SiteId": { + "target": "com.amazonaws.outposts#SiteId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.outposts#SiteName" + }, + "Description": { + "target": "com.amazonaws.outposts#SiteDescription" + }, + "Notes": { + "target": "com.amazonaws.outposts#SiteNotes", + "traits": { + "smithy.api#documentation": "\n Notes about a site.\n
" + } + } + } + }, + "com.amazonaws.outposts#UpdateSiteOutput": { + "type": "structure", + "members": { + "Site": { + "target": "com.amazonaws.outposts#Site" + } + } + }, + "com.amazonaws.outposts#UpdateSiteRackPhysicalProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#UpdateSiteRackPhysicalPropertiesInput" + }, + "output": { + "target": "com.amazonaws.outposts#UpdateSiteRackPhysicalPropertiesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.outposts#AccessDeniedException" + }, + { + "target": "com.amazonaws.outposts#ConflictException" + }, + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + }, + { + "target": "com.amazonaws.outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Update the physical and logistical details for a rack at a site. For more information\n about hardware requirements for racks, see Network \n readiness checklist in the Amazon Web Services Outposts User Guide.\n
\nTo update a rack at a site with an order of IN_PROGRESS, you must wait for\n the order to complete or cancel the order.
Specify in kVA the power draw available at the hardware placement position for the\n rack.
" + } + }, + "PowerPhase": { + "target": "com.amazonaws.outposts#PowerPhase", + "traits": { + "smithy.api#documentation": "Specify the power option that you can provide for hardware.
\nSingle-phase AC feed: 200 V to 277 V, 50 Hz or 60 Hz
\nThree-phase AC feed: 346 V to 480 V, 50 Hz or 60 Hz
\n Specify the power connector that Amazon Web Services should plan to provide for connections to the\n hardware. Note the correlation between PowerPhase and\n PowerConnector.
Single-phase AC feed
\n\n L6-30P – (common in US); 30A; single phase
\n\n IEC309 (blue) – P+N+E, 6hr; 32 A; single\n phase
\nThree-phase AC feed
\n\n AH530P7W (red) – 3P+N+E, 7hr; 30A; three\n phase
\n\n AH532P6W (red) – 3P+N+E, 6hr; 32A; three\n phase
\nSpecify whether the power feed comes above or below the rack.
" + } + }, + "UplinkGbps": { + "target": "com.amazonaws.outposts#UplinkGbps", + "traits": { + "smithy.api#documentation": "Specify the uplink speed the rack should support for the connection to the Region.\n
" + } + }, + "UplinkCount": { + "target": "com.amazonaws.outposts#UplinkCount", + "traits": { + "smithy.api#documentation": "Racks come with two Outpost network devices. Depending on the supported uplink speed at\n the site, the Outpost network devices provide a variable number of uplinks. Specify the number\n of uplinks for each Outpost network device that you intend to use to connect the rack to your\n network. Note the correlation between UplinkGbps and UplinkCount.
1Gbps - Uplinks available: 1, 2, 4, 6, 8
\n10Gbps - Uplinks available: 1, 2, 4, 8, 12, 16
\n40 and 100 Gbps- Uplinks available: 1, 2, 4
\nSpecify the type of fiber that you will use to attach the Outpost to your network.\n
" + } + }, + "OpticalStandard": { + "target": "com.amazonaws.outposts#OpticalStandard", + "traits": { + "smithy.api#documentation": "Specify the type of optical standard that you will use to attach the Outpost to your\n network. This field is dependent on uplink speed, fiber type, and distance to the upstream\n device. For more information\n about networking requirements for racks, see Network \n in the Amazon Web Services Outposts User Guide.\n
\n\n OPTIC_10GBASE_SR: 10GBASE-SR
\n OPTIC_10GBASE_IR: 10GBASE-IR
\n OPTIC_10GBASE_LR: 10GBASE-LR
\n OPTIC_40GBASE_SR: 40GBASE-SR
\n OPTIC_40GBASE_ESR: 40GBASE-ESR
\n OPTIC_40GBASE_IR4_LR4L: 40GBASE-IR (LR4L)
\n OPTIC_40GBASE_LR4: 40GBASE-LR4
\n OPTIC_100GBASE_SR4: 100GBASE-SR4
\n OPTIC_100GBASE_CWDM4: 100GBASE-CWDM4
\n OPTIC_100GBASE_LR4: 100GBASE-LR4
\n OPTIC_100G_PSM4_MSA: 100G PSM4 MSA
\n OPTIC_1000BASE_LX: 1000Base-LX
\n OPTIC_1000BASE_SX : 1000Base-SX
Specify the maximum rack weight that this site can support. NO_LIMIT is over\n 2000lbs.
Returns a list of recommended items. The required input depends on the recipe type used to\n create the solution backing the campaign, as follows:
\nRELATED_ITEMS - itemId required, userId not used
USER_PERSONALIZATION - itemId optional, userId\n required
Campaigns that are backed by a solution created using a recipe of type\n PERSONALIZED_RANKING use the API.
\nReturns a list of recommended items. For campaigns, the campaign's Amazon Resource Name (ARN) is required and the required user and item input depends on the recipe type used to\n create the solution backing the campaign as follows:
\nUSER_PERSONALIZATION - userId required, itemId not used
RELATED_ITEMS - itemId required, userId not used
Campaigns that are backed by a solution created using a recipe of type\n PERSONALIZED_RANKING use the API.
\n\n For recommenders, the recommender's ARN is required and the required item and user input depends on the use case (domain-based recipe) backing the recommender.\n For information on use case requirements see Choosing recommender use cases.\n
", "smithy.api#http": { "method": "POST", "uri": "/recommendations", @@ -258,8 +258,7 @@ "campaignArn": { "target": "com.amazonaws.personalizeruntime#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.
" } }, "itemId": { @@ -297,6 +296,12 @@ "traits": { "smithy.api#documentation": "The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case)\n as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.\n
\nFor filter expressions that use an INCLUDE element to include items,\n you must provide values for all parameters that are defined in the expression. For\n filters with expressions that use an EXCLUDE element to exclude items, you\n can omit the filter-values.In this case, Amazon Personalize doesn't use that portion of\n the expression to filter recommendations.
For more information, see\n Filtering Recommendations.
" } + }, + "recommenderArn": { + "target": "com.amazonaws.personalizeruntime#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you\n created a Domain dataset group with a recommender for a domain use case.
" + } } } }, @@ -306,7 +311,7 @@ "itemList": { "target": "com.amazonaws.personalizeruntime#ItemList", "traits": { - "smithy.api#documentation": "A list of recommendations sorted in ascending order by prediction score. There can be a\n maximum of 500 items in the list.
" + "smithy.api#documentation": "A list of recommendations sorted in descending order by prediction score. There can be a\n maximum of 500 items in the list.
" } }, "recommendationId": { diff --git a/aws/sdk/aws-models/personalize.json b/aws/sdk/aws-models/personalize.json index e1f2d9ca9aa223be0c05c1020f1ab9afcf55a357..a50cd4961ac3e580598fc16ff6230e080ec8d991 100644 --- a/aws/sdk/aws-models/personalize.json +++ b/aws/sdk/aws-models/personalize.json @@ -129,11 +129,29 @@ }, "com.amazonaws.personalize#AmazonPersonalize": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Personalize", + "arnNamespace": "personalize", + "cloudFormationName": "Personalize", + "cloudTrailEventSource": "personalize.amazonaws.com", + "endpointPrefix": "personalize" + }, + "aws.auth#sigv4": { + "name": "personalize" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Amazon Personalize is a machine learning service that makes it easy to add individualized\n recommendations to customers.
", + "smithy.api#title": "Amazon Personalize" + }, "version": "2018-05-22", "operations": [ { "target": "com.amazonaws.personalize#CreateBatchInferenceJob" }, + { + "target": "com.amazonaws.personalize#CreateBatchSegmentJob" + }, { "target": "com.amazonaws.personalize#CreateCampaign" }, @@ -155,6 +173,9 @@ { "target": "com.amazonaws.personalize#CreateFilter" }, + { + "target": "com.amazonaws.personalize#CreateRecommender" + }, { "target": "com.amazonaws.personalize#CreateSchema" }, @@ -179,6 +200,9 @@ { "target": "com.amazonaws.personalize#DeleteFilter" }, + { + "target": "com.amazonaws.personalize#DeleteRecommender" + }, { "target": "com.amazonaws.personalize#DeleteSchema" }, @@ -191,6 +215,9 @@ { "target": "com.amazonaws.personalize#DescribeBatchInferenceJob" }, + { + "target": "com.amazonaws.personalize#DescribeBatchSegmentJob" + }, { "target": "com.amazonaws.personalize#DescribeCampaign" }, @@ -218,6 +245,9 @@ { "target": "com.amazonaws.personalize#DescribeRecipe" }, + { + "target": "com.amazonaws.personalize#DescribeRecommender" + }, { "target": "com.amazonaws.personalize#DescribeSchema" }, @@ -233,6 +263,9 @@ { "target": "com.amazonaws.personalize#ListBatchInferenceJobs" }, + { + "target": "com.amazonaws.personalize#ListBatchSegmentJobs" + }, { "target": "com.amazonaws.personalize#ListCampaigns" }, @@ -257,6 +290,9 @@ { "target": "com.amazonaws.personalize#ListRecipes" }, + { + "target": "com.amazonaws.personalize#ListRecommenders" + }, { "target": "com.amazonaws.personalize#ListSchemas" }, @@ -271,23 +307,11 @@ }, { "target": "com.amazonaws.personalize#UpdateCampaign" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "Personalize", - "arnNamespace": "personalize", - "cloudFormationName": "Personalize", - "cloudTrailEventSource": "personalize.amazonaws.com", - "endpointPrefix": "personalize" - }, - "aws.auth#sigv4": { - "name": "personalize" }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Personalize is a machine learning service that makes it easy to add individualized\n recommendations to customers.
", - "smithy.api#title": "Amazon Personalize" - } + { + "target": "com.amazonaws.personalize#UpdateRecommender" + } + ] }, "com.amazonaws.personalize#Arn": { "type": "string", @@ -546,6 +570,176 @@ } } }, + "com.amazonaws.personalize#BatchSegmentJob": { + "type": "structure", + "members": { + "jobName": { + "target": "com.amazonaws.personalize#Name", + "traits": { + "smithy.api#documentation": "The name of the batch segment job.
" + } + }, + "batchSegmentJobArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the batch segment job.
" + } + }, + "filterArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the filter used on the batch segment job.
" + } + }, + "failureReason": { + "target": "com.amazonaws.personalize#FailureReason", + "traits": { + "smithy.api#documentation": "If the batch segment job failed, the reason for the failure.
" + } + }, + "solutionVersionArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
" + } + }, + "numResults": { + "target": "com.amazonaws.personalize#NumBatchResults", + "traits": { + "smithy.api#documentation": "The number of predicted users generated by the batch segment job for each line of input data.
" + } + }, + "jobInput": { + "target": "com.amazonaws.personalize#BatchSegmentJobInput", + "traits": { + "smithy.api#documentation": "The Amazon S3 path that leads to the input data used to generate the batch segment job.
" + } + }, + "jobOutput": { + "target": "com.amazonaws.personalize#BatchSegmentJobOutput", + "traits": { + "smithy.api#documentation": "The Amazon S3 bucket that contains the output data generated by the batch segment job.
" + } + }, + "roleArn": { + "target": "com.amazonaws.personalize#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
" + } + }, + "status": { + "target": "com.amazonaws.personalize#Status", + "traits": { + "smithy.api#documentation": "The status of the batch segment job. The status is one of the following values:
\nPENDING
\nIN PROGRESS
\nACTIVE
\nCREATE FAILED
\nThe time at which the batch segment job was created.
" + } + }, + "lastUpdatedDateTime": { + "target": "com.amazonaws.personalize#Date", + "traits": { + "smithy.api#documentation": "The time at which the batch segment job last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on a batch segment job.
" + } + }, + "com.amazonaws.personalize#BatchSegmentJobInput": { + "type": "structure", + "members": { + "s3DataSource": { + "target": "com.amazonaws.personalize#S3DataConfig", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input configuration of a batch segment job.
" + } + }, + "com.amazonaws.personalize#BatchSegmentJobOutput": { + "type": "structure", + "members": { + "s3DataDestination": { + "target": "com.amazonaws.personalize#S3DataConfig", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The output configuration parameters of a batch segment job.
" + } + }, + "com.amazonaws.personalize#BatchSegmentJobSummary": { + "type": "structure", + "members": { + "batchSegmentJobArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the batch segment job.
" + } + }, + "jobName": { + "target": "com.amazonaws.personalize#Name", + "traits": { + "smithy.api#documentation": "The name of the batch segment job.
" + } + }, + "status": { + "target": "com.amazonaws.personalize#Status", + "traits": { + "smithy.api#documentation": "The status of the batch segment job. The status is one of the following values:
\nPENDING
\nIN PROGRESS
\nACTIVE
\nCREATE FAILED
\nThe time at which the batch segment job was created.
" + } + }, + "lastUpdatedDateTime": { + "target": "com.amazonaws.personalize#Date", + "traits": { + "smithy.api#documentation": "The time at which the batch segment job was last updated.
" + } + }, + "failureReason": { + "target": "com.amazonaws.personalize#FailureReason", + "traits": { + "smithy.api#documentation": "If the batch segment job failed, the reason for the failure.
" + } + }, + "solutionVersionArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A truncated version of the BatchSegmentJob datatype. The ListBatchSegmentJobs operation returns a list of batch segment job\n summaries.
" + } + }, + "com.amazonaws.personalize#BatchSegmentJobs": { + "type": "list", + "member": { + "target": "com.amazonaws.personalize#BatchSegmentJobSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.personalize#Boolean": { "type": "boolean", "traits": { @@ -614,7 +808,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes a deployed solution version, otherwise known as a campaign.\n For more information on campaigns, see CreateCampaign.
" + "smithy.api#documentation": "An object that describes the deployment of a solution version.\n For more information on campaigns, see CreateCampaign.
" } }, "com.amazonaws.personalize#CampaignConfig": { @@ -623,7 +817,7 @@ "itemExplorationConfig": { "target": "com.amazonaws.personalize#HyperParameters", "traits": { - "smithy.api#documentation": "A string to string map specifying the exploration configuration hyperparameters, including explorationWeight and \n explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when\n recommending items. Provide itemExplorationConfig data only if your solution uses the\n User-Personalization recipe.
Specifies the exploration configuration hyperparameters, including explorationWeight and \n explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when\n recommending items. Provide itemExplorationConfig data only if your solution uses the\n User-Personalization recipe.
Creates a batch segment job. The operation can handle up to 50 million records and the\n input file must be in JSON format. For more information, see recommendations-batch.
" + } + }, + "com.amazonaws.personalize#CreateBatchSegmentJobRequest": { + "type": "structure", + "members": { + "jobName": { + "target": "com.amazonaws.personalize#Name", + "traits": { + "smithy.api#documentation": "The name of the batch segment job to create.
", + "smithy.api#required": {} + } + }, + "solutionVersionArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate\n batch segments.
", + "smithy.api#required": {} + } + }, + "filterArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the filter to apply to the batch segment job. For more information on using\n filters, see filter-batch.
" + } + }, + "numResults": { + "target": "com.amazonaws.personalize#NumBatchResults", + "traits": { + "smithy.api#documentation": "The number of predicted users generated by the batch segment job for each line of input data.
" + } + }, + "jobInput": { + "target": "com.amazonaws.personalize#BatchSegmentJobInput", + "traits": { + "smithy.api#documentation": "The Amazon S3 path for the input data used to generate the batch segment job.
", + "smithy.api#required": {} + } + }, + "jobOutput": { + "target": "com.amazonaws.personalize#BatchSegmentJobOutput", + "traits": { + "smithy.api#documentation": "The Amazon S3 path for the bucket where the job's output will be stored.
", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.personalize#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output\n Amazon S3 buckets respectively.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.personalize#CreateBatchSegmentJobResponse": { + "type": "structure", + "members": { + "batchSegmentJobArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the batch segment job.
" + } + } + } + }, "com.amazonaws.personalize#CreateCampaign": { "type": "operation", "input": { @@ -965,7 +1251,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a campaign by deploying a solution version. When a client calls the\n GetRecommendations\n and\n GetPersonalizedRanking\n APIs, a campaign is specified in the request.
\n\n\n Minimum Provisioned TPS and Auto-Scaling\n
\n \nA transaction is a single GetRecommendations or\n GetPersonalizedRanking call. Transactions per second (TPS) is the throughput\n and unit of billing for Amazon Personalize. The minimum provisioned TPS\n (minProvisionedTPS) specifies the baseline throughput provisioned by\n Amazon Personalize, and thus, the minimum billing charge. \n
\n If your TPS increases beyond\n minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down,\n but never below minProvisionedTPS.\n There's a short time delay while the capacity is increased that might cause loss of\n transactions.
The actual TPS used is calculated as the average requests/second within a 5-minute window.\n You pay for maximum of either the minimum provisioned TPS or the actual TPS.\n We recommend starting with a low minProvisionedTPS, track\n your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS\n as necessary.
\n Status\n
\nA campaign can be in one of the following states:
\nCREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
\nDELETE PENDING > DELETE IN_PROGRESS
\nTo get the campaign status, call DescribeCampaign.
\nWait until the status of the campaign\n is ACTIVE before asking the campaign for recommendations.
\n Related APIs\n
\n\n ListCampaigns\n
\n\n DescribeCampaign\n
\n\n UpdateCampaign\n
\n\n DeleteCampaign\n
\nCreates a campaign that deploys a solution version. When a client calls the\n GetRecommendations\n and\n GetPersonalizedRanking\n APIs, a campaign is specified in the request.
\n\n\n Minimum Provisioned TPS and Auto-Scaling\n
\n \nA transaction is a single GetRecommendations or\n GetPersonalizedRanking call. Transactions per second (TPS) is the throughput\n and unit of billing for Amazon Personalize. The minimum provisioned TPS\n (minProvisionedTPS) specifies the baseline throughput provisioned by\n Amazon Personalize, and thus, the minimum billing charge. \n
\n If your TPS increases beyond\n minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down,\n but never below minProvisionedTPS.\n There's a short time delay while the capacity is increased that might cause loss of\n transactions.
The actual TPS used is calculated as the average requests/second within a 5-minute window.\n You pay for maximum of either the minimum provisioned TPS or the actual TPS.\n We recommend starting with a low minProvisionedTPS, track\n your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS\n as necessary.
\n Status\n
\nA campaign can be in one of the following states:
\nCREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
\nDELETE PENDING > DELETE IN_PROGRESS
\nTo get the campaign status, call DescribeCampaign.
\nWait until the status of the campaign\n is ACTIVE before asking the campaign for recommendations.
\n Related APIs\n
\n\n ListCampaigns\n
\n\n DescribeCampaign\n
\n\n UpdateCampaign\n
\n\n DeleteCampaign\n
\nCreates an empty dataset group. A dataset group contains related datasets that supply data\n for training a model. A dataset group can contain at most three datasets, one for each type of\n dataset:
\nInteractions
\nItems
\nUsers
\nTo train a model (create a solution), a dataset group that contains an\n Interactions dataset is required. Call CreateDataset to add a\n dataset to the group.
A dataset group can be in one of the following states:
\nCREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
\nDELETE PENDING
\nTo get the status of the dataset group, call DescribeDatasetGroup. If\n the status shows as CREATE FAILED, the response includes a failureReason key,\n which describes why the creation failed.
You must wait until the status of the dataset group is ACTIVE\n before adding a dataset to the group.
You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you\n specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to\n access the key.
\n\n APIs that require a dataset group ARN in the request\n
\n\n CreateDataset\n
\n\n CreateEventTracker\n
\n\n CreateSolution\n
\n\n Related APIs\n
\n\n ListDatasetGroups\n
\n\n DescribeDatasetGroup\n
\n\n DeleteDatasetGroup\n
\nCreates an empty dataset group. A dataset group is a container for Amazon Personalize resources. \n A dataset group can contain at most three datasets, one for each type of\n dataset:
\nInteractions
\nItems
\nUsers
\n\n A dataset group can be a Domain dataset group, where you specify a domain and use\n pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that\n you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as\n solutions and solution versions trained with recipes for custom use cases and deployed with campaigns.\n
\nA dataset group can be in one of the following states:
\nCREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
\nDELETE PENDING
\nTo get the status of the dataset group, call DescribeDatasetGroup. If\n the status shows as CREATE FAILED, the response includes a failureReason key,\n which describes why the creation failed.
You must wait until the status of the dataset group is ACTIVE\n before adding a dataset to the group.
You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you\n specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to\n access the key.
\n\n APIs that require a dataset group ARN in the request\n
\n\n CreateDataset\n
\n\n CreateEventTracker\n
\n\n CreateSolution\n
\n\n Related APIs\n
\n\n ListDatasetGroups\n
\n\n DescribeDatasetGroup\n
\n\n DeleteDatasetGroup\n
\nThe Amazon Resource Name (ARN) of a Key Management Service (KMS) key used to encrypt the datasets.
" } + }, + "domain": { + "target": "com.amazonaws.personalize#Domain", + "traits": { + "smithy.api#documentation": "The domain of the dataset group. Specify a domain to create a Domain dataset group. The domain you specify \n determines the default schemas for datasets and the use cases available for recommenders. If you don't specify a domain,\n you create a Custom dataset group with solution versions that you deploy with a campaign.\n
" + } } } }, @@ -1176,6 +1468,12 @@ "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the new dataset group.
" } + }, + "domain": { + "target": "com.amazonaws.personalize#Domain", + "traits": { + "smithy.api#documentation": "The domain for the new Domain dataset group.
" + } } } }, @@ -1425,6 +1723,76 @@ } } }, + "com.amazonaws.personalize#CreateRecommender": { + "type": "operation", + "input": { + "target": "com.amazonaws.personalize#CreateRecommenderRequest" + }, + "output": { + "target": "com.amazonaws.personalize#CreateRecommenderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.personalize#InvalidInputException" + }, + { + "target": "com.amazonaws.personalize#LimitExceededException" + }, + { + "target": "com.amazonaws.personalize#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.personalize#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a recommender with the recipe (a Domain dataset group use case) you specify. \n You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a\n GetRecommendations\n request.\n
\n \n \n \n\n Status\n
\nA recommender can be in one of the following states:
\nCREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
\nDELETE PENDING > DELETE IN_PROGRESS
\nTo get the recommender status, call DescribeRecommender.
\nWait until the status of the recommender\n is ACTIVE before asking the recommender for recommendations.
\n Related APIs\n
\n\n ListRecommenders\n
\n\n DescribeRecommender\n
\n\n UpdateRecommender\n
\n\n DeleteRecommender\n
\nThe name of the recommender.
", + "smithy.api#required": {} + } + }, + "datasetGroupArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.
", + "smithy.api#required": {} + } + }, + "recipeArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group\n use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see Choosing recommender use cases.\n
", + "smithy.api#required": {} + } + }, + "recommenderConfig": { + "target": "com.amazonaws.personalize#RecommenderConfig", + "traits": { + "smithy.api#documentation": "The configuration details of the recommender.
" + } + } + } + }, + "com.amazonaws.personalize#CreateRecommenderResponse": { + "type": "structure", + "members": { + "recommenderArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recommender.
" + } + } + } + }, "com.amazonaws.personalize#CreateSchema": { "type": "operation", "input": { @@ -1445,7 +1813,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Amazon Personalize schema from the specified schema string. The schema you create\n must be in Avro JSON format.
\nAmazon Personalize recognizes three schema variants. Each schema is associated with a dataset\n type and has a set of required field and keywords.\n You specify a schema when you call CreateDataset.
\n \n\n Related APIs\n
\n\n ListSchemas\n
\n\n DescribeSchema\n
\n\n DeleteSchema\n
\nCreates an Amazon Personalize schema from the specified schema string. The schema you create\n must be in Avro JSON format.
\nAmazon Personalize recognizes three schema variants. Each schema is associated with a dataset\n type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you\n provide the domain of the Domain dataset group.\n You specify a schema when you call CreateDataset.
\n \n\n Related APIs\n
\n\n ListSchemas\n
\n\n DescribeSchema\n
\n\n DeleteSchema\n
\nA schema in Avro JSON format.
", "smithy.api#required": {} } + }, + "domain": { + "target": "com.amazonaws.personalize#Domain", + "traits": { + "smithy.api#documentation": "The domain for the schema. If you are creating a schema for a dataset in a Domain dataset group, specify\n the domain you chose when you created the Domain dataset group.
" + } } } }, @@ -1591,7 +1965,7 @@ } ], "traits": { - "smithy.api#documentation": "Trains or retrains an active solution. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling\n CreateSolutionVersion. A new version of the solution is created every time you\n call this operation.
\n Status\n
\nA solution version can be in one of the following states:
\nCREATE PENDING
\nCREATE IN_PROGRESS
\nACTIVE
\nCREATE FAILED
\nCREATE STOPPING
\nCREATE STOPPED
\nTo get the status of the version, call DescribeSolutionVersion. Wait\n until the status shows as ACTIVE before calling CreateCampaign.
If the status shows as CREATE FAILED, the response includes a failureReason\n key, which describes why the job failed.
\n Related APIs\n
\n\n ListSolutionVersions\n
\n\n ListSolutions\n
\n\n CreateSolution\n
\n\n DescribeSolution\n
\n\n DeleteSolution\n
\nTrains or retrains an active solution in a Custom dataset group. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling\n CreateSolutionVersion. A new version of the solution is created every time you\n call this operation.
\n Status\n
\nA solution version can be in one of the following states:
\nCREATE PENDING
\nCREATE IN_PROGRESS
\nACTIVE
\nCREATE FAILED
\nCREATE STOPPING
\nCREATE STOPPED
\nTo get the status of the version, call DescribeSolutionVersion. Wait\n until the status shows as ACTIVE before calling CreateCampaign.
If the status shows as CREATE FAILED, the response includes a failureReason\n key, which describes why the job failed.
\n Related APIs\n
\n\n ListSolutionVersions\n
\n\n ListSolutions\n
\n\n CreateSolution\n
\n\n DescribeSolution\n
\n\n DeleteSolution\n
\nIf creating a dataset group fails, provides the reason why.
" } + }, + "domain": { + "target": "com.amazonaws.personalize#Domain", + "traits": { + "smithy.api#documentation": "The domain of a Domain dataset group.
" + } } }, "traits": { @@ -1925,6 +2305,12 @@ "traits": { "smithy.api#documentation": "If creating a dataset group fails, the reason behind the failure.
" } + }, + "domain": { + "target": "com.amazonaws.personalize#Domain", + "traits": { + "smithy.api#documentation": "The domain of a Domain dataset group.
" + } } }, "traits": { @@ -2093,6 +2479,12 @@ "traits": { "smithy.api#documentation": "The date and time (in Unix time) that the schema was last updated.
" } + }, + "domain": { + "target": "com.amazonaws.personalize#Domain", + "traits": { + "smithy.api#documentation": "The domain of a schema that you created for a dataset in a Domain dataset group.
" + } } }, "traits": { @@ -2125,6 +2517,12 @@ "traits": { "smithy.api#documentation": "The date and time (in Unix time) that the schema was last updated.
" } + }, + "domain": { + "target": "com.amazonaws.personalize#Domain", + "traits": { + "smithy.api#documentation": "The domain of a schema that you created for a dataset in a Domain dataset group.
" + } } }, "traits": { @@ -2515,6 +2913,39 @@ } } }, + "com.amazonaws.personalize#DeleteRecommender": { + "type": "operation", + "input": { + "target": "com.amazonaws.personalize#DeleteRecommenderRequest" + }, + "errors": [ + { + "target": "com.amazonaws.personalize#InvalidInputException" + }, + { + "target": "com.amazonaws.personalize#ResourceInUseException" + }, + { + "target": "com.amazonaws.personalize#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations\n request.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.personalize#DeleteRecommenderRequest": { + "type": "structure", + "members": { + "recommenderArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recommender to delete.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.personalize#DeleteSchema": { "type": "operation", "input": { @@ -2669,6 +3100,50 @@ } } }, + "com.amazonaws.personalize#DescribeBatchSegmentJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.personalize#DescribeBatchSegmentJobRequest" + }, + "output": { + "target": "com.amazonaws.personalize#DescribeBatchSegmentJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.personalize#InvalidInputException" + }, + { + "target": "com.amazonaws.personalize#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the properties of a batch segment job including name, Amazon Resource Name (ARN),\n status, input and output configurations, and the ARN of the solution version used to generate\n segments.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.personalize#DescribeBatchSegmentJobRequest": { + "type": "structure", + "members": { + "batchSegmentJobArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the batch segment job to describe.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.personalize#DescribeBatchSegmentJobResponse": { + "type": "structure", + "members": { + "batchSegmentJob": { + "target": "com.amazonaws.personalize#BatchSegmentJob", + "traits": { + "smithy.api#documentation": "Information on the specified batch segment job.
" + } + } + } + }, "com.amazonaws.personalize#DescribeCampaign": { "type": "operation", "input": { @@ -3065,6 +3540,50 @@ } } }, + "com.amazonaws.personalize#DescribeRecommender": { + "type": "operation", + "input": { + "target": "com.amazonaws.personalize#DescribeRecommenderRequest" + }, + "output": { + "target": "com.amazonaws.personalize#DescribeRecommenderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.personalize#InvalidInputException" + }, + { + "target": "com.amazonaws.personalize#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the given recommender, including its status.
\nA recommender can be in one of the following states:
\nCREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
\nDELETE PENDING > DELETE IN_PROGRESS
\nWhen the status is CREATE FAILED, the response includes the\n failureReason key, which describes why.
For more information on recommenders, see CreateRecommender.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.personalize#DescribeRecommenderRequest": { + "type": "structure", + "members": { + "recommenderArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recommender to describe.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.personalize#DescribeRecommenderResponse": { + "type": "structure", + "members": { + "recommender": { + "target": "com.amazonaws.personalize#Recommender", + "traits": { + "smithy.api#documentation": "The properties of the recommender.
" + } + } + } + }, "com.amazonaws.personalize#DescribeSchema": { "type": "operation", "input": { @@ -3209,6 +3728,21 @@ } } }, + "com.amazonaws.personalize#Domain": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ECOMMERCE", + "name": "ECOMMERCE" + }, + { + "value": "VIDEO_ON_DEMAND", + "name": "VIDEO_ON_DEMAND" + } + ] + } + }, "com.amazonaws.personalize#ErrorMessage": { "type": "string" }, @@ -3835,6 +4369,10 @@ "com.amazonaws.personalize#KmsKeyArn": { "type": "string", "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, "smithy.api#pattern": "^arn:aws.*:kms:.*:[0-9]{12}:key/" } }, @@ -3857,7 +4395,74 @@ "target": "com.amazonaws.personalize#ListBatchInferenceJobsRequest" }, "output": { - "target": "com.amazonaws.personalize#ListBatchInferenceJobsResponse" + "target": "com.amazonaws.personalize#ListBatchInferenceJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.personalize#InvalidInputException" + }, + { + "target": "com.amazonaws.personalize#InvalidNextTokenException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a list of the batch inference jobs that have been performed off of a solution\n version.
", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "batchInferenceJobs", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.personalize#ListBatchInferenceJobsRequest": { + "type": "structure", + "members": { + "solutionVersionArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the solution version from which the batch inference jobs\n were created.
" + } + }, + "nextToken": { + "target": "com.amazonaws.personalize#NextToken", + "traits": { + "smithy.api#documentation": "The token to request the next page of results.
" + } + }, + "maxResults": { + "target": "com.amazonaws.personalize#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of batch inference job results to return in each page. The default\n value is 100.
" + } + } + } + }, + "com.amazonaws.personalize#ListBatchInferenceJobsResponse": { + "type": "structure", + "members": { + "batchInferenceJobs": { + "target": "com.amazonaws.personalize#BatchInferenceJobs", + "traits": { + "smithy.api#documentation": "A list containing information on each job that is returned.
" + } + }, + "nextToken": { + "target": "com.amazonaws.personalize#NextToken", + "traits": { + "smithy.api#documentation": "The token to use to retrieve the next page of results. The value is null when\n there are no more results to return.
Gets a list of the batch inference jobs that have been performed off of a solution\n version.
", + "smithy.api#documentation": "Gets a list of the batch segment jobs that have been performed off of a solution\n version that you specify.
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "batchInferenceJobs", + "items": "batchSegmentJobs", "pageSize": "maxResults" } } }, - "com.amazonaws.personalize#ListBatchInferenceJobsRequest": { + "com.amazonaws.personalize#ListBatchSegmentJobsRequest": { "type": "structure", "members": { "solutionVersionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the solution version from which the batch inference jobs\n were created.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the solution version that the batch segment jobs used to generate batch segments.
" } }, "nextToken": { @@ -3896,16 +4501,16 @@ "maxResults": { "target": "com.amazonaws.personalize#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of batch inference job results to return in each page. The default\n value is 100.
" + "smithy.api#documentation": "The maximum number of batch segment job results to return in each page. The default\n value is 100.
" } } } }, - "com.amazonaws.personalize#ListBatchInferenceJobsResponse": { + "com.amazonaws.personalize#ListBatchSegmentJobsResponse": { "type": "structure", "members": { - "batchInferenceJobs": { - "target": "com.amazonaws.personalize#BatchInferenceJobs", + "batchSegmentJobs": { + "target": "com.amazonaws.personalize#BatchSegmentJobs", "traits": { "smithy.api#documentation": "A list containing information on each job that is returned.
" } @@ -4387,6 +4992,9 @@ "target": "com.amazonaws.personalize#ListRecipesResponse" }, "errors": [ + { + "target": "com.amazonaws.personalize#InvalidInputException" + }, { "target": "com.amazonaws.personalize#InvalidNextTokenException" } @@ -4422,6 +5030,12 @@ "traits": { "smithy.api#documentation": "The maximum number of recipes to return.
" } + }, + "domain": { + "target": "com.amazonaws.personalize#Domain", + "traits": { + "smithy.api#documentation": "\n Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases)\n for this domain are included in the response. If you don't specify a domain, only non-domain recipes are returned.\n
" + } } } }, @@ -4442,6 +5056,73 @@ } } }, + "com.amazonaws.personalize#ListRecommenders": { + "type": "operation", + "input": { + "target": "com.amazonaws.personalize#ListRecommendersRequest" + }, + "output": { + "target": "com.amazonaws.personalize#ListRecommendersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.personalize#InvalidInputException" + }, + { + "target": "com.amazonaws.personalize#InvalidNextTokenException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of recommenders in a given Domain dataset group.\n When a Domain dataset group is not specified, all the recommenders associated with the account are listed.\n The response provides the properties for each recommender, including the Amazon Resource Name (ARN).\n For more information on recommenders, see CreateRecommender.
", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "recommenders", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.personalize#ListRecommendersRequest": { + "type": "structure", + "members": { + "datasetGroupArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Domain dataset group to list the recommenders for. When\n a Domain dataset group is not specified, all the recommenders associated with the account are listed.
" + } + }, + "nextToken": { + "target": "com.amazonaws.personalize#NextToken", + "traits": { + "smithy.api#documentation": "A token returned from the previous call to ListRecommenders for getting\n the next set of recommenders (if they exist).
The maximum number of recommenders to return.
" + } + } + } + }, + "com.amazonaws.personalize#ListRecommendersResponse": { + "type": "structure", + "members": { + "recommenders": { + "target": "com.amazonaws.personalize#Recommenders", + "traits": { + "smithy.api#documentation": "A list of the recommenders.
" + } + }, + "nextToken": { + "target": "com.amazonaws.personalize#NextToken", + "traits": { + "smithy.api#documentation": "A token for getting the next set of recommenders (if they exist).
" + } + } + } + }, "com.amazonaws.personalize#ListSchemas": { "type": "operation", "input": { @@ -4698,7 +5379,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 1300 + "max": 1500 } } }, @@ -4880,6 +5561,12 @@ "traits": { "smithy.api#documentation": "The date and time (in Unix time) that the recipe was last updated.
" } + }, + "domain": { + "target": "com.amazonaws.personalize#Domain", + "traits": { + "smithy.api#documentation": "The domain of the recipe (if the recipe is a Domain dataset group use case).
" + } } }, "traits": { @@ -4907,6 +5594,194 @@ } } }, + "com.amazonaws.personalize#Recommender": { + "type": "structure", + "members": { + "recommenderArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recommender.
" + } + }, + "datasetGroupArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
" + } + }, + "name": { + "target": "com.amazonaws.personalize#Name", + "traits": { + "smithy.api#documentation": "The name of the recommender.
" + } + }, + "recipeArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.\n
" + } + }, + "recommenderConfig": { + "target": "com.amazonaws.personalize#RecommenderConfig", + "traits": { + "smithy.api#documentation": "The configuration details of the recommender.
" + } + }, + "creationDateTime": { + "target": "com.amazonaws.personalize#Date", + "traits": { + "smithy.api#documentation": "The date and time (in Unix format) that the recommender was created.
" + } + }, + "lastUpdatedDateTime": { + "target": "com.amazonaws.personalize#Date", + "traits": { + "smithy.api#documentation": "The date and time (in Unix format) that the recommender was last updated.
" + } + }, + "status": { + "target": "com.amazonaws.personalize#Status", + "traits": { + "smithy.api#documentation": "The status of the recommender.
\nA recommender can be in one of the following states:
\nCREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
\nDELETE PENDING > DELETE IN_PROGRESS
\nIf a recommender fails, the reason behind the failure.
" + } + }, + "latestRecommenderUpdate": { + "target": "com.amazonaws.personalize#RecommenderUpdateSummary", + "traits": { + "smithy.api#documentation": "Provides a summary of the latest updates to the recommender.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a recommendation generator for a Domain dataset group. You create a recommender in a Domain dataset group\n for a specific domain use case (domain recipe), and specify the recommender in a GetRecommendations request.
" + } + }, + "com.amazonaws.personalize#RecommenderConfig": { + "type": "structure", + "members": { + "itemExplorationConfig": { + "target": "com.amazonaws.personalize#HyperParameters", + "traits": { + "smithy.api#documentation": "Specifies the exploration configuration hyperparameters, including explorationWeight and \n explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when\n recommending items. Provide itemExplorationConfig data only if your recommenders generate personalized recommendations for a user\n (not popular items or similar items).
The configuration details of the recommender.
" + } + }, + "com.amazonaws.personalize#RecommenderSummary": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.personalize#Name", + "traits": { + "smithy.api#documentation": "The name of the recommender.
" + } + }, + "recommenderArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recommender.
" + } + }, + "datasetGroupArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
" + } + }, + "recipeArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
" + } + }, + "recommenderConfig": { + "target": "com.amazonaws.personalize#RecommenderConfig", + "traits": { + "smithy.api#documentation": "The configuration details of the recommender.
" + } + }, + "status": { + "target": "com.amazonaws.personalize#Status", + "traits": { + "smithy.api#documentation": "The status of the recommender. A recommender can be in one of the following states:
\nCREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
\nDELETE PENDING > DELETE IN_PROGRESS
\nThe date and time (in Unix format) that the recommender was created.
" + } + }, + "lastUpdatedDateTime": { + "target": "com.amazonaws.personalize#Date", + "traits": { + "smithy.api#documentation": "The date and time (in Unix format) that the recommender was last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides a summary of the properties of the recommender.
" + } + }, + "com.amazonaws.personalize#RecommenderUpdateSummary": { + "type": "structure", + "members": { + "recommenderConfig": { + "target": "com.amazonaws.personalize#RecommenderConfig", + "traits": { + "smithy.api#documentation": "The configuration details of the recommender update.
" + } + }, + "creationDateTime": { + "target": "com.amazonaws.personalize#Date", + "traits": { + "smithy.api#documentation": "The date and time (in Unix format) that the recommender update was created.
" + } + }, + "lastUpdatedDateTime": { + "target": "com.amazonaws.personalize#Date", + "traits": { + "smithy.api#documentation": "The date and time (in Unix time) that the recommender update was last updated.
" + } + }, + "status": { + "target": "com.amazonaws.personalize#Status", + "traits": { + "smithy.api#documentation": "The status of the recommender update.
\nA recommender can be in one of the following states:
\nCREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
\nDELETE PENDING > DELETE IN_PROGRESS
\nIf a recommender update fails, the reason behind the failure.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides a summary of the properties of a recommender update. For a complete listing, call the\n DescribeRecommender API.
" + } + }, + "com.amazonaws.personalize#Recommenders": { + "type": "list", + "member": { + "target": "com.amazonaws.personalize#RecommenderSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.personalize#ResourceAlreadyExistsException": { "type": "structure", "members": { @@ -5277,7 +6152,7 @@ } }, "traits": { - "smithy.api#documentation": "An object that provides information about a specific version of a Solution.
" + "smithy.api#documentation": "An object that provides information about a specific version of a Solution in a Custom dataset group.
" } }, "com.amazonaws.personalize#SolutionVersionSummary": { @@ -5516,6 +6391,60 @@ } } } + }, + "com.amazonaws.personalize#UpdateRecommender": { + "type": "operation", + "input": { + "target": "com.amazonaws.personalize#UpdateRecommenderRequest" + }, + "output": { + "target": "com.amazonaws.personalize#UpdateRecommenderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.personalize#InvalidInputException" + }, + { + "target": "com.amazonaws.personalize#ResourceInUseException" + }, + { + "target": "com.amazonaws.personalize#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the recommender to modify the recommender configuration.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.personalize#UpdateRecommenderRequest": { + "type": "structure", + "members": { + "recommenderArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recommender to modify.
", + "smithy.api#required": {} + } + }, + "recommenderConfig": { + "target": "com.amazonaws.personalize#RecommenderConfig", + "traits": { + "smithy.api#documentation": "The configuration details of the recommender.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.personalize#UpdateRecommenderResponse": { + "type": "structure", + "members": { + "recommenderArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "The same recommender Amazon Resource Name (ARN) as given in the request.
" + } + } + } } } } diff --git a/aws/sdk/aws-models/pinpoint.json b/aws/sdk/aws-models/pinpoint.json index 9419a9f8d62bca51f2d7ca5ea4d35ef81696d8b0..1984fc1cbfa7ea5f0bf077900403a6d20e65a53b 100644 --- a/aws/sdk/aws-models/pinpoint.json +++ b/aws/sdk/aws-models/pinpoint.json @@ -12951,6 +12951,21 @@ }, "com.amazonaws.pinpoint#Pinpoint": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Pinpoint", + "arnNamespace": "mobiletargeting", + "cloudFormationName": "Pinpoint", + "cloudTrailEventSource": "pinpoint.amazonaws.com", + "endpointPrefix": "pinpoint" + }, + "aws.auth#sigv4": { + "name": "mobiletargeting" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Doc Engage API - Amazon Pinpoint API
", + "smithy.api#title": "Amazon Pinpoint" + }, "version": "2016-12-01", "operations": [ { @@ -13223,6 +13238,9 @@ { "target": "com.amazonaws.pinpoint#SendMessages" }, + { + "target": "com.amazonaws.pinpoint#SendOTPMessage" + }, { "target": "com.amazonaws.pinpoint#SendUsersMessages" }, @@ -13303,23 +13321,11 @@ }, { "target": "com.amazonaws.pinpoint#UpdateVoiceTemplate" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "Pinpoint", - "arnNamespace": "mobiletargeting", - "cloudFormationName": "Pinpoint", - "cloudTrailEventSource": "pinpoint.amazonaws.com", - "endpointPrefix": "pinpoint" }, - "aws.auth#sigv4": { - "name": "mobiletargeting" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Doc Engage API - Amazon Pinpoint API
", - "smithy.api#title": "Amazon Pinpoint" - } + { + "target": "com.amazonaws.pinpoint#VerifyOTPMessage" + } + ] }, "com.amazonaws.pinpoint#PublicEndpoint": { "type": "structure", @@ -14893,6 +14899,157 @@ } } }, + "com.amazonaws.pinpoint#SendOTPMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpoint#SendOTPMessageRequest" + }, + "output": { + "target": "com.amazonaws.pinpoint#SendOTPMessageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pinpoint#BadRequestException" + }, + { + "target": "com.amazonaws.pinpoint#ForbiddenException" + }, + { + "target": "com.amazonaws.pinpoint#InternalServerErrorException" + }, + { + "target": "com.amazonaws.pinpoint#MethodNotAllowedException" + }, + { + "target": "com.amazonaws.pinpoint#NotFoundException" + }, + { + "target": "com.amazonaws.pinpoint#PayloadTooLargeException" + }, + { + "target": "com.amazonaws.pinpoint#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Send an OTP message
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/apps/{ApplicationId}/otp", + "code": 200 + } + } + }, + "com.amazonaws.pinpoint#SendOTPMessageRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "The unique ID of your Amazon Pinpoint application.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SendOTPMessageRequestParameters": { + "target": "com.amazonaws.pinpoint#SendOTPMessageRequestParameters", + "traits": { + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.pinpoint#SendOTPMessageRequestParameters": { + "type": "structure", + "members": { + "AllowedAttempts": { + "target": "com.amazonaws.pinpoint#__integer", + "traits": { + "smithy.api#documentation": "The attempts allowed to validate an OTP.
" + } + }, + "BrandName": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "The brand name that will be substituted into the OTP message body. Should be owned by calling AWS account.
", + "smithy.api#required": {} + } + }, + "Channel": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "Channel type for the OTP message. Supported values: [SMS].
", + "smithy.api#required": {} + } + }, + "CodeLength": { + "target": "com.amazonaws.pinpoint#__integer", + "traits": { + "smithy.api#documentation": "The number of characters in the generated OTP.
" + } + }, + "DestinationIdentity": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "The destination identity to send OTP to.
", + "smithy.api#required": {} + } + }, + "EntityId": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "A unique Entity ID received from DLT after entity registration is approved.
" + } + }, + "Language": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "The language to be used for the outgoing message body containing the OTP.
" + } + }, + "OriginationIdentity": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "The origination identity used to send OTP from.
", + "smithy.api#required": {} + } + }, + "ReferenceId": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "Developer-specified reference identifier. Required to match during OTP verification.
", + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "A unique Template ID received from DLT after entity registration is approved.
" + } + }, + "ValidityPeriod": { + "target": "com.amazonaws.pinpoint#__integer", + "traits": { + "smithy.api#documentation": "The time in minutes before the OTP is no longer valid.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Send OTP message request parameters.
" + } + }, + "com.amazonaws.pinpoint#SendOTPMessageResponse": { + "type": "structure", + "members": { + "MessageResponse": { + "target": "com.amazonaws.pinpoint#MessageResponse", + "traits": { + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.pinpoint#SendUsersMessageRequest": { "type": "structure", "members": { @@ -17645,6 +17802,121 @@ } } }, + "com.amazonaws.pinpoint#VerificationResponse": { + "type": "structure", + "members": { + "Valid": { + "target": "com.amazonaws.pinpoint#__boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the OTP is valid or not.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Verify OTP Message Response.
" + } + }, + "com.amazonaws.pinpoint#VerifyOTPMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpoint#VerifyOTPMessageRequest" + }, + "output": { + "target": "com.amazonaws.pinpoint#VerifyOTPMessageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pinpoint#BadRequestException" + }, + { + "target": "com.amazonaws.pinpoint#ForbiddenException" + }, + { + "target": "com.amazonaws.pinpoint#InternalServerErrorException" + }, + { + "target": "com.amazonaws.pinpoint#MethodNotAllowedException" + }, + { + "target": "com.amazonaws.pinpoint#NotFoundException" + }, + { + "target": "com.amazonaws.pinpoint#PayloadTooLargeException" + }, + { + "target": "com.amazonaws.pinpoint#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Verify an OTP
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/apps/{ApplicationId}/verify-otp", + "code": 200 + } + } + }, + "com.amazonaws.pinpoint#VerifyOTPMessageRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "The unique ID of your Amazon Pinpoint application.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VerifyOTPMessageRequestParameters": { + "target": "com.amazonaws.pinpoint#VerifyOTPMessageRequestParameters", + "traits": { + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.pinpoint#VerifyOTPMessageRequestParameters": { + "type": "structure", + "members": { + "DestinationIdentity": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "The destination identity to send OTP to.
", + "smithy.api#required": {} + } + }, + "Otp": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "The OTP the end user provided for verification.
", + "smithy.api#required": {} + } + }, + "ReferenceId": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "The reference identifier provided when the OTP was previously sent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Verify OTP message request.
" + } + }, + "com.amazonaws.pinpoint#VerifyOTPMessageResponse": { + "type": "structure", + "members": { + "VerificationResponse": { + "target": "com.amazonaws.pinpoint#VerificationResponse", + "traits": { + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.pinpoint#VoiceChannelRequest": { "type": "structure", "members": { diff --git a/aws/sdk/aws-models/proton.json b/aws/sdk/aws-models/proton.json index 91873ee3b764867b52290bd1bae57d0a68210cb1..4b0f11e1fd6013b7d52b9f0afc1faf9aa887d401 100644 --- a/aws/sdk/aws-models/proton.json +++ b/aws/sdk/aws-models/proton.json @@ -30,7 +30,7 @@ } ], "traits": { - "smithy.api#documentation": "In a management account, an environment account connection request is accepted. When the environment account connection request is\n accepted, AWS Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment\n account.
\nFor more information, see Environment account\n connections in the AWS Proton Administrator guide.
", + "smithy.api#documentation": "In a management account, an environment account connection request is accepted. When the environment account connection request is accepted,\n Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.
\nFor more information, see Environment account\n connections in the Proton Administrator guide.
", "smithy.api#idempotent": {} } }, @@ -59,7 +59,7 @@ "environmentAccountConnection": { "target": "com.amazonaws.proton#EnvironmentAccountConnection", "traits": { - "smithy.api#documentation": "The environment account connection data that's returned by AWS Proton.
", + "smithy.api#documentation": "The environment account connection data that's returned by Proton.
", "smithy.api#required": {} } } @@ -85,14 +85,20 @@ "type": "structure", "members": { "pipelineServiceRoleArn": { - "target": "com.amazonaws.proton#Arn", + "target": "com.amazonaws.proton#PipelineRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Proton pipeline service role.
" + } + }, + "pipelineProvisioningRepository": { + "target": "com.amazonaws.proton#RepositoryBranch", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Proton pipeline service role.
" + "smithy.api#documentation": "The repository that you provide with pull request provisioning.
\nProvisioning by pull request is currently in feature preview and is\n only usable with Terraform based Proton Templates. To learn more about\n Amazon Web Services Feature Preview terms, see section 2 on Beta and\n Previews.
\nThe AWS Proton pipeline service role data.
" + "smithy.api#documentation": "The Proton pipeline service role and repository data.
" } }, "com.amazonaws.proton#AccountSettingsResource": { @@ -121,6 +127,21 @@ }, "com.amazonaws.proton#AwsProton20200720": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Proton", + "arnNamespace": "awsproton20200720", + "cloudFormationName": "AwsProton20200720", + "cloudTrailEventSource": "awsproton20200720.amazonaws.com", + "endpointPrefix": "proton" + }, + "aws.auth#sigv4": { + "name": "proton" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "This is the Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the\n actions and data types for the Proton\n service.
\nThe documentation for each action shows the Query API request parameters and the XML response.
\nAlternatively, you can use the Amazon Web Services CLI to access an API. For more information, see the Amazon Web Services Command Line Interface User\n Guide.
\nThe Proton service is a two-pronged automation framework. Administrators create service templates to provide\n standardized infrastructure and deployment tooling for serverless and container based applications. Developers, in\n turn, select from the available service templates to automate their application or service deployments.
\nBecause administrators define the infrastructure and tooling that Proton deploys and manages, they need\n permissions to use all of the listed API operations.
\nWhen developers select a specific infrastructure and tooling set, Proton deploys their applications. To\n monitor their applications that are running on Proton, developers need permissions to the service\n create, list, update and delete\n API operations and the service instance list and update API\n operations.
\nTo learn more about Proton administration, see the Proton Administrator Guide.
\nTo learn more about deploying serverless and containerized applications on Proton, see the Proton User Guide.
\n\n Ensuring Idempotency\n
\nWhen you make a mutating API request, the request typically returns a result before the asynchronous workflows\n of the operation are complete. Operations might also time out or encounter other server issues before they're\n complete, even if the request already returned a result. This might make it difficult to determine whether the\n request succeeded. Moreover, you might need to retry the request multiple times to ensure that the operation\n completes successfully. However, if the original request and the subsequent retries are successful, the operation\n occurs multiple times. This means that you might create more resources than you intended.
\n\n Idempotency ensures that an API request action completes no more than one time. With an\n idempotent request, if the original request action completes successfully, any subsequent retries complete\n successfully without performing any further actions. However, the result might contain updated information, such as\n the current creation status.
\nThe following lists of APIs are grouped according to methods that ensure idempotency.
\n\n Idempotent create APIs with a client token\n
\nThe API actions in this list support idempotency with the use of a client token. The\n corresponding Amazon Web Services CLI commands also support idempotency using a client token. A client token is a unique,\n case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions,\n specify a client token in the request. We recommend that you don't reuse the same client token\n for other API requests. If you don’t provide a client token for these APIs, a default client token is automatically\n provided by SDKs.
\nGiven a request action that has succeeded:
\nIf you retry the request using the same client token and the same parameters, the retry succeeds without\n performing any further actions other than returning the original resource detail data in the response.
\nIf you retry the request using the same client token, but one or more of the parameters are different, the retry\n throws a ValidationException with an IdempotentParameterMismatch error.
Client tokens expire eight hours after a request is made. If you retry the request with the expired token, a new\n resource is created.
\nIf the original resource is deleted and you retry the request, a new resource is created.
\nIdempotent create APIs with a client token:
\nCreateEnvironmentTemplateVersion
\nCreateServiceTemplateVersion
\nCreateEnvironmentAccountConnection
\n\n Idempotent create APIs\n
\nGiven a request action that has succeeded:
\nIf you retry the request with an API from this group, and the original resource hasn't been\n modified, the retry succeeds without performing any further actions other than returning the original resource detail\n data in the response.
\nIf the original resource has been modified, the retry throws a ConflictException.
If you retry with different input parameters, the retry throws a ValidationException with an\n IdempotentParameterMismatch error.
Idempotent create APIs:
\nCreateEnvironmentTemplate
\nCreateServiceTemplate
\nCreateEnvironment
\nCreateService
\n\n Idempotent delete APIs\n
\nGiven a request action that has succeeded:
\nWhen you retry the request with an API from this group and the resource was deleted, its metadata is returned in\n the response.
\nIf you retry and the resource doesn't exist, the response is empty.
\nIn both cases, the retry succeeds.
\nIdempotent delete APIs:
\nDeleteEnvironmentTemplate
\nDeleteEnvironmentTemplateVersion
\nDeleteServiceTemplate
\nDeleteServiceTemplateVersion
\nDeleteEnvironmentAccountConnection
\n\n Asynchronous idempotent delete APIs\n
\nGiven a request action that has succeeded:
\nIf you retry the request with an API from this group, if the original request delete operation status is\n DELETE_IN_PROGRESS, the retry returns the resource detail data in the response without performing any\n further actions.
If the original request delete operation is complete, a retry returns an empty response.
\nAsynchronous idempotent delete APIs:
\nDeleteEnvironment
\nDeleteService
\nThis is the AWS Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the actions and data types for the AWS Proton service.
\nThe documentation for each action shows the Query API request parameters and the XML response.
\nAlternatively, you can use the AWS CLI to access an API. For more information, see the AWS Command Line Interface User Guide.
\nThe AWS Proton service is a two-pronged automation framework. Administrators create service templates to provide standardized\n infrastructure and deployment tooling for serverless and container based applications. Developers, in turn, select from the available\n service templates to automate their application or service deployments.
\nBecause administrators define the infrastructure and tooling that AWS Proton deploys and manages, they need permissions to use all of the\n listed API operations.
\nWhen developers select a specific infrastructure and tooling set, AWS Proton deploys their applications. To monitor their applications\n that are running on AWS Proton, developers need permissions to the service create, list,\n update and delete API operations and the service instance list and\n update API operations.
\nTo learn more about AWS Proton administration, see the AWS Proton\n Administrator Guide.
\nTo learn more about deploying serverless and containerized applications on AWS Proton, see the AWS Proton User Guide.
\n\n Ensuring Idempotency\n
\nWhen you make a mutating API request, the request typically returns a result before the asynchronous workflows of the operation are\n complete. Operations might also time out or encounter other server issues before they're complete, even if the request already returned a\n result. This might make it difficult to determine whether the request succeeded. Moreover, you might need to retry the request multiple\n times to ensure that the operation completes successfully. However, if the original request and the subsequent retries are successful, the\n operation occurs multiple times. This means that you might create more resources than you intended.
\n\n Idempotency ensures that an API request action completes no more than one time. With an idempotent request, if the\n original request action completes successfully, any subsequent retries complete successfully without performing any further actions.\n However, the result might contain updated information, such as the current creation status.
\nThe following lists of APIs are grouped according to methods that ensure idempotency.
\n\n Idempotent create APIs with a client token\n
\nThe API actions in this list support idempotency with the use of a client token. The corresponding AWS CLI\n commands also support idempotency using a client token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. To\n make an idempotent API request using one of these actions, specify a client token in the request. We recommend that you\n don't reuse the same client token for other API requests. If you don’t provide a client token for these APIs, a\n default client token is automatically provided by SDKs.
\nGiven a request action that has succeeded:
\nIf you retry the request using the same client token and the same parameters, the retry succeeds without performing any further actions\n other than returning the original resource detail data in the response.
\nIf you retry the request using the same client token, but one or more of the parameters are different, the retry throws a\n ValidationException with an IdempotentParameterMismatch error.
Client tokens expire eight hours after a request is made. If you retry the request with the expired token, a new resource is\n created.
\nIf the original resource is deleted and you retry the request, a new resource is created.
\nIdempotent create APIs with a client token:
\nCreateEnvironmentTemplateVersion
\nCreateServiceTemplateVersion
\nCreateEnvironmentAccountConnection
\n\n Idempotent create APIs\n
\nGiven a request action that has succeeded:
\nIf you retry the request with an API from this group, and the original resource hasn't been modified, the retry\n succeeds without performing any further actions other than returning the original resource detail data in the response.
\nIf the original resource has been modified, the retry throws a ConflictException.
If you retry with different input parameters, the retry throws a ValidationException with an\n IdempotentParameterMismatch error.
Idempotent create APIs:
\nCreateEnvironmentTemplate
\nCreateServiceTemplate
\nCreateEnvironment
\nCreateService
\n\n Idempotent delete APIs\n
\nGiven a request action that has succeeded:
\nWhen you retry the request with an API from this group and the resource was deleted, its metadata is returned in the response.
\nIf you retry and the resource doesn't exist, the response is empty.
\nIn both cases, the retry succeeds.
\nIdempotent delete APIs:
\nDeleteEnvironmentTemplate
\nDeleteEnvironmentTemplateVersion
\nDeleteServiceTemplate
\nDeleteServiceTemplateVersion
\nDeleteEnvironmentAccountConnection
\n\n Asynchronous idempotent delete APIs\n
\nGiven a request action that has succeeded:
\nIf you retry the request with an API from this group, if the original request delete operation status is\n DELETE_IN_PROGRESS, the retry returns the resource detail data in the response without performing any further actions.
If the original request delete operation is complete, a retry returns an empty response.
\nAsynchronous idempotent delete APIs:
\nDeleteEnvironment
\nDeleteService
\nAttempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is\n IN_PROGRESS. For more information, see Update an environment in the AWS Proton Administrator guide.
The following list includes potential cancellation scenarios.
\nIf the cancellation attempt succeeds, the resulting deployment state is CANCELLED.
If the cancellation attempt fails, the resulting deployment state is FAILED.
If the current UpdateEnvironment action succeeds before the cancellation attempt starts, the resulting\n deployment state is SUCCEEDED and the cancellation attempt has no effect.
Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is IN_PROGRESS.\n For more information, see Update an environment in the\n Proton Administrator guide.
The following list includes potential cancellation scenarios.
\nIf the cancellation attempt succeeds, the resulting deployment state is CANCELLED.
If the cancellation attempt fails, the resulting deployment state is FAILED.
If the current UpdateEnvironment action succeeds before the cancellation attempt starts, the resulting deployment state is\n SUCCEEDED and the cancellation attempt has no effect.
The environment summary data that's returned by AWS Proton.
", + "smithy.api#documentation": "The environment summary data that's returned by Proton.
", "smithy.api#required": {} } } @@ -285,7 +327,7 @@ } ], "traits": { - "smithy.api#documentation": "Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is\n IN_PROGRESS. For more information, see Update a service instance in the AWS Proton Administrator guide or the AWS Proton User guide.
The following list includes potential cancellation scenarios.
\nIf the cancellation attempt succeeds, the resulting deployment state is CANCELLED.
If the cancellation attempt fails, the resulting deployment state is FAILED.
If the current UpdateServiceInstance action succeeds before the cancellation attempt starts, the resulting\n deployment state is SUCCEEDED and the cancellation attempt has no effect.
Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is\n IN_PROGRESS. For more information, see Update a service instance in the Proton Administrator guide or the Proton User guide.
The following list includes potential cancellation scenarios.
\nIf the cancellation attempt succeeds, the resulting deployment state is CANCELLED.
If the cancellation attempt fails, the resulting deployment state is FAILED.
If the current UpdateServiceInstance action succeeds before the cancellation attempt starts, the resulting deployment\n state is SUCCEEDED and the cancellation attempt has no effect.
The service instance summary data that's returned by AWS Proton.
", + "smithy.api#documentation": "The service instance summary data that's returned by Proton.
", "smithy.api#required": {} } } @@ -359,7 +401,7 @@ } ], "traits": { - "smithy.api#documentation": "Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment is\n IN_PROGRESS. For more information, see Update a service pipeline in the AWS Proton Administrator guide or the AWS Proton User guide.
The following list includes potential cancellation scenarios.
\nIf the cancellation attempt succeeds, the resulting deployment state is CANCELLED.
If the cancellation attempt fails, the resulting deployment state is FAILED.
If the current UpdateServicePipeline action succeeds before the cancellation attempt starts, the resulting\n deployment state is SUCCEEDED and the cancellation attempt has no effect.
Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment is\n IN_PROGRESS. For more information, see Update a service pipeline in the Proton Administrator guide or the Proton User guide.
The following list includes potential cancellation scenarios.
\nIf the cancellation attempt succeeds, the resulting deployment state is CANCELLED.
If the cancellation attempt fails, the resulting deployment state is FAILED.
If the current UpdateServicePipeline action succeeds before the cancellation attempt starts, the resulting deployment\n state is SUCCEEDED and the cancellation attempt has no effect.
The service pipeline detail data that's returned by AWS Proton.
", + "smithy.api#documentation": "The service pipeline detail data that's returned by Proton.
", "smithy.api#required": {} } } @@ -515,7 +557,7 @@ } ], "traits": { - "smithy.api#documentation": "Deploy a new environment. An AWS Proton environment is created from an environment template that defines infrastructure and resources\n that can be shared across services. For more information, see the Environments in the AWS Proton Administrator\n Guide.\n
", + "smithy.api#documentation": "Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can\n be shared across services.
\n\n You can provision environments using the following methods:\n
\nStandard provisioning: Proton makes direct calls to provision your resources.
\nPull request provisioning: Proton makes pull requests on your repository to provide compiled infrastructure as code (IaC) files that your\n IaC engine uses to provision resources.
\nFor more information, see the Environments in the\n Proton Administrator Guide.\n
", "smithy.api#idempotent": {} } }, @@ -548,7 +590,7 @@ } ], "traits": { - "smithy.api#documentation": "Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in\n the environment account from a management account.
\nAn environment account connection is a secure bi-directional connection between a management account and an\n environment account that maintains authorization and permissions. For more information, see Environment account connections in the\n AWS Proton Administrator guide.
", + "smithy.api#documentation": "Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the\n environment account from a management account.
\nAn environment account connection is a secure bi-directional connection between a management account and an\n environment account that maintains authorization and permissions. For more information, see Environment account connections in the Proton Administrator\n guide.
", "smithy.api#idempotent": {} } }, @@ -558,30 +600,36 @@ "clientToken": { "target": "com.amazonaws.proton#ClientToken", "traits": { - "smithy.api#documentation": "When included, if two identicial requests are made with the same client token, AWS Proton returns the environment account connection that\n the first request created.
", + "smithy.api#documentation": "When included, if two identical requests are made with the same client token, Proton returns the environment account connection that the\n first request created.
", "smithy.api#idempotencyToken": {} } }, "managementAccountId": { "target": "com.amazonaws.proton#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID of the management account that accepts or rejects the environment account connection. You create an manage the AWS Proton\n environment in this account. If the management account accepts the environment account connection, AWS Proton can use the associated IAM\n role to provision environment infrastructure resources in the associated environment account.
", + "smithy.api#documentation": "The ID of the management account that accepts or rejects the environment account connection. You create an manage the Proton environment in\n this account. If the management account accepts the environment account connection, Proton can use the associated IAM role to provision\n environment infrastructure resources in the associated environment account.
", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.proton#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. AWS Proton uses this role to provision\n infrastructure resources in the associated environment account.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. Proton uses this role to provision\n infrastructure resources in the associated environment account.
", "smithy.api#required": {} } }, "environmentName": { "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "The name of the AWS Proton environment that's created in the associated management account.
", + "smithy.api#documentation": "The name of the Proton environment that's created in the associated management account.
", "smithy.api#required": {} } + }, + "tags": { + "target": "com.amazonaws.proton#TagList", + "traits": { + "smithy.api#documentation": "Tags for your environment account connection. For more information, see Proton resources and tagging in the Proton Administrator\n Guide.
" + } } } }, @@ -591,7 +639,7 @@ "environmentAccountConnection": { "target": "com.amazonaws.proton#EnvironmentAccountConnection", "traits": { - "smithy.api#documentation": "The environment account connection detail data that's returned by AWS Proton.
", + "smithy.api#documentation": "The environment account connection detail data that's returned by Proton.
", "smithy.api#required": {} } } @@ -610,21 +658,21 @@ "templateName": { "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "The name of the environment template. For more information, see Environment Templates in the AWS Proton Administrator\n Guide.
", + "smithy.api#documentation": "The name of the environment template. For more information, see Environment Templates in the Proton Administrator Guide.
", "smithy.api#required": {} } }, "templateMajorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the major version of the environment template.
", + "smithy.api#documentation": "The major version of the environment template.
", "smithy.api#required": {} } }, "templateMinorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the minor version of the environment template.
" + "smithy.api#documentation": "The minor version of the environment template.
" } }, "description": { @@ -636,26 +684,32 @@ "spec": { "target": "com.amazonaws.proton#SpecContents", "traits": { - "smithy.api#documentation": "A link to a YAML formatted spec file that provides inputs as defined in the environment template bundle schema file. For more\n information, see Environments in the\n AWS Proton Administrator Guide.
", + "smithy.api#documentation": "A link to a YAML formatted spec file that provides inputs as defined in the environment template bundle schema file. For more information, see\n Environments in the Proton Administrator\n Guide.
", "smithy.api#required": {} } }, "protonServiceRoleArn": { "target": "com.amazonaws.proton#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make calls to other services on your behalf. You\n must include either the environmentAccountConnectionId or protonServiceRoleArn parameter and value.
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf. You must\n include either the environmentAccountConnectionId or protonServiceRoleArn parameter and value and omit the\n provisioningRepository parameter when you use standard provisioning.
The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an\n environment account. You must include either the environmentAccountConnectionId or protonServiceRoleArn\n parameter and value. For more information, see Environment account connections in the AWS Proton Administrator guide.
The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an\n environment account. You must include either the environmentAccountConnectionId or protonServiceRoleArn parameter and\n value and omit the provisioningRepository parameter and values. For more information, see Environment account connections in the Proton Administrator\n guide.
Create tags for your environment. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.
" + "smithy.api#documentation": "Create tags for your environment. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
" + } + }, + "provisioningRepository": { + "target": "com.amazonaws.proton#RepositoryBranchInput", + "traits": { + "smithy.api#documentation": "The repository that you provide with pull request provisioning. If you provide this parameter, you must omit the\n environmentAccountConnectionId and protonServiceRoleArn parameters.
Provisioning by pull request is currently in feature preview and is\n only usable with Terraform based Proton Templates. To learn more about\n Amazon Web Services Feature Preview terms, see section 2 on Beta and\n Previews.
\nThe environment detail data that's returned by AWS Proton.
", + "smithy.api#documentation": "The environment detail data that's returned by Proton.
", "smithy.api#required": {} } } @@ -701,7 +755,7 @@ } ], "traits": { - "smithy.api#documentation": "Create an environment template for AWS Proton. For more information, see Environment Templates in the AWS Proton Administrator\n Guide.
\nYou can create an environment template in one of the two following ways:
\nRegister and publish a standard environment template that instructs AWS Proton to deploy and manage\n environment infrastructure.
\nRegister and publish a customer managed environment template that connects AWS Proton to your existing\n provisioned infrastructure that you manage. AWS Proton doesn't manage your existing provisioned\n infrastructure. To create an environment template for customer provisioned and managed infrastructure, include the\n provisioning parameter and set the value to CUSTOMER_MANAGED. For more information, see Register and publish an environment template\n in the AWS Proton Administrator Guide.
Create an environment template for Proton. For more information, see Environment Templates in the Proton Administrator Guide.
\nYou can create an environment template in one of the two following ways:
\nRegister and publish a standard environment template that instructs Proton to deploy and manage environment\n infrastructure.
\nRegister and publish a customer managed environment template that connects Proton to your existing provisioned\n infrastructure that you manage. Proton doesn't manage your existing provisioned infrastructure. To create an environment\n template for customer provisioned and managed infrastructure, include the provisioning parameter and set the value to\n CUSTOMER_MANAGED. For more information, see Register and publish an environment template in the Proton Administrator Guide.
A customer provided encryption key that AWS Proton uses to encrypt data.
" + "smithy.api#documentation": "A customer provided encryption key that Proton uses to encrypt data.
" } }, "provisioning": { @@ -742,7 +796,7 @@ "tags": { "target": "com.amazonaws.proton#TagList", "traits": { - "smithy.api#documentation": "Create tags for your environment template. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.
" + "smithy.api#documentation": "Create tags for your environment template. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
" } } } @@ -753,7 +807,7 @@ "environmentTemplate": { "target": "com.amazonaws.proton#EnvironmentTemplate", "traits": { - "smithy.api#documentation": "The environment template detail data that's returned by AWS Proton.
", + "smithy.api#documentation": "The environment template detail data that's returned by Proton.
", "smithy.api#required": {} } } @@ -791,7 +845,7 @@ } ], "traits": { - "smithy.api#documentation": "Create a new major or minor version of an environment template. A major version of an environment template is a version that\n isn't backwards compatible. A minor version of an environment template is a version that's backwards compatible\n within its major version.
", + "smithy.api#documentation": "Create a new major or minor version of an environment template. A major version of an environment template is a version that\n isn't backwards compatible. A minor version of an environment template is a version that's backwards compatible within its\n major version.
", "smithy.api#idempotent": {} } }, @@ -801,7 +855,7 @@ "clientToken": { "target": "com.amazonaws.proton#ClientToken", "traits": { - "smithy.api#documentation": "When included, if two identicial requests are made with the same client token, AWS Proton returns the environment template version that\n the first request created.
", + "smithy.api#documentation": "When included, if two identical requests are made with the same client token, Proton returns the environment template version that the\n first request created.
", "smithy.api#idempotencyToken": {} } }, @@ -821,7 +875,7 @@ "majorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "To create a new minor version of the environment template, include a majorVersion.
To create a new major and minor version of the environment template, exclude\n majorVersion.
To create a new minor version of the environment template, include a major Version.
To create a new major and minor version of the environment template, exclude\n major Version.
The environment template detail data that's returned by AWS Proton.
", + "smithy.api#documentation": "The environment template detail data that's returned by Proton.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.proton#CreateRepository": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#CreateRepositoryInput" + }, + "output": { + "target": "com.amazonaws.proton#CreateRepositoryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#ConflictException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Create and register a link to a repository that can be used with pull request provisioning or template sync configurations. For more\n information, see Template bundles and Template sync configurations in the Proton\n Administrator Guide.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.proton#CreateRepositoryInput": { + "type": "structure", + "members": { + "provider": { + "target": "com.amazonaws.proton#RepositoryProvider", + "traits": { + "smithy.api#documentation": "The repository provider.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.proton#RepositoryName", + "traits": { + "smithy.api#documentation": "The repository name, for example myrepos/myrepo.
The Amazon Resource Name (ARN) of your Amazon Web Services CodeStar connection. For more information, see Setting up for Proton in the Proton Administrator Guide.
", + "smithy.api#required": {} + } + }, + "encryptionKey": { + "target": "com.amazonaws.proton#Arn", + "traits": { + "smithy.api#documentation": "The ARN of your customer Amazon Web Services Key Management Service (Amazon Web Services KMS) key.
" + } + } + } + }, + "com.amazonaws.proton#CreateRepositoryOutput": { + "type": "structure", + "members": { + "repository": { + "target": "com.amazonaws.proton#Repository", + "traits": { + "smithy.api#documentation": "The repository detail data that's returned by Proton.
", "smithy.api#required": {} } } @@ -883,7 +1014,7 @@ } ], "traits": { - "smithy.api#documentation": "Create an AWS Proton service. An AWS Proton service is an instantiation of a service template and often includes several service instances\n and pipeline. For more information, see Services in\n the AWS Proton Administrator Guide and Services in the AWS Proton User Guide.
", + "smithy.api#documentation": "Create an Proton service. An Proton service is an instantiation of a service template and often includes several service instances and\n pipeline. For more information, see Services in the\n Proton Administrator Guide and Services\n in the Proton User Guide.
", "smithy.api#idempotent": {} } }, @@ -900,7 +1031,7 @@ "description": { "target": "com.amazonaws.proton#Description", "traits": { - "smithy.api#documentation": "A description of the AWS Proton service.
" + "smithy.api#documentation": "A description of the Proton service.
" } }, "templateName": { @@ -913,45 +1044,45 @@ "templateMajorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the major version of the service template that was used to create the service.
", + "smithy.api#documentation": "The major version of the service template that was used to create the service.
", "smithy.api#required": {} } }, "templateMinorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the minor version of the service template that was used to create the service.
" + "smithy.api#documentation": "The minor version of the service template that was used to create the service.
" } }, "spec": { "target": "com.amazonaws.proton#SpecContents", "traits": { - "smithy.api#documentation": "A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format. Don’t\n include pipeline inputs in the spec if your service template doesn’t include a service pipeline. For more\n information, see Create a service in the\n AWS Proton Administrator Guide and Create a service in the AWS Proton User Guide.
", + "smithy.api#documentation": "A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format. Don’t\n include pipeline inputs in the spec if your service template doesn’t include a service pipeline. For more information, see\n Create a service in the Proton\n Administrator Guide and Create a service in the\n Proton User Guide.
", "smithy.api#required": {} } }, "repositoryConnectionArn": { "target": "com.amazonaws.proton#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the repository connection. For more information, see Set up repository connection in the\n AWS Proton Administrator Guide and Setting up with AWS Proton in the AWS Proton\n User Guide. Don't include this parameter if your service template doesn't include\n a service pipeline.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the repository connection. For more information, see Set up repository connection in the Proton\n Administrator Guide and Setting up\n with Proton in the Proton User Guide. Don't include this parameter if your service\n template doesn't include a service pipeline.
" } }, "repositoryId": { "target": "com.amazonaws.proton#RepositoryId", "traits": { - "smithy.api#documentation": "The ID of the code repository. Don't include this parameter if your service template doesn't\n include a service pipeline.
" + "smithy.api#documentation": "The ID of the code repository. Don't include this parameter if your service template doesn't include\n a service pipeline.
" } }, "branchName": { "target": "com.amazonaws.proton#GitBranchName", "traits": { - "smithy.api#documentation": "The name of the code repository branch that holds the code that's deployed in AWS Proton. Don't include this\n parameter if your service template doesn't include a service pipeline.
" + "smithy.api#documentation": "The name of the code repository branch that holds the code that's deployed in Proton. Don't include this parameter if\n your service template doesn't include a service pipeline.
" } }, "tags": { "target": "com.amazonaws.proton#TagList", "traits": { - "smithy.api#documentation": "Create tags for your service. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.
" + "smithy.api#documentation": "Create tags for your service. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
" } } } @@ -962,7 +1093,7 @@ "service": { "target": "com.amazonaws.proton#Service", "traits": { - "smithy.api#documentation": "The service detail data that's returned by AWS Proton.
", + "smithy.api#documentation": "The service detail data that's returned by Proton.
", "smithy.api#required": {} } } @@ -997,7 +1128,7 @@ } ], "traits": { - "smithy.api#documentation": "Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CICD\n service pipeline. Developers, in turn, select the service template from AWS Proton. If the selected service template includes a service\n pipeline definition, they provide a link to their source code repository. AWS Proton then deploys and manages the infrastructure defined by\n the selected service template. For more information, see Service Templates in the AWS Proton Administrator\n Guide.
", + "smithy.api#documentation": "Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CICD service\n pipeline. Developers, in turn, select the service template from Proton. If the selected service template includes a service pipeline definition,\n they provide a link to their source code repository. Proton then deploys and manages the infrastructure defined by the selected service\n template. For more information, see Service\n Templates in the Proton Administrator Guide.
", "smithy.api#idempotent": {} } }, @@ -1032,13 +1163,13 @@ "pipelineProvisioning": { "target": "com.amazonaws.proton#Provisioning", "traits": { - "smithy.api#documentation": "AWS Proton includes a service pipeline for your service by default. When included, this parameter indicates that an AWS Proton service\n pipeline won't be included for your service. Once specified, this parameter can't be changed.\n For more information, see Service template\n bundles in the AWS Proton Administrator Guide.
" + "smithy.api#documentation": "Proton includes a service pipeline for your service by default. When included, this parameter indicates that an Proton service pipeline\n won't be included for your service. Once specified, this parameter can't be changed. For more\n information, see Service template bundles in the\n Proton Administrator Guide.
" } }, "tags": { "target": "com.amazonaws.proton#TagList", "traits": { - "smithy.api#documentation": "Create tags for your service template. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.
" + "smithy.api#documentation": "Create tags for your service template. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
" } } } @@ -1049,7 +1180,7 @@ "serviceTemplate": { "target": "com.amazonaws.proton#ServiceTemplate", "traits": { - "smithy.api#documentation": "The service template detail data that's returned by AWS Proton.
", + "smithy.api#documentation": "The service template detail data that's returned by Proton.
", "smithy.api#required": {} } } @@ -1087,7 +1218,7 @@ } ], "traits": { - "smithy.api#documentation": "Create a new major or minor version of a service template. A major version of a service template is a version that\n isn't backwards compatible. A minor version of a service template is a version that's backwards compatible within\n its major version.
", + "smithy.api#documentation": "Create a new major or minor version of a service template. A major version of a service template is a version that isn't\n backward compatible. A minor version of a service template is a version that's backward compatible within its major version.
", "smithy.api#idempotent": {} } }, @@ -1097,7 +1228,7 @@ "clientToken": { "target": "com.amazonaws.proton#ClientToken", "traits": { - "smithy.api#documentation": "When included, if two identicial requests are made with the same client token, AWS Proton returns the service template version that the\n first request created.
", + "smithy.api#documentation": "When included, if two identical requests are made with the same client token, Proton returns the service template version that the first\n request created.
", "smithy.api#idempotencyToken": {} } }, @@ -1117,7 +1248,7 @@ "majorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "To create a new minor version of the service template, include a majorVersion.
To create a new major and minor version of the service template, exclude\n majorVersion.
To create a new minor version of the service template, include a major Version.
To create a new major and minor version of the service template, exclude\n major Version.
The service template version summary of detail data that's returned by AWS Proton.
", + "smithy.api#documentation": "The service template version summary of detail data that's returned by Proton.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.proton#CreateTemplateSyncConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#CreateTemplateSyncConfigInput" + }, + "output": { + "target": "com.amazonaws.proton#CreateTemplateSyncConfigOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#ConflictException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Set up a template for automated template version creation. When a commit is pushed to your registered repository, Proton checks for changes to your repository template bundles. If it\n detects a template bundle change, a new minor or major version of its template is created, if the version doesn’t already exist. For more\n information, see Template sync configurations in\n the Proton Administrator Guide.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.proton#CreateTemplateSyncConfigInput": { + "type": "structure", + "members": { + "templateName": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "The name of your registered template.
", + "smithy.api#required": {} + } + }, + "templateType": { + "target": "com.amazonaws.proton#TemplateType", + "traits": { + "smithy.api#documentation": "The type of the registered template.
", + "smithy.api#required": {} + } + }, + "repositoryProvider": { + "target": "com.amazonaws.proton#RepositoryProvider", + "traits": { + "smithy.api#documentation": "The provider type for your repository.
", + "smithy.api#required": {} + } + }, + "repositoryName": { + "target": "com.amazonaws.proton#RepositoryName", + "traits": { + "smithy.api#documentation": "The name of your repository, for example myrepos/myrepo.
The branch of the registered repository for your template.
", "smithy.api#required": {} } + }, + "subdirectory": { + "target": "com.amazonaws.proton#Subdirectory", + "traits": { + "smithy.api#documentation": "A repository subdirectory path to your template bundle directory. When included, Proton limits the template bundle search to this\n repository directory.
" + } + } + } + }, + "com.amazonaws.proton#CreateTemplateSyncConfigOutput": { + "type": "structure", + "members": { + "templateSyncConfig": { + "target": "com.amazonaws.proton#TemplateSyncConfig", + "traits": { + "smithy.api#documentation": "The template sync configuration detail data that's returned by Proton.
" + } } } }, @@ -1216,7 +1437,7 @@ } ], "traits": { - "smithy.api#documentation": "In an environment account, delete an environment account connection.
\nAfter you delete an environment account connection that’s in use by an AWS Proton environment, AWS Proton can’t\n manage the environment infrastructure resources until a new environment account connection is accepted for the environment account and\n associated environment. You're responsible for cleaning up provisioned resources that remain without an environment connection.
\nFor more information, see Environment account\n connections in the AWS Proton Administrator guide.
", + "smithy.api#documentation": "In an environment account, delete an environment account connection.
\nAfter you delete an environment account connection that’s in use by an Proton environment, Proton can’t manage the\n environment infrastructure resources until a new environment account connection is accepted for the environment account and associated environment.\n You're responsible for cleaning up provisioned resources that remain without an environment connection.
\nFor more information, see Environment account\n connections in the Proton Administrator guide.
", "smithy.api#idempotent": {} } }, @@ -1245,7 +1466,7 @@ "environmentAccountConnection": { "target": "com.amazonaws.proton#EnvironmentAccountConnection", "traits": { - "smithy.api#documentation": "The environment account connection detail data that's returned by AWS Proton.
" + "smithy.api#documentation": "The environment account connection detail data that's returned by Proton.
" } } } @@ -1275,7 +1496,7 @@ "environment": { "target": "com.amazonaws.proton#Environment", "traits": { - "smithy.api#documentation": "The environment detail data that's returned by AWS Proton.
" + "smithy.api#documentation": "The environment detail data that's returned by Proton.
" } } } @@ -1338,7 +1559,7 @@ "environmentTemplate": { "target": "com.amazonaws.proton#EnvironmentTemplate", "traits": { - "smithy.api#documentation": "The environment template detail data that's returned by AWS Proton.
" + "smithy.api#documentation": "The environment template detail data that's returned by Proton.
" } } } @@ -1372,7 +1593,7 @@ } ], "traits": { - "smithy.api#documentation": "If no other minor versions of an environment template exist, delete a major version of the environment template if it's not the\n Recommended version. Delete the Recommended version of the environment template if no other major versions\n or minor versions of the environment template exist. A major version of an environment template is a version that's not backwards\n compatible.
Delete a minor version of an environment template if it isn't the Recommended version. Delete a\n Recommended minor version of the environment template if no other minor versions of the environment template exist. A\n minor version of an environment template is a version that's backwards compatible.
If no other minor versions of an environment template exist, delete a major version of the environment template if it's not the\n Recommended version. Delete the Recommended version of the environment template if no other major versions or minor\n versions of the environment template exist. A major version of an environment template is a version that's not backward compatible.
Delete a minor version of an environment template if it isn't the Recommended version. Delete a\n Recommended minor version of the environment template if no other minor versions of the environment template exist. A minor version\n of an environment template is a version that's backward compatible.
The environment template version detail data that's returned by AWS Proton.
" + "smithy.api#documentation": "The environment template version detail data that's returned by Proton.
" + } + } + } + }, + "com.amazonaws.proton#DeleteRepository": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#DeleteRepositoryInput" + }, + "output": { + "target": "com.amazonaws.proton#DeleteRepositoryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#ConflictException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "De-register and unlink your repository.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.proton#DeleteRepositoryInput": { + "type": "structure", + "members": { + "provider": { + "target": "com.amazonaws.proton#RepositoryProvider", + "traits": { + "smithy.api#documentation": "The repository provider.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.proton#RepositoryName", + "traits": { + "smithy.api#documentation": "The name of the repository.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#references": [ + { + "resource": "com.amazonaws.proton#RepositoryResource" + } + ] + } + }, + "com.amazonaws.proton#DeleteRepositoryOutput": { + "type": "structure", + "members": { + "repository": { + "target": "com.amazonaws.proton#Repository", + "traits": { + "smithy.api#documentation": "The repository detail data that's returned by Proton.
" } } } @@ -1478,7 +1769,7 @@ "service": { "target": "com.amazonaws.proton#Service", "traits": { - "smithy.api#documentation": "The service detail data that's returned by AWS Proton.
" + "smithy.api#documentation": "The service detail data that's returned by Proton.
" } } } @@ -1541,7 +1832,7 @@ "serviceTemplate": { "target": "com.amazonaws.proton#ServiceTemplate", "traits": { - "smithy.api#documentation": "The service template detail data that's returned by AWS Proton.
" + "smithy.api#documentation": "The service template detail data that's returned by Proton.
" } } } @@ -1575,7 +1866,7 @@ } ], "traits": { - "smithy.api#documentation": "If no other minor versions of a service template exist, delete a major version of the service template if it's not the\n Recommended version. Delete the Recommended version of the service template if no other major versions or\n minor versions of the service template exist. A major version of a service template is a version that isn't backwards\n compatible.
Delete a minor version of a service template if it's not the Recommended version. Delete a Recommended minor\n version of the service template if no other minor versions of the service template exist. A minor version of a service template is a\n version that's backwards compatible.
If no other minor versions of a service template exist, delete a major version of the service template if it's not the\n Recommended version. Delete the Recommended version of the service template if no other major versions or minor versions\n of the service template exist. A major version of a service template is a version that isn't backwards compatible.
Delete a minor version of a service template if it's not the Recommended version. Delete a Recommended minor version\n of the service template if no other minor versions of the service template exist. A minor version of a service template is a version that's\n backwards compatible.
The service template version detail data that's returned by AWS Proton.
" + "smithy.api#documentation": "The service template version detail data that's returned by Proton.
" } } } }, - "com.amazonaws.proton#DeploymentStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" - }, - { + "com.amazonaws.proton#DeleteTemplateSyncConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#DeleteTemplateSyncConfigInput" + }, + "output": { + "target": "com.amazonaws.proton#DeleteTemplateSyncConfigOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#ConflictException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Delete a template sync configuration.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.proton#DeleteTemplateSyncConfigInput": { + "type": "structure", + "members": { + "templateName": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "The template name.
", + "smithy.api#required": {} + } + }, + "templateType": { + "target": "com.amazonaws.proton#TemplateType", + "traits": { + "smithy.api#documentation": "The template type.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.proton#DeleteTemplateSyncConfigOutput": { + "type": "structure", + "members": { + "templateSyncConfig": { + "target": "com.amazonaws.proton#TemplateSyncConfig", + "traits": { + "smithy.api#documentation": "The template sync configuration detail data that's returned by Proton.
" + } + } + } + }, + "com.amazonaws.proton#DeploymentId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + } + }, + "com.amazonaws.proton#DeploymentStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { "value": "FAILED", "name": "FAILED" }, @@ -1705,6 +2065,15 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.proton#EmptyNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 0 + } + } + }, "com.amazonaws.proton#Environment": { "type": "structure", "members": { @@ -1786,7 +2155,7 @@ "protonServiceRoleArn": { "target": "com.amazonaws.proton#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make calls to other services on your\n behalf.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
" } }, "environmentAccountConnectionId": { @@ -1812,10 +2181,16 @@ "traits": { "smithy.api#documentation": "When included, indicates that the environment template is for customer provisioned and managed infrastructure.
" } + }, + "provisioningRepository": { + "target": "com.amazonaws.proton#RepositoryBranch", + "traits": { + "smithy.api#documentation": "The repository that you provide with pull request provisioning.
\nProvisioning by pull request is currently in feature preview and is\n only usable with Terraform based Proton Templates. To learn more about\n Amazon Web Services Feature Preview terms, see section 2 on Beta and\n Previews.
\nThe environment detail data. An AWS Proton environment is a set resources shared across an AWS Proton service.
" + "smithy.api#documentation": "The environment detail data. An Proton environment is a set resources shared across an Proton service.
" } }, "com.amazonaws.proton#EnvironmentAccountConnection": { @@ -2067,6 +2442,34 @@ } } }, + "com.amazonaws.proton#EnvironmentOutputResource": { + "type": "resource", + "identifiers": { + "environmentName": { + "target": "com.amazonaws.proton#ResourceName" + }, + "key": { + "target": "com.amazonaws.proton#OutputKey" + } + }, + "list": { + "target": "com.amazonaws.proton#ListEnvironmentOutputs" + } + }, + "com.amazonaws.proton#EnvironmentProvisionedResourceResource": { + "type": "resource", + "identifiers": { + "environmentName": { + "target": "com.amazonaws.proton#ResourceName" + }, + "name": { + "target": "com.amazonaws.proton#ProvisionedResourceName" + } + }, + "list": { + "target": "com.amazonaws.proton#ListEnvironmentProvisionedResources" + } + }, "com.amazonaws.proton#EnvironmentResource": { "type": "resource", "identifiers": { @@ -2153,14 +2556,14 @@ "templateMajorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the major version of the environment template.
", + "smithy.api#documentation": "The major version of the environment template.
", "smithy.api#required": {} } }, "templateMinorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the minor version of the environment template.
", + "smithy.api#documentation": "The minor version of the environment template.
", "smithy.api#required": {} } }, @@ -2180,7 +2583,7 @@ "protonServiceRoleArn": { "target": "com.amazonaws.proton#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make calls to other services on your\n behalf.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
" } }, "environmentAccountConnectionId": { @@ -2392,7 +2795,7 @@ "recommendedVersion": { "target": "com.amazonaws.proton#FullTemplateVersionNumber", "traits": { - "smithy.api#documentation": "The ID of the recommended version of the environment template.
" + "smithy.api#documentation": "The recommended version of the environment template.
" } }, "provisioning": { @@ -2425,21 +2828,21 @@ "majorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the latest major version that's associated with the version of an environment template.
", + "smithy.api#documentation": "The latest major version that's associated with the version of an environment template.
", "smithy.api#required": {} } }, "minorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the minor version of an environment template.
", + "smithy.api#documentation": "The minor version of an environment template.
", "smithy.api#required": {} } }, "recommendedMinorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the recommended minor version of the environment template.
" + "smithy.api#documentation": "The recommended minor version of the environment template.
" } }, "status": { @@ -2551,21 +2954,21 @@ "majorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the latest major version that's associated with the version of an environment template.
", + "smithy.api#documentation": "The latest major version that's associated with the version of an environment template.
", "smithy.api#required": {} } }, "minorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the version of an environment template.
", + "smithy.api#documentation": "The version of an environment template.
", "smithy.api#required": {} } }, "recommendedMinorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the recommended minor version of the environment template.
" + "smithy.api#documentation": "The recommended minor version of the environment template.
" } }, "status": { @@ -2661,7 +3064,7 @@ } ], "traits": { - "smithy.api#documentation": "Get detail data for the AWS Proton pipeline service role.
", + "smithy.api#documentation": "Get detail data for the Proton pipeline service role.
", "smithy.api#readonly": {} } }, @@ -2675,7 +3078,7 @@ "accountSettings": { "target": "com.amazonaws.proton#AccountSettings", "traits": { - "smithy.api#documentation": "The AWS Proton pipeline service role detail data that's returned by AWS Proton.
" + "smithy.api#documentation": "The Proton pipeline service role detail data that's returned by Proton.
" } } } @@ -2765,7 +3168,7 @@ } ], "traits": { - "smithy.api#documentation": "In an environment account, view the detail data for an environment account connection.
\nFor more information, see Environment account\n connections in the AWS Proton Administrator guide.
", + "smithy.api#documentation": "In an environment account, view the detail data for an environment account connection.
\nFor more information, see Environment account\n connections in the Proton Administrator guide.
", "smithy.api#readonly": {} } }, @@ -2794,7 +3197,7 @@ "environmentAccountConnection": { "target": "com.amazonaws.proton#EnvironmentAccountConnection", "traits": { - "smithy.api#documentation": "The environment account connection detail data that's returned by AWS Proton.
", + "smithy.api#documentation": "The environment account connection detail data that's returned by Proton.
", "smithy.api#required": {} } } @@ -2825,7 +3228,7 @@ "environment": { "target": "com.amazonaws.proton#Environment", "traits": { - "smithy.api#documentation": "The environment detail data that's returned by AWS Proton.
", + "smithy.api#documentation": "The environment detail data that's returned by Proton.
", "smithy.api#required": {} } } @@ -2879,7 +3282,7 @@ "environmentTemplate": { "target": "com.amazonaws.proton#EnvironmentTemplate", "traits": { - "smithy.api#documentation": "The environment template detail data that's returned by AWS Proton.
", + "smithy.api#documentation": "The environment template detail data that's returned by Proton.
", "smithy.api#required": {} } } @@ -2966,7 +3369,7 @@ "majorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "To view environment template major version detail data, include majorVersion.
To view environment template major version detail data, include major Version.
The environment template version detail data that's returned by AWS Proton.
", + "smithy.api#documentation": "The environment template version detail data that's returned by Proton.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.proton#GetRepository": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#GetRepositoryInput" + }, + "output": { + "target": "com.amazonaws.proton#GetRepositoryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get detail data for a repository.
", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.proton#GetRepositoryInput": { + "type": "structure", + "members": { + "provider": { + "target": "com.amazonaws.proton#RepositoryProvider", + "traits": { + "smithy.api#documentation": "The repository provider.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.proton#RepositoryName", + "traits": { + "smithy.api#documentation": "The repository name, for example myrepos/myrepo.
The repository detail data that's returned by Proton.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.proton#GetRepositorySyncStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#GetRepositorySyncStatusInput" + }, + "output": { + "target": "com.amazonaws.proton#GetRepositorySyncStatusOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get the repository sync status.
" + } + }, + "com.amazonaws.proton#GetRepositorySyncStatusInput": { + "type": "structure", + "members": { + "repositoryName": { + "target": "com.amazonaws.proton#RepositoryName", + "traits": { + "smithy.api#documentation": "The repository name.
", + "smithy.api#required": {} + } + }, + "repositoryProvider": { + "target": "com.amazonaws.proton#RepositoryProvider", + "traits": { + "smithy.api#documentation": "The repository provider.
", + "smithy.api#required": {} + } + }, + "branch": { + "target": "com.amazonaws.proton#GitBranchName", + "traits": { + "smithy.api#documentation": "The repository branch.
", + "smithy.api#required": {} + } + }, + "syncType": { + "target": "com.amazonaws.proton#SyncType", + "traits": { + "smithy.api#documentation": "The repository sync type.
", "smithy.api#required": {} } } } }, + "com.amazonaws.proton#GetRepositorySyncStatusOutput": { + "type": "structure", + "members": { + "latestSync": { + "target": "com.amazonaws.proton#RepositorySyncAttempt", + "traits": { + "smithy.api#documentation": "The repository sync status detail data that's returned by Proton.
" + } + } + } + }, "com.amazonaws.proton#GetService": { "type": "operation", "input": { @@ -3229,7 +3773,7 @@ } ], "traits": { - "smithy.api#documentation": "Get detail data for a service instance. A service instance is an instantiation of service template, which is running in a specific\n environment.
", + "smithy.api#documentation": "Get detail data for a service instance. A service instance is an instantiation of service template, which is running in a specific\n environment.
", "smithy.api#readonly": {}, "smithy.waiters#waitable": { "ServiceInstanceDeployed": { @@ -3294,7 +3838,7 @@ "serviceInstance": { "target": "com.amazonaws.proton#ServiceInstance", "traits": { - "smithy.api#documentation": "The service instance detail data that's returned by AWS Proton.
", + "smithy.api#documentation": "The service instance detail data that's returned by Proton.
", "smithy.api#required": {} } } @@ -3306,7 +3850,7 @@ "service": { "target": "com.amazonaws.proton#Service", "traits": { - "smithy.api#documentation": "The service detail data that's returned by AWS Proton.
" + "smithy.api#documentation": "The service detail data that's returned by Proton.
" } } } @@ -3366,7 +3910,7 @@ "serviceTemplate": { "target": "com.amazonaws.proton#ServiceTemplate", "traits": { - "smithy.api#documentation": "The service template detail data that's returned by AWS Proton.
", + "smithy.api#documentation": "The service template detail data that's returned by Proton.
", "smithy.api#required": {} } } @@ -3453,7 +3997,7 @@ "majorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "To view service template major version detail data, include majorVersion.
To view service template major version detail data, include major Version.
The service template version detail data that's returned by AWS Proton.
", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.proton#GitBranchName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.proton#InternalServerException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.proton#ErrorMessage", - "traits": { + "smithy.api#documentation": "The service template version detail data that's returned by Proton.
", "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "The request failed to register with the service.
", - "smithy.api#error": "server", - "smithy.api#httpError": 500, - "smithy.api#retryable": {} } }, - "com.amazonaws.proton#ListEnvironmentAccountConnections": { + "com.amazonaws.proton#GetTemplateSyncConfig": { "type": "operation", "input": { - "target": "com.amazonaws.proton#ListEnvironmentAccountConnectionsInput" + "target": "com.amazonaws.proton#GetTemplateSyncConfigInput" }, "output": { - "target": "com.amazonaws.proton#ListEnvironmentAccountConnectionsOutput" + "target": "com.amazonaws.proton#GetTemplateSyncConfigOutput" }, "errors": [ { @@ -3526,6 +4044,9 @@ { "target": "com.amazonaws.proton#InternalServerException" }, + { + "target": "com.amazonaws.proton#ResourceNotFoundException" + }, { "target": "com.amazonaws.proton#ThrottlingException" }, @@ -3534,77 +4055,47 @@ } ], "traits": { - "smithy.api#documentation": "View a list of environment account connections.
\nFor more information, see Environment account\n connections in the AWS Proton Administrator guide.
", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "environmentAccountConnections", - "pageSize": "maxResults" - }, + "smithy.api#documentation": "Get detail data for a template sync configuration.
", "smithy.api#readonly": {} } }, - "com.amazonaws.proton#ListEnvironmentAccountConnectionsInput": { + "com.amazonaws.proton#GetTemplateSyncConfigInput": { "type": "structure", "members": { - "requestedBy": { - "target": "com.amazonaws.proton#EnvironmentAccountConnectionRequesterAccountType", + "templateName": { + "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "The type of account making the ListEnvironmentAccountConnections request.
The template name.
", "smithy.api#required": {} } }, - "environmentName": { - "target": "com.amazonaws.proton#ResourceName", + "templateType": { + "target": "com.amazonaws.proton#TemplateType", "traits": { - "smithy.api#documentation": "The environment name that's associated with each listed environment account connection.
" - } - }, - "statuses": { - "target": "com.amazonaws.proton#EnvironmentAccountConnectionStatusList", - "traits": { - "smithy.api#documentation": "The status details for each listed environment account connection.
" - } - }, - "nextToken": { - "target": "com.amazonaws.proton#NextToken", - "traits": { - "smithy.api#documentation": "A token to indicate the location of the next environment account connection in the array of environment account connections, after the\n list of environment account connections that was previously requested.
" - } - }, - "maxResults": { - "target": "com.amazonaws.proton#MaxPageResults", - "traits": { - "smithy.api#documentation": "The maximum number of environment account connections to list.
" + "smithy.api#documentation": "The template type.
", + "smithy.api#required": {} } } } }, - "com.amazonaws.proton#ListEnvironmentAccountConnectionsOutput": { + "com.amazonaws.proton#GetTemplateSyncConfigOutput": { "type": "structure", "members": { - "environmentAccountConnections": { - "target": "com.amazonaws.proton#EnvironmentAccountConnectionSummaryList", - "traits": { - "smithy.api#documentation": "An array of environment account connections with details that's returned by AWS Proton.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.proton#NextToken", + "templateSyncConfig": { + "target": "com.amazonaws.proton#TemplateSyncConfig", "traits": { - "smithy.api#documentation": "A token to indicate the location of the next environment account connection in the array of environment account connections, after the\n current requested list of environment account connections.
" + "smithy.api#documentation": "The template sync configuration detail data that's returned by Proton.
" } } } }, - "com.amazonaws.proton#ListEnvironmentTemplateVersions": { + "com.amazonaws.proton#GetTemplateSyncStatus": { "type": "operation", "input": { - "target": "com.amazonaws.proton#ListEnvironmentTemplateVersionsInput" + "target": "com.amazonaws.proton#GetTemplateSyncStatusInput" }, "output": { - "target": "com.amazonaws.proton#ListEnvironmentTemplateVersionsOutput" + "target": "com.amazonaws.proton#GetTemplateSyncStatusOutput" }, "errors": [ { @@ -3624,71 +4115,91 @@ } ], "traits": { - "smithy.api#documentation": "List major or minor versions of an environment template with detail data.
", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "templateVersions", - "pageSize": "maxResults" - }, - "smithy.api#readonly": {} + "smithy.api#documentation": "Get the status of a template sync.
" } }, - "com.amazonaws.proton#ListEnvironmentTemplateVersionsInput": { + "com.amazonaws.proton#GetTemplateSyncStatusInput": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.proton#NextToken", - "traits": { - "smithy.api#documentation": "A token to indicate the location of the next major or minor version in the array of major or minor versions of an environment template,\n after the list of major or minor versions that was previously requested.
" - } - }, - "maxResults": { - "target": "com.amazonaws.proton#MaxPageResults", + "templateName": { + "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "The maximum number of major or minor versions of an environment template to list.
" + "smithy.api#documentation": "The template name.
", + "smithy.api#required": {} } }, - "templateName": { - "target": "com.amazonaws.proton#ResourceName", + "templateType": { + "target": "com.amazonaws.proton#TemplateType", "traits": { - "smithy.api#documentation": "The name of the environment template.
", + "smithy.api#documentation": "The template type.
", "smithy.api#required": {} } }, - "majorVersion": { + "templateVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "To view a list of minor of versions under a major version of an environment template, include majorVersion.
To view a list of major versions of an environment template, exclude\n majorVersion.
The template version.
", + "smithy.api#required": {} } } } }, - "com.amazonaws.proton#ListEnvironmentTemplateVersionsOutput": { + "com.amazonaws.proton#GetTemplateSyncStatusOutput": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.proton#NextToken", + "latestSync": { + "target": "com.amazonaws.proton#ResourceSyncAttempt", "traits": { - "smithy.api#documentation": "A token to indicate the location of the next major or minor version in the array of major or minor versions of an environment template,\n after the list of major or minor versions that was previously requested.
" + "smithy.api#documentation": "The details of the last sync that's returned by Proton.
" } }, - "templateVersions": { - "target": "com.amazonaws.proton#EnvironmentTemplateVersionSummaryList", + "latestSuccessfulSync": { + "target": "com.amazonaws.proton#ResourceSyncAttempt", + "traits": { + "smithy.api#documentation": "The details of the last successful sync that's returned by Proton.
" + } + }, + "desiredState": { + "target": "com.amazonaws.proton#Revision", + "traits": { + "smithy.api#documentation": "The template sync desired state that's returned by Proton.
" + } + } + } + }, + "com.amazonaws.proton#GitBranchName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.proton#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.proton#ErrorMessage", "traits": { - "smithy.api#documentation": "An array of major or minor versions of an environment template detail data.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "The request failed to register with the service.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} } }, - "com.amazonaws.proton#ListEnvironmentTemplates": { + "com.amazonaws.proton#ListEnvironmentAccountConnections": { "type": "operation", "input": { - "target": "com.amazonaws.proton#ListEnvironmentTemplatesInput" + "target": "com.amazonaws.proton#ListEnvironmentAccountConnectionsInput" }, "output": { - "target": "com.amazonaws.proton#ListEnvironmentTemplatesOutput" + "target": "com.amazonaws.proton#ListEnvironmentAccountConnectionsOutput" }, "errors": [ { @@ -3705,58 +4216,77 @@ } ], "traits": { - "smithy.api#documentation": "List environment templates.
", + "smithy.api#documentation": "View a list of environment account connections.
\nFor more information, see Environment account\n connections in the Proton Administrator guide.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "templates", + "items": "environmentAccountConnections", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, - "com.amazonaws.proton#ListEnvironmentTemplatesInput": { + "com.amazonaws.proton#ListEnvironmentAccountConnectionsInput": { "type": "structure", "members": { + "requestedBy": { + "target": "com.amazonaws.proton#EnvironmentAccountConnectionRequesterAccountType", + "traits": { + "smithy.api#documentation": "The type of account making the ListEnvironmentAccountConnections request.
The environment name that's associated with each listed environment account connection.
" + } + }, + "statuses": { + "target": "com.amazonaws.proton#EnvironmentAccountConnectionStatusList", + "traits": { + "smithy.api#documentation": "The status details for each listed environment account connection.
" + } + }, "nextToken": { "target": "com.amazonaws.proton#NextToken", "traits": { - "smithy.api#documentation": "A token to indicate the location of the next environment template in the array of environment templates, after the list of environment\n templates that was previously requested.
" + "smithy.api#documentation": "A token to indicate the location of the next environment account connection in the array of environment account connections, after the list of\n environment account connections that was previously requested.
" } }, "maxResults": { "target": "com.amazonaws.proton#MaxPageResults", "traits": { - "smithy.api#documentation": "The maximum number of environment templates to list.
" + "smithy.api#documentation": "The maximum number of environment account connections to list.
" } } } }, - "com.amazonaws.proton#ListEnvironmentTemplatesOutput": { + "com.amazonaws.proton#ListEnvironmentAccountConnectionsOutput": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.proton#NextToken", + "environmentAccountConnections": { + "target": "com.amazonaws.proton#EnvironmentAccountConnectionSummaryList", "traits": { - "smithy.api#documentation": "A token to indicate the location of the next environment template in the array of environment templates, after the current requested\n list of environment templates.
" + "smithy.api#documentation": "An array of environment account connections with details that's returned by Proton.
", + "smithy.api#required": {} } }, - "templates": { - "target": "com.amazonaws.proton#EnvironmentTemplateSummaryList", + "nextToken": { + "target": "com.amazonaws.proton#NextToken", "traits": { - "smithy.api#documentation": "An array of environment templates with detail data.
", - "smithy.api#required": {} + "smithy.api#documentation": "A token to indicate the location of the next environment account connection in the array of environment account connections, after the current\n requested list of environment account connections.
" } } } }, - "com.amazonaws.proton#ListEnvironments": { + "com.amazonaws.proton#ListEnvironmentOutputs": { "type": "operation", "input": { - "target": "com.amazonaws.proton#ListEnvironmentsInput" + "target": "com.amazonaws.proton#ListEnvironmentOutputsInput" }, "output": { - "target": "com.amazonaws.proton#ListEnvironmentsOutput" + "target": "com.amazonaws.proton#ListEnvironmentOutputsOutput" }, "errors": [ { @@ -3776,64 +4306,58 @@ } ], "traits": { - "smithy.api#documentation": "List environments with detail data summaries.
", + "smithy.api#documentation": "List the infrastructure as code outputs for your environment.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "environments", - "pageSize": "maxResults" + "items": "outputs" }, "smithy.api#readonly": {} } }, - "com.amazonaws.proton#ListEnvironmentsInput": { + "com.amazonaws.proton#ListEnvironmentOutputsInput": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.proton#NextToken", - "traits": { - "smithy.api#documentation": "A token to indicate the location of the next environment in the array of environments, after the list of environments that was\n previously requested.
" - } - }, - "maxResults": { - "target": "com.amazonaws.proton#MaxPageResults", + "environmentName": { + "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "The maximum number of environments to list.
" + "smithy.api#documentation": "The environment name.
", + "smithy.api#required": {} } }, - "environmentTemplates": { - "target": "com.amazonaws.proton#EnvironmentTemplateFilterList", + "nextToken": { + "target": "com.amazonaws.proton#EmptyNextToken", "traits": { - "smithy.api#documentation": "An array of the versions of the environment template.
" + "smithy.api#documentation": "A token to indicate the location of the next environment output in the array of environment outputs, after the list of environment outputs\n that was previously requested.
" } } } }, - "com.amazonaws.proton#ListEnvironmentsOutput": { + "com.amazonaws.proton#ListEnvironmentOutputsOutput": { "type": "structure", "members": { "nextToken": { - "target": "com.amazonaws.proton#NextToken", + "target": "com.amazonaws.proton#EmptyNextToken", "traits": { - "smithy.api#documentation": "A token to indicate the location of the next environment in the array of environments, after the current requested list of\n environments.
" + "smithy.api#documentation": "A token to indicate the location of the next environment output in the array of environment outputs, after the current requested list of\n environment outputs.
" } }, - "environments": { - "target": "com.amazonaws.proton#EnvironmentSummaryList", + "outputs": { + "target": "com.amazonaws.proton#OutputsList", "traits": { - "smithy.api#documentation": "An array of environment detail data summaries.
", + "smithy.api#documentation": "An array of environment outputs with detail data.
", "smithy.api#required": {} } } } }, - "com.amazonaws.proton#ListServiceInstances": { + "com.amazonaws.proton#ListEnvironmentProvisionedResources": { "type": "operation", "input": { - "target": "com.amazonaws.proton#ListServiceInstancesInput" + "target": "com.amazonaws.proton#ListEnvironmentProvisionedResourcesInput" }, "output": { - "target": "com.amazonaws.proton#ListServiceInstancesOutput" + "target": "com.amazonaws.proton#ListEnvironmentProvisionedResourcesOutput" }, "errors": [ { @@ -3853,64 +4377,58 @@ } ], "traits": { - "smithy.api#documentation": "List service instances with summaries of detail data.
", + "smithy.api#documentation": "List the provisioned resources for your environment.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "serviceInstances", - "pageSize": "maxResults" + "items": "provisionedResources" }, "smithy.api#readonly": {} } }, - "com.amazonaws.proton#ListServiceInstancesInput": { + "com.amazonaws.proton#ListEnvironmentProvisionedResourcesInput": { "type": "structure", "members": { - "serviceName": { + "environmentName": { "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "The name of the service that the service instance belongs to.
" + "smithy.api#documentation": "The environment name.
", + "smithy.api#required": {} } }, "nextToken": { - "target": "com.amazonaws.proton#NextToken", - "traits": { - "smithy.api#documentation": "A token to indicate the location of the next service in the array of service instances, after the list of service instances that was\n previously requested.
" - } - }, - "maxResults": { - "target": "com.amazonaws.proton#MaxPageResults", + "target": "com.amazonaws.proton#EmptyNextToken", "traits": { - "smithy.api#documentation": "The maximum number of service instances to list.
" + "smithy.api#documentation": "A token to indicate the location of the next environment provisioned resource in the array of environment provisioned resources, after the\n list of environment provisioned resources that was previously requested.
" } } } }, - "com.amazonaws.proton#ListServiceInstancesOutput": { + "com.amazonaws.proton#ListEnvironmentProvisionedResourcesOutput": { "type": "structure", "members": { "nextToken": { - "target": "com.amazonaws.proton#NextToken", + "target": "com.amazonaws.proton#EmptyNextToken", "traits": { - "smithy.api#documentation": "A token to indicate the location of the next service instance in the array of service instances, after the current requested list of\n service instances.
" + "smithy.api#documentation": "A token to indicate the location of the next environment provisioned resource in the array of provisioned resources, after the current\n requested list of environment provisioned resources.
" } }, - "serviceInstances": { - "target": "com.amazonaws.proton#ServiceInstanceSummaryList", + "provisionedResources": { + "target": "com.amazonaws.proton#ProvisionedResourceList", "traits": { - "smithy.api#documentation": "An array of service instances with summaries of detail data.
", + "smithy.api#documentation": "An array of environment provisioned resources.
", "smithy.api#required": {} } } } }, - "com.amazonaws.proton#ListServiceTemplateVersions": { + "com.amazonaws.proton#ListEnvironmentTemplateVersions": { "type": "operation", "input": { - "target": "com.amazonaws.proton#ListServiceTemplateVersionsInput" + "target": "com.amazonaws.proton#ListEnvironmentTemplateVersionsInput" }, "output": { - "target": "com.amazonaws.proton#ListServiceTemplateVersionsOutput" + "target": "com.amazonaws.proton#ListEnvironmentTemplateVersionsOutput" }, "errors": [ { @@ -3930,7 +4448,7 @@ } ], "traits": { - "smithy.api#documentation": "List major or minor versions of a service template with detail data.
", + "smithy.api#documentation": "List major or minor versions of an environment template with detail data.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -3940,61 +4458,61 @@ "smithy.api#readonly": {} } }, - "com.amazonaws.proton#ListServiceTemplateVersionsInput": { + "com.amazonaws.proton#ListEnvironmentTemplateVersionsInput": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.proton#NextToken", "traits": { - "smithy.api#documentation": "A token to indicate the location of the next major or minor version in the array of major or minor versions of a service template, after\n the list of major or minor versions that was previously requested.
" + "smithy.api#documentation": "A token to indicate the location of the next major or minor version in the array of major or minor versions of an environment template, after\n the list of major or minor versions that was previously requested.
" } }, "maxResults": { "target": "com.amazonaws.proton#MaxPageResults", "traits": { - "smithy.api#documentation": "The maximum number of major or minor versions of a service template to list.
" + "smithy.api#documentation": "The maximum number of major or minor versions of an environment template to list.
" } }, "templateName": { "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "The name of the service template.
", + "smithy.api#documentation": "The name of the environment template.
", "smithy.api#required": {} } }, "majorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "To view a list of minor of versions under a major version of a service template, include majorVersion.
To view a list of major versions of a service template, exclude\n majorVersion.
To view a list of minor of versions under a major version of an environment template, include major Version.
To view a list of major versions of an environment template, exclude\n major Version.
A token to indicate the location of the next major or minor version in the array of major or minor versions of a service template, after\n the list of major or minor versions that was previously requested.
" + "smithy.api#documentation": "A token to indicate the location of the next major or minor version in the array of major or minor versions of an environment template, after\n the list of major or minor versions that was previously requested.
" } }, "templateVersions": { - "target": "com.amazonaws.proton#ServiceTemplateVersionSummaryList", + "target": "com.amazonaws.proton#EnvironmentTemplateVersionSummaryList", "traits": { - "smithy.api#documentation": "An array of major or minor versions of a service template with detail data.
", + "smithy.api#documentation": "An array of major or minor versions of an environment template detail data.
", "smithy.api#required": {} } } } }, - "com.amazonaws.proton#ListServiceTemplates": { + "com.amazonaws.proton#ListEnvironmentTemplates": { "type": "operation", "input": { - "target": "com.amazonaws.proton#ListServiceTemplatesInput" + "target": "com.amazonaws.proton#ListEnvironmentTemplatesInput" }, "output": { - "target": "com.amazonaws.proton#ListServiceTemplatesOutput" + "target": "com.amazonaws.proton#ListEnvironmentTemplatesOutput" }, "errors": [ { @@ -4011,7 +4529,7 @@ } ], "traits": { - "smithy.api#documentation": "List service templates with detail data.
", + "smithy.api#documentation": "List environment templates.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -4021,48 +4539,48 @@ "smithy.api#readonly": {} } }, - "com.amazonaws.proton#ListServiceTemplatesInput": { + "com.amazonaws.proton#ListEnvironmentTemplatesInput": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.proton#NextToken", "traits": { - "smithy.api#documentation": "A token to indicate the location of the next service template in the array of service templates, after the list of service templates\n previously requested.
" + "smithy.api#documentation": "A token to indicate the location of the next environment template in the array of environment templates, after the list of environment\n templates that was previously requested.
" } }, "maxResults": { "target": "com.amazonaws.proton#MaxPageResults", "traits": { - "smithy.api#documentation": "The maximum number of service templates to list.
" + "smithy.api#documentation": "The maximum number of environment templates to list.
" } } } }, - "com.amazonaws.proton#ListServiceTemplatesOutput": { + "com.amazonaws.proton#ListEnvironmentTemplatesOutput": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.proton#NextToken", "traits": { - "smithy.api#documentation": "A token to indicate the location of the next service template in the array of service templates, after the current requested list of\n service templates.
" + "smithy.api#documentation": "A token to indicate the location of the next environment template in the array of environment templates, after the current requested list of\n environment templates.
" } }, "templates": { - "target": "com.amazonaws.proton#ServiceTemplateSummaryList", + "target": "com.amazonaws.proton#EnvironmentTemplateSummaryList", "traits": { - "smithy.api#documentation": "An array of service templates with detail data.
", + "smithy.api#documentation": "An array of environment templates with detail data.
", "smithy.api#required": {} } } } }, - "com.amazonaws.proton#ListServices": { + "com.amazonaws.proton#ListEnvironments": { "type": "operation", "input": { - "target": "com.amazonaws.proton#ListServicesInput" + "target": "com.amazonaws.proton#ListEnvironmentsInput" }, "output": { - "target": "com.amazonaws.proton#ListServicesOutput" + "target": "com.amazonaws.proton#ListEnvironmentsOutput" }, "errors": [ { @@ -4071,6 +4589,9 @@ { "target": "com.amazonaws.proton#InternalServerException" }, + { + "target": "com.amazonaws.proton#ResourceNotFoundException" + }, { "target": "com.amazonaws.proton#ThrottlingException" }, @@ -4079,58 +4600,64 @@ } ], "traits": { - "smithy.api#documentation": "List services with summaries of detail data.
", + "smithy.api#documentation": "List environments with detail data summaries.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "services", + "items": "environments", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, - "com.amazonaws.proton#ListServicesInput": { + "com.amazonaws.proton#ListEnvironmentsInput": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.proton#NextToken", "traits": { - "smithy.api#documentation": "A token to indicate the location of the next service in the array of services, after the list of services that was previously\n requested.
" + "smithy.api#documentation": "A token to indicate the location of the next environment in the array of environments, after the list of environments that was previously\n requested.
" } }, "maxResults": { "target": "com.amazonaws.proton#MaxPageResults", "traits": { - "smithy.api#documentation": "The maximum number of services to list.
" + "smithy.api#documentation": "The maximum number of environments to list.
" + } + }, + "environmentTemplates": { + "target": "com.amazonaws.proton#EnvironmentTemplateFilterList", + "traits": { + "smithy.api#documentation": "An array of the versions of the environment template.
" } } } }, - "com.amazonaws.proton#ListServicesOutput": { + "com.amazonaws.proton#ListEnvironmentsOutput": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.proton#NextToken", "traits": { - "smithy.api#documentation": "A token to indicate the location of the next service in the array of services, after the current requested list of services.
" + "smithy.api#documentation": "A token to indicate the location of the next environment in the array of environments, after the current requested list of\n environments.
" } }, - "services": { - "target": "com.amazonaws.proton#ServiceSummaryList", + "environments": { + "target": "com.amazonaws.proton#EnvironmentSummaryList", "traits": { - "smithy.api#documentation": "An array of services with summaries of detail data.
", + "smithy.api#documentation": "An array of environment detail data summaries.
", "smithy.api#required": {} } } } }, - "com.amazonaws.proton#ListTagsForResource": { + "com.amazonaws.proton#ListRepositories": { "type": "operation", "input": { - "target": "com.amazonaws.proton#ListTagsForResourceInput" + "target": "com.amazonaws.proton#ListRepositoriesInput" }, "output": { - "target": "com.amazonaws.proton#ListTagsForResourceOutput" + "target": "com.amazonaws.proton#ListRepositoriesOutput" }, "errors": [ { @@ -4150,103 +4677,223 @@ } ], "traits": { - "smithy.api#documentation": "List tags for a resource. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.
", + "smithy.api#documentation": "List repositories with detail data.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "tags", + "items": "repositories", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, - "com.amazonaws.proton#ListTagsForResourceInput": { + "com.amazonaws.proton#ListRepositoriesInput": { "type": "structure", "members": { - "resourceArn": { - "target": "com.amazonaws.proton#Arn", + "nextToken": { + "target": "com.amazonaws.proton#NextToken", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for the listed tags.
", - "smithy.api#httpQuery": "resourceArn", - "smithy.api#required": {} + "smithy.api#documentation": "A token to indicate the location of the next repository in the array of repositories, after the list of repositories previously\n requested.
" } }, + "maxResults": { + "target": "com.amazonaws.proton#MaxPageResults", + "traits": { + "smithy.api#documentation": "The maximum number of repositories to list.
" + } + } + } + }, + "com.amazonaws.proton#ListRepositoriesOutput": { + "type": "structure", + "members": { "nextToken": { - "target": "smithy.api#String", + "target": "com.amazonaws.proton#NextToken", "traits": { - "smithy.api#documentation": "A token to indicate the location of the next resource tag in the array of resource tags, after the list of resource tags that was\n previously requested.
", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "A token to indicate the location of the next repository in the array of repositories, after the current requested list of repositories.\n
" } }, - "maxResults": { - "target": "com.amazonaws.proton#MaxPageResults", + "repositories": { + "target": "com.amazonaws.proton#RepositorySummaryList", "traits": { - "smithy.api#documentation": "The maximum number of tags to list.
", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "An array of repositories.
", + "smithy.api#required": {} } } } }, - "com.amazonaws.proton#ListTagsForResourceOutput": { + "com.amazonaws.proton#ListRepositorySyncDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#ListRepositorySyncDefinitionsInput" + }, + "output": { + "target": "com.amazonaws.proton#ListRepositorySyncDefinitionsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List repository sync definitions with detail data.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "syncDefinitions" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.proton#ListRepositorySyncDefinitionsInput": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.proton#TagList", + "repositoryName": { + "target": "com.amazonaws.proton#RepositoryName", "traits": { - "smithy.api#documentation": "An array of resource tags with detail data.
", + "smithy.api#documentation": "The repository name.
", + "smithy.api#required": {} + } + }, + "repositoryProvider": { + "target": "com.amazonaws.proton#RepositoryProvider", + "traits": { + "smithy.api#documentation": "The repository provider.
", + "smithy.api#required": {} + } + }, + "syncType": { + "target": "com.amazonaws.proton#SyncType", + "traits": { + "smithy.api#documentation": "The sync type. The only supported value is TEMPLATE_SYNC.
A token to indicate the location of the next resource tag in the array of resource tags, after the current requested list of resource\n tags.
" + "smithy.api#documentation": "A token to indicate the location of the next repository sync definition in the array of repository sync definitions, after the list of\n repository sync definitions previously requested.
" } } } }, - "com.amazonaws.proton#MaxPageResults": { - "type": "integer", - "traits": { - "smithy.api#box": {}, - "smithy.api#range": { - "min": 1, - "max": 100 + "com.amazonaws.proton#ListRepositorySyncDefinitionsOutput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.proton#EmptyNextToken", + "traits": { + "smithy.api#documentation": "A token to indicate the location of the next repository sync definition in the array of repository sync definitions, after the current\n requested list of repository sync definitions.
" + } + }, + "syncDefinitions": { + "target": "com.amazonaws.proton#RepositorySyncDefinitionList", + "traits": { + "smithy.api#documentation": "An array of repository sync definitions.
", + "smithy.api#required": {} + } } } }, - "com.amazonaws.proton#NextToken": { - "type": "string", + "com.amazonaws.proton#ListServiceInstanceOutputs": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#ListServiceInstanceOutputsInput" + }, + "output": { + "target": "com.amazonaws.proton#ListServiceInstanceOutputsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], "traits": { - "smithy.api#pattern": "^[A-Za-z0-9+=/]+$" + "smithy.api#documentation": "View a list service instance infrastructure as code outputs with detail data.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "outputs" + }, + "smithy.api#readonly": {} } }, - "com.amazonaws.proton#Provisioning": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CUSTOMER_MANAGED", - "name": "CUSTOMER_MANAGED" + "com.amazonaws.proton#ListServiceInstanceOutputsInput": { + "type": "structure", + "members": { + "serviceInstanceName": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "The service instance name.
", + "smithy.api#required": {} } - ] + }, + "serviceName": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "The service name.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.proton#EmptyNextToken", + "traits": { + "smithy.api#documentation": "A token to indicate the location of the next output in the array of outputs, after the list of outputs that was previously requested.
" + } + } } }, - "com.amazonaws.proton#RejectEnvironmentAccountConnection": { + "com.amazonaws.proton#ListServiceInstanceOutputsOutput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.proton#EmptyNextToken", + "traits": { + "smithy.api#documentation": "A token to indicate the location of the next output in the array of outputs, after the current requested list of outputs.
" + } + }, + "outputs": { + "target": "com.amazonaws.proton#OutputsList", + "traits": { + "smithy.api#documentation": "An array of service instance infrastructure as code outputs.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.proton#ListServiceInstanceProvisionedResources": { "type": "operation", "input": { - "target": "com.amazonaws.proton#RejectEnvironmentAccountConnectionInput" + "target": "com.amazonaws.proton#ListServiceInstanceProvisionedResourcesInput" }, "output": { - "target": "com.amazonaws.proton#RejectEnvironmentAccountConnectionOutput" + "target": "com.amazonaws.proton#ListServiceInstanceProvisionedResourcesOutput" }, "errors": [ { "target": "com.amazonaws.proton#AccessDeniedException" }, - { - "target": "com.amazonaws.proton#ConflictException" - }, { "target": "com.amazonaws.proton#InternalServerException" }, @@ -4261,74 +4908,1444 @@ } ], "traits": { - "smithy.api#documentation": "In a management account, reject an environment account connection from another environment account.
\nAfter you reject an environment account connection request, you won’t be able to accept or use the rejected\n environment account connection.
\nYou can’t reject an environment account connection that is connected to an environment.
\nFor more information, see Environment account\n connections in the AWS Proton Administrator guide.
", - "smithy.api#idempotent": {} + "smithy.api#documentation": "List provisioned resources for a service instance with details.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "provisionedResources" + }, + "smithy.api#readonly": {} } }, - "com.amazonaws.proton#RejectEnvironmentAccountConnectionInput": { + "com.amazonaws.proton#ListServiceInstanceProvisionedResourcesInput": { "type": "structure", "members": { - "id": { - "target": "com.amazonaws.proton#EnvironmentAccountConnectionId", + "serviceName": { + "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "The ID of the environment account connection to reject.
", + "smithy.api#documentation": "The service name.
", + "smithy.api#required": {} + } + }, + "serviceInstanceName": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "The service instance name.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.proton#EmptyNextToken", + "traits": { + "smithy.api#documentation": "A token to indicate the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned\n resources that was previously requested.
" + } + } + } + }, + "com.amazonaws.proton#ListServiceInstanceProvisionedResourcesOutput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.proton#EmptyNextToken", + "traits": { + "smithy.api#documentation": "A token to indicate the location of the next provisioned resource in the array of provisioned resources, after the current requested list of\n provisioned resources.
" + } + }, + "provisionedResources": { + "target": "com.amazonaws.proton#ProvisionedResourceList", + "traits": { + "smithy.api#documentation": "An array of provisioned resources for a service instance.
", "smithy.api#required": {} } } + } + }, + "com.amazonaws.proton#ListServiceInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#ListServiceInstancesInput" + }, + "output": { + "target": "com.amazonaws.proton#ListServiceInstancesOutput" }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], "traits": { - "smithy.api#references": [ - { - "resource": "com.amazonaws.proton#EnvironmentAccountConnectionResource" + "smithy.api#documentation": "List service instances with summaries of detail data.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "serviceInstances", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.proton#ListServiceInstancesInput": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the service that the service instance belongs to.
" } - ] + }, + "nextToken": { + "target": "com.amazonaws.proton#NextToken", + "traits": { + "smithy.api#documentation": "A token to indicate the location of the next service in the array of service instances, after the list of service instances that was\n previously requested.
" + } + }, + "maxResults": { + "target": "com.amazonaws.proton#MaxPageResults", + "traits": { + "smithy.api#documentation": "The maximum number of service instances to list.
" + } + } } }, - "com.amazonaws.proton#RejectEnvironmentAccountConnectionOutput": { + "com.amazonaws.proton#ListServiceInstancesOutput": { "type": "structure", "members": { - "environmentAccountConnection": { - "target": "com.amazonaws.proton#EnvironmentAccountConnection", + "nextToken": { + "target": "com.amazonaws.proton#NextToken", + "traits": { + "smithy.api#documentation": "A token to indicate the location of the next service instance in the array of service instances, after the current requested list of service\n instances.
" + } + }, + "serviceInstances": { + "target": "com.amazonaws.proton#ServiceInstanceSummaryList", + "traits": { + "smithy.api#documentation": "An array of service instances with summaries of detail data.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.proton#ListServicePipelineOutputs": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#ListServicePipelineOutputsInput" + }, + "output": { + "target": "com.amazonaws.proton#ListServicePipelineOutputsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "View a list service pipeline infrastructure as code outputs with detail.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "outputs" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.proton#ListServicePipelineOutputsInput": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "The service name.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.proton#EmptyNextToken", + "traits": { + "smithy.api#documentation": "A token to indicate the location of the next output in the array of outputs, after the list of outputs that was previously requested.
" + } + } + } + }, + "com.amazonaws.proton#ListServicePipelineOutputsOutput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.proton#EmptyNextToken", + "traits": { + "smithy.api#documentation": "A token to indicate the location of the next output in the array of outputs, after the current requested list of outputs.
" + } + }, + "outputs": { + "target": "com.amazonaws.proton#OutputsList", + "traits": { + "smithy.api#documentation": "An array of outputs.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.proton#ListServicePipelineProvisionedResources": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#ListServicePipelineProvisionedResourcesInput" + }, + "output": { + "target": "com.amazonaws.proton#ListServicePipelineProvisionedResourcesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List provisioned resources for a service and pipeline with details.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "provisionedResources" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.proton#ListServicePipelineProvisionedResourcesInput": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "The service name.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.proton#EmptyNextToken", + "traits": { + "smithy.api#documentation": "A token to indicate the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned\n resources that was previously requested.
" + } + } + } + }, + "com.amazonaws.proton#ListServicePipelineProvisionedResourcesOutput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.proton#EmptyNextToken", + "traits": { + "smithy.api#documentation": "A token to indicate the location of the next provisioned resource in the array of provisioned resources, after the current requested list of\n provisioned resources.
" + } + }, + "provisionedResources": { + "target": "com.amazonaws.proton#ProvisionedResourceList", + "traits": { + "smithy.api#documentation": "An array of provisioned resources for a service and pipeline.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.proton#ListServiceTemplateVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#ListServiceTemplateVersionsInput" + }, + "output": { + "target": "com.amazonaws.proton#ListServiceTemplateVersionsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List major or minor versions of a service template with detail data.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "templateVersions", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.proton#ListServiceTemplateVersionsInput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.proton#NextToken", + "traits": { + "smithy.api#documentation": "A token to indicate the location of the next major or minor version in the array of major or minor versions of a service template, after the\n list of major or minor versions that was previously requested.
" + } + }, + "maxResults": { + "target": "com.amazonaws.proton#MaxPageResults", + "traits": { + "smithy.api#documentation": "The maximum number of major or minor versions of a service template to list.
" + } + }, + "templateName": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the service template.
", + "smithy.api#required": {} + } + }, + "majorVersion": { + "target": "com.amazonaws.proton#TemplateVersionPart", + "traits": { + "smithy.api#documentation": "To view a list of minor of versions under a major version of a service template, include major Version.
To view a list of major versions of a service template, exclude\n major Version.
A token to indicate the location of the next major or minor version in the array of major or minor versions of a service template, after the\n current requested list of service major or minor versions.
" + } + }, + "templateVersions": { + "target": "com.amazonaws.proton#ServiceTemplateVersionSummaryList", + "traits": { + "smithy.api#documentation": "An array of major or minor versions of a service template with detail data.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.proton#ListServiceTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#ListServiceTemplatesInput" + }, + "output": { + "target": "com.amazonaws.proton#ListServiceTemplatesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List service templates with detail data.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "templates", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.proton#ListServiceTemplatesInput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.proton#NextToken", + "traits": { + "smithy.api#documentation": "A token to indicate the location of the next service template in the array of service templates, after the list of service templates\n previously requested.
" + } + }, + "maxResults": { + "target": "com.amazonaws.proton#MaxPageResults", + "traits": { + "smithy.api#documentation": "The maximum number of service templates to list.
" + } + } + } + }, + "com.amazonaws.proton#ListServiceTemplatesOutput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.proton#NextToken", + "traits": { + "smithy.api#documentation": "A token to indicate the location of the next service template in the array of service templates, after the current requested list of service\n templates.
" + } + }, + "templates": { + "target": "com.amazonaws.proton#ServiceTemplateSummaryList", + "traits": { + "smithy.api#documentation": "An array of service templates with detail data.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.proton#ListServices": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#ListServicesInput" + }, + "output": { + "target": "com.amazonaws.proton#ListServicesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List services with summaries of detail data.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "services", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.proton#ListServicesInput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.proton#NextToken", + "traits": { + "smithy.api#documentation": "A token to indicate the location of the next service in the array of services, after the list of services that was previously\n requested.
" + } + }, + "maxResults": { + "target": "com.amazonaws.proton#MaxPageResults", + "traits": { + "smithy.api#documentation": "The maximum number of services to list.
" + } + } + } + }, + "com.amazonaws.proton#ListServicesOutput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.proton#NextToken", + "traits": { + "smithy.api#documentation": "A token to indicate the location of the next service in the array of services, after the current requested list of services.
" + } + }, + "services": { + "target": "com.amazonaws.proton#ServiceSummaryList", + "traits": { + "smithy.api#documentation": "An array of services with summaries of detail data.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.proton#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#ListTagsForResourceInput" + }, + "output": { + "target": "com.amazonaws.proton#ListTagsForResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List tags for a resource. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "tags", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.proton#ListTagsForResourceInput": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.proton#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for the listed tags.
", + "smithy.api#httpQuery": "resourceArn", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A token to indicate the location of the next resource tag in the array of resource tags, after the list of resource tags that was previously\n requested.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.proton#MaxPageResults", + "traits": { + "smithy.api#documentation": "The maximum number of tags to list.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.proton#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.proton#TagList", + "traits": { + "smithy.api#documentation": "An array of resource tags with detail data.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A token to indicate the location of the next resource tag in the array of resource tags, after the current requested list of resource\n tags.
" + } + } + } + }, + "com.amazonaws.proton#MaxPageResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.proton#NextToken": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Za-z0-9+=/]+$" + } + }, + "com.amazonaws.proton#NotifyResourceDeploymentStatusChange": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#NotifyResourceDeploymentStatusChangeInput" + }, + "output": { + "target": "com.amazonaws.proton#NotifyResourceDeploymentStatusChangeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#ConflictException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.proton#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Notify Proton of status changes to a provisioned resource when you use pull request provisioning. For more information, see Template bundles.
\nProvisioning by pull request is currently in feature preview and is\n only usable with Terraform based Proton Templates. To learn more about\n Amazon Web Services Feature Preview terms, see section 2 on Beta and\n Previews.
\nThe provisioned resource Amazon Resource Name (ARN).
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.proton#ResourceDeploymentStatus", + "traits": { + "smithy.api#documentation": "The status of your provisioned resource.
", + "smithy.api#required": {} + } + }, + "outputs": { + "target": "com.amazonaws.proton#OutputsList", + "traits": { + "smithy.api#documentation": "The provisioned resource state change detail data that's returned by Proton.
", + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "deploymentId": { + "target": "com.amazonaws.proton#DeploymentId", + "traits": { + "smithy.api#documentation": "The deployment ID for your provisioned resource.
" + } + }, + "statusMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The deployment status message for your provisioned resource.
", + "smithy.api#length": { + "min": 0, + "max": 5000 + }, + "smithy.api#sensitive": {} + } + } + } + }, + "com.amazonaws.proton#NotifyResourceDeploymentStatusChangeOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.proton#Output": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.proton#OutputKey", + "traits": { + "smithy.api#documentation": "The output key.
" + } + }, + "valueString": { + "target": "com.amazonaws.proton#OutputValueString", + "traits": { + "smithy.api#documentation": "The output value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An infrastructure as code defined resource output.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.proton#OutputKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.proton#OutputValueString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.proton#OutputsList": { + "type": "list", + "member": { + "target": "com.amazonaws.proton#Output" + } + }, + "com.amazonaws.proton#PipelineRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "(^$)|(^arn:[a-zA-Z-]+:[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\\d*:[\\w+=\\/:,\\.@-]*)" + } + }, + "com.amazonaws.proton#ProvisionedResource": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.proton#ProvisionedResourceName", + "traits": { + "smithy.api#documentation": "The provisioned resource name.
" + } + }, + "identifier": { + "target": "com.amazonaws.proton#ProvisionedResourceIdentifier", + "traits": { + "smithy.api#documentation": "The provisioned resource identifier.
" + } + }, + "provisioningEngine": { + "target": "com.amazonaws.proton#ProvisionedResourceEngine", + "traits": { + "smithy.api#documentation": "The resource provisioning engine.
\nProvisioning by pull request is currently in feature preview and is\n only usable with Terraform based Proton Templates. To learn more about\n Amazon Web Services Feature Preview terms, see section 2 on Beta and\n Previews.
\nDetail data for a provisioned resource.
" + } + }, + "com.amazonaws.proton#ProvisionedResourceEngine": { + "type": "string", + "traits": { + "smithy.api#documentation": "List of provisioning engines", + "smithy.api#enum": [ + { + "value": "CLOUDFORMATION", + "name": "CLOUDFORMATION" + }, + { + "value": "TERRAFORM", + "name": "TERRAFORM" + } + ] + } + }, + "com.amazonaws.proton#ProvisionedResourceIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.proton#ProvisionedResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.proton#ProvisionedResource" + } + }, + "com.amazonaws.proton#ProvisionedResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.proton#Provisioning": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CUSTOMER_MANAGED", + "name": "CUSTOMER_MANAGED" + } + ] + } + }, + "com.amazonaws.proton#RejectEnvironmentAccountConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#RejectEnvironmentAccountConnectionInput" + }, + "output": { + "target": "com.amazonaws.proton#RejectEnvironmentAccountConnectionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#ConflictException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "In a management account, reject an environment account connection from another environment account.
\nAfter you reject an environment account connection request, you won’t be able to accept or use the rejected environment\n account connection.
\nYou can’t reject an environment account connection that is connected to an environment.
\nFor more information, see Environment account\n connections in the Proton Administrator guide.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.proton#RejectEnvironmentAccountConnectionInput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.proton#EnvironmentAccountConnectionId", + "traits": { + "smithy.api#documentation": "The ID of the environment account connection to reject.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#references": [ + { + "resource": "com.amazonaws.proton#EnvironmentAccountConnectionResource" + } + ] + } + }, + "com.amazonaws.proton#RejectEnvironmentAccountConnectionOutput": { + "type": "structure", + "members": { + "environmentAccountConnection": { + "target": "com.amazonaws.proton#EnvironmentAccountConnection", + "traits": { + "smithy.api#documentation": "The environment connection account detail data that's returned by Proton.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.proton#Repository": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.proton#RepositoryArn", + "traits": { + "smithy.api#documentation": "The repository Amazon Resource Name (ARN).
", + "smithy.api#required": {} + } + }, + "provider": { + "target": "com.amazonaws.proton#RepositoryProvider", + "traits": { + "smithy.api#documentation": "The repository provider.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.proton#RepositoryName", + "traits": { + "smithy.api#documentation": "The repository name.
", + "smithy.api#required": {} + } + }, + "connectionArn": { + "target": "com.amazonaws.proton#Arn", + "traits": { + "smithy.api#documentation": "The repository Amazon Web Services CodeStar connection that connects Proton to your repository.
", + "smithy.api#required": {} + } + }, + "encryptionKey": { + "target": "com.amazonaws.proton#Arn", + "traits": { + "smithy.api#documentation": "Your customer Amazon Web Services KMS encryption key.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Detail date for a repository that has been registered with Proton.
" + } + }, + "com.amazonaws.proton#RepositoryArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "resource": "com.amazonaws.proton#RepositoryResource" + } + } + }, + "com.amazonaws.proton#RepositoryBranch": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.proton#RepositoryArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the repository branch.
", + "smithy.api#required": {} + } + }, + "provider": { + "target": "com.amazonaws.proton#RepositoryProvider", + "traits": { + "smithy.api#documentation": "The repository provider.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.proton#RepositoryName", + "traits": { + "smithy.api#documentation": "The repository name.
", + "smithy.api#required": {} + } + }, + "branch": { + "target": "com.amazonaws.proton#GitBranchName", + "traits": { + "smithy.api#documentation": "The repository branch.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Detail data for a repository branch.
\nProvisioning by pull request is currently in feature preview and is\n only usable with Terraform based Proton Templates. To learn more about\n Amazon Web Services Feature Preview terms, see section 2 on Beta and\n Previews.
\nThe repository provider.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.proton#RepositoryName", + "traits": { + "smithy.api#documentation": "The repository name.
", + "smithy.api#required": {} + } + }, + "branch": { + "target": "com.amazonaws.proton#GitBranchName", + "traits": { + "smithy.api#documentation": "The repository branch.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Detail input data for a repository branch.
\nProvisioning by pull request is currently in feature preview and is\n only usable with Terraform based Proton Templates. To learn more about\n Amazon Web Services Feature Preview terms, see section 2 on Beta and\n Previews.
\nThe Amazon Resource Name (ARN) for a repository.
", + "smithy.api#required": {} + } + }, + "provider": { + "target": "com.amazonaws.proton#RepositoryProvider", + "traits": { + "smithy.api#documentation": "The repository provider.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.proton#RepositoryName", + "traits": { + "smithy.api#documentation": "The repository name.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of detail data for a registered repository.
" + } + }, + "com.amazonaws.proton#RepositorySummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.proton#RepositorySummary" + } + }, + "com.amazonaws.proton#RepositorySyncAttempt": { + "type": "structure", + "members": { + "startedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the sync attempt started.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.proton#RepositorySyncStatus", + "traits": { + "smithy.api#documentation": "The sync attempt status.
", + "smithy.api#required": {} + } + }, + "events": { + "target": "com.amazonaws.proton#RepositorySyncEvents", + "traits": { + "smithy.api#documentation": "Detail data for sync attempt events.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Detail data for a repository sync attempt activated by a push to a repository.
" + } + }, + "com.amazonaws.proton#RepositorySyncDefinition": { + "type": "structure", + "members": { + "target": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The resource that is synced to.
", + "smithy.api#required": {} + } + }, + "parent": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The resource that is synced from.
", + "smithy.api#required": {} + } + }, + "branch": { + "target": "com.amazonaws.proton#GitBranchName", + "traits": { + "smithy.api#documentation": "The repository branch.
", + "smithy.api#required": {} + } + }, + "directory": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The directory in the repository.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The repository sync definition.
" + } + }, + "com.amazonaws.proton#RepositorySyncDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.proton#RepositorySyncDefinition" + } + }, + "com.amazonaws.proton#RepositorySyncEvent": { + "type": "structure", + "members": { + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of event.
", + "smithy.api#required": {} + } + }, + "externalId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The external ID of the sync event.
" + } + }, + "time": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the sync event occurred.
", + "smithy.api#required": {} + } + }, + "event": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Event detail for a repository sync attempt.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Repository sync event detail data for a sync attempt.
" + } + }, + "com.amazonaws.proton#RepositorySyncEvents": { + "type": "list", + "member": { + "target": "com.amazonaws.proton#RepositorySyncEvent" + } + }, + "com.amazonaws.proton#RepositorySyncStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INITIATED", + "name": "INITIATED", + "documentation": " A repository sync attempt has been created and will begin soon.\n" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS", + "documentation": " A repository sync attempt has started and work is being done to reconcile the branch.\n" + }, + { + "value": "SUCCEEDED", + "name": "SUCCEEDED", + "documentation": " The repository sync attempt has completed successfully.\n" + }, + { + "value": "FAILED", + "name": "FAILED", + "documentation": " The repository sync attempt has failed.\n" + }, + { + "value": "QUEUED", + "name": "QUEUED", + "documentation": " The repository sync attempt didn't execute and was queued.\n" + } + ] + } + }, + "com.amazonaws.proton#ResourceDeploymentStatus": { + "type": "string", + "traits": { + "smithy.api#documentation": "The state that a PR-based deployment can be updated to.", + "smithy.api#enum": [ + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "SUCCEEDED", + "name": "SUCCEEDED" + } + ] + } + }, + "com.amazonaws.proton#ResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[0-9A-Za-z]+[0-9A-Za-z_\\-]*$" + } + }, + "com.amazonaws.proton#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.proton#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The requested resource wasn't found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.proton#ResourceSyncAttempt": { + "type": "structure", + "members": { + "initialRevision": { + "target": "com.amazonaws.proton#Revision", + "traits": { + "smithy.api#documentation": "Detail data for the initial repository commit, path and push.
", + "smithy.api#required": {} + } + }, + "targetRevision": { + "target": "com.amazonaws.proton#Revision", + "traits": { + "smithy.api#documentation": "Detail data for the target revision.
", + "smithy.api#required": {} + } + }, + "target": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The resource that is synced to.
", + "smithy.api#required": {} + } + }, + "startedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the sync attempt started.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.proton#ResourceSyncStatus", + "traits": { + "smithy.api#documentation": "The status of the sync attempt.
", + "smithy.api#required": {} + } + }, + "events": { + "target": "com.amazonaws.proton#ResourceSyncEvents", + "traits": { + "smithy.api#documentation": "An array of events with detail data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Detail data for a resource sync attempt activated by a push to a repository.
" + } + }, + "com.amazonaws.proton#ResourceSyncEvent": { + "type": "structure", + "members": { + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of event.
", + "smithy.api#required": {} + } + }, + "externalId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The external ID for the event.
" + } + }, + "time": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the event occurred.
", + "smithy.api#required": {} + } + }, + "event": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The environment connection account detail data that's returned by AWS Proton.
", + "smithy.api#documentation": "A resource sync event.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "Detail data for a resource sync event.
" } }, - "com.amazonaws.proton#RepositoryId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } + "com.amazonaws.proton#ResourceSyncEvents": { + "type": "list", + "member": { + "target": "com.amazonaws.proton#ResourceSyncEvent" } }, - "com.amazonaws.proton#ResourceName": { + "com.amazonaws.proton#ResourceSyncStatus": { "type": "string", "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^[0-9A-Za-z]+[0-9A-Za-z_\\-]*$" + "smithy.api#enum": [ + { + "value": "INITIATED", + "name": "INITIATED", + "documentation": " A sync attempt has been created and will begin soon.\n" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS", + "documentation": " Syncing has started and work is being done to reconcile state.\n" + }, + { + "value": "SUCCEEDED", + "name": "SUCCEEDED", + "documentation": " Syncing has completed successfully.\n" + }, + { + "value": "FAILED", + "name": "FAILED", + "documentation": " Syncing has failed.\n" + } + ] } }, - "com.amazonaws.proton#ResourceNotFoundException": { + "com.amazonaws.proton#Revision": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.proton#ErrorMessage", + "repositoryName": { + "target": "com.amazonaws.proton#RepositoryName", + "traits": { + "smithy.api#documentation": "The repository name.
", + "smithy.api#required": {} + } + }, + "repositoryProvider": { + "target": "com.amazonaws.proton#RepositoryProvider", + "traits": { + "smithy.api#documentation": "The repository provider.
", + "smithy.api#required": {} + } + }, + "sha": { + "target": "com.amazonaws.proton#SHA", + "traits": { + "smithy.api#documentation": "The secure hash algorithm (SHA) hash for the revision.
", + "smithy.api#required": {} + } + }, + "directory": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The repository directory changed by a commit and push that activated the sync attempt.
", + "smithy.api#required": {} + } + }, + "branch": { + "target": "com.amazonaws.proton#GitBranchName", "traits": { + "smithy.api#documentation": "The repository branch.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The requested resource wasn't found.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 + "smithy.api#documentation": "Revision detail data for a commit and push that activates a sync attempt
" } }, "com.amazonaws.proton#S3Bucket": { @@ -4372,6 +6389,15 @@ "smithy.api#documentation": "Template bundle S3 bucket data.
" } }, + "com.amazonaws.proton#SHA": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, "com.amazonaws.proton#Service": { "type": "structure", "members": { @@ -4445,19 +6471,19 @@ "repositoryConnectionArn": { "target": "com.amazonaws.proton#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the repository connection. For more information, see Set up a repository connection in the\n AWS Proton Administrator Guide and Setting up with AWS Proton in the AWS Proton\n User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the repository connection. For more information, see Set up a repository connection in the Proton\n Administrator Guide and Setting up\n with Proton in the Proton User Guide.
" } }, "repositoryId": { "target": "com.amazonaws.proton#RepositoryId", "traits": { - "smithy.api#documentation": "The ID of the code repository.
" + "smithy.api#documentation": "The ID of the source code repository.
" } }, "branchName": { "target": "com.amazonaws.proton#GitBranchName", "traits": { - "smithy.api#documentation": "The name of the code repository branch that holds the code that's deployed in AWS Proton.
" + "smithy.api#documentation": "The name of the code repository branch that holds the code that's deployed in Proton.
" } } }, @@ -4535,14 +6561,14 @@ "templateMajorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the major version of the service template that was used to create the service instance.
", + "smithy.api#documentation": "The major version of the service template that was used to create the service instance.
", "smithy.api#required": {} } }, "templateMinorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the minor version of the service template that was used to create the service instance.
", + "smithy.api#documentation": "The minor version of the service template that was used to create the service instance.
", "smithy.api#required": {} } }, @@ -4583,6 +6609,40 @@ } } }, + "com.amazonaws.proton#ServiceInstanceOutputResource": { + "type": "resource", + "identifiers": { + "serviceName": { + "target": "com.amazonaws.proton#ResourceName" + }, + "serviceInstanceName": { + "target": "com.amazonaws.proton#ResourceName" + }, + "key": { + "target": "com.amazonaws.proton#OutputKey" + } + }, + "list": { + "target": "com.amazonaws.proton#ListServiceInstanceOutputs" + } + }, + "com.amazonaws.proton#ServiceInstanceProvisionedResourceResource": { + "type": "resource", + "identifiers": { + "serviceName": { + "target": "com.amazonaws.proton#ResourceName" + }, + "serviceInstanceName": { + "target": "com.amazonaws.proton#ResourceName" + }, + "name": { + "target": "com.amazonaws.proton#ProvisionedResourceName" + } + }, + "list": { + "target": "com.amazonaws.proton#ListServiceInstanceProvisionedResources" + } + }, "com.amazonaws.proton#ServiceInstanceResource": { "type": "resource", "identifiers": { @@ -4673,14 +6733,14 @@ "templateMajorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the major version of a service template.
", + "smithy.api#documentation": "The service instance template major version.
", "smithy.api#required": {} } }, "templateMinorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the minor version of a service template.
", + "smithy.api#documentation": "The service instance template minor version.
", "smithy.api#required": {} } }, @@ -4754,14 +6814,14 @@ "templateMajorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the major version of the service template that was used to create the service pipeline.
", + "smithy.api#documentation": "The major version of the service template that was used to create the service pipeline.
", "smithy.api#required": {} } }, "templateMinorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the minor version of the service template that was used to create the service pipeline.
", + "smithy.api#documentation": "The minor version of the service template that was used to create the service pipeline.
", "smithy.api#required": {} } }, @@ -4789,6 +6849,34 @@ "smithy.api#documentation": "The service pipeline detail data.
" } }, + "com.amazonaws.proton#ServicePipelineOutputResource": { + "type": "resource", + "identifiers": { + "serviceName": { + "target": "com.amazonaws.proton#ResourceName" + }, + "key": { + "target": "com.amazonaws.proton#OutputKey" + } + }, + "list": { + "target": "com.amazonaws.proton#ListServicePipelineOutputs" + } + }, + "com.amazonaws.proton#ServicePipelineProvisionedResourceResource": { + "type": "resource", + "identifiers": { + "serviceName": { + "target": "com.amazonaws.proton#ResourceName" + }, + "name": { + "target": "com.amazonaws.proton#ProvisionedResourceName" + } + }, + "list": { + "target": "com.amazonaws.proton#ListServicePipelineProvisionedResources" + } + }, "com.amazonaws.proton#ServicePipelineResource": { "type": "resource", "identifiers": { @@ -4811,7 +6899,7 @@ } }, "traits": { - "smithy.api#documentation": "A quota was exceeded. For more information, see AWS Proton\n Quotas in the AWS Proton Administrator Guide.
", + "smithy.api#documentation": "A quota was exceeded. For more information, see Proton Quotas in the Proton Administrator\n Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -5025,7 +7113,7 @@ "recommendedVersion": { "target": "com.amazonaws.proton#FullTemplateVersionNumber", "traits": { - "smithy.api#documentation": "The ID of the recommended version of the service template.
" + "smithy.api#documentation": "The recommended version of the service template.
" } }, "encryptionKey": { @@ -5037,7 +7125,7 @@ "pipelineProvisioning": { "target": "com.amazonaws.proton#Provisioning", "traits": { - "smithy.api#documentation": "If pipelineProvisioning is true, a service pipeline is included in the service template. Otherwise, a service\n pipeline isn't included in the service template.
If pipelineProvisioning is true, a service pipeline is included in the service template. Otherwise, a service\n pipeline isn't included in the service template.
The ID of the recommended version of the service template.
" + "smithy.api#documentation": "The recommended version of the service template.
" } }, "pipelineProvisioning": { "target": "com.amazonaws.proton#Provisioning", "traits": { - "smithy.api#documentation": "If pipelineProvisioning is true, a service pipeline is included in the service template, otherwise a service\n pipeline isn't included in the service template.
If pipelineProvisioning is true, a service pipeline is included in the service template, otherwise a service\n pipeline isn't included in the service template.
The ID of the latest major version that's associated with the version of a service template.
", + "smithy.api#documentation": "The latest major version that's associated with the version of a service template.
", "smithy.api#required": {} } }, "minorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the minor version of a service template.
", + "smithy.api#documentation": "The minor version of a service template.
", "smithy.api#required": {} } }, "recommendedMinorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the recommended minor version of the service template.
" + "smithy.api#documentation": "The recommended minor version of the service template.
" } }, "status": { @@ -5297,21 +7385,21 @@ "majorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the latest major version that's associated with the version of a service template.
", + "smithy.api#documentation": "The latest major version that's associated with the version of a service template.
", "smithy.api#required": {} } }, "minorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the minor version of a service template.
", + "smithy.api#documentation": "The minor version of a service template.
", "smithy.api#required": {} } }, "recommendedMinorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the recommended minor version of the service template.
" + "smithy.api#documentation": "The recommended minor version of the service template.
" } }, "status": { @@ -5382,6 +7470,26 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.proton#Subdirectory": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "com.amazonaws.proton#SyncType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TEMPLATE_SYNC", + "name": "TEMPLATE_SYNC" + } + ] + } + }, "com.amazonaws.proton#Tag": { "type": "structure", "members": { @@ -5466,7 +7574,7 @@ } ], "traits": { - "smithy.api#documentation": "Tag a resource. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.
", + "smithy.api#documentation": "Tag a resource. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", "smithy.api#idempotent": {} } }, @@ -5514,6 +7622,85 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.proton#TemplateSyncConfig": { + "type": "structure", + "members": { + "templateName": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "The template name.
", + "smithy.api#required": {} + } + }, + "templateType": { + "target": "com.amazonaws.proton#TemplateType", + "traits": { + "smithy.api#documentation": "The template type.
", + "smithy.api#required": {} + } + }, + "repositoryProvider": { + "target": "com.amazonaws.proton#RepositoryProvider", + "traits": { + "smithy.api#documentation": "The repository provider.
", + "smithy.api#required": {} + } + }, + "repositoryName": { + "target": "com.amazonaws.proton#RepositoryName", + "traits": { + "smithy.api#documentation": "The name of the repository, for example myrepos/myrepo.
The repository branch.
", + "smithy.api#required": {} + } + }, + "subdirectory": { + "target": "com.amazonaws.proton#Subdirectory", + "traits": { + "smithy.api#documentation": "A subdirectory path to your template bundle version.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The detail data for a template sync configuration.
" + } + }, + "com.amazonaws.proton#TemplateSyncConfigResource": { + "type": "resource", + "put": { + "target": "com.amazonaws.proton#CreateTemplateSyncConfig" + }, + "read": { + "target": "com.amazonaws.proton#GetTemplateSyncConfig" + }, + "update": { + "target": "com.amazonaws.proton#UpdateTemplateSyncConfig" + }, + "delete": { + "target": "com.amazonaws.proton#DeleteTemplateSyncConfig" + } + }, + "com.amazonaws.proton#TemplateType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENVIRONMENT", + "name": "ENVIRONMENT" + }, + { + "value": "SERVICE", + "name": "SERVICE" + } + ] + } + }, "com.amazonaws.proton#TemplateVersionPart": { "type": "string", "traits": { @@ -5609,7 +7796,7 @@ } ], "traits": { - "smithy.api#documentation": "Remove a tag from a resource. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.
", + "smithy.api#documentation": "Remove a tag from a resource. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", "smithy.api#idempotent": {} } }, @@ -5663,16 +7850,22 @@ } ], "traits": { - "smithy.api#documentation": "Update the AWS Proton pipeline service account settings.
" + "smithy.api#documentation": "Update the Proton service pipeline role or repository settings.
" } }, "com.amazonaws.proton#UpdateAccountSettingsInput": { "type": "structure", "members": { "pipelineServiceRoleArn": { - "target": "com.amazonaws.proton#Arn", + "target": "com.amazonaws.proton#PipelineRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Proton pipeline service role.
\nProvisioning by pull request is currently in feature preview and is\n only usable with Terraform based Proton Templates. To learn more about\n Amazon Web Services Feature Preview terms, see section 2 on Beta and\n Previews.
\nThe Amazon Resource Name (ARN) of the AWS Proton pipeline service role.
" + "smithy.api#documentation": "The repository that you provide with pull request provisioning.
\nProvisioning by pull request is currently in feature preview and is\n only usable with Terraform based Proton Templates. To learn more about\n Amazon Web Services Feature Preview terms, see section 2 on Beta and\n Previews.
\nThe AWS Proton pipeline service role detail data that's returned by AWS Proton.
", + "smithy.api#documentation": "The Proton pipeline service role repository detail data that's returned by Proton.
", "smithy.api#required": {} } } @@ -5718,7 +7911,7 @@ } ], "traits": { - "smithy.api#documentation": "Update an environment.
\nIf the environment is associated with an environment account connection, don't update or include the\n protonServiceRoleArn parameter to update or connect to an environment account connection.
You can only update to a new environment account connection if it was created in the same environment account that the current\n environment account connection was created in and is associated with the current environment.
\nIf the environment isn't associated with an environment account connection, don't update or\n include the environmentAccountConnectionId parameter to update or connect to an environment account connection.
You can update either the environmentAccountConnectionId or protonServiceRoleArn parameter and value. You\n can’t update both.
There are four modes for updating an environment as described in the following. The deploymentType field defines the\n mode.
\n NONE\n
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
\n\n CURRENT_VERSION\n
In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are\n updated. Don’t include minor or major version parameters when you use this\n deployment-type.
\n MINOR_VERSION\n
In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current\n major version in use, by default. You can also specify a different minor version of the current major version in use.
\n\n MAJOR_VERSION\n
In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of\n the current template, by default. You can also specify a different major version that's higher than the major version in use\n and a minor version (optional).
\nUpdate an environment.
\nIf the environment is associated with an environment account connection, don't update or include the\n protonServiceRoleArn and provisioningRepository parameter to update or connect to an environment account\n connection.
You can only update to a new environment account connection if it was created in the same environment account that the current environment\n account connection was created in and is associated with the current environment.
\nIf the environment isn't associated with an environment account connection, don't update or include\n the environmentAccountConnectionId parameter to update or connect to an environment account connection.
You can update either the environmentAccountConnectionId or protonServiceRoleArn parameter and value. You can’t\n update both.
If the environment was provisioned with pull request provisioning, include the provisioningRepository parameter and omit the\n protonServiceRoleArn and environmentAccountConnectionId parameters.
If the environment wasn't provisioned with pull request provisioning, omit the provisioningRepository parameter.
There are four modes for updating an environment as described in the following. The deploymentType field defines the mode.
\n NONE\n
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
\n\n CURRENT_VERSION\n
In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated.\n Don’t include minor or major version parameters when you use this deployment-type.
\n MINOR_VERSION\n
In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version\n in use, by default. You can also specify a different minor version of the current major version in use.
\n\n MAJOR_VERSION\n
In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current\n template, by default. You can also specify a different major version that's higher than the major version in use and a minor version\n (optional).
\nIn an environment account, update an environment account connection to use a new IAM role.
\nFor more information, see Environment account\n connections in the AWS Proton Administrator guide.
", + "smithy.api#documentation": "In an environment account, update an environment account connection to use a new IAM role.
\nFor more information, see Environment account\n connections in the Proton Administrator guide.
", "smithy.api#idempotent": {} } }, @@ -5786,7 +7979,7 @@ "environmentAccountConnection": { "target": "com.amazonaws.proton#EnvironmentAccountConnection", "traits": { - "smithy.api#documentation": "The environment account connection detail data that's returned by AWS Proton.
", + "smithy.api#documentation": "The environment account connection detail data that's returned by Proton.
", "smithy.api#required": {} } } @@ -5817,32 +8010,38 @@ "templateMajorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the major version of the environment to update.
" + "smithy.api#documentation": "The major version of the environment to update.
" } }, "templateMinorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "The ID of the minor version of the environment to update.
" + "smithy.api#documentation": "The minor version of the environment to update.
" } }, "protonServiceRoleArn": { "target": "com.amazonaws.proton#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make API calls to other services your\n behalf.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf.
" } }, "deploymentType": { "target": "com.amazonaws.proton#DeploymentUpdateType", "traits": { - "smithy.api#documentation": "There are four modes for updating an environment as described in the following. The deploymentType field defines the\n mode.
\n NONE\n
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
\n\n CURRENT_VERSION\n
In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are\n updated. Don’t include minor or major version parameters when you use this\n deployment-type.
\n MINOR_VERSION\n
In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current\n major version in use, by default. You can also specify a different minor version of the current major version in use.
\n\n MAJOR_VERSION\n
In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of\n the current template, by default. You can also specify a different major version that is higher than the major version in use\n and a minor version (optional).
\nThere are four modes for updating an environment as described in the following. The deploymentType field defines the mode.
\n NONE\n
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
\n\n CURRENT_VERSION\n
In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated.\n Don’t include minor or major version parameters when you use this deployment-type.
\n MINOR_VERSION\n
In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version\n in use, by default. You can also specify a different minor version of the current major version in use.
\n\n MAJOR_VERSION\n
In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current\n template, by default. You can also specify a different major version that is higher than the major version in use and a minor version\n (optional).
\nThe ID of the environment account connection.
\nYou can only update to a new environment account connection if it was created in the same environment account that the current\n environment account connection was created in and is associated with the current environment.
" + "smithy.api#documentation": "The ID of the environment account connection.
\nYou can only update to a new environment account connection if it was created in the same environment account that the current environment\n account connection was created in and is associated with the current environment.
" + } + }, + "provisioningRepository": { + "target": "com.amazonaws.proton#RepositoryBranchInput", + "traits": { + "smithy.api#documentation": "The repository that you provide with pull request provisioning.
\nProvisioning by pull request is currently in feature preview and is\n only usable with Terraform based Proton Templates. To learn more about\n Amazon Web Services Feature Preview terms, see section 2 on Beta and\n Previews.
\nThe environment detail data that's returned by AWS Proton.
", + "smithy.api#documentation": "The environment detail data that's returned by Proton.
", "smithy.api#required": {} } } @@ -5935,7 +8134,7 @@ "environmentTemplate": { "target": "com.amazonaws.proton#EnvironmentTemplate", "traits": { - "smithy.api#documentation": "The environment template detail data that's returned by AWS Proton.
", + "smithy.api#documentation": "The environment template detail data that's returned by Proton.
", "smithy.api#required": {} } } @@ -5986,7 +8185,7 @@ "majorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "To update a major version of an environment template, include majorVersion.
To update a major version of an environment template, include major Version.
The environment template version detail data that's returned by AWS Proton.
", + "smithy.api#documentation": "The environment template version detail data that's returned by Proton.
", "smithy.api#required": {} } } @@ -6062,7 +8261,7 @@ } ], "traits": { - "smithy.api#documentation": "Edit a service description or use a spec to add and delete service instances.
\nExisting service instances and the service pipeline can't be edited using this API. They can only be\n deleted.
\nUse the description parameter to modify the description.
Edit the spec parameter to add or delete instances.
Edit a service description or use a spec to add and delete service instances.
\nExisting service instances and the service pipeline can't be edited using this API. They can only be deleted.
\nUse the description parameter to modify the description.
Edit the spec parameter to add or delete instances.
Lists the service instances to add and the existing service instances to remain. Omit the existing service instances to delete from the\n list. Don't include edits to the existing service instances or pipeline. For more information, see Edit a\n service in the AWS Proton Administrator\n Guide or the AWS Proton User Guide.
" + "smithy.api#documentation": "Lists the service instances to add and the existing service instances to remain. Omit the existing service instances to delete from the list.\n Don't include edits to the existing service instances or pipeline. For more information, see Edit a\n service in the Proton Administrator Guide or\n the Proton User Guide.
" } } }, @@ -6125,7 +8324,7 @@ } ], "traits": { - "smithy.api#documentation": "Update a service instance.
\nThere are four modes for updating a service instance as described in the following. The deploymentType field defines the\n mode.
\n NONE\n
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
\n\n CURRENT_VERSION\n
In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are\n updated. Don’t include minor or major version parameters when you use this\n deployment-type.
\n MINOR_VERSION\n
In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the\n current major version in use, by default. You can also specify a different minor version of the current major version in\n use.
\n\n MAJOR_VERSION\n
In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version\n of the current template, by default. You can also specify a different major version that is higher than the major version in\n use and a minor version (optional).
\nUpdate a service instance.
\nThere are four modes for updating a service instance as described in the following. The deploymentType field defines the\n mode.
\n NONE\n
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
\n\n CURRENT_VERSION\n
In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated.\n Don’t include minor or major version parameters when you use this deployment-type.
\n MINOR_VERSION\n
In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major\n version in use, by default. You can also specify a different minor version of the current major version in use.
\n\n MAJOR_VERSION\n
In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current\n template, by default. You can also specify a different major version that is higher than the major version in use and a minor version\n (optional).
\nThe deployment type.
\nThere are four modes for updating a service instance as described in the following. The deploymentType field defines the\n mode.
\n NONE\n
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
\n\n CURRENT_VERSION\n
In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are\n updated. Don’t include minor or major version parameters when you use this\n deployment-type.
\n MINOR_VERSION\n
In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the\n current major version in use, by default. You can also specify a different minor version of the current major version in\n use.
\n\n MAJOR_VERSION\n
In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version\n of the current template, by default. You can also specify a different major version that is higher than the major version in\n use and a minor version (optional).
\nThe deployment type.
\nThere are four modes for updating a service instance as described in the following. The deploymentType field defines the\n mode.
\n NONE\n
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
\n\n CURRENT_VERSION\n
In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated.\n Don’t include minor or major version parameters when you use this deployment-type.
\n MINOR_VERSION\n
In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major\n version in use, by default. You can also specify a different minor version of the current major version in use.
\n\n MAJOR_VERSION\n
In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current\n template, by default. You can also specify a different major version that is higher than the major version in use and a minor version\n (optional).
\nThe service instance summary data returned by AWS Proton.
", + "smithy.api#documentation": "The service instance summary data returned by Proton.
", "smithy.api#required": {} } } @@ -6197,7 +8396,7 @@ "service": { "target": "com.amazonaws.proton#Service", "traits": { - "smithy.api#documentation": "The service detail data that's returned by AWS Proton.
", + "smithy.api#documentation": "The service detail data that's returned by Proton.
", "smithy.api#required": {} } } @@ -6232,7 +8431,7 @@ } ], "traits": { - "smithy.api#documentation": "Update the service pipeline.
\nThere are four modes for updating a service pipeline as described in the following. The deploymentType field defines the\n mode.
\n NONE\n
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
\n\n CURRENT_VERSION\n
In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are\n updated. Don’t include minor or major version parameters when you use this\n deployment-type.
\n MINOR_VERSION\n
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the\n current major version in use, by default. You can also specify a different minor version of the current major version in\n use.
\n\n MAJOR_VERSION\n
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version\n of the current template by default. You can also specify a different major version that is higher than the major version in\n use and a minor version (optional).
\nUpdate the service pipeline.
\nThere are four modes for updating a service pipeline as described in the following. The deploymentType field defines the\n mode.
\n NONE\n
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
\n\n CURRENT_VERSION\n
In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated.\n Don’t include minor or major version parameters when you use this deployment-type.
\n MINOR_VERSION\n
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major\n version in use, by default. You can also specify a different minor version of the current major version in use.
\n\n MAJOR_VERSION\n
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current\n template by default. You can also specify a different major version that is higher than the major version in use and a minor version\n (optional).
\nThe deployment type.
\nThere are four modes for updating a service pipeline as described in the following. The deploymentType field defines the\n mode.
\n NONE\n
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
\n\n CURRENT_VERSION\n
In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are\n updated. Don’t include minor or major version parameters when you use this\n deployment-type.
\n MINOR_VERSION\n
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the\n current major version in use, by default. You can also specify a different minor version of the current major version in\n use.
\n\n MAJOR_VERSION\n
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version\n of the current template, by default. You can also specify a different major version that is higher than the major version in\n use and a minor version (optional).
\nThe deployment type.
\nThere are four modes for updating a service pipeline as described in the following. The deploymentType field defines the\n mode.
\n NONE\n
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
\n\n CURRENT_VERSION\n
In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated.\n Don’t include minor or major version parameters when you use this deployment-type.
\n MINOR_VERSION\n
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major\n version in use, by default. You can also specify a different minor version of the current major version in use.
\n\n MAJOR_VERSION\n
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current\n template, by default. You can also specify a different major version that is higher than the major version in use and a minor version\n (optional).
\nThe pipeline details returned by AWS Proton.
", + "smithy.api#documentation": "The pipeline details returned by Proton.
", "smithy.api#required": {} } } @@ -6364,7 +8563,7 @@ "serviceTemplate": { "target": "com.amazonaws.proton#ServiceTemplate", "traits": { - "smithy.api#documentation": "The service template detail data that's returned by AWS Proton.
", + "smithy.api#documentation": "The service template detail data that's returned by Proton.
", "smithy.api#required": {} } } @@ -6415,7 +8614,7 @@ "majorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "To update a major version of a service template, include majorVersion.
To update a major version of a service template, include major Version.
The service template version detail data that's returned by AWS Proton.
", + "smithy.api#documentation": "The service template version detail data that's returned by Proton.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.proton#UpdateTemplateSyncConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#UpdateTemplateSyncConfigInput" + }, + "output": { + "target": "com.amazonaws.proton#UpdateTemplateSyncConfigOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#ConflictException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Update template sync configuration parameters, except for the templateName and templateType.
The synced template name.
", + "smithy.api#required": {} + } + }, + "templateType": { + "target": "com.amazonaws.proton#TemplateType", + "traits": { + "smithy.api#documentation": "The synced template type.
", + "smithy.api#required": {} + } + }, + "repositoryProvider": { + "target": "com.amazonaws.proton#RepositoryProvider", + "traits": { + "smithy.api#documentation": "The repository provider.
", + "smithy.api#required": {} + } + }, + "repositoryName": { + "target": "com.amazonaws.proton#RepositoryName", + "traits": { + "smithy.api#documentation": "The name of the repository, for example myrepos/myrepo.
The repository branch.
", "smithy.api#required": {} } + }, + "subdirectory": { + "target": "com.amazonaws.proton#Subdirectory", + "traits": { + "smithy.api#documentation": "A subdirectory path to your template bundle version. When included, limits the template bundle search to this repository directory.
" + } + } + } + }, + "com.amazonaws.proton#UpdateTemplateSyncConfigOutput": { + "type": "structure", + "members": { + "templateSyncConfig": { + "target": "com.amazonaws.proton#TemplateSyncConfig", + "traits": { + "smithy.api#documentation": "The template sync configuration detail data that's returned by Proton.
" + } } } }, diff --git a/aws/sdk/aws-models/quicksight.json b/aws/sdk/aws-models/quicksight.json index f04e89bdae65131ffefb6a222228a71fd1061a14..139087316669807a6823d60fbf434724ee38d88e 100644 --- a/aws/sdk/aws-models/quicksight.json +++ b/aws/sdk/aws-models/quicksight.json @@ -56,10 +56,16 @@ "traits": { "smithy.api#documentation": "The default theme for this Amazon QuickSight subscription.
" } + }, + "DefaultEmailCustomizationTemplate": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The default email customization template.
" + } } }, "traits": { - "smithy.api#documentation": "The Amazon QuickSight customizations associated with your Amazon Web Services account or a Amazon QuickSight namespace in a specific Amazon Web Services Region.
" + "smithy.api#documentation": "The Amazon QuickSight customizations associated with your Amazon Web Services account or a QuickSight namespace in a specific Amazon Web Services Region.
" } }, "com.amazonaws.quicksight#AccountSettings": { @@ -112,7 +118,7 @@ "AssignmentName": { "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", "traits": { - "smithy.api#documentation": "A name for the IAMpolicy assignment.
" + "smithy.api#documentation": "A name for the IAM policy assignment.
" } }, "PolicyArn": { @@ -189,9 +195,13 @@ "Domain": { "target": "com.amazonaws.quicksight#Domain", "traits": { + "smithy.api#documentation": "The OpenSearch domain.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "The parameters for OpenSearch.
" } }, "com.amazonaws.quicksight#Analysis": { @@ -511,12 +521,12 @@ "Dashboard": { "target": "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfiguration", "traits": { - "smithy.api#documentation": "The type of embedding experience. In this case, an Amazon QuickSight dashboard.
" + "smithy.api#documentation": "The type of embedding experience. In this case, Amazon QuickSight dashboards.
" } } }, "traits": { - "smithy.api#documentation": "The type of experience you want to embed. For anonymous users, you can embed an Amazon QuickSight dashboard.
" + "smithy.api#documentation": "The type of experience you want to embed. For anonymous users, you can embed Amazon QuickSight dashboards.
" } }, "com.amazonaws.quicksight#Arn": { @@ -1135,7 +1145,7 @@ } }, "traits": { - "smithy.api#documentation": "A tag for a column in a TagColumnOperation structure. This is a\n variant type structure. For this structure to be valid, only one of the attributes can\n be non-null.
" + "smithy.api#documentation": "A tag for a column in a\n \n TagColumnOperation\n \n structure. This is a\n variant type structure. For this structure to be valid, only one of the attributes can\n be non-null.
Creates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, you can\n add a custom default theme by using the CreateAccountCustomization or\n UpdateAccountCustomization API operation. To further customize\n Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User\n Guide.\n
You can create customizations for your Amazon Web Services account or, if you specify a namespace, for\n a Amazon QuickSight namespace instead. Customizations that apply to a namespace always override\n customizations that apply to an Amazon Web Services account. To find out which customizations apply, use\n the DescribeAccountCustomization API operation.
Before you use the CreateAccountCustomization API operation to add a theme\n as the namespace default, make sure that you first share the theme with the namespace.\n If you don't share it with the namespace, the theme isn't visible to your users\n even if you make it the default theme.\n To check if the theme is shared, view the current permissions by using the\n \n DescribeThemePermissions\n API operation.\n To share the theme, grant permissions by using the\n \n UpdateThemePermissions\n API operation.
Creates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, you can\n add a custom default theme by using the CreateAccountCustomization or\n UpdateAccountCustomization API operation. To further customize\n Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User\n Guide.\n
You can create customizations for your Amazon Web Services account or, if you specify a namespace, for\n a QuickSight namespace instead. Customizations that apply to a namespace always override\n customizations that apply to an Amazon Web Services account. To find out which customizations apply, use\n the DescribeAccountCustomization API operation.
Before you use the CreateAccountCustomization API operation to add a theme\n as the namespace default, make sure that you first share the theme with the namespace.\n If you don't share it with the namespace, the theme isn't visible to your users\n even if you make it the default theme.\n To check if the theme is shared, view the current permissions by using the\n \n DescribeThemePermissions\n \n API operation.\n To share the theme, grant permissions by using the\n \n UpdateThemePermissions\n \n API operation.
The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add\n these to an Amazon Web Services account and a Amazon QuickSight namespace.
\nFor example, you can add a default theme by setting AccountCustomization\n to the midnight theme: \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight::aws:theme/MIDNIGHT\" }. Or, you can add a custom theme by\n specifying \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\"\n }.
The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add\n these to an Amazon Web Services account and a QuickSight namespace.
\nFor example, you can add a default theme by setting AccountCustomization\n to the midnight theme: \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight::aws:theme/MIDNIGHT\" }. Or, you can add a custom theme by\n specifying \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\"\n }.
Creates a dashboard from a template. To first create a template, see the \n CreateTemplate\n API operation.
A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created\n from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can\n create scheduled email reports from them. If you have the correct permissions, you can\n create a dashboard from a template that exists in a different Amazon Web Services account.
", + "smithy.api#documentation": "Creates a dashboard from a template. To first create a template, see the \n \n CreateTemplate\n \n API operation.
A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created\n from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can\n create scheduled email reports from them. If you have the correct permissions, you can\n create a dashboard from a template that exists in a different Amazon Web Services account.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}", @@ -1531,7 +1544,7 @@ "DashboardId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The ID for the dashboard, also added to the IAMpolicy.
", + "smithy.api#documentation": "The ID for the dashboard, also added to the IAM policy.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1552,13 +1565,13 @@ "Permissions": { "target": "com.amazonaws.quicksight#ResourcePermissionList", "traits": { - "smithy.api#documentation": "A structure that contains the permissions of the dashboard. You can use this structure\n for granting permissions by providing a list of IAMaction information for each\n principal ARN.
\n\nTo specify no permissions, omit the permissions list.
" + "smithy.api#documentation": "A structure that contains the permissions of the dashboard. You can use this structure\n for granting permissions by providing a list of IAM action information for each\n principal ARN.
\n\nTo specify no permissions, omit the permissions list.
" } }, "SourceEntity": { "target": "com.amazonaws.quicksight#DashboardSourceEntity", "traits": { - "smithy.api#documentation": "The entity that you are using as a source when you create the dashboard. In\n SourceEntity, you specify the type of object you're using as source. You\n can only create a dashboard from a template, so you use a SourceTemplate\n entity. If you need to create a dashboard from an analysis, first convert the analysis\n to a template by using the CreateTemplate API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplateARN can contain any Amazon Web Services account and any\n Amazon QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.
The entity that you are using as a source when you create the dashboard. In\n SourceEntity, you specify the type of object you're using as source. You\n can only create a dashboard from a template, so you use a SourceTemplate\n entity. If you need to create a dashboard from an analysis, first convert the analysis\n to a template by using the \n CreateTemplate\n \n API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplateARN can contain any Amazon Web Services account and any\n Amazon QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.
A set of one or more definitions of a \n ColumnLevelPermissionRule\n .
A set of one or more definitions of a \n ColumnLevelPermissionRule\n .
The AWS Account ID.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that contains the folder.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2062,7 +2075,7 @@ "FolderId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The folder ID.
", + "smithy.api#documentation": "The ID of the folder.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2091,7 +2104,7 @@ "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The status of the folder membership. If succeeded, the status is SC_OK (200).
The HTTP status of the request.
" } }, "FolderMember": { @@ -2103,7 +2116,7 @@ "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The request ID.
" + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" } } } @@ -2114,7 +2127,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The AWS Account ID.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account where you want to create the folder.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2122,7 +2135,7 @@ "FolderId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The folder ID.
", + "smithy.api#documentation": "The ID of the folder.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2142,13 +2155,13 @@ "ParentFolderArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the parent folder.
\n\t\n ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.
The Amazon Resource Name (ARN) for the parent folder.
\n\n ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.
A structure that describes the principals and the resource-level permissions of a folder.
\n\tTo specify no permissions, omit Permissions.
A structure that describes the principals and the resource-level permissions of a folder.
\nTo specify no permissions, omit Permissions.
The status of the newly created folder. If succeeded, the status is SC_OK (200).
The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, @@ -2297,7 +2310,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the \n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2432,7 +2445,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an assignment with one specified IAMpolicy, identified by its Amazon Resource Name \n\t\t\t(ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight.\n\t\t\tAssignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, \n\t\t\tuse assignment names that are unique.
", + "smithy.api#documentation": "Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name\n\t\t\t(ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight.\n\t\t\tAssignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces,\n\t\t\tuse assignment names that are unique.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments", @@ -2446,7 +2459,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID of the Amazon Web Services account where you want to assign an IAMpolicy to Amazon QuickSight users or\n\t\t\tgroups.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or\n\t\t\tgroups.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2468,7 +2481,7 @@ "PolicyArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The ARN for the IAMpolicy to apply to the Amazon QuickSight users and groups\n\t\t\tspecified in this assignment.
" + "smithy.api#documentation": "The ARN for the IAM policy to apply to the Amazon QuickSight users and groups\n\t\t\tspecified in this assignment.
" } }, "Identities": { @@ -2511,13 +2524,13 @@ "PolicyArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The ARN for the IAMpolicy that is applied to the Amazon QuickSight users and groups specified in this assignment.
" + "smithy.api#documentation": "The ARN for the IAM policy that is applied to the Amazon QuickSight users and groups specified in this assignment.
" } }, "Identities": { "target": "com.amazonaws.quicksight#IdentityMap", "traits": { - "smithy.api#documentation": "The Amazon QuickSight users, groups, or both that the IAMpolicy is assigned to.
" + "smithy.api#documentation": "The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.
" } }, "RequestId": { @@ -3191,7 +3204,7 @@ "BaseThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The ID of the theme that a custom theme will inherit from. All themes inherit from one of\n\t\t\tthe starting themes defined by Amazon QuickSight. For a list of the starting themes, use\n\t\t\t\tListThemes or choose Themes from\n\t\t\twithin a Amazon QuickSight analysis.
The ID of the theme that a custom theme will inherit from. All themes inherit from one of\n\t\t\tthe starting themes defined by Amazon QuickSight. For a list of the starting themes, use\n\t\t\t\tListThemes or choose Themes from\n\t\t\twithin an analysis.
A set of one or more definitions of a \n ColumnLevelPermissionRule\n .
A set of one or more definitions of a \n ColumnLevelPermissionRule\n .
Credential pair. For more information, see CredentialPair.
" + "smithy.api#documentation": "Credential pair. For more information, see\n \n CredentialPair\n .
The parameters for OpenSearch.
" + } + }, + "ExasolParameters": { + "target": "com.amazonaws.quicksight#ExasolParameters", + "traits": { + "smithy.api#documentation": "The parameters for Exasol.
" + } } }, "traits": { @@ -4548,6 +4570,10 @@ { "value": "AMAZON_OPENSEARCH", "name": "AMAZON_OPENSEARCH" + }, + { + "value": "EXASOL", + "name": "EXASOL" } ] } @@ -4641,6 +4667,9 @@ { "target": "com.amazonaws.quicksight#AccessDeniedException" }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, { "target": "com.amazonaws.quicksight#InternalFailureException" }, @@ -5163,7 +5192,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The AWS Account ID.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that contains the folder.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5200,13 +5229,13 @@ "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The status of deleting the asset. If succeeded, the status is SC_OK (200).
The HTTP status of the request.
" } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The request ID.
" + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" } } } @@ -5217,7 +5246,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The AWS Account ID for the folder.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that contains the folder.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5225,7 +5254,7 @@ "FolderId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The folder ID.
", + "smithy.api#documentation": "The ID of the folder.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5238,7 +5267,7 @@ "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The status of deleting the folder. If succeeded, the status is SC_OK (200).
The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, @@ -5251,13 +5280,13 @@ "FolderId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The folder ID.
" + "smithy.api#documentation": "The ID of the folder.
" } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The request ID.
" + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" } } } @@ -5476,7 +5505,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing IAMpolicy assignment.
", + "smithy.api#documentation": "Deletes an existing IAM policy assignment.
", "smithy.api#http": { "method": "DELETE", "uri": "/accounts/{AwsAccountId}/namespace/{Namespace}/iam-policy-assignments/{AssignmentName}", @@ -5490,7 +5519,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID where you want to delete the IAMpolicy assignment.
", + "smithy.api#documentation": "The Amazon Web Services account ID where you want to delete the IAM policy assignment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6228,7 +6257,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the customizations associated with the provided Amazon Web Services account and Amazon\n Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which\n customizations to apply by running this API operation with the Resolved flag\n included.
To determine what customizations display when you run this command, it can help to\n visualize the relationship of the entities involved.
\n\n Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy.\n It has the potential to use all of the Amazon Web Services Regions and AWS Services. When you\n subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region.\n That's where your free SPICE capacity is located. You can use Amazon QuickSight in any\n supported Amazon Web Services Region.
\n Amazon Web Services Region - In each Amazon Web Services Region where you sign in to Amazon QuickSight\n at least once, Amazon QuickSight acts as a separate instance of the same service. If\n you have a user directory, it resides in us-east-1, which is the US East (N.\n Virginia). Generally speaking, these users have access to Amazon QuickSight in any\n Amazon Web Services Region, unless they are constrained to a namespace.
To run the command in a different Amazon Web Services Region, you change your Region settings.\n If you're using the AWS CLI, you can use one of the following options:
\nUse command line options.
\nUse named profiles.
\nRun aws configure to change your default Amazon Web Services Region. Use\n Enter to key the same settings for your keys. For more information, see\n Configuring the AWS CLI.
\n Namespace - A Amazon QuickSight namespace is a partition that contains\n users and assets (data sources, datasets, dashboards, and so on). To access\n assets that are in a specific namespace, users and groups must also be part of\n the same namespace. People who share a namespace are completely isolated from\n users and assets in other namespaces, even if they are in the same Amazon Web Services account\n and Amazon Web Services Region.
\n Applied customizations - Within an Amazon Web Services Region, a set of\n Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace.\n Settings that you apply to a namespace override settings that you apply to an\n Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region. To apply them in\n other Amazon Web Services Regions, run the CreateAccountCustomization command in\n each Amazon Web Services Region where you want to apply the same customizations.
Describes the customizations associated with the provided Amazon Web Services account and Amazon\n Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which\n customizations to apply by running this API operation with the Resolved flag\n included.
To determine what customizations display when you run this command, it can help to\n visualize the relationship of the entities involved.
\n\n Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy.\n It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you\n subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region.\n That's where your free SPICE capacity is located. You can use Amazon QuickSight in any\n supported Amazon Web Services Region.
\n Amazon Web Services Region - In each Amazon Web Services Region where you sign in to Amazon QuickSight\n at least once, Amazon QuickSight acts as a separate instance of the same service. If\n you have a user directory, it resides in us-east-1, which is the US East (N.\n Virginia). Generally speaking, these users have access to Amazon QuickSight in any\n Amazon Web Services Region, unless they are constrained to a namespace.
To run the command in a different Amazon Web Services Region, you change your Region settings.\n If you're using the CLI, you can use one of the following options:
\nUse command line options.
\nUse named profiles.
\nRun aws configure to change your default Amazon Web Services Region. Use\n Enter to key the same settings for your keys. For more information, see\n Configuring the CLI.
\n Namespace - A QuickSight namespace is a partition that contains\n users and assets (data sources, datasets, dashboards, and so on). To access\n assets that are in a specific namespace, users and groups must also be part of\n the same namespace. People who share a namespace are completely isolated from\n users and assets in other namespaces, even if they are in the same Amazon Web Services account\n and Amazon Web Services Region.
\n Applied customizations - Within an Amazon Web Services Region, a set of\n Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace.\n Settings that you apply to a namespace override settings that you apply to an\n Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region. To apply them in\n other Amazon Web Services Regions, run the CreateAccountCustomization command in\n each Amazon Web Services Region where you want to apply the same customizations.
The Amazon QuickSight settings for this Amazon Web Services account. This information includes the edition of Amazon\n Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the\n Amazon QuickSight subscription. In the Amazon QuickSight console, the Amazon QuickSight subscription is sometimes\n referred to as a Amazon QuickSight \"account\" even though it's technically not an account\n by itself. Instead, it's a subscription to the Amazon QuickSight service for your Amazon Web Services account. The\n edition that you subscribe to applies to Amazon QuickSight in every Amazon Web Services Region where you use it.
" + "smithy.api#documentation": "The Amazon QuickSight settings for this Amazon Web Services account. This information includes the edition of Amazon\n Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the\n Amazon QuickSight subscription. In the QuickSight console, the Amazon QuickSight subscription is sometimes\n referred to as a QuickSight \"account\" even though it's technically not an account\n by itself. Instead, it's a subscription to the Amazon QuickSight service for your Amazon Web Services account. The\n edition that you subscribe to applies to Amazon QuickSight in every Amazon Web Services Region where you use it.
" } }, "RequestId": { @@ -6637,7 +6666,7 @@ "DashboardId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The ID for the dashboard, also added to the IAMpolicy.
", + "smithy.api#documentation": "The ID for the dashboard, also added to the IAM policy.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6677,6 +6706,12 @@ "traits": { "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" } + }, + "LinkSharingConfiguration": { + "target": "com.amazonaws.quicksight#LinkSharingConfiguration", + "traits": { + "smithy.api#documentation": "A structure that contains the configuration of a shareable link that grants access to\n the dashboard. Your users can use the link to view and interact with the dashboard, if\n the dashboard has been shared with them. For more information about sharing dashboards,\n see Sharing Dashboards.
" + } } } }, @@ -7159,7 +7194,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The AWS Account ID.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that contains the folder.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7167,7 +7202,7 @@ "FolderId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The folder ID.
", + "smithy.api#documentation": "The ID of the folder.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7180,14 +7215,14 @@ "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The status. If succeeded, the status is SC_OK.
The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "FolderId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The folder ID.
" + "smithy.api#documentation": "The ID of the folder.
" } }, "Arn": { @@ -7205,7 +7240,7 @@ "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The request ID.
" + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" } } } @@ -7216,7 +7251,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The AWS account ID.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that contains the folder.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7224,7 +7259,7 @@ "FolderId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The folder ID.
", + "smithy.api#documentation": "The ID of the folder.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7274,7 +7309,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The AWS account ID.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that contains the folder.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7282,7 +7317,7 @@ "FolderId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The folder ID.
", + "smithy.api#documentation": "The ID of the folder.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7295,32 +7330,32 @@ "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The status. If succeeded, the status is SC_OK\n
The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "FolderId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The folder ID.
" + "smithy.api#documentation": "The ID of the folder.
" } }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN).
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the folder.
" } }, "Permissions": { "target": "com.amazonaws.quicksight#ResourcePermissionList", "traits": { - "smithy.api#documentation": "Information about the permissions on the dashboard.
" + "smithy.api#documentation": "Information about the permissions for the folder.
" } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The request ID.
" + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" } } } @@ -7331,7 +7366,7 @@ "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The status. If succeeded, the status is SC_OK (200).
The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, @@ -7344,7 +7379,7 @@ "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The request ID.
" + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" } } } @@ -7471,7 +7506,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes an existing IAMpolicy assignment, as specified by the assignment name.
", + "smithy.api#documentation": "Describes an existing IAM policy assignment, as specified by the assignment name.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/{AssignmentName}", @@ -7514,7 +7549,7 @@ "IAMPolicyAssignment": { "target": "com.amazonaws.quicksight#IAMPolicyAssignment", "traits": { - "smithy.api#documentation": "Information describing the IAMpolicy assignment.
" + "smithy.api#documentation": "Information describing the IAM policy assignment.
" } }, "RequestId": { @@ -7648,7 +7683,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides a summary and status of IP Rules.
", + "smithy.api#documentation": "Provides a summary and status of IP rules.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/ip-restriction", @@ -7662,7 +7697,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "Your AWS account ID.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the IP rules.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7675,31 +7710,31 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "Your AWS account ID.
" + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the IP rules.
" } }, "IpRestrictionRuleMap": { "target": "com.amazonaws.quicksight#IpRestrictionRuleMap", "traits": { - "smithy.api#documentation": "Describes the IP rules with CIDR range and description.
" + "smithy.api#documentation": "A map that describes the IP rules with CIDR range and description.
" } }, "Enabled": { "target": "com.amazonaws.quicksight#NullableBoolean", "traits": { - "smithy.api#documentation": "Whether or not IP rules are enabled.
" + "smithy.api#documentation": "A value that specifies whether IP rules are turned on.
" } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The ID of the describe request.
" + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The status of a set of IP restrictions. A successful request returns a 200 status code.
", + "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } @@ -8558,6 +8593,28 @@ "smithy.api#documentation": "Error information for the SPICE ingestion of a dataset.
" } }, + "com.amazonaws.quicksight#ExasolParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "The hostname or IP address of the Exasol data source.
", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "The port for the Exasol data source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The required parameters for connecting to an Exasol data source.
" + } + }, "com.amazonaws.quicksight#ExceptionResourceType": { "type": "string", "traits": { @@ -8734,13 +8791,13 @@ "FolderId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The folder ID.
" + "smithy.api#documentation": "The ID of the folder.
" } }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The folder Amazon Resource Name (ARN).
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the folder.
" } }, "Name": { @@ -8752,13 +8809,13 @@ "FolderType": { "target": "com.amazonaws.quicksight#FolderType", "traits": { - "smithy.api#documentation": "The type of the folder.
" + "smithy.api#documentation": "The type of folder it is.
" } }, "FolderPath": { "target": "com.amazonaws.quicksight#Path", "traits": { - "smithy.api#documentation": "An array of ancestor folder ARN strings.
" + "smithy.api#documentation": "An array of ancestor ARN strings for the folder.
" } }, "CreatedTime": { @@ -8775,7 +8832,7 @@ } }, "traits": { - "smithy.api#documentation": "A folder.
" + "smithy.api#documentation": "A folder in Amazon QuickSight.
" } }, "com.amazonaws.quicksight#FolderColumnList": { @@ -8807,18 +8864,18 @@ "MemberId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The ID of the asset.
" + "smithy.api#documentation": "The ID of an asset in the folder.
" } }, "MemberType": { "target": "com.amazonaws.quicksight#MemberType", "traits": { - "smithy.api#documentation": "The type of the asset.
" + "smithy.api#documentation": "The type of asset that it is.
" } } }, "traits": { - "smithy.api#documentation": "An asset in a folder, such as a dashboard, analysis, or dataset.
" + "smithy.api#documentation": "An asset in a Amazon QuickSight folder, such as a dashboard, analysis, or dataset.
" } }, "com.amazonaws.quicksight#FolderMemberList": { @@ -8848,13 +8905,13 @@ "Operator": { "target": "com.amazonaws.quicksight#FilterOperator", "traits": { - "smithy.api#documentation": "The comparison operator that you want to use as a filter. For example, \"Operator\": \"StringEquals\".
The comparison operator that you want to use in the filter. For example, \"Operator\": \"StringEquals\".
The name of the value that you want to use as a filter. For example, \"Name\": \"PARENT_FOLDER_ARN\".
The name of a value that you want to use in the filter. For example, \"Name\": \"PARENT_FOLDER_ARN\".
Searches a folder by a filter.
" + "smithy.api#documentation": "A filter to use to search a Amazon QuickSight folder.
" } }, "com.amazonaws.quicksight#FolderSearchFilterList": { @@ -8886,13 +8943,13 @@ "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN).
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the folder.
" } }, "FolderId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The folder ID.
" + "smithy.api#documentation": "The ID of the folder.
" } }, "Name": { @@ -8921,7 +8978,7 @@ } }, "traits": { - "smithy.api#documentation": "A summary of the folder.
" + "smithy.api#documentation": "A summary of information about an existing Amazon QuickSight folder.
" } }, "com.amazonaws.quicksight#FolderSummaryList": { @@ -9136,7 +9193,7 @@ "ExperienceConfiguration": { "target": "com.amazonaws.quicksight#RegisteredUserEmbeddingExperienceConfiguration", "traits": { - "smithy.api#documentation": "The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards, the entire Amazon QuickSight console, or the Amazon QuickSight Q search bar.
", + "smithy.api#documentation": "The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards or the entire Amazon QuickSight console.
", "smithy.api#required": {} } } @@ -9148,7 +9205,7 @@ "EmbedUrl": { "target": "com.amazonaws.quicksight#EmbeddingUrl", "traits": { - "smithy.api#documentation": "The embed URL for the Amazon QuickSight dashboard, console, or Q search bar.
", + "smithy.api#documentation": "The embed URL for the Amazon QuickSight dashboard or console.
", "smithy.api#required": {} } }, @@ -9357,7 +9414,7 @@ "UserArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.\n\t\t\tYou can use this for any Amazon QuickSight users in your account (readers, authors, or\n\t\t\tadmins) authenticated as one of the following:
Active Directory (AD) users or group members
\n\t\t\tInvited nonfederated users
\n\t\t\tIAMusers and IAMrole-based sessions authenticated through Federated Single Sign-On using\n\t\t\t\t\tSAML, OpenID Connect, or IAMfederation.
\n\t\t\tOmit this parameter for users in the third group – IAMusers and IAM\n role-based sessions.
", + "smithy.api#documentation": "The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.\n\t\t\tYou can use this for any Amazon QuickSight users in your account (readers, authors, or\n\t\t\tadmins) authenticated as one of the following:
Active Directory (AD) users or group members
\n\t\t\tInvited nonfederated users
\n\t\t\tIAM users and IAM role-based sessions authenticated through Federated Single Sign-On using\n\t\t\t\t\tSAML, OpenID Connect, or IAM federation.
\n\t\t\tOmit this parameter for users in the third group – IAM users and IAM\n role-based sessions.
", "smithy.api#httpQuery": "user-arn" } }, @@ -9371,7 +9428,7 @@ "AdditionalDashboardIds": { "target": "com.amazonaws.quicksight#AdditionalDashboardIdList", "traits": { - "smithy.api#documentation": "A list of one or more dashboard IDs that you want to add to a session that includes\n anonymous users. The IdentityType parameter must be set to\n ANONYMOUS for this to work, because other identity types authenticate\n as Amazon QuickSight or IAMusers. For example, if you set \"--dashboard-id dash_id1\n --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS\", the session\n can access all three dashboards.
A list of one or more dashboard IDs that you want to add to a session that includes\n anonymous users. The IdentityType parameter must be set to\n ANONYMOUS for this to work, because other identity types authenticate\n as Amazon QuickSight or IAM users. For example, if you set \"--dashboard-id dash_id1\n --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS\", the session\n can access all three dashboards.
Generates a session URL and authorization code that you can use to embed the Amazon\n Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where\n you want to provide an authoring portal that allows users to create data sources,\n datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console\n need belong to the author or admin security cohort. If you want to restrict permissions\n to some of these features, add a custom permissions profile to the user with the\n \n UpdateUser\n API operation. Use \n RegisterUser\n API operation to add a new user with a custom permission profile attached. For more\n information, see the following sections in the Amazon QuickSight User\n Guide:
\n Embedding Analytics\n
\nGenerates a session URL and authorization code that you can use to embed the Amazon\n Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where\n you want to provide an authoring portal that allows users to create data sources,\n datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console\n need belong to the author or admin security cohort. If you want to restrict permissions\n to some of these features, add a custom permissions profile to the user with the\n \n UpdateUser\n API operation. Use \n RegisterUser\n \n API operation to add a new user with a custom permission profile attached. For more\n information, see the following sections in the Amazon QuickSight User\n Guide:
\n Embedding Analytics\n
\nThe Amazon Resource Name (ARN) for the IAMpolicy.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the IAM policy.
" } }, "Identities": { @@ -9700,7 +9757,7 @@ } }, "traits": { - "smithy.api#documentation": "IAMpolicy assignment summary.
" + "smithy.api#documentation": "IAM policy assignment summary.
" } }, "com.amazonaws.quicksight#IAMPolicyAssignmentSummaryList": { @@ -10458,6 +10515,20 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.quicksight#LinkSharingConfiguration": { + "type": "structure", + "members": { + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "A structure that contains the permissions of a shareable link.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains the configuration of a shareable link to the dashboard.
" + } + }, "com.amazonaws.quicksight#ListAnalyses": { "type": "operation", "input": { @@ -10994,7 +11065,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The AWS account ID.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that contains the folder.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11002,7 +11073,7 @@ "FolderId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The folder ID.
", + "smithy.api#documentation": "The ID of the folder.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11030,7 +11101,7 @@ "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The status. If succeeded, the status is SC_OK\n
The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, @@ -11049,7 +11120,7 @@ "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The request ID.
" + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" } } } @@ -11100,7 +11171,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The AWS account ID.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that contains the folder.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11128,14 +11199,14 @@ "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The status. If succeeded, the status is SC_OK\n
The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "FolderSummaryList": { "target": "com.amazonaws.quicksight#FolderSummaryList", "traits": { - "smithy.api#documentation": "A structure that contains all of the folders in your AWS account. This structure provides basic information about the folders.
" + "smithy.api#documentation": "A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.
" } }, "NextToken": { @@ -11147,7 +11218,7 @@ "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The request ID.
" + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" } } } @@ -11407,7 +11478,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists IAMpolicy assignments in the current Amazon QuickSight account.
", + "smithy.api#documentation": "Lists IAM policy assignments in the current Amazon QuickSight account.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments", @@ -11447,7 +11518,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all the IAMpolicy assignments, including the Amazon Resource Names (ARNs) for the IAM\n\t\t\tpolicies assigned to the specified user and group or groups that the user belongs\n\t\t\tto.
", + "smithy.api#documentation": "Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM\n\t\t\tpolicies assigned to the specified user and group or groups that the user belongs\n\t\t\tto.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/iam-policy-assignments", @@ -11535,7 +11606,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID of the Amazon Web Services account that contains these IAMpolicy assignments.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains these IAM policy assignments.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11577,7 +11648,7 @@ "IAMPolicyAssignments": { "target": "com.amazonaws.quicksight#IAMPolicyAssignmentSummaryList", "traits": { - "smithy.api#documentation": "Information describing the IAMpolicy assignments.
" + "smithy.api#documentation": "Information describing the IAM policy assignments.
" } }, "NextToken": { @@ -12941,7 +13012,7 @@ } }, "traits": { - "smithy.api#documentation": "An object that consists of the member Amazon Resource Name (ARN) and member ID.
" + "smithy.api#documentation": "An object that consists of a member Amazon Resource Name (ARN) and a member ID.
" } }, "com.amazonaws.quicksight#MemberType": { @@ -13503,6 +13574,21 @@ }, "com.amazonaws.quicksight#QuickSight_20180401": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "QuickSight", + "arnNamespace": "quicksight", + "cloudFormationName": "QuickSight", + "cloudTrailEventSource": "quicksight.amazonaws.com", + "endpointPrefix": "quicksight" + }, + "aws.auth#sigv4": { + "name": "quicksight" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Amazon QuickSight is a fully managed, serverless business intelligence service for the\n Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your\n organization. This API reference contains documentation for a programming interface that\n you can use to manage Amazon QuickSight.
", + "smithy.api#title": "Amazon QuickSight" + }, "version": "2018-04-01", "operations": [ { @@ -13850,22 +13936,7 @@ { "target": "com.amazonaws.quicksight#UpdateUser" } - ], - "traits": { - "aws.api#service": { - "sdkId": "QuickSight", - "arnNamespace": "quicksight", - "cloudFormationName": "QuickSight", - "cloudTrailEventSource": "quicksight.amazonaws.com", - "endpointPrefix": "quicksight" - }, - "aws.auth#sigv4": { - "name": "quicksight" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Amazon QuickSight is a fully managed, serverless business intelligence service for the\n Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your\n organization. This API reference contains documentation for a programming interface that\n you can use to manage Amazon QuickSight.
", - "smithy.api#title": "Amazon QuickSight" - } + ] }, "com.amazonaws.quicksight#RdsParameters": { "type": "structure", @@ -13970,7 +14041,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity\n\t\t\tand Access Management (IAM) identity or role specified in the request.
", + "smithy.api#documentation": "Creates an Amazon QuickSight user, whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users", @@ -13984,7 +14055,7 @@ "IdentityType": { "target": "com.amazonaws.quicksight#IdentityType", "traits": { - "smithy.api#documentation": "Amazon QuickSight supports several ways of managing the identity of users. This\n\t\t\tparameter accepts two values:
\n\t\t\n IAM: A user whose identity maps to an existing IAMuser or role.\n\t\t\t\t
\n QUICKSIGHT: A user whose identity is owned and managed internally by\n\t\t\t\t\tAmazon QuickSight.
Amazon QuickSight supports several ways of managing the identity of users. This\n\t\t\tparameter accepts two values:
\n\t\t\n IAM: A user whose identity maps to an existing IAM user or role.\n\t\t\t\t
\n QUICKSIGHT: A user whose identity is owned and managed internally by\n\t\t\t\t\tAmazon QuickSight.
The ARN of the IAMuser or role that you are registering with Amazon QuickSight.
" + "smithy.api#documentation": "The ARN of the IAM user or role that you are registering with Amazon QuickSight.
" } }, "SessionName": { "target": "com.amazonaws.quicksight#RoleSessionName", "traits": { - "smithy.api#documentation": "You need to use this parameter only when you register one or more users using an assumed\n\t\t\tIAMrole. You don't need to provide the session name for other scenarios, for example when\n\t\t\tyou are registering an IAMuser or an Amazon QuickSight user. You can register multiple\n\t\t\tusers using the same IAMrole if each user has a different session name. For more\n\t\t\tinformation on assuming IAMroles, see \n assume-role\n in the AWS CLI Reference.\n
You need to use this parameter only when you register one or more users using an assumed\n\t\t\tIAM role. You don't need to provide the session name for other scenarios, for example when\n\t\t\tyou are registering an IAM user or an Amazon QuickSight user. You can register multiple\n\t\t\tusers using the same IAM role if each user has a different session name. For more\n\t\t\tinformation on assuming IAM roles, see \n assume-role\n in the CLI Reference.\n
(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:
\nCreate and update data sources
\nCreate and update datasets
\nCreate and update email reports
\nSubscribe to email reports
\nTo add custom permissions to an existing user, use \n UpdateUser\n instead.
A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the Amazon QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a Amazon QuickSight user.
Amazon QuickSight custom permissions are applied through IAMpolicies. Therefore, they\n override the permissions typically granted by assigning Amazon QuickSight users to one of the\n default security cohorts in Amazon QuickSight (admin, author, reader).
\nThis feature is available only to Amazon QuickSight Enterprise edition subscriptions.
" + "smithy.api#documentation": "(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:
\nCreate and update data sources
\nCreate and update datasets
\nCreate and update email reports
\nSubscribe to email reports
\nTo add custom permissions to an existing user, use \n UpdateUser\n instead.
A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the Amazon QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a QuickSight user.
Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning Amazon QuickSight users to one of the\n default security cohorts in Amazon QuickSight (admin, author, reader).
\nThis feature is available only to Amazon QuickSight Enterprise edition subscriptions.
" } }, "ExternalLoginFederationProviderType": { @@ -14119,18 +14190,18 @@ "QuickSightConsole": { "target": "com.amazonaws.quicksight#RegisteredUserQuickSightConsoleEmbeddingConfiguration", "traits": { - "smithy.api#documentation": "The configuration details for providing an Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User\n Guide.
\nUse GenerateEmbedUrlForRegisteredUser where\n you want to provide an authoring portal that allows users to create data sources,\n datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console\n needs to belong to the author or admin security cohort. If you want to restrict permissions\n to some of these features, add a custom permissions profile to the user with the\n \n UpdateUser\n API operation. Use \n RegisterUser\n API operation to add a new user with a custom permission profile attached. For more\n information, see the following sections in the Amazon QuickSight User\n Guide:
\n Embedding the Full Functionality of the Amazon QuickSight Console for Authenticated Users\n
\nFor more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
" + "smithy.api#documentation": "The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User\n Guide.
\nUse \n GenerateEmbedUrlForRegisteredUser\n \n where\n you want to provide an authoring portal that allows users to create data sources,\n datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console\n needs to belong to the author or admin security cohort. If you want to restrict permissions\n to some of these features, add a custom permissions profile to the user with the\n \n UpdateUser\n API operation. Use the \n RegisterUser\n API operation to add a new user with a custom permission profile attached. For more\n information, see the following sections in the Amazon QuickSight User\n Guide:
\n Embedding the Full Functionality of the Amazon QuickSight Console for Authenticated Users\n
\nFor more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
" } }, "QSearchBar": { "target": "com.amazonaws.quicksight#RegisteredUserQSearchBarEmbeddingConfiguration", "traits": { - "smithy.api#documentation": "The configuration details for embedding the Q search bar.
\nFor more information about embedding the Q search bar, see Embedding Overview.
" + "smithy.api#documentation": "The configuration details for embedding the Q search bar.
\nFor more information about embedding the Q search bar, see\n Embedding Overview.
" } } }, "traits": { - "smithy.api#documentation": "The type of experience you want to embed. For registered users, you can embed an Amazon QuickSight dashboard or the Amazon QuickSight console.
\nExactly one of the experience configurations is required. You can choose Dashboard or QuickSightConsole. You cannot choose more than one experience configuraton.
The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.
\nExactly one of the experience configurations is required. You can choose\n Dashboard or QuickSightConsole. You cannot choose more\n than one experience configuration.
The ID of the Q topic that you want to make the starting topic in the Q search bar. You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening a topic. The ID is in the URL for the topic that you open.
\nIf you don't specify an initial topic, a list of all shared topics is shown in the Q bar for your readers. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the available ones in the list.
" + "smithy.api#documentation": "The ID of the Q topic that you want to make the starting topic in the Q search bar.\n You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening\n a topic. The ID is in the URL for the topic that you open.
\nIf you don't specify an initial topic, a list of all shared topics is shown in the Q bar\n for your readers. When you select an initial topic, you can specify whether or not readers\n are allowed to select other topics from the available ones in the list.
" } } }, @@ -14319,14 +14390,14 @@ "Principal": { "target": "com.amazonaws.quicksight#Principal", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:
\nThe ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
\nThe ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
\nThe ARN of an Amazon Web Services account root: This is an IAMARN rather than a Amazon QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.)
\nThe Amazon Resource Name (ARN) of the principal. This can be one of the\n following:
\nThe ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
\nThe ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
\nThe ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.)
\nThe IAMaction to grant or revoke permissions on.
", + "smithy.api#documentation": "The IAM action to grant or revoke permissions on.
", "smithy.api#required": {} } } @@ -15017,7 +15088,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The AWS account ID.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that contains the folder.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -15050,14 +15121,14 @@ "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The status. If succeeded, the status is SC_OK.
The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "FolderSummaryList": { "target": "com.amazonaws.quicksight#FolderSummaryList", "traits": { - "smithy.api#documentation": "A structure that contains all of the folders in your AWS account. This structure provides basic information about the folders.
" + "smithy.api#documentation": "A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.
" } }, "NextToken": { @@ -15069,7 +15140,7 @@ "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The request ID.
" + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" } } } @@ -15516,7 +15587,7 @@ } ], "traits": { - "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
\n\t\tTags can help you organize and categorize your resources. You can also use them to\n\t\t\tscope user permissions, by granting a user permission to access or change only resources\n\t\t\twith certain tag values. You can use the TagResource operation with a\n\t\t\tresource that already has tags. If you specify a new tag key for the resource, this tag\n\t\t\tis appended to the list of tags associated with the resource. If you specify a tag key\n\t\t\tthat is already associated with the resource, the new tag value that you specify\n\t\t\treplaces the previous value for that tag.
You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data\n\t\t\tset, data source, dashboard, and template.
\n\t\tTagging for Amazon QuickSight works in a similar way to tagging for other AWS services, except for\n\t\t\tthe following:
\n\t\tYou can't use tags to track AWS costs for Amazon QuickSight. This restriction is because Amazon QuickSight\n\t\t\t\t\tcosts are based on users and SPICE capacity, which aren't taggable\n\t\t\t\t\tresources.
\nAmazon QuickSight doesn't currently support the Tag Editor for Resource Groups.
\nAssigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
\n\t\tTags can help you organize and categorize your resources. You can also use them to\n\t\t\tscope user permissions, by granting a user permission to access or change only resources\n\t\t\twith certain tag values. You can use the TagResource operation with a\n\t\t\tresource that already has tags. If you specify a new tag key for the resource, this tag\n\t\t\tis appended to the list of tags associated with the resource. If you specify a tag key\n\t\t\tthat is already associated with the resource, the new tag value that you specify\n\t\t\treplaces the previous value for that tag.
You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data\n\t\t\tset, data source, dashboard, and template.
\n\t\tTagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for\n\t\t\tthe following:
\n\t\tYou can't use tags to track costs for Amazon QuickSight. This isn't\n\t\t\t\tpossible because you can't tag the resources that Amazon QuickSight costs are based \n\t\t\t\ton, for example Amazon QuickSight storage capacity (SPICE), number of users, type \n\t\t\t\tof users, and usage metrics.
\n\t\t\tAmazon QuickSight doesn't currently support the tag editor for Resource Groups.
\n\t\t\t\tThis error indicates that you are calling an embedding operation in Amazon QuickSight\n\t\t\twithout the required pricing plan on your Amazon Web Services account. Before you can use embedding \n\t\t\tfor anonymous users, a Amazon QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You \n\t\t can do this on the Manage Amazon QuickSight page.
\nAfter capacity pricing is added, you can use the \n GetDashboardEmbedUrl API operation with the \n --identity-type ANONYMOUS option.
This error indicates that you are calling an embedding operation in Amazon QuickSight\n\t\t\twithout the required pricing plan on your Amazon Web Services account. Before you can use embedding \n\t\t\tfor anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You \n\t\t can do this on the Manage Amazon QuickSight page.
\nAfter capacity pricing is added, you can use the \n \n GetDashboardEmbedUrl\n API operation with the \n --identity-type ANONYMOUS option.
Updates a dashboard in an Amazon Web Services account.
\nUpdating a Dashboard creates a new dashboard version but does not immediately publish\n the new version. You can update the published version of a dashboard by\n using the UpdateDashboardPublishedVersion API operation.
\nUpdates a dashboard in an Amazon Web Services account.
\nUpdating a Dashboard creates a new dashboard version but does not immediately publish\n the new version. You can update the published version of a dashboard by\n using the \n UpdateDashboardPublishedVersion\n API operation.
The permissions that you want to revoke from this resource.
" } + }, + "GrantLinkPermissions": { + "target": "com.amazonaws.quicksight#UpdateLinkPermissionList", + "traits": { + "smithy.api#documentation": "Grants link permissions to all users in a defined namespace.
" + } + }, + "RevokeLinkPermissions": { + "target": "com.amazonaws.quicksight#UpdateLinkPermissionList", + "traits": { + "smithy.api#documentation": "Revokes link permissions from all users in a defined namespace.
" + } } } }, @@ -17276,6 +17362,12 @@ "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } + }, + "LinkSharingConfiguration": { + "target": "com.amazonaws.quicksight#LinkSharingConfiguration", + "traits": { + "smithy.api#documentation": "Updates the permissions of a shared link to an Amazon QuickSight dashboard.
" + } } } }, @@ -17404,7 +17496,7 @@ "SourceEntity": { "target": "com.amazonaws.quicksight#DashboardSourceEntity", "traits": { - "smithy.api#documentation": "The entity that you are using as a source when you update the dashboard. In\n SourceEntity, you specify the type of object you're using as source. You\n can only update a dashboard from a template, so you use a SourceTemplate\n entity. If you need to update a dashboard from an analysis, first convert the analysis\n to a template by using the CreateTemplate API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplate ARN can contain any Amazon Web Services account and any\n Amazon QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.
The entity that you are using as a source when you update the dashboard. In\n SourceEntity, you specify the type of object you're using as source. You\n can only update a dashboard from a template, so you use a SourceTemplate\n entity. If you need to update a dashboard from an analysis, first convert the analysis\n to a template by using the \n CreateTemplate\n API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplate ARN can contain any Amazon Web Services account and any\n Amazon QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.
A set of one or more definitions of a \n ColumnLevelPermissionRule\n .
A set of one or more definitions of a \n ColumnLevelPermissionRule\n .
The AWS account ID.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that contains the folder to update.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -18063,7 +18155,7 @@ "FolderId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The folder ID.
", + "smithy.api#documentation": "The ID of the folder.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -18088,31 +18180,31 @@ "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The status. If succeeded, the status is SC_OK.
The HTTP status of the request.
" } }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN).
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the folder.
" } }, "FolderId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The folder ID.
" + "smithy.api#documentation": "The ID of the folder.
" } }, "Permissions": { "target": "com.amazonaws.quicksight#ResourcePermissionList", "traits": { - "smithy.api#documentation": "Information about the permissions on the dashboard.
" + "smithy.api#documentation": "Information about the permissions for the folder.
" } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The request ID.
" + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" } } } @@ -18123,7 +18215,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The AWS account ID.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that contains the folder to update.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -18131,7 +18223,7 @@ "FolderId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The folder ID.
", + "smithy.api#documentation": "The ID of the folder.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -18151,26 +18243,26 @@ "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The status. If succeeded, the status is SC_OK.
The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN).
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the folder.
" } }, "FolderId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The folder ID.
" + "smithy.api#documentation": "The ID of the folder.
" } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The request ID.
" + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" } } } @@ -18306,7 +18398,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an existing IAMpolicy assignment. This operation updates only the optional\n\t\t\tparameter or parameters that are specified in the request. \n\t\t This overwrites all of the users included in Identities. \n\t\t
Updates an existing IAM policy assignment. This operation updates only the optional\n\t\t\tparameter or parameters that are specified in the request.\n\t\t This overwrites all of the users included in Identities.\n\t\t
The ID of the Amazon Web Services account that contains the IAMpolicy assignment.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the IAM policy assignment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -18350,7 +18442,7 @@ "PolicyArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The ARN for the IAMpolicy to apply to the Amazon QuickSight users and groups\n\t\t\tspecified in this assignment.
" + "smithy.api#documentation": "The ARN for the IAM policy to apply to the Amazon QuickSight users and groups\n\t\t\tspecified in this assignment.
" } }, "Identities": { @@ -18379,13 +18471,13 @@ "PolicyArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The ARN for the IAMpolicy applied to the Amazon QuickSight users and groups specified in this\n\t\t\tassignment.
" + "smithy.api#documentation": "The ARN for the IAM policy applied to the Amazon QuickSight users and groups specified in this\n\t\t\tassignment.
" } }, "Identities": { "target": "com.amazonaws.quicksight#IdentityMap", "traits": { - "smithy.api#documentation": "The Amazon QuickSight users, groups, or both that the IAMpolicy is assigned to.
" + "smithy.api#documentation": "The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.
" } }, "AssignmentStatus": { @@ -18438,7 +18530,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates content and status of IP Rules.
", + "smithy.api#documentation": "Updates the content and status of IP rules. To use this operation, you need to provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.
Your AWS account ID.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the IP rules.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -18460,13 +18552,13 @@ "IpRestrictionRuleMap": { "target": "com.amazonaws.quicksight#IpRestrictionRuleMap", "traits": { - "smithy.api#documentation": "Describes updated IP rules.
" + "smithy.api#documentation": "A map that describes the updated IP rules with CIDR ranges and descriptions.
" } }, "Enabled": { "target": "com.amazonaws.quicksight#NullableBoolean", "traits": { - "smithy.api#documentation": "Whether or not IP rules are enabled.
" + "smithy.api#documentation": "A value that specifies whether IP rules are turned on.
" } } } @@ -18477,24 +18569,36 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "Your AWS account ID.
" + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the IP rules.
" } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The ID of the update request.
" + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The status of the updated IP rules. A successful request returns a 200 code.
", + "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, + "com.amazonaws.quicksight#UpdateLinkPermissionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ResourcePermission" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, "com.amazonaws.quicksight#UpdateResourcePermissionList": { "type": "list", "member": { @@ -19253,7 +19357,7 @@ "CustomPermissionsName": { "target": "com.amazonaws.quicksight#RoleName", "traits": { - "smithy.api#documentation": "(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:
\nCreate and update data sources
\nCreate and update datasets
\nCreate and update email reports
\nSubscribe to email reports
\nA set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the Amazon QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a Amazon QuickSight user.
Amazon QuickSight custom permissions are applied through IAMpolicies. Therefore, they\n override the permissions typically granted by assigning Amazon QuickSight users to one of the\n default security cohorts in Amazon QuickSight (admin, author, reader).
\nThis feature is available only to Amazon QuickSight Enterprise edition subscriptions.
" + "smithy.api#documentation": "(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:
\nCreate and update data sources
\nCreate and update datasets
\nCreate and update email reports
\nSubscribe to email reports
\nA set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the Amazon QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a QuickSight user.
Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning Amazon QuickSight users to one of the\n default security cohorts in Amazon QuickSight (admin, author, reader).
\nThis feature is available only to Amazon QuickSight Enterprise edition subscriptions.
" } }, "UnapplyCustomPermissions": { @@ -19265,7 +19369,7 @@ "ExternalLoginFederationProviderType": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.
\n\n COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the \"CustomFederationProviderUrl\" parameter which is only needed when the external provider is custom.
\n CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.
\n NONE: This clears all the previously saved external login information for a user. Use \n DescribeUser\n API to check the external login information.
The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.
\n\n COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the \"CustomFederationProviderUrl\" parameter which is only needed when the external provider is custom.
\n CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.
\n NONE: This clears all the previously saved external login information for a user. Use the\n \n DescribeUser\n \n API operation to check the external login information.
The user's user name.
" + "smithy.api#documentation": "The user's user name. In the output, the value for UserName is\n N/A when the value for IdentityType is IAM\n and the corresponding IAM user is deleted.
The type of supported external login provider that provides identity to let the user\n federate into Amazon QuickSight with an associated IAMrole. The type can be one of the following.
\n\n COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.
\n CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.
The type of supported external login provider that provides identity to let the user\n federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.
\n\n COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.
\n CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.
This is the Recycle Bin API Reference. This documentation provides \n descriptions and syntax for each of the actions and data types in Recycle Bin.
\n \nRecycle Bin is a snapshot recovery feature that enables you to restore accidentally \n deleted snapshots. When using Recycle Bin, if your snapshots are deleted, they are retained \n in the Recycle Bin for a time period that you specify.
\n \nYou can restore a snapshot from the Recycle Bin at any time before its retention period \n expires. After you restore a snapshot from the Recycle Bin, the snapshot is removed from the \n Recycle Bin, and you can then use it in the same way you use any other snapshot in your \n account. If the retention period expires and the snapshot is not restored, the snapshot is \n permanently deleted from the Recycle Bin and is no longer available for recovery. For more \n information about Recycle Bin, see \n Recycle Bin in the Amazon EC2 User Guide.
", + "smithy.api#title": "Amazon Recycle Bin" + }, + "version": "2021-06-15", + "operations": [ + { + "target": "com.amazonaws.rbin#CreateRule" + }, + { + "target": "com.amazonaws.rbin#DeleteRule" + }, + { + "target": "com.amazonaws.rbin#GetRule" + }, + { + "target": "com.amazonaws.rbin#ListRules" + }, + { + "target": "com.amazonaws.rbin#ListTagsForResource" + }, + { + "target": "com.amazonaws.rbin#TagResource" + }, + { + "target": "com.amazonaws.rbin#UntagResource" + }, + { + "target": "com.amazonaws.rbin#UpdateRule" + } + ] + }, + "com.amazonaws.rbin#CreateRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.rbin#CreateRuleRequest" + }, + "output": { + "target": "com.amazonaws.rbin#CreateRuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rbin#InternalServerException" + }, + { + "target": "com.amazonaws.rbin#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.rbin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a Recycle Bin retention rule. For more information, see \n Create Recycle Bin retention rules in the Amazon EC2 User Guide.
", + "smithy.api#http": { + "method": "POST", + "uri": "/rules", + "code": 201 + } + } + }, + "com.amazonaws.rbin#CreateRuleRequest": { + "type": "structure", + "members": { + "RetentionPeriod": { + "target": "com.amazonaws.rbin#RetentionPeriod", + "traits": { + "smithy.api#documentation": "Information about the retention period for which the retention rule is to retain resources.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.rbin#Description", + "traits": { + "smithy.api#documentation": "A brief description for the retention rule.
" + } + }, + "Tags": { + "target": "com.amazonaws.rbin#TagList", + "traits": { + "smithy.api#documentation": "Information about the tags to assign to the retention rule.
" + } + }, + "ResourceType": { + "target": "com.amazonaws.rbin#ResourceType", + "traits": { + "smithy.api#documentation": "The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots are \n supported.
", + "smithy.api#required": {} + } + }, + "ResourceTags": { + "target": "com.amazonaws.rbin#ResourceTags", + "traits": { + "smithy.api#documentation": "Information about the resource tags to use to identify resources that are to be retained \n by the retention rule. The retention rule retains only deleted snapshots that have one or more \n of the specified tag key and value pairs. If a snapshot is deleted, but it does not have \n any of the specified tag key and value pairs, it is immediately deleted without being retained \n by the retention rule.
\nYou can add the same tag key and value pair to a maximum or five retention rules.
" + } + } + } + }, + "com.amazonaws.rbin#CreateRuleResponse": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.rbin#RuleIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the retention rule.
" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.rbin#RetentionPeriod" + }, + "Description": { + "target": "com.amazonaws.rbin#Description", + "traits": { + "smithy.api#documentation": "The retention rule description.
" + } + }, + "Tags": { + "target": "com.amazonaws.rbin#TagList", + "traits": { + "smithy.api#documentation": "The tags assigned to the retention rule.
" + } + }, + "ResourceType": { + "target": "com.amazonaws.rbin#ResourceType", + "traits": { + "smithy.api#documentation": "The resource type retained by the retention rule.
" + } + }, + "ResourceTags": { + "target": "com.amazonaws.rbin#ResourceTags", + "traits": { + "smithy.api#documentation": "Information about the resource tags used to identify resources that are retained by the retention \n rule.
" + } + }, + "Status": { + "target": "com.amazonaws.rbin#RuleStatus", + "traits": { + "smithy.api#documentation": "The state of the retention rule. Only retention rules that are in the available state retain snapshots.
Deletes a Recycle Bin retention rule. For more information, see \n Delete Recycle Bin retention rules in the Amazon EC2 User Guide.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/rules/{Identifier}", + "code": 204 + } + } + }, + "com.amazonaws.rbin#DeleteRuleRequest": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.rbin#RuleIdentifier", + "traits": { + "smithy.api#documentation": "The unique ID of the retention rule to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.rbin#DeleteRuleResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.rbin#Description": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\S ]{0,255}$" + } + }, + "com.amazonaws.rbin#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.rbin#GetRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.rbin#GetRuleRequest" + }, + "output": { + "target": "com.amazonaws.rbin#GetRuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rbin#InternalServerException" + }, + { + "target": "com.amazonaws.rbin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rbin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a Recycle Bin retention rule.
", + "smithy.api#http": { + "method": "GET", + "uri": "/rules/{Identifier}", + "code": 200 + } + } + }, + "com.amazonaws.rbin#GetRuleRequest": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.rbin#RuleIdentifier", + "traits": { + "smithy.api#documentation": "The unique ID of the retention rule.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.rbin#GetRuleResponse": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.rbin#RuleIdentifier", + "traits": { + "smithy.api#documentation": "The unique ID of the retention rule.
" + } + }, + "Description": { + "target": "com.amazonaws.rbin#Description", + "traits": { + "smithy.api#documentation": "The description assigned to the retention rule.
" + } + }, + "ResourceType": { + "target": "com.amazonaws.rbin#ResourceType", + "traits": { + "smithy.api#documentation": "The resource type retained by the retention rule. Currently, only Amazon EBS snapshots are supported.
" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.rbin#RetentionPeriod", + "traits": { + "smithy.api#documentation": "Information about the period for which the retention rule retains resources.
" + } + }, + "ResourceTags": { + "target": "com.amazonaws.rbin#ResourceTags", + "traits": { + "smithy.api#documentation": "The resource tags used to identify resources that are to be retained by the retention rule.
" + } + }, + "Status": { + "target": "com.amazonaws.rbin#RuleStatus", + "traits": { + "smithy.api#documentation": "The state of the retention rule. Only retention rules that are in the available state retain snapshots.
The service could not respond to the request due to an internal problem.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.rbin#ListRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.rbin#ListRulesRequest" + }, + "output": { + "target": "com.amazonaws.rbin#ListRulesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rbin#InternalServerException" + }, + { + "target": "com.amazonaws.rbin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the Recycle Bin retention rules in the Region.
", + "smithy.api#http": { + "method": "POST", + "uri": "/list-rules", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.rbin#ListRulesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.rbin#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
The token to use to retrieve the next page of results.
" + } + }, + "ResourceType": { + "target": "com.amazonaws.rbin#ResourceType", + "traits": { + "smithy.api#documentation": "The resource type retained by the retention rule. Only retention rules that retain the specified resource type \n are listed.
", + "smithy.api#required": {} + } + }, + "ResourceTags": { + "target": "com.amazonaws.rbin#ResourceTags", + "traits": { + "smithy.api#documentation": "The tags used to identify resources that are to be retained by the retention rule.
" + } + } + } + }, + "com.amazonaws.rbin#ListRulesResponse": { + "type": "structure", + "members": { + "Rules": { + "target": "com.amazonaws.rbin#RuleSummaryList", + "traits": { + "smithy.api#documentation": "Information about the retention rules.
" + } + }, + "NextToken": { + "target": "com.amazonaws.rbin#NextToken", + "traits": { + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Lists the tags assigned a specific resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.rbin#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.rbin#RuleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which to list the tags.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.rbin#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.rbin#TagList", + "traits": { + "smithy.api#documentation": "Information about the tags assigned to the resource.
" + } + } + } + }, + "com.amazonaws.rbin#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.rbin#NextToken": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Za-z0-9+/=]{1,2048}$" + } + }, + "com.amazonaws.rbin#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.rbin#ErrorMessage" + }, + "Reason": { + "target": "com.amazonaws.rbin#ResourceNotFoundExceptionReason", + "traits": { + "smithy.api#documentation": "The reason for the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified resource was not found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rbin#ResourceNotFoundExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RULE_NOT_FOUND", + "name": "RULE_NOT_FOUND" + } + ] + } + }, + "com.amazonaws.rbin#ResourceTag": { + "type": "structure", + "members": { + "ResourceTagKey": { + "target": "com.amazonaws.rbin#ResourceTagKey", + "traits": { + "smithy.api#documentation": "The tag key.
", + "smithy.api#required": {} + } + }, + "ResourceTagValue": { + "target": "com.amazonaws.rbin#ResourceTagValue", + "traits": { + "smithy.api#documentation": "The tag value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a resource tag used to identify resources that are to be retained by a Recycle Bin retention rule.
" + } + }, + "com.amazonaws.rbin#ResourceTagKey": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\S\\s]{1,128}$" + } + }, + "com.amazonaws.rbin#ResourceTagValue": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\S\\s]{0,256}$" + } + }, + "com.amazonaws.rbin#ResourceTags": { + "type": "list", + "member": { + "target": "com.amazonaws.rbin#ResourceTag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.rbin#ResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EBS_SNAPSHOT", + "name": "EBS_SNAPSHOT" + } + ] + } + }, + "com.amazonaws.rbin#RetentionPeriod": { + "type": "structure", + "members": { + "RetentionPeriodValue": { + "target": "com.amazonaws.rbin#RetentionPeriodValue", + "traits": { + "smithy.api#documentation": "The period value for which the retention rule is to retain resources. The period is measured using \n the unit specified for RetentionPeriodUnit.
", + "smithy.api#required": {} + } + }, + "RetentionPeriodUnit": { + "target": "com.amazonaws.rbin#RetentionPeriodUnit", + "traits": { + "smithy.api#documentation": "The unit of time in which the retention period is measured. Currently, only DAYS \n is supported.
Information about the retention period for which a retention rule is to retain resources.
" + } + }, + "com.amazonaws.rbin#RetentionPeriodUnit": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DAYS", + "name": "DAYS" + } + ] + } + }, + "com.amazonaws.rbin#RetentionPeriodValue": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 3650 + } + } + }, + "com.amazonaws.rbin#RuleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[a-z]{1,3}){0,2}:rbin:[a-z\\-0-9]{0,63}:[0-9]{12}:rule/[0-9a-zA-Z]{11}{0,1011}$" + } + }, + "com.amazonaws.rbin#RuleIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-zA-Z]{11}$" + } + }, + "com.amazonaws.rbin#RuleStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "pending", + "name": "PENDING" + }, + { + "value": "available", + "name": "AVAILABLE" + } + ] + } + }, + "com.amazonaws.rbin#RuleSummary": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.rbin#RuleIdentifier", + "traits": { + "smithy.api#documentation": "The unique ID of the retention rule.
" + } + }, + "Description": { + "target": "com.amazonaws.rbin#Description", + "traits": { + "smithy.api#documentation": "The description for the retention rule.
" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.rbin#RetentionPeriod", + "traits": { + "smithy.api#documentation": "Information about the retention period for which the retention rule retains resources
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a Recycle Bin retention rule.
" + } + }, + "com.amazonaws.rbin#RuleSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.rbin#RuleSummary" + } + }, + "com.amazonaws.rbin#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.rbin#ErrorMessage" + }, + "Reason": { + "target": "com.amazonaws.rbin#ServiceQuotaExceededExceptionReason", + "traits": { + "smithy.api#documentation": "The reason for the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request would cause a service quota for the number of tags per resource to be exceeded.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.rbin#ServiceQuotaExceededExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SERVICE_QUOTA_EXCEEDED", + "name": "SERVICE_QUOTA_EXCEEDED" + } + ] + } + }, + "com.amazonaws.rbin#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.rbin#TagKey", + "traits": { + "smithy.api#documentation": "The tag key.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.rbin#TagValue", + "traits": { + "smithy.api#documentation": "The tag value.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the tags assigned to a Recycle Bin retention rule.
" + } + }, + "com.amazonaws.rbin#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.rbin#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.rbin#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.rbin#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.rbin#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.rbin#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.rbin#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.rbin#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rbin#InternalServerException" + }, + { + "target": "com.amazonaws.rbin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rbin#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.rbin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Assigns tags to the specified resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{ResourceArn}", + "code": 201 + } + } + }, + "com.amazonaws.rbin#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.rbin#RuleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to which to assign the tags.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rbin#TagList", + "traits": { + "smithy.api#documentation": "Information about the tags to assign to the resource.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.rbin#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.rbin#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.rbin#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.rbin#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.rbin#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rbin#InternalServerException" + }, + { + "target": "com.amazonaws.rbin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rbin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Unassigns a tag from a resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{ResourceArn}", + "code": 204 + } + } + }, + "com.amazonaws.rbin#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.rbin#RuleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource from which to unassign the tags.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.rbin#TagKeyList", + "traits": { + "smithy.api#documentation": "Information about the tags to unassign from the resource.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.rbin#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.rbin#UpdateRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.rbin#UpdateRuleRequest" + }, + "output": { + "target": "com.amazonaws.rbin#UpdateRuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rbin#InternalServerException" + }, + { + "target": "com.amazonaws.rbin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rbin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing Recycle Bin retention rule. For more information, see \n Update Recycle Bin retention rules in the Amazon EC2 User Guide.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/rules/{Identifier}", + "code": 200 + } + } + }, + "com.amazonaws.rbin#UpdateRuleRequest": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.rbin#RuleIdentifier", + "traits": { + "smithy.api#documentation": "The unique ID of the retention rule to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.rbin#RetentionPeriod", + "traits": { + "smithy.api#documentation": "Information about the retention period for which the retention rule is to retain resources.
" + } + }, + "Description": { + "target": "com.amazonaws.rbin#Description", + "traits": { + "smithy.api#documentation": "The retention rule description.
" + } + }, + "ResourceType": { + "target": "com.amazonaws.rbin#ResourceType", + "traits": { + "smithy.api#documentation": "The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots are supported.
" + } + }, + "ResourceTags": { + "target": "com.amazonaws.rbin#ResourceTags", + "traits": { + "smithy.api#documentation": "Information about the resource tags to use to identify resources that are to be retained \n by the retention rule. The retention rule retains only deleted snapshots that have one or more \n of the specified tag key and value pairs. If a snapshot is deleted, but it does not have \n any of the specified tag key and value pairs, it is immediately deleted without being retained \n by the retention rule.
\nYou can add the same tag key and value pair to a maximum or five retention rules.
" + } + } + } + }, + "com.amazonaws.rbin#UpdateRuleResponse": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.rbin#RuleIdentifier", + "traits": { + "smithy.api#documentation": "The unique ID of the retention rule.
" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.rbin#RetentionPeriod" + }, + "Description": { + "target": "com.amazonaws.rbin#Description", + "traits": { + "smithy.api#documentation": "The retention rule description.
" + } + }, + "ResourceType": { + "target": "com.amazonaws.rbin#ResourceType", + "traits": { + "smithy.api#documentation": "The resource type retained by the retention rule.
" + } + }, + "ResourceTags": { + "target": "com.amazonaws.rbin#ResourceTags", + "traits": { + "smithy.api#documentation": "Information about the resource tags used to identify resources that are retained by the retention \n rule.
" + } + }, + "Status": { + "target": "com.amazonaws.rbin#RuleStatus", + "traits": { + "smithy.api#documentation": "The state of the retention rule. Only retention rules that are in the available state retain snapshots.
The reason for the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "One or more of the parameters in the request is not valid.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rbin#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INVALID_PAGE_TOKEN", + "name": "INVALID_PAGE_TOKEN" + }, + { + "value": "INVALID_PARAMETER_VALUE", + "name": "INVALID_PARAMETER_VALUE" + } + ] + } + } + } +} diff --git a/aws/sdk/aws-models/rds.json b/aws/sdk/aws-models/rds.json index 9f3fce7c2bc69356a9b97461461925b8ee835633..f56820ee0d1dc5d98ed97a9a5edf648192599479 100644 --- a/aws/sdk/aws-models/rds.json +++ b/aws/sdk/aws-models/rds.json @@ -142,7 +142,7 @@ } ], "traits": { - "smithy.api#documentation": "Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster.\n For more information, see Authorizing Amazon Aurora MySQL \n to Access Other Amazon Web Services Services on Your Behalf in the Amazon Aurora User Guide.
\nThis action only applies to Aurora DB clusters.
\nAssociates an Identity and Access Management (IAM) role with a DB cluster.
" } }, "com.amazonaws.rds#AddRoleToDBClusterMessage": { @@ -158,7 +158,7 @@ "RoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB\n cluster, for example, arn:aws:iam::123456789012:role/AuroraAccessRole.
The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB\n cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.
\n
Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and \n scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational \n database and manages common database administration tasks, freeing up developers to focus on what makes their applications \n and businesses unique.
\nAmazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, \n Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools \n you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS \n automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS \n is flexible: you can scale your DB instance's compute resources and storage capacity to meet your \n application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for \n the resources you use.
\nThis interface reference for Amazon RDS contains documentation for a programming or command line interface \n you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might \n require techniques such as polling or callback functions to determine when a command has been applied. In this \n reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, \n or during the maintenance window. The reference structure is as follows, and we list following some related topics \n from the user guide.
\n \n\n Amazon RDS API Reference\n
\n \nFor the alphabetical list of API actions, see \n API Actions.
\nFor the alphabetical list of data types, see \n Data Types.
\nFor a list of common query parameters, see \n Common Parameters.
\nFor descriptions of the error codes, see \n Common Errors.
\n\n Amazon RDS User Guide\n
\n \nFor a summary of the Amazon RDS interfaces, see \n Available RDS Interfaces.
\nFor more information about how to use the Query API, see \n Using the Query API.
\n\n
Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and \n scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational \n database and manages common database administration tasks, freeing up developers to focus on what makes their applications \n and businesses unique.
\nAmazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, \n Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools \n you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS \n automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS \n is flexible: you can scale your DB instance's compute resources and storage capacity to meet your \n application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for \n the resources you use.
\nThis interface reference for Amazon RDS contains documentation for a programming or command line interface \n you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might \n require techniques such as polling or callback functions to determine when a command has been applied. In this \n reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, \n or during the maintenance window. The reference structure is as follows, and we list following some related topics \n from the user guide.
\n \n\n Amazon RDS API Reference\n
\n \nFor the alphabetical list of API actions, see \n API Actions.
\nFor the alphabetical list of data types, see \n Data Types.
\nFor a list of common query parameters, see \n Common Parameters.
\nFor descriptions of the error codes, see \n Common Errors.
\n\n Amazon RDS User Guide\n
\n \nFor a summary of the Amazon RDS interfaces, see \n Available RDS Interfaces.
\nFor more information about how to use the Query API, see \n Using the Query API.
\nEnables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security \n groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC \n instances. Second, IP ranges are available if the application accessing your database is running on the Internet. \n Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId \n and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
\nYou can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in \n another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.
\nFor an overview of CIDR ranges, go to the \n Wikipedia Tutorial.\n
" + "smithy.api#documentation": "Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security \n groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC \n instances. Second, IP ranges are available if the application accessing your database is running on the internet. \n Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId \n and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
\nYou can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in \n another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.
\nFor an overview of CIDR ranges, go to the \n Wikipedia Tutorial.\n
" } }, "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressMessage": { @@ -1469,7 +1472,7 @@ } ], "traits": { - "smithy.api#documentation": "Copies the specified DB cluster parameter group.
\nThis action only applies to Aurora DB clusters.
\nCopies the specified DB cluster parameter group.
" } }, "com.amazonaws.rds#CopyDBClusterParameterGroupMessage": { @@ -1538,7 +1541,7 @@ } ], "traits": { - "smithy.api#documentation": "Copies a snapshot of a DB cluster.
\nTo copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier\n must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.
You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot action \n is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, \n you must provide the following values:
\n KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to \n encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.
\n PreSignedUrl - A URL that contains a Signature Version 4 signed request for the \n CopyDBClusterSnapshot action to be called in the source Amazon Web Services Region where the DB cluster snapshot is copied from. \n The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the \n source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied.
The pre-signed URL request must contain the following parameter values:
\n\n KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB \n cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot \n action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.
\n DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.
\n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster \n snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, \n if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier\n looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.
\nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.
\n TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.
\n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. \n This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified\n by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in \"copying\" status.
For more information on copying encrypted DB cluster snapshots from one Amazon Web Services Region to another, see \n \n Copying a Snapshot in the Amazon Aurora User Guide.\n
\nFor more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nCopies a snapshot of a DB cluster.
\nTo copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier\n must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.
You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot action \n is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, \n you must provide the following values:
\n KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to \n encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.
\n PreSignedUrl - A URL that contains a Signature Version 4 signed request for the \n CopyDBClusterSnapshot action to be called in the source Amazon Web Services Region where the DB cluster snapshot is copied from. \n The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the \n source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied.
The pre-signed URL request must contain the following parameter values:
\n\n KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB \n cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot \n action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.
\n DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.
\n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster \n snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, \n if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier\n looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.
\nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.
\n TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.
\n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. \n This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified\n by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in \"copying\" status.
For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see \n \n Copying a Snapshot in the Amazon Aurora User Guide.\n
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
\nThe Multi-AZ DB clusters feature is in preview and is subject to change.
\nCreates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and \n specific AMI. The only supported engine is Oracle Database 19c Enterprise Edition with the January 2021 \n or later RU/RUR. For \n more information, see \n Amazon RDS Custom requirements and limitations in the Amazon RDS User Guide.
\nAmazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software.\n The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create\n your database. With Amazon RDS Custom, you upload your database installation files in Amazon S3. For \n more information, see \n Preparing to create a CEV in the Amazon RDS User Guide.
\nWhen you create a custom engine version, you specify the files in a JSON document called a CEV manifest. \n This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from \n the installation files that you provided. This service model is called Bring Your Own Media (BYOM).
\nCreation takes approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with \n the message Creation failed for custom engine version, and includes details about the failure. \n For example, the event prints missing files.
After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple \n RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or\n inactive.
\nThe MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n CreateCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the CreateCustomDbEngineVersion event.
For more information, see \n Creating a CEV in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific\n AMI. The only supported engine is Oracle Database 19c Enterprise Edition with the January 2021 or later\n RU/RUR.
\nAmazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software.\n The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create\n your database. With Amazon RDS Custom, you upload your database installation files in Amazon S3.
\nWhen you create a custom engine version, you specify the files in a JSON document called a CEV manifest. \n This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from \n the installation files that you provided. This service model is called Bring Your Own Media (BYOM).
\nCreation takes approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with \n the message Creation failed for custom engine version, and includes details about the failure. \n For example, the event prints missing files.
After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple \n RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or\n inactive.
\nThe MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n CreateCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the CreateCustomDbEngineVersion event.
For more information, see \n Creating a CEV in the Amazon RDS User Guide.
" } }, "com.amazonaws.rds#CreateCustomDBEngineVersionMessage": { @@ -2020,7 +2023,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new Amazon Aurora DB cluster.
\nYou can use the ReplicationSourceIdentifier parameter to create the DB\n cluster as a read replica of another DB cluster or Amazon RDS MySQL or PostgreSQL DB instance. For\n cross-region replication where the DB cluster identified by\n ReplicationSourceIdentifier is encrypted, you must also specify the\n PreSignedUrl parameter.
For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nCreates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
\nYou can use the ReplicationSourceIdentifier parameter to create an Amazon\n Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or\n PostgreSQL DB instance. For cross-Region replication where the DB cluster identified by\n ReplicationSourceIdentifier is encrypted, also specify the\n PreSignedUrl parameter.
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
\nThe Multi-AZ DB clusters feature is in preview and is subject to change.
\nCreates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
\nThis action only applies to Aurora DB clusters.
\nCreates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
\nThis action only applies to Aurora DB clusters.
\nThe type of the endpoint. One of: READER, WRITER, ANY.
The type of the endpoint, one of: READER, WRITER, ANY.
List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n Only relevant if the list of static members is empty.
" + "smithy.api#documentation": "List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n This parameter is relevant only if the list of static members is empty.
" } }, "Tags": { @@ -2105,201 +2108,267 @@ "AvailabilityZones": { "target": "com.amazonaws.rds#AvailabilityZones", "traits": { - "smithy.api#documentation": "A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Choosing the Regions and \n Availability Zones in the Amazon Aurora User Guide.\n
" + "smithy.api#documentation": "A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.\n
\nFor information on Amazon Web Services Regions and Availability Zones, see \n Choosing the Regions and \n Availability Zones in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days for which automated backups are retained.
\nDefault: 1
\nConstraints:
\nMust be a value from 1 to 35
\nThe number of days for which automated backups are retained.
\nDefault: 1
\nConstraints:
\nMust be a value from 1 to 35
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "CharacterSetName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "A value that indicates that the DB cluster should be associated with the specified CharacterSet.
" + "smithy.api#documentation": "A value that indicates that the DB cluster should be associated with the specified CharacterSet.
\nValid for: Aurora DB clusters only
" } }, "DatabaseName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name for your database of up to 64 alphanumeric characters. If you do not\n provide a name, Amazon RDS doesn't create a database in the DB cluster you are\n creating.
" + "smithy.api#documentation": "The name for your database of up to 64 alphanumeric characters. If you do not\n provide a name, Amazon RDS doesn't create a database in the DB cluster you are\n creating.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The DB cluster identifier. This parameter is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster1\n
The DB cluster identifier. This parameter is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster1\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", "smithy.api#required": {} } }, "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "\n The name of the DB cluster parameter group to associate\n with this DB cluster. If you do not specify a value, then \n the default DB cluster parameter group for the specified DB engine and version is used.\n
\nConstraints:
\nIf supplied, must match the name of an existing DB cluster parameter group.
\n\n The name of the DB cluster parameter group to associate\n with this DB cluster. If you do not specify a value, then \n the default DB cluster parameter group for the specified DB engine and version is used.\n
\nConstraints:
\nIf supplied, must match the name of an existing DB cluster parameter group.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "A list of EC2 VPC security groups to associate with this DB cluster.
" + "smithy.api#documentation": "A list of EC2 VPC security groups to associate with this DB cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "A DB subnet group to associate with this DB cluster.
\nConstraints: Must match the name of an existing DBSubnetGroup. Must not be default.
\nExample: mySubnetgroup\n
A DB subnet group to associate with this DB cluster.
\nThis setting is required to create a Multi-AZ DB cluster.
\nConstraints: Must match the name of an existing DBSubnetGroup. Must not be default.
\nExample: mySubnetgroup\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the database engine to be used for this DB cluster.
\nValid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql \n
The name of the database engine to be used for this DB cluster.
\nValid Values:
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible Aurora)
\n aurora-postgresql\n
\n mysql\n
\n postgres\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", "smithy.api#required": {} } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The version number of the database engine to use.
\nTo list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for aurora-postgresql, use the following command:
\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
\n Aurora MySQL\n
\nExample: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5\n
\n Aurora PostgreSQL\n
\nExample: 9.6.3, 10.7\n
The version number of the database engine to use.
\nTo list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for MySQL 5.7-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for MySQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n
\n Aurora MySQL\n
\nFor information, see MySQL on Amazon RDS Versions in the \n Amazon Aurora User Guide.\n
\n\n Aurora PostgreSQL\n
\nFor information, see Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.\n
\n\n MySQL\n
\nFor information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n
\n\n PostgreSQL\n
\nFor information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The port number on which the instances in the DB cluster accept connections.
\n\n Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.\n
The port number on which the instances in the DB cluster accept connections.
\n\n RDS for MySQL and Aurora MySQL\n
\n\n Default: 3306\n
\n Valid values: 1150-65535\n
\n RDS for PostgreSQL and Aurora PostgreSQL\n
\n\n Default: 5432\n
\n Valid values: 1150-65535\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the master user for the DB cluster.
\nConstraints:
\nMust be 1 to 16 letters or numbers.
\nFirst character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\nThe name of the master user for the DB cluster.
\nConstraints:
\nMust be 1 to 16 letters or numbers.
\nFirst character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
\nConstraints: Must contain from 8 to 41 characters.
" + "smithy.api#documentation": "The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
\nConstraints: Must contain from 8 to 41 characters.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "A value that indicates that the DB cluster should be associated with the specified option group.
\nPermanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
" + "smithy.api#documentation": "A value that indicates that the DB cluster should be associated with the specified option group.
\nDB clusters are associated with a default option group that can't be modified.
" } }, "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.\n
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nThe daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.\n
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
\nFormat: ddd:hh24:mi-ddd:hh24:mi\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.\n
\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
\nConstraints: Minimum 30-minute window.
" + "smithy.api#documentation": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
\nFormat: ddd:hh24:mi-ddd:hh24:mi\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.\n
\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
\nConstraints: Minimum 30-minute window.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "ReplicationSourceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB\n cluster is created as a read replica.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB\n cluster is created as a read replica.
\nValid for: Aurora DB clusters only
" } }, "Tags": { "target": "com.amazonaws.rds#TagList", "traits": { - "smithy.api#documentation": "Tags to assign to the DB cluster.
" + "smithy.api#documentation": "Tags to assign to the DB cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB cluster is encrypted.
" + "smithy.api#documentation": "A value that indicates whether the DB cluster is encrypted.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for an encrypted DB cluster.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nWhen a KMS key isn't specified in KmsKeyId:
If ReplicationSourceIdentifier identifies an encrypted\n source, then Amazon RDS will use the KMS key used to encrypt the\n source. Otherwise, Amazon RDS will use your default KMS key.
If the StorageEncrypted parameter is enabled and\n ReplicationSourceIdentifier isn't specified, then Amazon RDS\n will use your default KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.
\nIf you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you\n must set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services\n Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nWhen a KMS key isn't specified in KmsKeyId:
If ReplicationSourceIdentifier identifies an encrypted\n source, then Amazon RDS will use the KMS key used to encrypt the\n source. Otherwise, Amazon RDS will use your default KMS key.
If the StorageEncrypted parameter is enabled and\n ReplicationSourceIdentifier isn't specified, then Amazon RDS\n will use your default KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.
\nIf you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you\n must set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services\n Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "A URL that contains a Signature Version 4 signed request for \n the CreateDBCluster action to be called in the source Amazon Web Services Region where the DB cluster is replicated from. \n You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.
The pre-signed URL must be a valid request for the CreateDBCluster API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster to be copied.
The pre-signed URL request must contain the following parameter values:
\n\n KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of \n the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster \n action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.
\n DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will\n be created in.
\n ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an \n encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like\n Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.
\nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.
A URL that contains a Signature Version 4 signed request for \n the CreateDBCluster action to be called in the source Amazon Web Services Region where the DB cluster is replicated from. \n Specify PreSignedUrl only when you are performing cross-Region replication from an encrypted DB cluster.
The pre-signed URL must be a valid request for the CreateDBCluster API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster to be copied.
The pre-signed URL request must contain the following parameter values:
\n\n KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of \n the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster \n action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.
\n DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will\n be created in.
\n ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an \n encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like\n Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.
\nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.
Valid for: Aurora DB clusters only
" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n
\nValid for: Aurora DB clusters only
" } }, "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { - "smithy.api#documentation": "The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\nCurrently, Backtrack is only supported for Aurora MySQL DB clusters.
\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nThe target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\n\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nValid for: Aurora MySQL DB clusters only
" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
\n\n Aurora MySQL\n
\nPossible values are audit, error, general, and slowquery. \n
\n Aurora PostgreSQL\n
\nPossible value is postgresql.\n
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
\n\n Aurora MySQL\n
\nPossible values are audit, error, general, and slowquery.
\n Aurora PostgreSQL\n
\nPossible value is postgresql.
Valid for: Aurora DB clusters only
" } }, "EngineMode": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The DB engine mode of the DB cluster, either provisioned, serverless, \n parallelquery, global, or multimaster.
The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, \n and version 2.09 and higher 2.x versions.
The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, \n and global engine mode isn't required for any 2.x versions.
The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.
For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery \n and the multimaster engine modes currently aren't supported.
Limitations and requirements apply to some DB engine modes. For more information, see the \n following sections in the Amazon Aurora User Guide:
\nThe DB engine mode of the DB cluster, either provisioned, serverless, \n parallelquery, global, or multimaster.
The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, \n and version 2.09 and higher 2.x versions.
The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, \n and global engine mode isn't required for any 2.x versions.
The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.
For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery \n and the multimaster engine modes currently aren't supported.
Limitations and requirements apply to some DB engine modes. For more information, see the \n following sections in the Amazon Aurora User Guide:
\nValid for: Aurora DB clusters only
" } }, "ScalingConfiguration": { "target": "com.amazonaws.rds#ScalingConfiguration", "traits": { - "smithy.api#documentation": "For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled.
" + "smithy.api#documentation": "A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "GlobalClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "\n The global cluster ID of an Aurora cluster that becomes the primary cluster\n in the new global database cluster.\n
" + "smithy.api#documentation": "\n The global cluster ID of an Aurora cluster that becomes the primary cluster\n in the new global database cluster.\n
\nValid for: Aurora DB clusters only
" } }, "EnableHttpEndpoint": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint \n is disabled.
\nWhen enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless DB cluster. You can also query your database\n from inside the RDS console with the query editor.
\nFor more information, see Using the Data API for Aurora Serverless in the \n Amazon Aurora User Guide.
" + "smithy.api#documentation": "A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint \n is disabled.
\nWhen enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless DB cluster. You can also query your database\n from inside the RDS console with the query editor.
\nFor more information, see Using the Data API for Aurora Serverless in the \n Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.
" + "smithy.api#documentation": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.
\nValid for: Aurora DB clusters only
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Active Directory directory ID to create the DB cluster in.
\n\n For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.\n
" + "smithy.api#documentation": "The Active Directory directory ID to create the DB cluster in.
\n\n For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.
\nFor more information, see Kerberos authentication\n in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
" + "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nValid for: Aurora DB clusters only
" } }, "EnableGlobalWriteForwarding": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an\n Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.
\nYou can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the\n primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.\n
" + "smithy.api#documentation": "A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an\n Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.
\nYou can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the\n primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.\n
\nValid for: Aurora DB clusters only
" + } + }, + "DBClusterInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
\nFor the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.\n
\nThis setting is required to create a Multi-AZ DB cluster.
\nValid for: Multi-AZ DB clusters only
" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
\nThis setting is required to create a Multi-AZ DB cluster.
\nValid for: Multi-AZ DB clusters only
" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "Specifies the storage type to be associated with the DB cluster.
\nThis setting is required to create a Multi-AZ DB cluster.
\n\n Valid values: standard | gp2 | io1\n
\n If you specify io1, also include a value for the\n Iops parameter.\n
\n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
Valid for: Multi-AZ DB clusters only
" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.
\nFor information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide.\n
This setting is required to create a Multi-AZ DB cluster.
\nConstraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
\nValid for: Multi-AZ DB clusters only
" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "A value that indicates whether the DB cluster is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
\nDefault: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
\nIf DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
\nValid for: Multi-AZ DB clusters only
" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.
\nValid for: Multi-AZ DB clusters only
" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off \n collecting Enhanced Monitoring metrics, specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60\n
Valid for: Multi-AZ DB clusters only
" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. \n An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting \n up and enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
Valid for: Multi-AZ DB clusters only
" + } + }, + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "A value that indicates whether to turn on Performance Insights for the DB cluster.\n
\nFor more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.\n
\nValid for: Multi-AZ DB clusters only
" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for: Multi-AZ DB clusters only
" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
\nValid for: Multi-AZ DB clusters only
" } } }, @@ -2324,7 +2393,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new DB cluster parameter group.
\nParameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
\n\n A DB cluster parameter group is initially created with the default parameters for the\n database engine used by instances in the DB cluster. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to\n associate it with your DB cluster using ModifyDBCluster. When you associate\n a new DB cluster parameter group with a running DB cluster, you need to reboot the DB\n instances in the DB cluster without failover for the new DB cluster parameter group and \n associated settings to take effect. \n
After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster\n that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters action to verify \n that your DB cluster parameter group has been created or modified.
For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nCreates a new DB cluster parameter group.
\nParameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
\n\n A DB cluster parameter group is initially created with the default parameters for the\n database engine used by instances in the DB cluster. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to\n associate it with your DB cluster using ModifyDBCluster.
When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB\n instances in the DB cluster without failover for the new DB cluster parameter group and \n associated settings to take effect. \n
\nWhen you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB\n cluster without failover for the new DB cluster parameter group and associated settings to take effect. \n
\nAfter you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster\n that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters action to verify \n that your DB cluster parameter group has been created or modified.
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
\nThe Multi-AZ DB clusters feature is in preview and is subject to change.
\nThe name of the DB cluster parameter group.
\nConstraints:
\nMust match the name of an existing DB cluster parameter group.
\nThis value is stored as a lowercase string.
\nThe name of the DB cluster parameter group.
\nConstraints:
\nMust not match the name of an existing DB cluster parameter group.
\nThis value is stored as a lowercase string.
\nThe DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster \n parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
\n\n Aurora MySQL\n
\nExample: aurora5.6, aurora-mysql5.7\n
\n Aurora PostgreSQL\n
\nExample: aurora-postgresql9.6\n
To list all of the available parameter group families for a DB engine, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine aurora-postgresql\n
The output contains duplicates.
\nThe following are the valid DB engine values:
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible Aurora)
\n aurora-postgresql\n
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster \n parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
\n\n Aurora MySQL\n
\nExample: aurora5.6, aurora-mysql5.7\n
\n Aurora PostgreSQL\n
\nExample: aurora-postgresql9.6\n
\n RDS for MySQL\n
\nExample: mysql8.0\n
\n RDS for PostgreSQL\n
\nExample: postgres12\n
To list all of the available parameter group families for a DB engine, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine aurora-postgresql\n
The output contains duplicates.
\nThe following are the valid DB engine values:
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible Aurora)
\n aurora-postgresql\n
\n mysql\n
\n postgres\n
Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nCreates a snapshot of a DB cluster.
\nFor more information on Amazon Aurora, see What is Amazon\n Aurora? in the Amazon Aurora User Guide.\n
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
\nThe Multi-AZ DB clusters feature is in preview and is subject to change.
\nThe compute and memory capacity of the DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n
The compute and memory capacity of the DB instance, for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n
", "smithy.api#required": {} } }, @@ -2553,7 +2622,7 @@ "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name for the master user.
\n\n\n Amazon Aurora\n
\nNot applicable. The name for the master user is managed by the DB cluster.\n
\n\n\n MariaDB\n
\nConstraints:
\nRequired for MariaDB.
\nMust be 1 to 16 letters or numbers.
\nCan't be a reserved word for the chosen database engine.
\n\n Microsoft SQL Server\n
\nConstraints:
\nRequired for SQL Server.
\nMust be 1 to 128 letters or numbers.
\nThe first character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\n\n MySQL\n
\nConstraints:
\nRequired for MySQL.
\nMust be 1 to 16 letters or numbers.
\nFirst character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\n\n Oracle\n
\nConstraints:
\nRequired for Oracle.
\nMust be 1 to 30 letters or numbers.
\nFirst character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\n\n PostgreSQL\n
\nConstraints:
\nRequired for PostgreSQL.
\nMust be 1 to 63 letters or numbers.
\nFirst character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\nThe name for the master user.
\n\n\n Amazon Aurora\n
\nNot applicable. The name for the master user is managed by the DB cluster.\n
\n \n\n Amazon RDS\n
\nConstraints:
\nRequired.
\nMust be 1 to 16 letters, numbers, or underscores.
\nFirst character must be a letter.
\nCan't be a reserved word for the chosen database engine.
\nThe version number of the database engine to use.
\nFor a list of valid engine versions, use the DescribeDBEngineVersions action.
The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.
\n \n\n Amazon Aurora\n
\nNot applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.
\n \n\n Amazon RDS Custom\n
\nA custom engine version (CEV) that you have previously created. This setting is required for RDS Custom. The CEV \n name has the following format: 19.customized_string\n . An example identifier is \n 19.my_cev1. For more information, see \n Creating an RDS Custom DB instance in the Amazon RDS User Guide..
\n MariaDB\n
\n\nSee MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.\n
\n \n\n Microsoft SQL Server\n
\n \nSee Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.\n
\n \n\n MySQL\n
\n\nSee MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n
\n \n\n Oracle\n
\n \nSee Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.\n
\n\n\n PostgreSQL\n
\n\nSee Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n
" + "smithy.api#documentation": "The version number of the database engine to use.
\nFor a list of valid engine versions, use the DescribeDBEngineVersions action.
The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.
\n \n\n Amazon Aurora\n
\nNot applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.
\n \n\n Amazon RDS Custom\n
\nA custom engine version (CEV) that you have previously created. This setting is required for RDS Custom. The CEV \n name has the following format: 19.customized_string\n . An example identifier is \n 19.my_cev1. For more information, see \n Creating an RDS Custom DB instance in the Amazon RDS User Guide..
\n MariaDB\n
\n\nFor information, see MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.\n
\n \n\n Microsoft SQL Server\n
\n \nFor information, see Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.\n
\n \n\n MySQL\n
\n\nFor information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n
\n \n\n Oracle\n
\n \nFor information, see Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.\n
\n\n\n PostgreSQL\n
\n\nFor information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n
" } }, "AutoMinorVersionUpgrade": { @@ -2643,7 +2712,7 @@ "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.\n For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.\n
\nConstraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. \n For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.\n
" + "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.\n For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide.\n
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 \n of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 \n of the storage amount for the DB instance.\n
" } }, "OptionGroupName": { @@ -2667,7 +2736,7 @@ "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nDefault: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.
\nIf the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.
\nIf DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private.
\nIf the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.
\nA value that indicates whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from \n within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nDefault: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB instance is private.
\nIf the default VPC in the target Region has an internet gateway attached to it, the DB instance is public.
\nIf DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB instance is private.
\nIf the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.
\nA value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\nThis setting doesn't apply to RDS Custom or Amazon Aurora. In Aurora, mapping Amazon Web Services IAM accounts \n to database accounts is managed by the DB cluster.
\nFor more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\nThis setting doesn't apply to RDS Custom or Amazon Aurora. In Aurora, mapping Amazon Web Services IAM accounts \n to database accounts is managed by the DB cluster.
\nFor more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" } }, "EnablePerformanceInsights": { @@ -2781,7 +2850,7 @@ "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database\n Service User Guide.
\n\n Amazon Aurora\n
\nNot applicable. CloudWatch Logs exports are managed by the DB cluster.\n
\n\n RDS Custom\n
\nNot applicable.\n
\n\n MariaDB\n
\nPossible values are audit, error, general, and slowquery. \n
\n Microsoft SQL Server\n
\nPossible values are agent and error.\n
\n MySQL\n
\nPossible values are audit, error, general, and slowquery. \n
\n Oracle\n
\nPossible values are alert, audit, listener, trace, and\n oemagent.\n
\n PostgreSQL\n
\nPossible values are postgresql and upgrade.\n
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database\n Service User Guide.
\n\n Amazon Aurora\n
\nNot applicable. CloudWatch Logs exports are managed by the DB cluster.\n
\n\n RDS Custom\n
\nNot applicable.\n
\n\n MariaDB\n
\nPossible values are audit, error, general, and slowquery. \n
\n Microsoft SQL Server\n
\nPossible values are agent and error.\n
\n MySQL\n
\nPossible values are audit, error, general, and slowquery. \n
\n Oracle\n
\nPossible values are alert, audit, listener, trace, and\n oemagent.\n
\n PostgreSQL\n
\nPossible values are postgresql and upgrade.\n
A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled. For more information, see \n \n Deleting a DB Instance.\n
\n\n Amazon Aurora\n
\nNot applicable. You can enable or disable deletion protection for the DB cluster. \n For more information, see CreateDBCluster. DB instances in a DB \n cluster can be deleted even when deletion protection is enabled for the DB cluster.\n
A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.\n
\n\n Amazon Aurora\n
\nNot applicable. You can enable or disable deletion protection for the DB cluster. \n For more information, see CreateDBCluster. DB instances in a DB \n cluster can be deleted even when deletion protection is enabled for the DB cluster.\n
The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:
\nThe profile must exist in your account.
\nThe profile must have an IAM role that Amazon EC2 has permissions to assume.
\nThe instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon Relational Database Service\n User Guide.
\nThis setting is required for RDS Custom.
" } + }, + "BackupTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "Specifies where automated backups and manual snapshots are stored.
\nPossible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
" + } } }, "traits": { @@ -2903,14 +2978,14 @@ "SourceDBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The identifier of the DB instance that will act as the source for the read replica.\n Each DB instance can have up to five read replicas.
\nConstraints:
\nMust be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB\n instance.
\nCan specify a DB instance that is a MySQL read replica only if the source is running MySQL\n 5.6 or later.
\nFor the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the\n Amazon RDS User Guide.
\nFor the limitations of SQL Server read replicas, see Read Replica\n Limitations with Microsoft SQL Server in the Amazon RDS User Guide.
\nCan specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or\n later (9.4.7 and higher for cross-region replication).
\nThe specified DB instance must have automatic backups enabled, that is, its backup\n retention period must be greater than 0.
\nIf the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB\n instance identifier.
\nIf the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. \n For more information, see Constructing an ARN for Amazon RDS \n in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS Custom, which don't support \n cross-Region replicas.
\nThe identifier of the DB instance that will act as the source for the read replica.\n Each DB instance can have up to five read replicas.
\nConstraints:
\nMust be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB\n instance.
\nCan specify a DB instance that is a MySQL read replica only if the source is running MySQL\n 5.6 or later.
\nFor the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the\n Amazon RDS User Guide.
\nFor the limitations of SQL Server read replicas, see Read Replica\n Limitations with Microsoft SQL Server in the Amazon RDS User Guide.
\nCan specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or\n later (9.4.7 and higher for cross-Region replication).
\nThe specified DB instance must have automatic backups enabled, that is, its backup\n retention period must be greater than 0.
\nIf the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB\n instance identifier.
\nIf the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. \n For more information, see Constructing an ARN for Amazon RDS \n in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS Custom, which don't support \n cross-Region replicas.
\nThe compute and memory capacity of the read replica, for example,\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.\n
Default: Inherits from the source DB instance.
" + "smithy.api#documentation": "The compute and memory capacity of the read replica, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.\n
\nDefault: Inherits from the source DB instance.
" } }, "AvailabilityZone": { @@ -2952,13 +3027,13 @@ "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB parameter group to associate with this DB instance.
\nIf you do not specify a value for DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of source DB instance for a same region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross region read replica.
Specifying a parameter group for this operation is only supported for Oracle DB instances. It \n isn't supported for RDS Custom.
\nConstraints:
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nThe name of the DB parameter group to associate with this DB instance.
\nIf you do not specify a value for DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of source DB instance for a same Region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross-Region read replica.
Specifying a parameter group for this operation is only supported for Oracle DB instances. It \n isn't supported for RDS Custom.
\nConstraints:
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nA value that indicates whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" + "smithy.api#documentation": "A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" } }, "Tags": { @@ -3009,13 +3084,13 @@ "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action \n in the source Amazon Web Services Region that contains the source DB instance.\n
You must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted source DB instance. \n The presigned URL request must contain the following parameter values:\n
\n DestinationRegion - The Amazon Web Services Region that the encrypted read\n replica is created in. This Amazon Web Services Region is the same one where the\n CreateDBInstanceReadReplica action is called that contains this presigned URL.
For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region,\n from a source DB instance in the us-east-2 Amazon Web Services Region, \n then you call the CreateDBInstanceReadReplica action in\n the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the\n CreateDBInstanceReadReplica action in the us-west-2 Amazon Web Services Region. For this\n example, the DestinationRegion in the presigned URL must be set to\n the us-east-1 Amazon Web Services Region.\n
\n KmsKeyId - The Amazon Web Services KMS key identifier for the key to use to\n encrypt the read replica in the destination Amazon Web Services Region. This is the same\n identifier for both the CreateDBInstanceReadReplica action that is\n called in the destination Amazon Web Services Region, and the action contained in the presigned\n URL.
\n SourceDBInstanceIdentifier - The DB instance identifier for\n the encrypted DB instance to be replicated. This identifier must be in the\n Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you\n are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services\n Region, then your SourceDBInstanceIdentifier looks like the\n following example:\n arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.
To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.\n
\n \nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can be executed in the source Amazon Web Services Region.
\n SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS\n doesn't support cross-region read replicas.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action \n in the source Amazon Web Services Region that contains the source DB instance.\n
You must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted source DB instance. \n The presigned URL request must contain the following parameter values:\n
\n DestinationRegion - The Amazon Web Services Region that the encrypted read\n replica is created in. This Amazon Web Services Region is the same one where the\n CreateDBInstanceReadReplica action is called that contains this presigned URL.
For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region,\n from a source DB instance in the us-east-2 Amazon Web Services Region, \n then you call the CreateDBInstanceReadReplica action in\n the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the\n CreateDBInstanceReadReplica action in the us-west-2 Amazon Web Services Region. For this\n example, the DestinationRegion in the presigned URL must be set to\n the us-east-1 Amazon Web Services Region.\n
\n KmsKeyId - The Amazon Web Services KMS key identifier for the key to use to\n encrypt the read replica in the destination Amazon Web Services Region. This is the same\n identifier for both the CreateDBInstanceReadReplica action that is\n called in the destination Amazon Web Services Region, and the action contained in the presigned\n URL.
\n SourceDBInstanceIdentifier - The DB instance identifier for\n the encrypted DB instance to be replicated. This identifier must be in the\n Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you\n are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services\n Region, then your SourceDBInstanceIdentifier looks like the\n following example:\n arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.
To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.\n
\n \nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can be executed in the source Amazon Web Services Region.
\n SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS\n doesn't support cross-Region read replicas.
This setting doesn't apply to RDS Custom.
" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\n \nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
\nThis setting doesn't apply to RDS Custom.
" } }, "EnablePerformanceInsights": { @@ -3057,7 +3132,7 @@ "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled. For more information, see \n \n Deleting a DB Instance.\n
" + "smithy.api#documentation": "A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.\n
" } }, "Domain": { @@ -4336,10 +4411,70 @@ "traits": { "smithy.api#documentation": "A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. \n Specific changes are identified by subelements.
" } + }, + "DBClusterInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The name of the compute and memory capacity class of the DB instance.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The storage type associated with DB instance.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "The Provisioned IOPS (I/O operations per second) value.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "Specifies the accessibility options for the DB instance.
\nWhen the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private \n IP address from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "A value that indicates that minor version patches are applied automatically.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + } + }, + "PerformanceInsightsEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "True if Performance Insights is enabled for the DB cluster, and otherwise false.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + } } }, "traits": { - "smithy.api#documentation": "Contains the details of an Amazon Aurora DB cluster.\n
\nThis data type is used as a response element in the DescribeDBClusters,\n StopDBCluster, and StartDBCluster actions.\n
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.\n
\nFor an Amazon Aurora DB cluster, this data type is used as a response element in the operations \n CreateDBCluster, DeleteDBCluster, DescribeDBClusters, \n FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, \n RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, \n RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.
For a Multi-AZ DB cluster, this data type is used as a response element in the operations \n CreateDBCluster, DeleteDBCluster, DescribeDBClusters, \n FailoverDBCluster, ModifyDBCluster, RebootDBCluster, \n RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.
For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
\nThe Multi-AZ DB clusters feature is in preview and is subject to change.
\nContains one or more identifiers of Aurora DB clusters to which the RDS DB instance\n is replicated as a read replica. For example, when you create an Aurora read replica of\n an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is\n shown. This output does not contain information about cross region Aurora read\n replicas.
\nCurrently, each RDS DB instance can have only one Aurora read replica.
\nContains one or more identifiers of Aurora DB clusters to which the RDS DB instance\n is replicated as a read replica. For example, when you create an Aurora read replica of\n an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is\n shown. This output doesn't contain information about cross-Region Aurora read\n replicas.
\nCurrently, each RDS DB instance can have only one Aurora read replica.
\nSpecifies the accessibility options for the DB instance.
\nWhen the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" + "smithy.api#documentation": "Specifies the accessibility options for the DB instance.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" } }, "StatusInfos": { @@ -5840,10 +5975,16 @@ "traits": { "smithy.api#documentation": "The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:
\nThe profile must exist in your account.
\nThe profile must have an IAM role that Amazon EC2 has permissions to assume.
\nThe instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon Relational Database Service\n User Guide.
" } + }, + "BackupTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
" + } } }, "traits": { - "smithy.api#documentation": "Contains the details of an Amazon RDS DB instance.\n
\nThis data type is used as a response element in the DescribeDBInstances action.\n
Contains the details of an Amazon RDS DB instance.\n
\nThis data type is used as a response element in the operations CreateDBInstance, \n CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, \n ModifyDBInstance, PromoteReadReplica, RebootDBInstance, \n RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, \n StartDBInstance, and StopDBInstance.\n
The list of replications to different Amazon Web Services Regions associated with the automated backup.
" } + }, + "BackupTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "Specifies where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
" + } } }, "traits": { @@ -7400,6 +7547,12 @@ "traits": { "smithy.api#documentation": "Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.
" } + }, + "SnapshotTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
" + } } }, "traits": { @@ -7815,7 +7968,7 @@ } ], "traits": { - "smithy.api#documentation": "The DeleteDBCluster action deletes a previously provisioned DB cluster. \n When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. \n Manual DB cluster snapshots of the specified DB cluster are not deleted.
\n \nFor more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nThe DeleteDBCluster action deletes a previously provisioned DB cluster. \n When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. \n Manual DB cluster snapshots of the specified DB cluster are not deleted.
\nFor more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
\nThe Multi-AZ DB clusters feature is in preview and is subject to change.
\nDeletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
\nFor more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nDeletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
\nFor more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
\nThe Multi-AZ DB clusters feature is in preview and is subject to change.
\nDeletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
\nThe DB cluster snapshot must be in the available state to be\n deleted.
For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nDeletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
\nThe DB cluster snapshot must be in the available state to be\n deleted.
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
\nThe Multi-AZ DB clusters feature is in preview and is subject to change.
\nReturns information about backtracks for a DB cluster.
\nFor more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora MySQL DB clusters.
\nReturns information about backtracks for a DB cluster.
\nFor more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora MySQL DB clusters.
\n\n Returns a list of DBClusterParameterGroup descriptions. If a \n DBClusterParameterGroupName parameter is specified,\n the list will contain only the description of the specified DB cluster parameter group.\n
For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\n\n Returns a list of DBClusterParameterGroup descriptions. If a \n DBClusterParameterGroupName parameter is specified,\n the list will contain only the description of the specified DB cluster parameter group.\n
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
\nThe Multi-AZ DB clusters feature is in preview and is subject to change.
\nReturns the detailed parameter list for a particular DB cluster parameter group.
\nFor more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nReturns the detailed parameter list for a particular DB cluster parameter group.
\nFor more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
\nThe Multi-AZ DB clusters feature is in preview and is subject to change.
\nReturns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
\nWhen sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes\n returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are \n authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB cluster snapshot is public and\n can be copied or restored by all Amazon Web Services accounts.
To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the\n manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
This action only applies to Aurora DB clusters.
\nReturns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
\nWhen sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes\n returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are \n authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB cluster snapshot is public and\n can be copied or restored by all Amazon Web Services accounts.
To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the\n manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
Returns information about DB cluster snapshots. This API action supports pagination.
\nFor more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nReturns information about DB cluster snapshots. This API action supports pagination.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
\nThe Multi-AZ DB clusters feature is in preview and is subject to change.
\nReturns information about provisioned Aurora DB clusters. This API supports pagination.
\nFor more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide. \n
\nThis operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
\nReturns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
\nThe Multi-AZ DB clusters feature is in preview and is subject to change.
\nThis operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -10458,7 +10611,7 @@ "target": "com.amazonaws.rds#DescribeEngineDefaultClusterParametersResult" }, "traits": { - "smithy.api#documentation": "Returns the default engine and system parameter information for the cluster database engine.
\nFor more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
" + "smithy.api#documentation": "Returns the default engine and system parameter information for the cluster database engine.
\nFor more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n
" } }, "com.amazonaws.rds#DescribeEngineDefaultClusterParametersMessage": { @@ -10769,7 +10922,7 @@ "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to\n include in the output. Filter names and values are case-sensitive.
\nSupported filters include the following:
\n\n export-task-identifier - An identifier for the snapshot export task.
\n s3-bucket - The Amazon S3 bucket the snapshot is exported to.
\n source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3
\n status - The status of the export task. Must be lowercase. Valid statuses are the following:
\n canceled\n
\n canceling\n
\n complete\n
\n failed\n
\n starting\n
Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to\n include in the output. Filter names and values are case-sensitive.
\nSupported filters include the following:
\n\n export-task-identifier - An identifier for the snapshot export task.
\n s3-bucket - The Amazon S3 bucket the snapshot is exported to.
\n source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3
\n status - The status of the export task. Must be lowercase. Valid statuses are the following:
\n canceled\n
\n canceling\n
\n complete\n
\n failed\n
\n in_progress\n
\n starting\n
\n Returns information about Aurora global database clusters. This API supports pagination.\n
\n\n For more information on Amazon Aurora, see What Is Amazon Aurora? in the\n Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\n\n Returns information about Aurora global database clusters. This API supports pagination.\n
\n\n For more information on Amazon Aurora, see What is Amazon Aurora? in the\n Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nReturns a list of orderable DB instance options for the specified engine.
", + "smithy.api#documentation": "Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -12153,7 +12306,7 @@ } ], "traits": { - "smithy.api#documentation": "Forces a failover for a DB cluster.
\nA failover for a DB cluster promotes one of the Aurora Replicas (read-only instances)\n in the DB cluster to be the primary instance (the cluster writer).
\nAmazon Aurora will automatically fail over to an Aurora Replica, if one exists,\n when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. \n Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing \n connections that use those endpoint addresses when the failover is complete.
\nFor more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nForces a failover for a DB cluster.
\nFor an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).
\nFor a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).
\nAn Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists,\n when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readbable standby \n DB instance when the primary DB instance fails.
\nTo simulate a failure of a primary instance for testing, you can force a failover. \n Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing \n connections that use those endpoint addresses when the failover is complete.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
\nThe Multi-AZ DB clusters feature is in preview and is subject to change.
\nThe name of the instance to promote to the primary instance.
\nYou must specify the instance identifier for an Aurora Replica in the DB cluster.\n For example, mydbcluster-replica1.
The name of the DB instance to promote to the primary DB instance.
\nSpecify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster,\n for example mydbcluster-replica1.
This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.
" } } }, @@ -13567,7 +13720,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling \n DescribeDBEngineVersions.
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the ModifyCustomDbEngineVersion event.
For more information, see Modifying CEV status \n in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling \n DescribeDBEngineVersions.
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the ModifyCustomDbEngineVersion event.
For more information, see Modifying CEV status \n in the Amazon RDS User Guide.
" } }, "com.amazonaws.rds#ModifyCustomDBEngineVersionMessage": { @@ -13648,7 +13801,7 @@ } ], "traits": { - "smithy.api#documentation": "Modify a setting for an Amazon Aurora DB cluster. \n You can change one\n or more database configuration parameters by specifying these parameters and the new values in the\n request. For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nModify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster. \n You can change one or more settings by specifying these parameters and the new values in the\n request.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
\nThe Multi-AZ DB clusters feature is in preview and is subject to change.
\nThe DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
\nConstraints: This identifier must match the identifier of an existing DB\n cluster.
", + "smithy.api#documentation": "The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
\nConstraints: This identifier must match the identifier of an existing DB\n cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
", "smithy.api#required": {} } }, "NewDBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nThe first character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-cluster2\n
The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nThe first character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-cluster2\n
Valid for: Aurora DB clusters only
" } }, "ApplyImmediately": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "A value that indicates whether the modifications in this request and\n any pending modifications are asynchronously applied\n as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the DB cluster. \n If this parameter is disabled, changes to the\n DB cluster are applied during the next maintenance window.
The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, \n MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately \n parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, \n and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are\n applied immediately, regardless of the value of the ApplyImmediately parameter.
By default, this parameter is disabled.
" + "smithy.api#documentation": "A value that indicates whether the modifications in this request and\n any pending modifications are asynchronously applied\n as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the DB cluster. \n If this parameter is disabled, changes to the\n DB cluster are applied during the next maintenance window.
The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, \n MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately \n parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, \n and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are\n applied immediately, regardless of the value of the ApplyImmediately parameter.
By default, this parameter is disabled.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days for which automated backups are retained. You must specify a minimum value of 1.
\nDefault: 1
\nConstraints:
\nMust be a value from 1 to 35
\nThe number of days for which automated backups are retained. Specify a minimum value of 1.
\nDefault: 1
\nConstraints:
\nMust be a value from 1 to 35
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB cluster parameter group to use for the DB cluster.
" + "smithy.api#documentation": "The name of the DB cluster parameter group to use for the DB cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "A list of VPC security groups that the DB cluster will belong to.
" + "smithy.api#documentation": "A list of VPC security groups that the DB cluster will belong to.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The port number on which the DB cluster accepts connections.
\nConstraints: Value must be 1150-65535\n
Default: The same port as the original DB cluster.
" + "smithy.api#documentation": "The port number on which the DB cluster accepts connections.
\nConstraints: Value must be 1150-65535\n
Default: The same port as the original DB cluster.
\nValid for: Aurora DB clusters only
" } }, "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The new password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
\nConstraints: Must contain from 8 to 41 characters.
" + "smithy.api#documentation": "The new password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
\nConstraints: Must contain from 8 to 41 characters.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "A value that indicates that the DB cluster should be associated with the specified option group. \n Changing this parameter doesn't result in an outage except in the following case, and the change \n is applied during the next maintenance window\n unless the ApplyImmediately is enabled for this request. If the parameter change results in an option group that \n enables OEM, this change can cause a brief (sub-second) period during which new connections \n are rejected but existing connections are not interrupted.\n
Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
" + "smithy.api#documentation": "A value that indicates that the DB cluster should be associated with the specified option group.
\nDB clusters are associated with a default option group that can't be modified.
" } }, "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.\n
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nThe daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.\n
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
\nFormat: ddd:hh24:mi-ddd:hh24:mi\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.\n
\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
\nConstraints: Minimum 30-minute window.
" + "smithy.api#documentation": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
\nFormat: ddd:hh24:mi-ddd:hh24:mi\n
The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.\n
\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
\nConstraints: Minimum 30-minute window.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n
\nValid for: Aurora DB clusters only
" } }, "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { - "smithy.api#documentation": "The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\nCurrently, Backtrack is only supported for Aurora MySQL DB clusters.
\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nThe target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nValid for: Aurora MySQL DB clusters only
" } }, "CloudwatchLogsExportConfiguration": { "target": "com.amazonaws.rds#CloudwatchLogsExportConfiguration", "traits": { - "smithy.api#documentation": "The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
" + "smithy.api#documentation": "The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
\nValid for: Aurora DB clusters only
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The version number of the database engine to which you want to upgrade. \n Changing this parameter results in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.
To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for aurora-postgresql, use the following command:
\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
The version number of the database engine to which you want to upgrade. \n Changing this parameter results in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.
To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for MySQL 5.7-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for MySQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "AllowMajorVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "A value that indicates whether major version upgrades are allowed.
\nConstraints: You must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.
A value that indicates whether major version upgrades are allowed.
\nConstraints: You must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.
Valid for: Aurora DB clusters only
" } }, "DBInstanceParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB parameter group to apply to all instances of the DB cluster.
\nWhen you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB\n cluster isn't rebooted automatically. Also, parameter changes aren't\n applied during the next maintenance window but instead are applied immediately.
Default: The existing name setting
\nConstraints:
\nThe DB parameter group must be in the same DB parameter group family as this DB cluster.
\nThe DBInstanceParameterGroupName parameter is only valid in combination with \n the AllowMajorVersionUpgrade parameter.
The name of the DB parameter group to apply to all instances of the DB cluster.
\nWhen you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB\n cluster isn't rebooted automatically. Also, parameter changes aren't\n applied during the next maintenance window but instead are applied immediately.
Default: The existing name setting
\nConstraints:
\nThe DB parameter group must be in the same DB parameter group family as this DB cluster.
\nThe DBInstanceParameterGroupName parameter is only valid in combination with \n the AllowMajorVersionUpgrade parameter.
Valid for: Aurora DB clusters only
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Active Directory directory ID to move the DB cluster to. \n Specify none to remove the cluster from its current domain.\n The domain must be created prior to this operation.\n
For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.\n
" + "smithy.api#documentation": "The Active Directory directory ID to move the DB cluster to. \n Specify none to remove the cluster from its current domain.\n The domain must be created prior to this operation.\n
For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.\n
\nValid for: Aurora DB clusters only
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
" + "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nValid for: Aurora DB clusters only
" } }, "ScalingConfiguration": { "target": "com.amazonaws.rds#ScalingConfiguration", "traits": { - "smithy.api#documentation": "The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.
The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.
Valid for: Aurora DB clusters only
" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled.\n
" + "smithy.api#documentation": "A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "EnableHttpEndpoint": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint \n is disabled.
\nWhen enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless DB cluster. You can also query your database\n from inside the RDS console with the query editor.
\nFor more information, see Using the Data API for Aurora Serverless in the \n Amazon Aurora User Guide.
" + "smithy.api#documentation": "A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint \n is disabled.
\nWhen enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless DB cluster. You can also query your database\n from inside the RDS console with the query editor.
\nFor more information, see Using the Data API for Aurora Serverless in the \n Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.
" + "smithy.api#documentation": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.
\nValid for: Aurora DB clusters only
" } }, "EnableGlobalWriteForwarding": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an\n Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.
\nYou can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is\n demoted by the FailoverGlobalCluster API operation, but it does nothing until then.\n
" + "smithy.api#documentation": "A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an\n Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.
\nYou can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is\n demoted by the FailoverGlobalCluster API operation, but it does nothing until then.\n
\nValid for: Aurora DB clusters only
" + } + }, + "DBClusterInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
\nFor the full list of DB instance classes and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.\n
\nValid for: Multi-AZ DB clusters only
" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
\nType: Integer
\nValid for: Multi-AZ DB clusters only
" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "Specifies the storage type to be associated with the DB cluster.
\n\n Valid values: standard | gp2 | io1\n
\n If you specify io1, you must also include a value for the\n Iops parameter.\n
\n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
Valid for: Multi-AZ DB clusters only
" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.
\nFor information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.\n
\nConstraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
\nValid for: Multi-AZ DB clusters only
" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.
\nValid for: Multi-AZ DB clusters only
" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. \n To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60\n
Valid for: Multi-AZ DB clusters only
" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An\n example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
Valid for: Multi-AZ DB clusters only
" + } + }, + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "A value that indicates whether to turn on Performance Insights for the DB cluster.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.\n
\nValid for: Multi-AZ DB clusters only
" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for: Multi-AZ DB clusters only
" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
\nValid for: Multi-AZ DB clusters only
" } } }, @@ -13880,7 +14093,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Modifies the parameters of a DB cluster parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, \n and ApplyMethod. A maximum of 20\n parameters can be modified in a single request.\n
For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nAfter you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters action to verify \n that your DB cluster parameter group has been created or modified.
If the modified DB cluster parameter group is used by an Aurora Serverless cluster, Aurora\n applies the update immediately. The cluster restart might interrupt your workload. In that case,\n your application must reopen any connections and retry any transactions that were active\n when the parameter changes took effect.
\nThis action only applies to Aurora DB clusters.
\n\n Modifies the parameters of a DB cluster parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, \n and ApplyMethod. A maximum of 20\n parameters can be modified in a single request.\n
After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters action to verify \n that your DB cluster parameter group has been created or modified.
If the modified DB cluster parameter group is used by an Aurora Serverless cluster, Aurora\n applies the update immediately. The cluster restart might interrupt your workload. In that case,\n your application must reopen any connections and retry any transactions that were active\n when the parameter changes took effect.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
\nThe Multi-AZ DB clusters feature is in preview and is subject to change.
\nAdds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
\nTo share a manual DB cluster snapshot with other Amazon Web Services accounts, specify\n restore as the AttributeName and use the\n ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are\n authorized to restore the manual DB cluster snapshot. Use the value all to\n make the manual DB cluster snapshot public, which means that it can be copied or\n restored by all Amazon Web Services accounts.
Don't add the all value for any manual DB cluster snapshots\n that contain private information that you don't want available to all Amazon Web Services\n accounts.
If a manual DB cluster snapshot is encrypted, it can be shared, but only by\n specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd\n parameter. You can't use all as a value for that parameter in this\n case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster\n snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API action. The accounts are\n returned as values for the restore attribute.
This action only applies to Aurora DB clusters.
\nAdds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
\nTo share a manual DB cluster snapshot with other Amazon Web Services accounts, specify\n restore as the AttributeName and use the\n ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are\n authorized to restore the manual DB cluster snapshot. Use the value all to\n make the manual DB cluster snapshot public, which means that it can be copied or\n restored by all Amazon Web Services accounts.
Don't add the all value for any manual DB cluster snapshots\n that contain private information that you don't want available to all Amazon Web Services\n accounts.
If a manual DB cluster snapshot is encrypted, it can be shared, but only by\n specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd\n parameter. You can't use all as a value for that parameter in this\n case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster\n snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API action. The accounts are\n returned as values for the restore attribute.
The new compute and memory capacity of the DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n
If you modify the DB instance class, an outage occurs during the change.\n The change is applied during the next maintenance window,\n unless ApplyImmediately is enabled for this request.\n
This setting doesn't apply to RDS Custom.
\nDefault: Uses existing setting
" + "smithy.api#documentation": "The new compute and memory capacity of the DB instance, for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n
\nIf you modify the DB instance class, an outage occurs during the change.\n The change is applied during the next maintenance window,\n unless ApplyImmediately is enabled for this request.\n
This setting doesn't apply to RDS Custom.
\nDefault: Uses existing setting
" } }, "DBSubnetGroupName": { @@ -14224,7 +14437,7 @@ "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance is publicly accessible.\n
\nWhen the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\n\n PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a \n public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.\n
Changes to the PubliclyAccessible parameter are applied immediately regardless\n of the value of the ApplyImmediately parameter.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that indicates whether the DB instance is publicly accessible.\n
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\n\n PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a \n public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.\n
Changes to the PubliclyAccessible parameter are applied immediately regardless\n of the value of the ApplyImmediately parameter.
This setting doesn't apply to RDS Custom.
" } }, "MonitoringRoleArn": { @@ -14248,7 +14461,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\nThis setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB\n cluster.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\nThis setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB\n cluster.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
\nThis setting doesn't apply to RDS Custom.
" } }, "EnablePerformanceInsights": { @@ -14290,7 +14503,7 @@ "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled. For more information, see \n \n Deleting a DB Instance.\n
" + "smithy.api#documentation": "A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.\n
" } }, "MaxAllocatedStorage": { @@ -14885,7 +15098,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration\n parameters by specifying these parameters and the new values in the request. For more information on\n Amazon Aurora, see What Is Amazon Aurora? in the\n Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\n\n Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration\n parameters by specifying these parameters and the new values in the request. For more information on\n Amazon Aurora, see What is Amazon Aurora? in the\n Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nA value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
" } + }, + "SupportsClusters": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "Whether DB instances can be configured as a Multi-AZ DB cluster.
\nThe Multi-AZ DB clusters feature is in preview and is subject to change.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
" + } } }, "traits": { @@ -16213,7 +16432,7 @@ } ], "traits": { - "smithy.api#documentation": "Promotes a read replica DB cluster to a standalone DB cluster.
\nThis action only applies to Aurora DB clusters.
\nPromotes a read replica DB cluster to a standalone DB cluster.
" } }, "com.amazonaws.rds#PromoteReadReplicaDBClusterMessage": { @@ -16420,6 +16639,49 @@ "target": "com.amazonaws.rds#String" } }, + "com.amazonaws.rds#RebootDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RebootDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#RebootDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "You might need to reboot your DB cluster, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB cluster parameter group associated with the DB cluster, \n reboot the DB cluster for the changes to take effect.\n
\n \nRebooting a DB cluster restarts the database engine service. Rebooting a DB \n cluster results in a momentary outage, during which the DB cluster status is set to rebooting.\n
\n \nUse this operation only for a non-Aurora Multi-AZ DB cluster. \n The Multi-AZ DB clusters feature is in preview and is subject to change.
\n \nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the \n Amazon RDS User Guide.\n
" + } + }, + "com.amazonaws.rds#RebootDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The DB cluster identifier. This parameter is stored as a lowercase string.
\nConstraints:
\nMust match the identifier of an existing DBCluster.
\n\n Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a\n standalone cluster with read-write capability instead of being read-only and receiving data from a\n primary cluster in a different region.\n
\nThis action only applies to Aurora DB clusters.
\n\n Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a\n standalone cluster with read-write capability instead of being read-only and receiving data from a\n primary cluster in a different Region.\n
\nThis action only applies to Aurora DB clusters.
\nDisassociates an Amazon Web Services Identity and Access Management (IAM) role from an Amazon Aurora DB cluster.\n For more information, see Authorizing Amazon Aurora MySQL \n to Access Other Amazon Web Services Services on Your Behalf in the Amazon Aurora User Guide.
\nThis action only applies to Aurora DB clusters.
\nRemoves the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a\n DB cluster.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
\nThe Multi-AZ DB clusters feature is in preview and is subject to change.
\n\n Modifies the parameters of a DB cluster parameter group to the default value. To\n reset specific parameters submit a list of the following: ParameterName \n and ApplyMethod. To reset the\n entire DB cluster parameter group, specify the DBClusterParameterGroupName \n and ResetAllParameters parameters.\n
\n When resetting the entire group, dynamic parameters are updated immediately and static parameters\n are set to pending-reboot to take effect on the next DB instance restart \n or RebootDBInstance request. You must call RebootDBInstance for every\n DB instance in your DB cluster that you want the updated static parameter to apply to.
For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\n\n Modifies the parameters of a DB cluster parameter group to the default value. To\n reset specific parameters submit a list of the following: ParameterName \n and ApplyMethod. To reset the\n entire DB cluster parameter group, specify the DBClusterParameterGroupName \n and ResetAllParameters parameters.\n
\n When resetting the entire group, dynamic parameters are updated immediately and static parameters\n are set to pending-reboot to take effect on the next DB instance restart \n or RebootDBInstance request. You must call RebootDBInstance for every\n DB instance in your DB cluster that you want the updated static parameter to apply to.
For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
\nThe Multi-AZ DB clusters feature is in preview and is subject to change.
\nCreates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.\n Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be\n created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the\n Amazon Aurora User Guide.
\nThis action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromS3 action has completed and the DB\n cluster is available.
For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters. The source DB engine must be\n MySQL.
\nCreates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.\n Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be\n created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the\n Amazon Aurora User Guide.
\nThis action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromS3 action has completed and the DB\n cluster is available.
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters. The source DB engine must be\n MySQL.
\nA value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.
\n \nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n
" } }, "SourceEngine": { @@ -17490,7 +17752,7 @@ "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled.\n
" + "smithy.api#documentation": "A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.\n
" } }, "CopyTagsToSnapshot": { @@ -17583,7 +17845,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new DB cluster from a DB snapshot or DB cluster snapshot. This action\n only applies to Aurora DB clusters.
\nThe target DB cluster is created from the source snapshot with a default\n configuration. If you don't specify a security group, the new DB cluster is\n associated with the default security group.
\nThis action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromSnapshot action has completed and the DB\n cluster is available.
For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
\nThe target DB cluster is created from the source snapshot with a default\n configuration. If you don't specify a security group, the new DB cluster is\n associated with the default security group.
\nThis action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromSnapshot action has completed and the DB\n cluster is available.
For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
\nThe Multi-AZ DB clusters feature is in preview and is subject to change.
\nProvides the list of Availability Zones (AZs) where instances in the restored DB\n cluster can be created.
" + "smithy.api#documentation": "Provides the list of Availability Zones (AZs) where instances in the restored DB\n cluster can be created.
\nValid for: Aurora DB clusters only
" } }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.\n This parameter isn't case-sensitive.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-snapshot-id\n
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.\n This parameter isn't case-sensitive.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-snapshot-id\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", "smithy.api#required": {} } }, "SnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The identifier for the DB snapshot or DB cluster snapshot to restore from.
\nYou can use either the name or the Amazon Resource Name (ARN) to specify a DB\n cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
\nConstraints:
\nMust match the identifier of an existing Snapshot.
\nThe identifier for the DB snapshot or DB cluster snapshot to restore from.
\nYou can use either the name or the Amazon Resource Name (ARN) to specify a DB\n cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
\nConstraints:
\nMust match the identifier of an existing Snapshot.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
", "smithy.api#required": {} } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The database engine to use for the new DB cluster.
\nDefault: The same as source
\nConstraint: Must be compatible with the engine of the source
", + "smithy.api#documentation": "The database engine to use for the new DB cluster.
\nDefault: The same as source
\nConstraint: Must be compatible with the engine of the source
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
", "smithy.api#required": {} } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The version of the database engine to use for the new DB cluster.
\nTo list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for aurora-postgresql, use the following command:
\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
If you aren't using the default engine version, then you must specify the engine version.
\n\n Aurora MySQL\n
\nExample: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5\n
\n Aurora PostgreSQL\n
\nExample: 9.6.3, 10.7\n
The version of the database engine to use for the new DB cluster.
\nTo list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for MySQL 5.7-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for MySQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n
\n Aurora MySQL\n
\nSee MySQL on Amazon RDS Versions in the \n Amazon Aurora User Guide.\n
\n\n Aurora PostgreSQL\n
\nSee Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.\n
\n\n MySQL\n
\nSee MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n
\n\n PostgreSQL\n
\nSee Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The port number on which the new DB cluster accepts connections.
\nConstraints: This value must be 1150-65535\n
Default: The same port as the original DB cluster.
" + "smithy.api#documentation": "The port number on which the new DB cluster accepts connections.
\nConstraints: This value must be 1150-65535\n
Default: The same port as the original DB cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB subnet group to use for the new DB cluster.
\nConstraints: If supplied, must match the name of an existing DB subnet group.
\nExample: mySubnetgroup\n
The name of the DB subnet group to use for the new DB cluster.
\nConstraints: If supplied, must match the name of an existing DB subnet group.
\nExample: mySubnetgroup\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "DatabaseName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The database name for the restored DB cluster.
" + "smithy.api#documentation": "The database name for the restored DB cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the option group to use for the restored DB cluster.
" + "smithy.api#documentation": "The name of the option group to use for the restored DB cluster.
\nDB clusters are associated with a default option group that can't be modified.
" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "A list of VPC security groups that the new DB cluster will belong to.
" + "smithy.api#documentation": "A list of VPC security groups that the new DB cluster will belong to.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Tags": { "target": "com.amazonaws.rds#TagList", "traits": { - "smithy.api#documentation": "The tags to be assigned to the restored DB cluster.
" + "smithy.api#documentation": "The tags to be assigned to the restored DB cluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB\n snapshot or DB cluster snapshot.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nWhen you don't specify a value for the KmsKeyId parameter, then the\n following occurs:
If the DB snapshot or DB cluster snapshot in\n SnapshotIdentifier is encrypted, then the restored DB cluster\n is encrypted using the KMS key that was used to encrypt the DB snapshot or DB\n cluster snapshot.
If the DB snapshot or DB cluster snapshot in \n SnapshotIdentifier isn't encrypted, then the restored DB cluster\n isn't encrypted.
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB\n snapshot or DB cluster snapshot.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nWhen you don't specify a value for the KmsKeyId parameter, then the\n following occurs:
If the DB snapshot or DB cluster snapshot in\n SnapshotIdentifier is encrypted, then the restored DB cluster\n is encrypted using the KMS key that was used to encrypt the DB snapshot or DB\n cluster snapshot.
If the DB snapshot or DB cluster snapshot in \n SnapshotIdentifier isn't encrypted, then the restored DB cluster\n isn't encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n
\nValid for: Aurora DB clusters only
" } }, "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { - "smithy.api#documentation": "The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\nCurrently, Backtrack is only supported for Aurora MySQL DB clusters.
\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nThe target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\nCurrently, Backtrack is only supported for Aurora MySQL DB clusters.
\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nValid for: Aurora DB clusters only
" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.\n The values in the list depend on the DB engine being used. For more information, see\n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon\n Aurora User Guide.
" + "smithy.api#documentation": "The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.\n The values in the list depend on the DB engine being used.
\nFor more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon\n Aurora User Guide.
\nValid for: Aurora DB clusters only
" } }, "EngineMode": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The DB engine mode of the DB cluster, either provisioned, serverless,\n parallelquery, global, or multimaster.
For more information, see \n CreateDBCluster.
" + "smithy.api#documentation": "The DB engine mode of the DB cluster, either provisioned, serverless,\n parallelquery, global, or multimaster.
For more information, see \n CreateDBCluster.
\nValid for: Aurora DB clusters only
" } }, "ScalingConfiguration": { "target": "com.amazonaws.rds#ScalingConfiguration", "traits": { - "smithy.api#documentation": "For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
" } }, "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB cluster parameter group to associate with this DB cluster. If this\n argument is omitted, the default DB cluster parameter group for the specified engine is\n used.
\nConstraints:
\nIf supplied, must match the name of an existing default DB cluster parameter group.
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nThe name of the DB cluster parameter group to associate with this DB cluster. If this\n argument is omitted, the default DB cluster parameter group for the specified engine is\n used.
\nConstraints:
\nIf supplied, must match the name of an existing default DB cluster parameter group.
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled.\n
" + "smithy.api#documentation": "A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
" + "smithy.api#documentation": "A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
\nValid for: Aurora DB clusters only
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nValid for: Aurora DB clusters only
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
" + "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nValid for: Aurora DB clusters only
" + } + }, + "DBClusterInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
\nFor the full list of DB instance classes, and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.
\n\n Valid values: standard | gp2 | io1\n
\n If you specify io1, you must also include a value for the\n Iops parameter.\n
\n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for \n each DB instance in the Multi-AZ DB cluster.
\nFor information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.\n
\nConstraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "A value that indicates whether the DB cluster is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
\nWhen the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
\nDefault: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
\nIf DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } } }, @@ -17802,7 +18088,7 @@ } ], "traits": { - "smithy.api#documentation": "Restores a DB cluster to an arbitrary point in time. Users can restore to any point\n in time before LatestRestorableTime for up to\n BackupRetentionPeriod days. The target DB cluster is created from the\n source DB cluster with the same configuration as the original DB cluster, except that\n the new DB cluster is created with the default DB security group.
This action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterToPointInTime action has completed and the DB\n cluster is available.
For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nRestores a DB cluster to an arbitrary point in time. Users can restore to any point\n in time before LatestRestorableTime for up to\n BackupRetentionPeriod days. The target DB cluster is created from the\n source DB cluster with the same configuration as the original DB cluster, except that\n the new DB cluster is created with the default DB security group.
For Aurora, this action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterToPointInTime action has completed and the DB\n cluster is available.
For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
\nThe Multi-AZ DB clusters feature is in preview and is subject to change.
\nThe name of the new DB cluster to be created.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nThe name of the new DB cluster to be created.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
", "smithy.api#required": {} } }, "RestoreType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The type of restore to be performed. You can specify one of the following values:
\n\n full-copy - The new DB cluster is restored as a full copy of the\n source DB cluster.
\n copy-on-write - The new DB cluster is restored as a clone of the\n source DB cluster.
Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.
If you don't specify a RestoreType value, then the new DB cluster is\n restored as a full copy of the source DB cluster.
The type of restore to be performed. You can specify one of the following values:
\n\n full-copy - The new DB cluster is restored as a full copy of the\n source DB cluster.
\n copy-on-write - The new DB cluster is restored as a clone of the\n source DB cluster.
Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.
If you don't specify a RestoreType value, then the new DB cluster is\n restored as a full copy of the source DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "SourceDBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The identifier of the source DB cluster from which to restore.
\nConstraints:
\nMust match the identifier of an existing DBCluster.
\nThe identifier of the source DB cluster from which to restore.
\nConstraints:
\nMust match the identifier of an existing DBCluster.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
", "smithy.api#required": {} } }, "RestoreToTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "The date and time to restore the DB cluster to.
\nValid Values: Value must be a time in Universal Coordinated Time (UTC) format
\nConstraints:
\nMust be before the latest restorable time for the DB instance
\nMust be specified if UseLatestRestorableTime parameter isn't provided
Can't be specified if the UseLatestRestorableTime parameter is enabled
Can't be specified if the RestoreType parameter is copy-on-write\n
Example: 2015-03-07T23:45:00Z\n
The date and time to restore the DB cluster to.
\nValid Values: Value must be a time in Universal Coordinated Time (UTC) format
\nConstraints:
\nMust be before the latest restorable time for the DB instance
\nMust be specified if UseLatestRestorableTime parameter isn't provided
Can't be specified if the UseLatestRestorableTime parameter is enabled
Can't be specified if the RestoreType parameter is copy-on-write\n
Example: 2015-03-07T23:45:00Z\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "UseLatestRestorableTime": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "A value that indicates whether to restore the DB cluster to the latest \n restorable backup time. By default, the DB cluster isn't restored to the latest \n restorable backup time.\n
\nConstraints: Can't be specified if RestoreToTime parameter is provided.
A value that indicates whether to restore the DB cluster to the latest \n restorable backup time. By default, the DB cluster isn't restored to the latest \n restorable backup time.\n
\nConstraints: Can't be specified if RestoreToTime parameter is provided.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The port number on which the new DB cluster accepts connections.
\nConstraints: A value from 1150-65535.\n
Default: The default port for the engine.
" + "smithy.api#documentation": "The port number on which the new DB cluster accepts connections.
\nConstraints: A value from 1150-65535.\n
Default: The default port for the engine.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The DB subnet group name to use for the new DB cluster.
\nConstraints: If supplied, must match the name of an existing DBSubnetGroup.
\nExample: mySubnetgroup\n
The DB subnet group name to use for the new DB cluster.
\nConstraints: If supplied, must match the name of an existing DBSubnetGroup.
\nExample: mySubnetgroup\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the option group for the new DB cluster.
" + "smithy.api#documentation": "The name of the option group for the new DB cluster.
\nDB clusters are associated with a default option group that can't be modified.
" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "A list of VPC security groups that the new DB cluster belongs to.
" + "smithy.api#documentation": "A list of VPC security groups that the new DB cluster belongs to.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Tags": { @@ -17870,67 +18156,91 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nYou can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the\n KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key\n identified by the KmsKeyId parameter.
If you don't specify a value for the KmsKeyId parameter, then the following occurs:
If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
\nIf the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.
\nIf DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request\n is rejected.
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nYou can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the\n KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key\n identified by the KmsKeyId parameter.
If you don't specify a value for the KmsKeyId parameter, then the following occurs:
If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
\nIf the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.
\nIf DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request\n is rejected.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n
\nValid for: Aurora DB clusters only
" } }, "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { - "smithy.api#documentation": "The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\nCurrently, Backtrack is only supported for Aurora MySQL DB clusters.
\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nThe target backtrack window, in seconds. To disable backtracking, set this value to\n 0.
\nDefault: 0
\nConstraints:
\nIf specified, this value must be set to a number from 0 to 259,200 (72 hours).
\nValid for: Aurora MySQL DB clusters only
" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
" + "smithy.api#documentation": "The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used.
\nFor more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" } }, "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB cluster parameter group to associate with this DB cluster. \n If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
\nConstraints:
\nIf supplied, must match the name of an existing DB cluster parameter group.
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nThe name of the DB cluster parameter group to associate with this DB cluster. \n If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
\nConstraints:
\nIf supplied, must match the name of an existing DB cluster parameter group.
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled.\n
" + "smithy.api#documentation": "A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
" + "smithy.api#documentation": "A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
\nValid for: Aurora DB clusters only
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.\n
\n\n For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.\n
" + "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.\n
\n\n For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.\n
\nValid for: Aurora DB clusters only
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
" + "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nValid for: Aurora DB clusters only
" } }, "ScalingConfiguration": { "target": "com.amazonaws.rds#ScalingConfiguration", "traits": { - "smithy.api#documentation": "For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
" } }, "EngineMode": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The engine mode of the new cluster. Specify provisioned or serverless,\n depending on the type of the cluster you are creating. You can create an Aurora Serverless clone\n from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone\n that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or\n an encrypted provisioned cluster.
The engine mode of the new cluster. Specify provisioned or serverless,\n depending on the type of the cluster you are creating. You can create an Aurora Serverless clone\n from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone\n that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or\n an encrypted provisioned cluster.
Valid for: Aurora DB clusters only
" + } + }, + "DBClusterInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster,\n for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines.
\nFor the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.\n
\nValid for: Multi-AZ DB clusters only
" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.
\n\n Valid values: standard | gp2 | io1\n
\n If you specify io1, also include a value for the\n Iops parameter.\n
\n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
Valid for: Multi-AZ DB clusters only
" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "A value that indicates whether the DB cluster is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves\n to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
\nWhen the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
\nDefault: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
\nIf DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
\nIf the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
\nValid for: Multi-AZ DB clusters only
" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for \n each DB instance in the Multi-AZ DB cluster.
\nFor information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide.\n
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance. \n
\nValid for: Multi-AZ DB clusters only
" } } }, @@ -18040,7 +18350,7 @@ "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n
Default: The same DBInstanceClass as the original DB instance.
" + "smithy.api#documentation": "The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n
\nDefault: The same DBInstanceClass as the original DB instance.
" } }, "Port": { @@ -18070,7 +18380,7 @@ "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" + "smithy.api#documentation": "A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled \n by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" } }, "AutoMinorVersionUpgrade": { @@ -18157,7 +18467,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
\nThis setting doesn't apply to RDS Custom.
" } }, "EnableCloudwatchLogsExports": { @@ -18187,7 +18497,7 @@ "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled. For more information, see \n \n Deleting a DB Instance.\n
" + "smithy.api#documentation": "A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.\n
" } }, "EnableCustomerOwnedIp": { @@ -18201,6 +18511,12 @@ "traits": { "smithy.api#documentation": "The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:
\nThe profile must exist in your account.
\nThe profile must have an IAM role that Amazon EC2 has permissions to assume.
\nThe instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon Relational Database Service\n User Guide.
\nThis setting is required for RDS Custom.
" } + }, + "BackupTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "Specifies where automated backups and manual snapshots are stored for the restored DB instance.
\nPossible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
" + } } }, "traits": { @@ -18305,7 +18621,7 @@ "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The compute and memory capacity of the DB instance, \n for example, db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, \n or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.\n
Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.\n
", + "smithy.api#documentation": "The compute and memory capacity of the DB instance, \n for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, \n or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.\n
\nImporting from Amazon S3 isn't supported on the db.t2.micro DB instance class.\n
", "smithy.api#required": {} } }, @@ -18421,7 +18737,7 @@ "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" + "smithy.api#documentation": "A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" } }, "Tags": { @@ -18469,7 +18785,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\n \nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" } }, "SourceEngine": { @@ -18545,7 +18861,7 @@ "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled. For more information, see \n \n Deleting a DB Instance.\n
" + "smithy.api#documentation": "A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.\n
" } }, "MaxAllocatedStorage": { @@ -18675,7 +18991,7 @@ "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n
Default: The same DBInstanceClass as the original DB instance.
" + "smithy.api#documentation": "The compute and memory capacity of the Amazon RDS DB instance, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.\n
\nDefault: The same DBInstanceClass as the original DB instance.
" } }, "Port": { @@ -18705,7 +19021,7 @@ "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" + "smithy.api#documentation": "A value that indicates whether the DB instance is publicly accessible.
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\nFor more information, see CreateDBInstance.
" } }, "AutoMinorVersionUpgrade": { @@ -18792,7 +19108,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nThis setting doesn't apply to RDS Custom.
\n \nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\n \nThis setting doesn't apply to RDS Custom.
\n \nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" } }, "EnableCloudwatchLogsExports": { @@ -18822,7 +19138,7 @@ "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled. For more information, see \n \n Deleting a DB Instance.\n
" + "smithy.api#documentation": "A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.\n
" } }, "SourceDbiResourceId": { @@ -18854,6 +19170,12 @@ "traits": { "smithy.api#documentation": "The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:
\nThe profile must exist in your account.
\nThe profile must have an IAM role that Amazon EC2 has permissions to assume.
\nThe instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon Relational Database Service\n User Guide.
\nThis setting is required for RDS Custom.
" } + }, + "BackupTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "Specifies where automated backups and manual snapshots are stored for the restored DB instance.
\nPossible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
" + } } }, "traits": { diff --git a/aws/sdk/aws-models/redshift-data.json b/aws/sdk/aws-models/redshift-data.json index bcb9c1f904c5d25f17af7013234465cc948ff897..e3023018e88d1e145ece953ff8bc6b0c8ed48ce4 100644 --- a/aws/sdk/aws-models/redshift-data.json +++ b/aws/sdk/aws-models/redshift-data.json @@ -34,7 +34,7 @@ } ], "traits": { - "smithy.api#documentation": "Runs one or more SQL statements, which can be data manipulation language (DML) or data definition\n language (DDL). \n Depending on the authorization\n method, use one of the following combinations of request parameters:
\nSecrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the \n cluster identifier that matches the cluster in the secret.
\nTemporary credentials - specify the cluster identifier, the database name, and the\n database user name. Permission to call the redshift:GetClusterCredentials\n operation is required to use this method.
Runs one or more SQL statements, which can be data manipulation language (DML) or data definition\n language (DDL). \n Depending on the authorization\n method, use one of the following combinations of request parameters:
\nSecrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name.
\nTemporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless endpoint, specify the database name.
The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
", - "smithy.api#required": {} + "smithy.api#documentation": "The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
" } }, "SecretArn": { @@ -86,7 +85,7 @@ "DbUser": { "target": "com.amazonaws.redshiftdata#String", "traits": { - "smithy.api#documentation": "The database user name. This parameter is required when authenticating using temporary credentials.
" + "smithy.api#documentation": "The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
" } }, "Database": { @@ -128,7 +127,7 @@ "ClusterIdentifier": { "target": "com.amazonaws.redshiftdata#Location", "traits": { - "smithy.api#documentation": "The cluster identifier.
" + "smithy.api#documentation": "The cluster identifier. This parameter is not returned when connecting to a serverless endpoint.
" } }, "DbUser": { @@ -181,6 +180,9 @@ "target": "com.amazonaws.redshiftdata#CancelStatementResponse" }, "errors": [ + { + "target": "com.amazonaws.redshiftdata#DatabaseConnectionException" + }, { "target": "com.amazonaws.redshiftdata#InternalServerException" }, @@ -316,6 +318,22 @@ "target": "com.amazonaws.redshiftdata#ColumnMetadata" } }, + "com.amazonaws.redshiftdata#DatabaseConnectionException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Connection to a database failed.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, "com.amazonaws.redshiftdata#DatabaseList": { "type": "list", "member": { @@ -431,7 +449,7 @@ "HasResultSet": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "A value that indicates whether the statement has a result set. The result set can be empty.
" + "smithy.api#documentation": "A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set.\n The value is true if any substatement returns a result set.
" } }, "QueryString": { @@ -481,6 +499,9 @@ "target": "com.amazonaws.redshiftdata#DescribeTableResponse" }, "errors": [ + { + "target": "com.amazonaws.redshiftdata#DatabaseConnectionException" + }, { "target": "com.amazonaws.redshiftdata#InternalServerException" }, @@ -489,7 +510,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the detailed information about a table from metadata in the cluster. The\n information includes its columns. \n A token is returned to page through the column list.\n Depending on the authorization method, use one of the\n following combinations of request parameters:
\nSecrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the \n cluster identifier that matches the cluster in the secret.
\nTemporary credentials - specify the cluster identifier, the database name, and the database\n user name. Permission to call the redshift:GetClusterCredentials operation is\n required to use this method.
Describes the detailed information about a table from metadata in the cluster. The\n information includes its columns. \n A token is returned to page through the column list.\n Depending on the authorization method, use one of the\n following combinations of request parameters:
\nSecrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name.
\nTemporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless endpoint, specify the database name.
The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
", - "smithy.api#required": {} + "smithy.api#documentation": "The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
" } }, "SecretArn": { @@ -518,7 +538,7 @@ "DbUser": { "target": "com.amazonaws.redshiftdata#String", "traits": { - "smithy.api#documentation": "The database user name. This parameter is required when authenticating using temporary credentials.
" + "smithy.api#documentation": "The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
" } }, "Database": { @@ -603,7 +623,7 @@ } ], "traits": { - "smithy.api#documentation": "Runs an SQL statement, which can be data manipulation language (DML) or data definition\n language (DDL). This statement must be a single SQL statement. \n Depending on the authorization\n method, use one of the following combinations of request parameters:
\nSecrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the \n cluster identifier that matches the cluster in the secret.
\nTemporary credentials - specify the cluster identifier, the database name, and the\n database user name. Permission to call the redshift:GetClusterCredentials\n operation is required to use this method.
Runs an SQL statement, which can be data manipulation language (DML) or data definition\n language (DDL). This statement must be a single SQL statement. \n Depending on the authorization\n method, use one of the following combinations of request parameters:
\nSecrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name.
\nTemporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless endpoint, specify the database name.
The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
", - "smithy.api#required": {} + "smithy.api#documentation": "The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
" } }, "SecretArn": { @@ -656,7 +675,7 @@ "DbUser": { "target": "com.amazonaws.redshiftdata#String", "traits": { - "smithy.api#documentation": "The database user name. This parameter is required when authenticating using temporary credentials.
" + "smithy.api#documentation": "The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
" } }, "Database": { @@ -704,7 +723,7 @@ "ClusterIdentifier": { "target": "com.amazonaws.redshiftdata#Location", "traits": { - "smithy.api#documentation": "The cluster identifier.
" + "smithy.api#documentation": "The cluster identifier. This parameter is not returned when connecting to a serverless endpoint.
" } }, "DbUser": { @@ -883,6 +902,9 @@ "target": "com.amazonaws.redshiftdata#ListDatabasesResponse" }, "errors": [ + { + "target": "com.amazonaws.redshiftdata#DatabaseConnectionException" + }, { "target": "com.amazonaws.redshiftdata#InternalServerException" }, @@ -891,7 +913,7 @@ } ], "traits": { - "smithy.api#documentation": "List the databases in a cluster. \n A token is returned to page through the database list.\n Depending on the authorization method, use one of the\n following combinations of request parameters:
\nSecrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the \n cluster identifier that matches the cluster in the secret.
\nTemporary credentials - specify the cluster identifier, the database name, and the\n database user name. Permission to call the redshift:GetClusterCredentials\n operation is required to use this method.
List the databases in a cluster. \n A token is returned to page through the database list.\n Depending on the authorization method, use one of the\n following combinations of request parameters:
\nSecrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name.
\nTemporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless endpoint, specify the database name.
The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
", - "smithy.api#required": {} + "smithy.api#documentation": "The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
" } }, "Database": { @@ -927,7 +948,7 @@ "DbUser": { "target": "com.amazonaws.redshiftdata#String", "traits": { - "smithy.api#documentation": "The database user name. This parameter is required when authenticating using temporary credentials.
" + "smithy.api#documentation": "The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
" } }, "NextToken": { @@ -970,6 +991,9 @@ "target": "com.amazonaws.redshiftdata#ListSchemasResponse" }, "errors": [ + { + "target": "com.amazonaws.redshiftdata#DatabaseConnectionException" + }, { "target": "com.amazonaws.redshiftdata#InternalServerException" }, @@ -978,7 +1002,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the schemas in a database. \n A token is returned to page through the schema list. \n Depending on the authorization method, use one of the\n following combinations of request parameters:
\nSecrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the \n cluster identifier that matches the cluster in the secret.
\nTemporary credentials - specify the cluster identifier, the database name, and the\n database user name. Permission to call the redshift:GetClusterCredentials\n operation is required to use this method.
Lists the schemas in a database. \n A token is returned to page through the schema list. \n Depending on the authorization method, use one of the\n following combinations of request parameters:
\nSecrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name.
\nTemporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless endpoint, specify the database name.
The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
", - "smithy.api#required": {} + "smithy.api#documentation": "The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
" } }, "SecretArn": { @@ -1007,7 +1030,7 @@ "DbUser": { "target": "com.amazonaws.redshiftdata#String", "traits": { - "smithy.api#documentation": "The database user name. This parameter is required when authenticating using temporary credentials.
" + "smithy.api#documentation": "The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
" } }, "Database": { @@ -1158,6 +1181,9 @@ "target": "com.amazonaws.redshiftdata#ListTablesResponse" }, "errors": [ + { + "target": "com.amazonaws.redshiftdata#DatabaseConnectionException" + }, { "target": "com.amazonaws.redshiftdata#InternalServerException" }, @@ -1166,7 +1192,7 @@ } ], "traits": { - "smithy.api#documentation": "List the tables in a database. If neither SchemaPattern nor TablePattern are specified, then \n all tables in the database are returned.\n A token is returned to page through the table list. \n Depending on the authorization method, use one of the\n following combinations of request parameters:
Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the \n cluster identifier that matches the cluster in the secret.
\nTemporary credentials - specify the cluster identifier, the database name, and the\n database user name. Permission to call the redshift:GetClusterCredentials\n operation is required to use this method.
List the tables in a database. If neither SchemaPattern nor TablePattern are specified, then \n all tables in the database are returned.\n A token is returned to page through the table list. \n Depending on the authorization method, use one of the\n following combinations of request parameters:
Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name.
\nTemporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless endpoint, specify the database name.
The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
", - "smithy.api#required": {} + "smithy.api#documentation": "The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
" } }, "SecretArn": { @@ -1195,7 +1220,7 @@ "DbUser": { "target": "com.amazonaws.redshiftdata#String", "traits": { - "smithy.api#documentation": "The database user name. This parameter is required when authenticating using temporary credentials.
" + "smithy.api#documentation": "The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
" } }, "Database": { @@ -1653,7 +1678,7 @@ "HasResultSet": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "A value that indicates whether the statement has a result set. The result set can be empty.
" + "smithy.api#documentation": "A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set.
" } } }, diff --git a/aws/sdk/aws-models/redshift.json b/aws/sdk/aws-models/redshift.json index ae1f239831bc99d004a063873b0fca03666432a8..55fe8c09cacba757a372297d6549fd208d85e003 100644 --- a/aws/sdk/aws-models/redshift.json +++ b/aws/sdk/aws-models/redshift.json @@ -632,7 +632,7 @@ "ConsumerIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The identifier of the data consumer that is authorized to access the datashare. This identifier is an AWS account ID.
", + "smithy.api#documentation": "The identifier of the data consumer that is authorized to access the datashare. This identifier is an Amazon Web Services account ID.
", "smithy.api#required": {} } } @@ -1316,6 +1316,18 @@ "traits": { "smithy.api#documentation": "The AQUA (Advanced Query Accelerator) configuration of the cluster.
" } + }, + "DefaultIamRoleArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
" + } + }, + "ReservedNodeExchangeStatus": { + "target": "com.amazonaws.redshift#ReservedNodeExchangeStatus", + "traits": { + "smithy.api#documentation": "The status of the reserved-node exchange request. Statuses include in-progress and requested.
" + } } }, "traits": { @@ -2654,6 +2666,12 @@ "traits": { "smithy.api#documentation": "The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created. Possible values include the following.
\nenabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.
\ndisabled - Don't use AQUA.
\nauto - Amazon Redshift determines whether to use AQUA.
\nThe Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.
" + } } }, "traits": { @@ -3731,7 +3749,7 @@ } }, "traits": { - "smithy.api#documentation": "The association of a datashare from a producer account with a data consumer.\n
" + "smithy.api#documentation": "The association of a datashare from a producer account with a data consumer.\n
" } }, "com.amazonaws.redshift#DataShareAssociationList": { @@ -3902,7 +3920,7 @@ "ConsumerIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The identifier of the data consumer that is to have authorization removed from the datashare. \n This identifier is an AWS account ID.
", + "smithy.api#documentation": "The identifier of the data consumer that is to have authorization removed from the datashare. \n This identifier is an Amazon Web Services account ID.
", "smithy.api#required": {} } } @@ -5368,7 +5386,13 @@ } ], "traits": { - "smithy.api#documentation": "Shows the status of any inbound or outbound datashares available in the specified\n account.
" + "smithy.api#documentation": "Shows the status of any inbound or outbound datashares available in the specified\n account.
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DataShares", + "pageSize": "MaxRecords" + } } }, "com.amazonaws.redshift#DescribeDataSharesForConsumer": { @@ -5385,7 +5409,13 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of datashares where the account identifier being called is a consumer account identifier.
" + "smithy.api#documentation": "Returns a list of datashares where the account identifier being called is a consumer account identifier.
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DataShares", + "pageSize": "MaxRecords" + } } }, "com.amazonaws.redshift#DescribeDataSharesForConsumerMessage": { @@ -5412,7 +5442,7 @@ "Marker": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeDataSharesForConsumer request\n exceed the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.
An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeDataSharesForConsumer request\n exceed the value specified in MaxRecords, Amazon Web Services returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.
An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeDataSharesForConsumer request\n exceed the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.
An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeDataSharesForConsumer request\n exceed the value specified in MaxRecords, Amazon Web Services returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.
Returns a list of datashares when the account identifier being called is a producer account identifier.
" + "smithy.api#documentation": "Returns a list of datashares when the account identifier being called is a producer account identifier.
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DataShares", + "pageSize": "MaxRecords" + } } }, "com.amazonaws.redshift#DescribeDataSharesForProducerMessage": { @@ -5475,7 +5511,7 @@ "Marker": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeDataSharesForProducer request\n exceed the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.
An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeDataSharesForProducer request\n exceed the value specified in MaxRecords, Amazon Web Services returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.
An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeDataSharesForProducer request\n exceed the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.
An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeDataSharesForProducer request\n exceed the value specified in MaxRecords, Amazon Web Services returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataShares request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataShares request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataShares request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataShares request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Returns exchange status details and associated metadata for a reserved-node\n exchange. Statuses include such values as in progress and requested.
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "ReservedNodeExchangeStatusDetails", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.redshift#DescribeReservedNodeExchangeStatusInputMessage": { + "type": "structure", + "members": { + "ReservedNodeId": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The identifier of the source reserved node in a reserved-node exchange request.
" + } + }, + "ReservedNodeExchangeRequestId": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The identifier of the reserved-node exchange request.
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.redshift#IntegerOptional", + "traits": { + "smithy.api#documentation": "The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a Marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.
An optional pagination token provided by a previous DescribeReservedNodeExchangeStatus request. If this \n parameter is specified, the response includes only records beyond the marker, up to the value \n specified by the MaxRecords parameter. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.
The details of the reserved-node exchange request, including the status, request\n time, source reserved-node identifier, and additional details.
" + } + }, + "Marker": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "A pagination token provided by a previous DescribeReservedNodeExchangeStatus request.
The request parameters to get cluster credentials.
" } }, + "com.amazonaws.redshift#GetReservedNodeExchangeConfigurationOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshift#GetReservedNodeExchangeConfigurationOptionsInputMessage" + }, + "output": { + "target": "com.amazonaws.redshift#GetReservedNodeExchangeConfigurationOptionsOutputMessage" + }, + "errors": [ + { + "target": "com.amazonaws.redshift#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.redshift#ClusterSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.redshift#DependentServiceUnavailableFault" + }, + { + "target": "com.amazonaws.redshift#InvalidReservedNodeStateFault" + }, + { + "target": "com.amazonaws.redshift#ReservedNodeAlreadyMigratedFault" + }, + { + "target": "com.amazonaws.redshift#ReservedNodeNotFoundFault" + }, + { + "target": "com.amazonaws.redshift#ReservedNodeOfferingNotFoundFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" + } + ], + "traits": { + "smithy.api#documentation": "Gets the configuration options for the reserved-node exchange. These options\n include information about the source reserved node and target reserved node offering.\n Details include the node type, the price, the node count, and the offering type.
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "ReservedNodeConfigurationOptionList", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.redshift#GetReservedNodeExchangeConfigurationOptionsInputMessage": { + "type": "structure", + "members": { + "ActionType": { + "target": "com.amazonaws.redshift#ReservedNodeExchangeActionType", + "traits": { + "smithy.api#documentation": "The action type of the reserved-node configuration. The action type can be an exchange initiated from either a snapshot or a resize.
", + "smithy.api#required": {} + } + }, + "ClusterIdentifier": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The identifier for the cluster that is the source for a reserved-node exchange.
" + } + }, + "SnapshotIdentifier": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The identifier for the snapshot that is the source for the reserved-node exchange.
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.redshift#IntegerOptional", + "traits": { + "smithy.api#documentation": "The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a Marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.
An optional pagination token provided by a previous GetReservedNodeExchangeConfigurationOptions request. If this \n parameter is specified, the response includes only records beyond the marker, up to the value \n specified by the MaxRecords parameter. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.
A pagination token provided by a previous GetReservedNodeExchangeConfigurationOptions request.
the configuration options for the reserved-node\n exchange. These options include information about the source reserved node and target reserved\n node. Details include the node type, the price, the node count, and the offering\n type.
" + } + } + } + }, "com.amazonaws.redshift#GetReservedNodeExchangeOfferings": { "type": "operation", "input": { @@ -9209,6 +9417,12 @@ "traits": { "smithy.api#documentation": "Zero or more IAM roles in ARN format to disassociate from the cluster. You can\n disassociate up to 10 IAM roles from a single cluster in a single request.
" } + }, + "DefaultIamRoleArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last modified.
" + } } }, "traits": { @@ -10884,6 +11098,24 @@ }, "com.amazonaws.redshift#RedshiftServiceVersion20121201": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Redshift", + "arnNamespace": "redshift", + "cloudFormationName": "Redshift", + "cloudTrailEventSource": "redshift.amazonaws.com", + "endpointPrefix": "redshift" + }, + "aws.auth#sigv4": { + "name": "redshift" + }, + "aws.protocols#awsQuery": {}, + "smithy.api#documentation": "\n Overview\n
\nThis is an interface reference for Amazon Redshift. It contains documentation for one of\n the programming or command line interfaces you can use to manage Amazon Redshift clusters.\n Note that Amazon Redshift is asynchronous, which means that some interfaces may require\n techniques, such as polling or asynchronous callback handlers, to determine when a\n command has been applied. In this reference, the parameter descriptions indicate whether\n a change is applied immediately, on the next instance reboot, or during the next\n maintenance window. For a summary of the Amazon Redshift cluster management interfaces, go to\n Using the\n Amazon Redshift Management Interfaces.
\nAmazon Redshift manages all the work of setting up, operating, and scaling a data\n warehouse: provisioning capacity, monitoring and backing up the cluster, and applying\n patches and upgrades to the Amazon Redshift engine. You can focus on using your data to\n acquire new insights for your business and customers.
\nIf you are a first-time user of Amazon Redshift, we recommend that you begin by reading\n the Amazon Redshift Getting Started Guide.
\n\nIf you are a database developer, the Amazon Redshift Database Developer Guide explains how to design,\n build, query, and maintain the databases that make up your data warehouse.
", + "smithy.api#title": "Amazon Redshift", + "smithy.api#xmlNamespace": { + "uri": "http://redshift.amazonaws.com/doc/2012-12-01/" + } + }, "version": "2012-12-01", "operations": [ { @@ -11093,6 +11325,9 @@ { "target": "com.amazonaws.redshift#DescribePartners" }, + { + "target": "com.amazonaws.redshift#DescribeReservedNodeExchangeStatus" + }, { "target": "com.amazonaws.redshift#DescribeReservedNodeOfferings" }, @@ -11141,6 +11376,9 @@ { "target": "com.amazonaws.redshift#GetClusterCredentials" }, + { + "target": "com.amazonaws.redshift#GetReservedNodeExchangeConfigurationOptions" + }, { "target": "com.amazonaws.redshift#GetReservedNodeExchangeOfferings" }, @@ -11234,25 +11472,7 @@ { "target": "com.amazonaws.redshift#UpdatePartnerStatus" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Redshift", - "arnNamespace": "redshift", - "cloudFormationName": "Redshift", - "cloudTrailEventSource": "redshift.amazonaws.com", - "endpointPrefix": "redshift" - }, - "aws.auth#sigv4": { - "name": "redshift" - }, - "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "\n Overview\n
\nThis is an interface reference for Amazon Redshift. It contains documentation for one of\n the programming or command line interfaces you can use to manage Amazon Redshift clusters.\n Note that Amazon Redshift is asynchronous, which means that some interfaces may require\n techniques, such as polling or asynchronous callback handlers, to determine when a\n command has been applied. In this reference, the parameter descriptions indicate whether\n a change is applied immediately, on the next instance reboot, or during the next\n maintenance window. For a summary of the Amazon Redshift cluster management interfaces, go to\n Using the\n Amazon Redshift Management Interfaces.
\nAmazon Redshift manages all the work of setting up, operating, and scaling a data\n warehouse: provisioning capacity, monitoring and backing up the cluster, and applying\n patches and upgrades to the Amazon Redshift engine. You can focus on using your data to\n acquire new insights for your business and customers.
\nIf you are a first-time user of Amazon Redshift, we recommend that you begin by reading\n the Amazon Redshift Getting Started Guide.
\n\nIf you are a database developer, the Amazon Redshift Database Developer Guide explains how to design,\n build, query, and maintain the databases that make up your data warehouse.
", - "smithy.api#title": "Amazon Redshift", - "smithy.api#xmlNamespace": { - "uri": "http://redshift.amazonaws.com/doc/2012-12-01/" - } - } + ] }, "com.amazonaws.redshift#RejectDataShare": { "type": "operation", @@ -11403,6 +11623,169 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.redshift#ReservedNodeConfigurationOption": { + "type": "structure", + "members": { + "SourceReservedNode": { + "target": "com.amazonaws.redshift#ReservedNode" + }, + "TargetReservedNodeCount": { + "target": "com.amazonaws.redshift#Integer", + "traits": { + "smithy.api#documentation": "The target reserved-node count.
" + } + }, + "TargetReservedNodeOffering": { + "target": "com.amazonaws.redshift#ReservedNodeOffering" + } + }, + "traits": { + "smithy.api#documentation": "Details for a reserved-node exchange. Examples include the node type for a\n reserved node, the price for a node, the node's state, and other details.
" + } + }, + "com.amazonaws.redshift#ReservedNodeConfigurationOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshift#ReservedNodeConfigurationOption", + "traits": { + "smithy.api#xmlName": "ReservedNodeConfigurationOption" + } + } + }, + "com.amazonaws.redshift#ReservedNodeExchangeActionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "restore-cluster", + "name": "RESTORE_CLUSTER" + }, + { + "value": "resize-cluster", + "name": "RESIZE_CLUSTER" + } + ] + } + }, + "com.amazonaws.redshift#ReservedNodeExchangeNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.redshift#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedNodeExchangeNotFond", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "The reserved-node exchange status wasn't found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.redshift#ReservedNodeExchangeStatus": { + "type": "structure", + "members": { + "ReservedNodeExchangeRequestId": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The identifier of the reserved-node exchange request.
" + } + }, + "Status": { + "target": "com.amazonaws.redshift#ReservedNodeExchangeStatusType", + "traits": { + "smithy.api#documentation": "The status of the reserved-node exchange request. Statuses include in-progress and requested.
" + } + }, + "RequestTime": { + "target": "com.amazonaws.redshift#TStamp", + "traits": { + "smithy.api#documentation": "A date and time that indicate when the reserved-node exchange was requested.
" + } + }, + "SourceReservedNodeId": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The identifier of the source reserved node.
" + } + }, + "SourceReservedNodeType": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The source reserved-node type, for example ds2.xlarge.
" + } + }, + "SourceReservedNodeCount": { + "target": "com.amazonaws.redshift#Integer", + "traits": { + "smithy.api#documentation": "The source reserved-node count in the cluster.
" + } + }, + "TargetReservedNodeOfferingId": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The identifier of the target reserved node offering.
" + } + }, + "TargetReservedNodeType": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The node type of the target reserved node, for example ra3.4xlarge.
" + } + }, + "TargetReservedNodeCount": { + "target": "com.amazonaws.redshift#Integer", + "traits": { + "smithy.api#documentation": "The count of target reserved nodes in the cluster.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Reserved-node status details, such as the source reserved-node\n identifier, the target reserved-node identifier, the node type, the node count, and\n other details.
" + } + }, + "com.amazonaws.redshift#ReservedNodeExchangeStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshift#ReservedNodeExchangeStatus", + "traits": { + "smithy.api#xmlName": "ReservedNodeExchangeStatus" + } + } + }, + "com.amazonaws.redshift#ReservedNodeExchangeStatusType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "REQUESTED", + "name": "REQUESTED" + }, + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "RETRYING", + "name": "RETRYING" + }, + { + "value": "SUCCEEDED", + "name": "SUCCEEDED" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, "com.amazonaws.redshift#ReservedNodeList": { "type": "list", "member": { @@ -11648,12 +12031,18 @@ { "target": "com.amazonaws.redshift#ClusterNotFoundFault" }, + { + "target": "com.amazonaws.redshift#DependentServiceUnavailableFault" + }, { "target": "com.amazonaws.redshift#InsufficientClusterCapacityFault" }, { "target": "com.amazonaws.redshift#InvalidClusterStateFault" }, + { + "target": "com.amazonaws.redshift#InvalidReservedNodeStateFault" + }, { "target": "com.amazonaws.redshift#LimitExceededFault" }, @@ -11663,6 +12052,18 @@ { "target": "com.amazonaws.redshift#NumberOfNodesQuotaExceededFault" }, + { + "target": "com.amazonaws.redshift#ReservedNodeAlreadyExistsFault" + }, + { + "target": "com.amazonaws.redshift#ReservedNodeAlreadyMigratedFault" + }, + { + "target": "com.amazonaws.redshift#ReservedNodeNotFoundFault" + }, + { + "target": "com.amazonaws.redshift#ReservedNodeOfferingNotFoundFault" + }, { "target": "com.amazonaws.redshift#UnauthorizedOperation" }, @@ -11710,6 +12111,18 @@ "traits": { "smithy.api#documentation": "A boolean value indicating whether the resize operation is using the classic resize\n process. If you don't provide this parameter or set the value to\n false, the resize type is elastic.
The identifier of the reserved node.
" + } + }, + "TargetReservedNodeOfferingId": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The identifier of the target reserved node offering.
" + } } }, "traits": { @@ -11924,6 +12337,9 @@ { "target": "com.amazonaws.redshift#DependentServiceRequestThrottlingFault" }, + { + "target": "com.amazonaws.redshift#DependentServiceUnavailableFault" + }, { "target": "com.amazonaws.redshift#HsmClientCertificateNotFoundFault" }, @@ -11945,6 +12361,9 @@ { "target": "com.amazonaws.redshift#InvalidElasticIpFault" }, + { + "target": "com.amazonaws.redshift#InvalidReservedNodeStateFault" + }, { "target": "com.amazonaws.redshift#InvalidRestoreFault" }, @@ -11966,6 +12385,18 @@ { "target": "com.amazonaws.redshift#NumberOfNodesQuotaExceededFault" }, + { + "target": "com.amazonaws.redshift#ReservedNodeAlreadyExistsFault" + }, + { + "target": "com.amazonaws.redshift#ReservedNodeAlreadyMigratedFault" + }, + { + "target": "com.amazonaws.redshift#ReservedNodeNotFoundFault" + }, + { + "target": "com.amazonaws.redshift#ReservedNodeOfferingNotFoundFault" + }, { "target": "com.amazonaws.redshift#SnapshotScheduleNotFoundFault" }, @@ -11974,6 +12405,9 @@ }, { "target": "com.amazonaws.redshift#UnauthorizedOperation" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" } ], "traits": { @@ -12152,6 +12586,24 @@ "traits": { "smithy.api#documentation": "The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.
\nenabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.
\ndisabled - Don't use AQUA.
\nauto - Amazon Redshift determines whether to use AQUA.
\nThe Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last modified while it was restored from a snapshot.
" + } + }, + "ReservedNodeId": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The identifier of the target reserved node offering.
" + } + }, + "TargetReservedNodeOfferingId": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The identifier of the target reserved node offering.
" + } } }, "traits": { diff --git a/aws/sdk/aws-models/resiliencehub.json b/aws/sdk/aws-models/resiliencehub.json new file mode 100644 index 0000000000000000000000000000000000000000..4d5384cfa1b790b8c7d51728869643d51f31e13f --- /dev/null +++ b/aws/sdk/aws-models/resiliencehub.json @@ -0,0 +1,5627 @@ +{ + "smithy": "1.0", + "shapes": { + "com.amazonaws.resiliencehub#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.resiliencehub#String500" + } + }, + "traits": { + "smithy.api#documentation": "You don't have permissions to perform the requested operation. The user or role that is\n making the request must have at least one IAM permissions policy attached that grants the\n required permissions.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.resiliencehub#AddDraftAppVersionResourceMappings": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#AddDraftAppVersionResourceMappingsRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#AddDraftAppVersionResourceMappingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Adds the resource mapping for the draft application version.
", + "smithy.api#http": { + "method": "POST", + "uri": "/add-draft-app-version-resource-mappings", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#AddDraftAppVersionResourceMappingsRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
Mappings used to map logical resources from the template to physical resources. You can\n use the mapping type CFN_STACK if the application template uses\n a logical stack name. Or you can map individual resources by using the mapping type\n RESOURCE. We recommend using the mapping type CFN_STACK if the\n application is backed by a CloudFormation stack.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The version of the application.
", + "smithy.api#required": {} + } + }, + "resourceMappings": { + "target": "com.amazonaws.resiliencehub#ResourceMappingList", + "traits": { + "smithy.api#documentation": "Mappings used to map logical resources from the template to physical resources. You can\n use the mapping type CFN_STACK if the application template uses\n a logical stack name. Or you can map individual resources by using the mapping type\n RESOURCE. We recommend using the mapping type CFN_STACK if the\n application is backed by a CloudFormation stack.
The identifier of the alarm recommendation.
", + "smithy.api#required": {} + } + }, + "referenceId": { + "target": "com.amazonaws.resiliencehub#SpecReferenceId", + "traits": { + "smithy.api#documentation": "The reference identifier of the alarm recommendation.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "The name of the alarm recommendation.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.resiliencehub#EntityDescription", + "traits": { + "smithy.api#documentation": "The description of the recommendation.
" + } + }, + "type": { + "target": "com.amazonaws.resiliencehub#AlarmType", + "traits": { + "smithy.api#documentation": "The type of alarm recommendation.
", + "smithy.api#required": {} + } + }, + "appComponentName": { + "target": "com.amazonaws.resiliencehub#EntityId", + "traits": { + "smithy.api#documentation": "The application component for the CloudWatch alarm recommendation.
" + } + }, + "items": { + "target": "com.amazonaws.resiliencehub#RecommendationItemList", + "traits": { + "smithy.api#documentation": "The list of CloudWatch alarm recommendations.
" + } + }, + "prerequisite": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "The prerequisite for the alarm recommendation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a recommendation for a CloudWatch alarm.
" + } + }, + "com.amazonaws.resiliencehub#AlarmRecommendationList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#AlarmRecommendation" + } + }, + "com.amazonaws.resiliencehub#AlarmType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Metric", + "name": "METRIC" + }, + { + "value": "Composite", + "name": "COMPOSITE" + }, + { + "value": "Canary", + "name": "CANARY" + }, + { + "value": "Logs", + "name": "LOGS" + }, + { + "value": "Event", + "name": "EVENT" + } + ] + } + }, + "com.amazonaws.resiliencehub#App": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The name for the application.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.resiliencehub#EntityDescription", + "traits": { + "smithy.api#documentation": "The optional description for an app.
" + } + }, + "policyArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:dcps:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The timestamp for when the app was created.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.resiliencehub#AppStatusType", + "traits": { + "smithy.api#documentation": "The status of the action.
" + } + }, + "complianceStatus": { + "target": "com.amazonaws.resiliencehub#AppComplianceStatusType", + "traits": { + "smithy.api#documentation": "The current status of compliance for the resiliency policy.
" + } + }, + "lastAppComplianceEvaluationTime": { + "target": "com.amazonaws.resiliencehub#TimeStamp", + "traits": { + "smithy.api#documentation": "The timestamp for the most recent compliance evaluation.
" + } + }, + "resiliencyScore": { + "target": "com.amazonaws.resiliencehub#Double", + "traits": { + "smithy.api#documentation": "The current resiliency score for the application.
" + } + }, + "lastResiliencyScoreEvaluationTime": { + "target": "com.amazonaws.resiliencehub#TimeStamp", + "traits": { + "smithy.api#documentation": "The timestamp for the most recent resiliency score evaluation.
" + } + }, + "tags": { + "target": "com.amazonaws.resiliencehub#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a Resilience Hub application.
" + } + }, + "com.amazonaws.resiliencehub#AppAssessment": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The version of the application.
" + } + }, + "invoker": { + "target": "com.amazonaws.resiliencehub#AssessmentInvoker", + "traits": { + "smithy.api#documentation": "The entity that invoked the assessment.
", + "smithy.api#required": {} + } + }, + "cost": { + "target": "com.amazonaws.resiliencehub#Cost", + "traits": { + "smithy.api#documentation": "The cost for the application.
" + } + }, + "resiliencyScore": { + "target": "com.amazonaws.resiliencehub#ResiliencyScore", + "traits": { + "smithy.api#documentation": "The current resiliency score for the application.
" + } + }, + "compliance": { + "target": "com.amazonaws.resiliencehub#AssessmentCompliance", + "traits": { + "smithy.api#documentation": "The application compliance against the resiliency policy.
" + } + }, + "complianceStatus": { + "target": "com.amazonaws.resiliencehub#ComplianceStatus", + "traits": { + "smithy.api#documentation": "The current status of the compliance for the resiliency policy.
" + } + }, + "assessmentStatus": { + "target": "com.amazonaws.resiliencehub#AssessmentStatus", + "traits": { + "smithy.api#documentation": "The current status of the assessment for the resiliency policy.
", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.resiliencehub#TimeStamp", + "traits": { + "smithy.api#documentation": "The starting time for the action.
" + } + }, + "endTime": { + "target": "com.amazonaws.resiliencehub#TimeStamp", + "traits": { + "smithy.api#documentation": "The end time for the action.
" + } + }, + "message": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "Error or warning message from the assessment execution
" + } + }, + "assessmentName": { + "target": "com.amazonaws.resiliencehub#EntityName", + "traits": { + "smithy.api#documentation": "The name of the assessment.
" + } + }, + "assessmentArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The resiliency policy.
" + } + }, + "tags": { + "target": "com.amazonaws.resiliencehub#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines an application assessment.
" + } + }, + "com.amazonaws.resiliencehub#AppAssessmentSummary": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The version of the application.
" + } + }, + "assessmentStatus": { + "target": "com.amazonaws.resiliencehub#AssessmentStatus", + "traits": { + "smithy.api#documentation": "The current status of the assessment for the resiliency policy.
", + "smithy.api#required": {} + } + }, + "invoker": { + "target": "com.amazonaws.resiliencehub#AssessmentInvoker", + "traits": { + "smithy.api#documentation": "The entity that invoked the assessment.
" + } + }, + "startTime": { + "target": "com.amazonaws.resiliencehub#TimeStamp", + "traits": { + "smithy.api#documentation": "The starting time for the action.
" + } + }, + "endTime": { + "target": "com.amazonaws.resiliencehub#TimeStamp", + "traits": { + "smithy.api#documentation": "The end time for the action.
" + } + }, + "message": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "The message from the assessment run.
" + } + }, + "assessmentName": { + "target": "com.amazonaws.resiliencehub#EntityName", + "traits": { + "smithy.api#documentation": "The name of the assessment.
" + } + }, + "assessmentArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The current status of compliance for the resiliency policy.
" + } + }, + "cost": { + "target": "com.amazonaws.resiliencehub#Cost", + "traits": { + "smithy.api#documentation": "The cost for the application.
" + } + }, + "resiliencyScore": { + "target": "com.amazonaws.resiliencehub#Double", + "traits": { + "smithy.api#documentation": "The current resiliency score for the application.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines an application assessment summary.
" + } + }, + "com.amazonaws.resiliencehub#AppAssessmentSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#AppAssessmentSummary" + } + }, + "com.amazonaws.resiliencehub#AppComplianceStatusType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PolicyBreached", + "name": "POLICY_BREACHED" + }, + { + "value": "PolicyMet", + "name": "POLICY_MET" + }, + { + "value": "NotAssessed", + "name": "NOT_ASSESSED" + }, + { + "value": "ChangesDetected", + "name": "CHANGES_DETECTED" + } + ] + } + }, + "com.amazonaws.resiliencehub#AppComponent": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "The name of the application component.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "The type of application component.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines an application component.
" + } + }, + "com.amazonaws.resiliencehub#AppComponentCompliance": { + "type": "structure", + "members": { + "cost": { + "target": "com.amazonaws.resiliencehub#Cost", + "traits": { + "smithy.api#documentation": "The cost for the application.
" + } + }, + "appComponentName": { + "target": "com.amazonaws.resiliencehub#EntityId", + "traits": { + "smithy.api#documentation": "The name of the application component.
" + } + }, + "compliance": { + "target": "com.amazonaws.resiliencehub#AssessmentCompliance", + "traits": { + "smithy.api#documentation": "The compliance of the application component against the resiliency policy.
" + } + }, + "message": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "The compliance message.
" + } + }, + "status": { + "target": "com.amazonaws.resiliencehub#ComplianceStatus", + "traits": { + "smithy.api#documentation": "The status of the action.
" + } + }, + "resiliencyScore": { + "target": "com.amazonaws.resiliencehub#ResiliencyScore", + "traits": { + "smithy.api#documentation": "The current resiliency score for the application.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the compliance of an application component against the resiliency policy.
" + } + }, + "com.amazonaws.resiliencehub#AppComponentList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#AppComponent" + } + }, + "com.amazonaws.resiliencehub#AppStatusType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Active", + "name": "ACTIVE" + }, + { + "value": "Deleting", + "name": "DELETING" + } + ] + } + }, + "com.amazonaws.resiliencehub#AppSummary": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The name of the application.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.resiliencehub#EntityDescription", + "traits": { + "smithy.api#documentation": "The optional description for an app.
" + } + }, + "creationTime": { + "target": "com.amazonaws.resiliencehub#TimeStamp", + "traits": { + "smithy.api#documentation": "The timestamp for when the app was created.
", + "smithy.api#required": {} + } + }, + "complianceStatus": { + "target": "com.amazonaws.resiliencehub#AppComplianceStatusType", + "traits": { + "smithy.api#documentation": "The current status of compliance for the resiliency policy.
" + } + }, + "resiliencyScore": { + "target": "com.amazonaws.resiliencehub#Double", + "traits": { + "smithy.api#documentation": "The current resiliency score for the application.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines an application summary.
" + } + }, + "com.amazonaws.resiliencehub#AppSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#AppSummary" + } + }, + "com.amazonaws.resiliencehub#AppTemplateBody": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5000 + }, + "smithy.api#pattern": "^[\\w\\s:,-\\.'{}\\[\\]:\"]+$" + } + }, + "com.amazonaws.resiliencehub#AppVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#AppVersionSummary" + } + }, + "com.amazonaws.resiliencehub#AppVersionSummary": { + "type": "structure", + "members": { + "appVersion": { + "target": "com.amazonaws.resiliencehub#EntityVersion", + "traits": { + "smithy.api#documentation": "The version of the application.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The version of the application.
" + } + }, + "com.amazonaws.resiliencehub#Arn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$" + } + }, + "com.amazonaws.resiliencehub#ArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#Arn" + } + }, + "com.amazonaws.resiliencehub#AssessmentCompliance": { + "type": "map", + "key": { + "target": "com.amazonaws.resiliencehub#DisruptionType" + }, + "value": { + "target": "com.amazonaws.resiliencehub#DisruptionCompliance" + } + }, + "com.amazonaws.resiliencehub#AssessmentInvoker": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "User", + "name": "USER" + }, + { + "value": "System", + "name": "SYSTEM" + } + ] + } + }, + "com.amazonaws.resiliencehub#AssessmentStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Pending", + "name": "PENDING" + }, + { + "value": "InProgress", + "name": "INPROGRESS" + }, + { + "value": "Failed", + "name": "FAILED" + }, + { + "value": "Success", + "name": "SUCCESS" + } + ] + } + }, + "com.amazonaws.resiliencehub#AssessmentStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#AssessmentStatus" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.resiliencehub#AwsRegion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]$" + } + }, + "com.amazonaws.resiliencehub#AwsResilienceHub": { + "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "resiliencehub", + "arnNamespace": "resiliencehub", + "cloudFormationName": "Resiliencehub", + "cloudTrailEventSource": "resiliencehub.amazonaws.com", + "endpointPrefix": "resiliencehub" + }, + "aws.auth#sigv4": { + "name": "resiliencehub" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*,authorization,date,x-amz-date,x-amz-security-token,x-amz-target,content-type,x-amz-content-sha256,x-amz-user-agent,x-amzn-platform-id,x-amzn-trace-id,amz-sdk-invocation-id,amz-sdk-request" + ] + }, + "smithy.api#documentation": "AWS Resilience Hub helps you proactively prepare and protect your Amazon Web Services applications from\n disruptions. Resilience Hub offers continuous resiliency assessment and validation that integrates\n into your software development lifecycle. This enables you to uncover resiliency weaknesses,\n ensure recovery time objective (RTO) and recovery point objective (RPO) targets for your\n applications are met, and resolve issues before they are released into production.
", + "smithy.api#title": "AWS Resilience Hub" + }, + "version": "2020-04-30", + "operations": [ + { + "target": "com.amazonaws.resiliencehub#AddDraftAppVersionResourceMappings" + }, + { + "target": "com.amazonaws.resiliencehub#CreateApp" + }, + { + "target": "com.amazonaws.resiliencehub#CreateRecommendationTemplate" + }, + { + "target": "com.amazonaws.resiliencehub#CreateResiliencyPolicy" + }, + { + "target": "com.amazonaws.resiliencehub#DeleteApp" + }, + { + "target": "com.amazonaws.resiliencehub#DeleteAppAssessment" + }, + { + "target": "com.amazonaws.resiliencehub#DeleteRecommendationTemplate" + }, + { + "target": "com.amazonaws.resiliencehub#DeleteResiliencyPolicy" + }, + { + "target": "com.amazonaws.resiliencehub#DescribeApp" + }, + { + "target": "com.amazonaws.resiliencehub#DescribeAppAssessment" + }, + { + "target": "com.amazonaws.resiliencehub#DescribeAppVersionResourcesResolutionStatus" + }, + { + "target": "com.amazonaws.resiliencehub#DescribeAppVersionTemplate" + }, + { + "target": "com.amazonaws.resiliencehub#DescribeDraftAppVersionResourcesImportStatus" + }, + { + "target": "com.amazonaws.resiliencehub#DescribeResiliencyPolicy" + }, + { + "target": "com.amazonaws.resiliencehub#ImportResourcesToDraftAppVersion" + }, + { + "target": "com.amazonaws.resiliencehub#ListAlarmRecommendations" + }, + { + "target": "com.amazonaws.resiliencehub#ListAppAssessments" + }, + { + "target": "com.amazonaws.resiliencehub#ListAppComponentCompliances" + }, + { + "target": "com.amazonaws.resiliencehub#ListAppComponentRecommendations" + }, + { + "target": "com.amazonaws.resiliencehub#ListApps" + }, + { + "target": "com.amazonaws.resiliencehub#ListAppVersionResourceMappings" + }, + { + "target": "com.amazonaws.resiliencehub#ListAppVersionResources" + }, + { + "target": "com.amazonaws.resiliencehub#ListAppVersions" + }, + { + "target": "com.amazonaws.resiliencehub#ListRecommendationTemplates" + }, + { + "target": "com.amazonaws.resiliencehub#ListResiliencyPolicies" + }, + { + "target": "com.amazonaws.resiliencehub#ListSopRecommendations" + }, + { + "target": "com.amazonaws.resiliencehub#ListSuggestedResiliencyPolicies" + }, + { + "target": "com.amazonaws.resiliencehub#ListTagsForResource" + }, + { + "target": "com.amazonaws.resiliencehub#ListTestRecommendations" + }, + { + "target": "com.amazonaws.resiliencehub#ListUnsupportedAppVersionResources" + }, + { + "target": "com.amazonaws.resiliencehub#PublishAppVersion" + }, + { + "target": "com.amazonaws.resiliencehub#PutDraftAppVersionTemplate" + }, + { + "target": "com.amazonaws.resiliencehub#RemoveDraftAppVersionResourceMappings" + }, + { + "target": "com.amazonaws.resiliencehub#ResolveAppVersionResources" + }, + { + "target": "com.amazonaws.resiliencehub#StartAppAssessment" + }, + { + "target": "com.amazonaws.resiliencehub#TagResource" + }, + { + "target": "com.amazonaws.resiliencehub#UntagResource" + }, + { + "target": "com.amazonaws.resiliencehub#UpdateApp" + }, + { + "target": "com.amazonaws.resiliencehub#UpdateResiliencyPolicy" + } + ] + }, + "com.amazonaws.resiliencehub#BooleanOptional": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.resiliencehub#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[A-za-z0-9_.-]{0,63}$" + } + }, + "com.amazonaws.resiliencehub#ComplianceStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PolicyBreached", + "name": "POLICY_BREACHED" + }, + { + "value": "PolicyMet", + "name": "POLICY_MET" + } + ] + } + }, + "com.amazonaws.resiliencehub#ComponentCompliancesList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#AppComponentCompliance" + } + }, + "com.amazonaws.resiliencehub#ComponentRecommendation": { + "type": "structure", + "members": { + "appComponentName": { + "target": "com.amazonaws.resiliencehub#EntityId", + "traits": { + "smithy.api#documentation": "The name of the application component.
", + "smithy.api#required": {} + } + }, + "recommendationStatus": { + "target": "com.amazonaws.resiliencehub#RecommendationComplianceStatus", + "traits": { + "smithy.api#documentation": "The recommendation status.
", + "smithy.api#required": {} + } + }, + "configRecommendations": { + "target": "com.amazonaws.resiliencehub#ConfigRecommendationList", + "traits": { + "smithy.api#documentation": "The list of recommendations.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines recommendations for a Resilience Hub application component, returned as an object. This\n object contains component names, configuration recommendations, and recommendation\n statuses.
" + } + }, + "com.amazonaws.resiliencehub#ComponentRecommendationList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#ComponentRecommendation" + } + }, + "com.amazonaws.resiliencehub#ConfigRecommendation": { + "type": "structure", + "members": { + "cost": { + "target": "com.amazonaws.resiliencehub#Cost", + "traits": { + "smithy.api#documentation": "The cost for the application.
" + } + }, + "appComponentName": { + "target": "com.amazonaws.resiliencehub#EntityId", + "traits": { + "smithy.api#documentation": "The application component name.
" + } + }, + "compliance": { + "target": "com.amazonaws.resiliencehub#AssessmentCompliance", + "traits": { + "smithy.api#documentation": "The current compliance against the resiliency policy before applying the configuration\n change.
" + } + }, + "recommendationCompliance": { + "target": "com.amazonaws.resiliencehub#RecommendationCompliance", + "traits": { + "smithy.api#documentation": "The expected compliance against the resiliency policy after applying the configuration\n change.
" + } + }, + "optimizationType": { + "target": "com.amazonaws.resiliencehub#ConfigRecommendationOptimizationType", + "traits": { + "smithy.api#documentation": "The type of optimization.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.resiliencehub#EntityName", + "traits": { + "smithy.api#documentation": "The name of the recommendation configuration.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.resiliencehub#EntityDescription", + "traits": { + "smithy.api#documentation": "The optional description for an app.
" + } + }, + "suggestedChanges": { + "target": "com.amazonaws.resiliencehub#SuggestedChangesList", + "traits": { + "smithy.api#documentation": "List of the suggested configuration changes.
" + } + }, + "haArchitecture": { + "target": "com.amazonaws.resiliencehub#HaArchitecture", + "traits": { + "smithy.api#documentation": "The architecture type.
" + } + }, + "referenceId": { + "target": "com.amazonaws.resiliencehub#SpecReferenceId", + "traits": { + "smithy.api#documentation": "The reference identifier for the recommendation configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a configuration recommendation.
" + } + }, + "com.amazonaws.resiliencehub#ConfigRecommendationList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#ConfigRecommendation" + } + }, + "com.amazonaws.resiliencehub#ConfigRecommendationOptimizationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LeastCost", + "name": "LEAST_COST" + }, + { + "value": "LeastChange", + "name": "LEAST_CHANGE" + }, + { + "value": "BestAZRecovery", + "name": "BEST_AZ_RECOVERY" + }, + { + "value": "LeastErrors", + "name": "LEAST_ERRORS" + }, + { + "value": "BestAttainable", + "name": "BEST_ATTAINABLE" + } + ] + } + }, + "com.amazonaws.resiliencehub#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.resiliencehub#String500" + }, + "resourceId": { + "target": "com.amazonaws.resiliencehub#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the resource that the exception applies to.
" + } + }, + "resourceType": { + "target": "com.amazonaws.resiliencehub#ResourceType", + "traits": { + "smithy.api#documentation": "The type of the resource that the exception applies to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Occurs when a conflict with a previous successful write is detected. This generally occurs\n when the previous write did not have time to propagate to the host serving the current\n request. A retry (with appropriate backoff logic) is the recommended response to this\n exception.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.resiliencehub#Cost": { + "type": "structure", + "members": { + "amount": { + "target": "com.amazonaws.resiliencehub#Double", + "traits": { + "smithy.api#documentation": "The cost amount.
", + "smithy.api#required": {} + } + }, + "currency": { + "target": "com.amazonaws.resiliencehub#CurrencyCode", + "traits": { + "smithy.api#documentation": "The cost currency, for example USD.
The cost frequency.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a cost object.
" + } + }, + "com.amazonaws.resiliencehub#CostFrequency": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Hourly", + "name": "HOURLY" + }, + { + "value": "Daily", + "name": "DAILY" + }, + { + "value": "Monthly", + "name": "MONTHLY" + }, + { + "value": "Yearly", + "name": "YEARLY" + } + ] + } + }, + "com.amazonaws.resiliencehub#CreateApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#CreateAppRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#CreateAppResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a Resilience Hub application. A Resilience Hub application is a collection of Amazon Web Services\n resources structured to prevent and recover Amazon Web Services application disruptions. To describe a\n Resilience Hub application, you provide an application name, resources from one or more–up to\n five–CloudFormation stacks, and an appropriate resiliency policy.
\n\nAfter you create a Resilience Hub application, you publish it so that you can run a resiliency\n assessment on it. You can then use recommendations from the assessment to improve resiliency\n by running another assessment, comparing results, and then iterating the process until you\n achieve your goals for recovery time objective (RTO) and recovery point objective\n (RPO).
", + "smithy.api#http": { + "method": "POST", + "uri": "/create-app", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#CreateAppRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.resiliencehub#EntityName", + "traits": { + "smithy.api#documentation": "The name for the application.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.resiliencehub#EntityDescription", + "traits": { + "smithy.api#documentation": "The optional description for an app.
" + } + }, + "policyArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:dcps:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.
" + } + }, + "clientToken": { + "target": "com.amazonaws.resiliencehub#ClientToken", + "traits": { + "smithy.api#documentation": "Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. \nYou should not reuse the same client token for other API requests.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.resiliencehub#CreateAppResponse": { + "type": "structure", + "members": { + "app": { + "target": "com.amazonaws.resiliencehub#App", + "traits": { + "smithy.api#documentation": "The created application returned as an object with details including compliance status,\n creation time, description, resiliency score, and more.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#CreateRecommendationTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#CreateRecommendationTemplateRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#CreateRecommendationTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new recommendation template.
", + "smithy.api#http": { + "method": "POST", + "uri": "/create-recommendation-template", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#CreateRecommendationTemplateRequest": { + "type": "structure", + "members": { + "recommendationIds": { + "target": "com.amazonaws.resiliencehub#RecommendationIdList", + "traits": { + "smithy.api#documentation": "Identifiers for the recommendations used to create a recommendation template.
" + } + }, + "format": { + "target": "com.amazonaws.resiliencehub#TemplateFormat", + "traits": { + "smithy.api#documentation": "The format for the recommendation template.
\nThe template is CloudFormation JSON.
\nThe template is CloudFormation YAML.
\nAn array of strings that specify the recommendation template type or types.
\nThe template is an AlarmRecommendation template.
\nThe template is a SopRecommendation template.
\nThe template is a TestRecommendation template.
\nThe Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The name for the recommendation template.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.resiliencehub#ClientToken", + "traits": { + "smithy.api#documentation": "Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. \nYou should not reuse the same client token for other API requests.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.resiliencehub#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.
" + } + }, + "bucketName": { + "target": "com.amazonaws.resiliencehub#EntityName", + "traits": { + "smithy.api#documentation": "The name of the Amazon S3 bucket that will contain the recommendation template.
" + } + } + } + }, + "com.amazonaws.resiliencehub#CreateRecommendationTemplateResponse": { + "type": "structure", + "members": { + "recommendationTemplate": { + "target": "com.amazonaws.resiliencehub#RecommendationTemplate", + "traits": { + "smithy.api#documentation": "The newly created recommendation template, returned as an object. This object includes the\n template's name, format, status, tags, Amazon S3 bucket location, and more.
" + } + } + } + }, + "com.amazonaws.resiliencehub#CreateResiliencyPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#CreateResiliencyPolicyRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#CreateResiliencyPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a resiliency policy for an application.
", + "smithy.api#http": { + "method": "POST", + "uri": "/create-resiliency-policy", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#CreateResiliencyPolicyRequest": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.resiliencehub#EntityName", + "traits": { + "smithy.api#documentation": "The name of the policy
", + "smithy.api#required": {} + } + }, + "policyDescription": { + "target": "com.amazonaws.resiliencehub#EntityDescription", + "traits": { + "smithy.api#documentation": "The description for the policy.
" + } + }, + "dataLocationConstraint": { + "target": "com.amazonaws.resiliencehub#DataLocationConstraint", + "traits": { + "smithy.api#documentation": "Specifies a high-level geographical location constraint for where your resilience policy\n data can be stored.
" + } + }, + "tier": { + "target": "com.amazonaws.resiliencehub#ResiliencyPolicyTier", + "traits": { + "smithy.api#documentation": "The tier for this resiliency policy, ranging from the highest severity\n (MissionCritical) to lowest (NonCritical).
The type of resiliency policy to be created, including the recovery time objective (RTO)\n and recovery point objective (RPO) in seconds.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.resiliencehub#ClientToken", + "traits": { + "smithy.api#documentation": "Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. \nYou should not reuse the same client token for other API requests.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.resiliencehub#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.
" + } + } + } + }, + "com.amazonaws.resiliencehub#CreateResiliencyPolicyResponse": { + "type": "structure", + "members": { + "policy": { + "target": "com.amazonaws.resiliencehub#ResiliencyPolicy", + "traits": { + "smithy.api#documentation": "The type of resiliency policy that was created, including the recovery time objective\n (RTO) and recovery point objective (RPO) in seconds.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#CurrencyCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.resiliencehub#CustomerId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{12}$" + } + }, + "com.amazonaws.resiliencehub#DataLocationConstraint": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AnyLocation", + "name": "ANY_LOCATION" + }, + { + "value": "SameContinent", + "name": "SAME_CONTINENT" + }, + { + "value": "SameCountry", + "name": "SAME_COUNTRY" + } + ] + } + }, + "com.amazonaws.resiliencehub#DeleteApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#DeleteAppRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#DeleteAppResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an AWS Resilience Hub application. This is a destructive action that can't be\n undone.
", + "smithy.api#http": { + "method": "POST", + "uri": "/delete-app", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#DeleteAppAssessment": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#DeleteAppAssessmentRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#DeleteAppAssessmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an AWS Resilience Hub application assessment. This is a destructive action that can't\n be undone.
", + "smithy.api#http": { + "method": "POST", + "uri": "/delete-app-assessment", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#DeleteAppAssessmentRequest": { + "type": "structure", + "members": { + "assessmentArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. \nYou should not reuse the same client token for other API requests.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.resiliencehub#DeleteAppAssessmentResponse": { + "type": "structure", + "members": { + "assessmentArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The current status of the assessment for the resiliency policy.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#DeleteAppRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
A boolean option to force the deletion of a Resilience Hub application.
" + } + }, + "clientToken": { + "target": "com.amazonaws.resiliencehub#ClientToken", + "traits": { + "smithy.api#documentation": "Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. \nYou should not reuse the same client token for other API requests.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.resiliencehub#DeleteAppResponse": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
Deletes a recommendation template. This is a destructive action that can't be\n undone.
", + "smithy.api#http": { + "method": "POST", + "uri": "/delete-recommendation-template", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#DeleteRecommendationTemplateRequest": { + "type": "structure", + "members": { + "recommendationTemplateArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for a recommendation template.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.resiliencehub#ClientToken", + "traits": { + "smithy.api#documentation": "Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. \nYou should not reuse the same client token for other API requests.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.resiliencehub#DeleteRecommendationTemplateResponse": { + "type": "structure", + "members": { + "recommendationTemplateArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for a recommendation template.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.resiliencehub#RecommendationTemplateStatus", + "traits": { + "smithy.api#documentation": "The status of the action.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#DeleteResiliencyPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#DeleteResiliencyPolicyRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#DeleteResiliencyPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a resiliency policy. This is a destructive action that can't be undone.
", + "smithy.api#http": { + "method": "POST", + "uri": "/delete-resiliency-policy", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#DeleteResiliencyPolicyRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:dcps:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. \nYou should not reuse the same client token for other API requests.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.resiliencehub#DeleteResiliencyPolicyResponse": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:dcps:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
Describes an AWS Resilience Hub application.
", + "smithy.api#http": { + "method": "POST", + "uri": "/describe-app", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#DescribeAppAssessment": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#DescribeAppAssessmentRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#DescribeAppAssessmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Describes an assessment for an AWS Resilience Hub application.
", + "smithy.api#http": { + "method": "POST", + "uri": "/describe-app-assessment", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#DescribeAppAssessmentRequest": { + "type": "structure", + "members": { + "assessmentArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The assessment for an AWS Resilience Hub application, returned as an object. This object\n includes Amazon Resource Names (ARNs), compliance information, compliance status, cost,\n messages, resiliency scores, and more.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#DescribeAppRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The specified application, returned as an object with details including compliance status,\n creation time, description, resiliency score, and more.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#DescribeAppVersionResourcesResolutionStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#DescribeAppVersionResourcesResolutionStatusRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#DescribeAppVersionResourcesResolutionStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the resolution status for the specified resolution identifier for an application\n version. If resolutionId is not specified, the current resolution status is\n returned.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The version of the application.
", + "smithy.api#required": {} + } + }, + "resolutionId": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "The identifier for a specific resolution.
" + } + } + } + }, + "com.amazonaws.resiliencehub#DescribeAppVersionResourcesResolutionStatusResponse": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The version of the application.
", + "smithy.api#required": {} + } + }, + "resolutionId": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "The identifier for a specific resolution.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.resiliencehub#ResourceResolutionStatusType", + "traits": { + "smithy.api#documentation": "The status of the action.
", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "The returned error message for the request.
" + } + } + } + }, + "com.amazonaws.resiliencehub#DescribeAppVersionTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#DescribeAppVersionTemplateRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#DescribeAppVersionTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Describes details about an AWS Resilience Hub
", + "smithy.api#http": { + "method": "POST", + "uri": "/describe-app-version-template", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#DescribeAppVersionTemplateRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The version of the application.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#DescribeAppVersionTemplateResponse": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The version of the application.
", + "smithy.api#required": {} + } + }, + "appTemplateBody": { + "target": "com.amazonaws.resiliencehub#AppTemplateBody", + "traits": { + "smithy.api#documentation": "The body of the template.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#DescribeDraftAppVersionResourcesImportStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#DescribeDraftAppVersionResourcesImportStatusRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#DescribeDraftAppVersionResourcesImportStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the status of importing resources to an application version.
", + "smithy.api#http": { + "method": "POST", + "uri": "/describe-draft-app-version-resources-import-status", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#DescribeDraftAppVersionResourcesImportStatusRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The version of the application.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.resiliencehub#ResourceImportStatusType", + "traits": { + "smithy.api#documentation": "The status of the action.
", + "smithy.api#required": {} + } + }, + "statusChangeTime": { + "target": "com.amazonaws.resiliencehub#TimeStamp", + "traits": { + "smithy.api#documentation": "The timestamp for when the status last changed.
", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "The returned error message for the request.
" + } + } + } + }, + "com.amazonaws.resiliencehub#DescribeResiliencyPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#DescribeResiliencyPolicyRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#DescribeResiliencyPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Describes a specified resiliency policy for an AWS Resilience Hub application. The returned\n policy object includes creation time, data location constraints, the Amazon Resource Name\n (ARN) for the policy, tags, tier, and more.
", + "smithy.api#http": { + "method": "POST", + "uri": "/describe-resiliency-policy", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#DescribeResiliencyPolicyRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:dcps:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
Information about the specific resiliency policy, returned as an object. This object\n includes creation time, data location constraints, its name, description, tags, the recovery\n time objective (RTO) and recovery point objective (RPO) in seconds, and more.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#DisruptionCompliance": { + "type": "structure", + "members": { + "achievableRtoInSecs": { + "target": "com.amazonaws.resiliencehub#Seconds", + "traits": { + "smithy.api#documentation": "The Recovery Time Objective (RTO) that is achievable, in seconds
" + } + }, + "currentRtoInSecs": { + "target": "com.amazonaws.resiliencehub#Seconds", + "traits": { + "smithy.api#documentation": "The current RTO, in seconds.
" + } + }, + "rtoReferenceId": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "The RTO reference identifier.
" + } + }, + "rtoDescription": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "The RTO description.
" + } + }, + "currentRpoInSecs": { + "target": "com.amazonaws.resiliencehub#Seconds", + "traits": { + "smithy.api#documentation": "The current RPO, in seconds.
" + } + }, + "rpoReferenceId": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "The RPO reference identifier.
" + } + }, + "rpoDescription": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "The RPO description.
" + } + }, + "complianceStatus": { + "target": "com.amazonaws.resiliencehub#ComplianceStatus", + "traits": { + "smithy.api#documentation": "The current status of compliance for the resiliency policy.
", + "smithy.api#required": {} + } + }, + "achievableRpoInSecs": { + "target": "com.amazonaws.resiliencehub#Seconds", + "traits": { + "smithy.api#documentation": "The Recovery Point Objective (RPO) that is achievable, in seconds.
" + } + }, + "message": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "The disruption compliance message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the compliance against the resiliency policy for a disruption.
" + } + }, + "com.amazonaws.resiliencehub#DisruptionPolicy": { + "type": "map", + "key": { + "target": "com.amazonaws.resiliencehub#DisruptionType" + }, + "value": { + "target": "com.amazonaws.resiliencehub#FailurePolicy" + } + }, + "com.amazonaws.resiliencehub#DisruptionResiliencyScore": { + "type": "map", + "key": { + "target": "com.amazonaws.resiliencehub#DisruptionType" + }, + "value": { + "target": "com.amazonaws.resiliencehub#Double" + } + }, + "com.amazonaws.resiliencehub#DisruptionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Software", + "name": "SOFTWARE" + }, + { + "value": "Hardware", + "name": "HARDWARE" + }, + { + "value": "AZ", + "name": "AZ" + }, + { + "value": "Region", + "name": "REGION" + } + ] + } + }, + "com.amazonaws.resiliencehub#DocumentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.resiliencehub#Double": { + "type": "double" + }, + "com.amazonaws.resiliencehub#EntityDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.resiliencehub#EntityId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\S{1,100}$" + } + }, + "com.amazonaws.resiliencehub#EntityName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}$" + } + }, + "com.amazonaws.resiliencehub#EntityNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#EntityName" + } + }, + "com.amazonaws.resiliencehub#EntityVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\S{1,50}$" + } + }, + "com.amazonaws.resiliencehub#EstimatedCostTier": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "L1", + "name": "L1" + }, + { + "value": "L2", + "name": "L2" + }, + { + "value": "L3", + "name": "L3" + }, + { + "value": "L4", + "name": "L4" + } + ] + } + }, + "com.amazonaws.resiliencehub#FailurePolicy": { + "type": "structure", + "members": { + "rtoInSecs": { + "target": "com.amazonaws.resiliencehub#Seconds", + "traits": { + "smithy.api#documentation": "The Recovery Time Objective (RTO), in seconds.
", + "smithy.api#required": {} + } + }, + "rpoInSecs": { + "target": "com.amazonaws.resiliencehub#Seconds", + "traits": { + "smithy.api#documentation": "The Recovery Point Objective (RPO), in seconds.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a failure policy.
" + } + }, + "com.amazonaws.resiliencehub#HaArchitecture": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MultiSite", + "name": "MULTI_SITE" + }, + { + "value": "WarmStandby", + "name": "WARM_STANDBY" + }, + { + "value": "PilotLight", + "name": "PILOT_LIGHT" + }, + { + "value": "BackupAndRestore", + "name": "BACKUP_AND_RESTORE" + }, + { + "value": "NoRecoveryPlan", + "name": "NO_RECOVERY_PLAN" + } + ] + } + }, + "com.amazonaws.resiliencehub#ImportResourcesToDraftAppVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#ImportResourcesToDraftAppVersionRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#ImportResourcesToDraftAppVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Imports resources from sources such as a CloudFormation stack, resource-groups, or application\n registry app to a draft application version.
", + "smithy.api#http": { + "method": "POST", + "uri": "/import-resources-to-draft-app-version", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#ImportResourcesToDraftAppVersionRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Names (ARNs) for the resources that you want to import.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#ImportResourcesToDraftAppVersionResponse": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The version of the application.
", + "smithy.api#required": {} + } + }, + "sourceArns": { + "target": "com.amazonaws.resiliencehub#ArnList", + "traits": { + "smithy.api#documentation": "The Amazon Resource Names (ARNs) for the resources that you imported.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.resiliencehub#ResourceImportStatusType", + "traits": { + "smithy.api#documentation": "The status of the action.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.resiliencehub#String500" + } + }, + "traits": { + "smithy.api#documentation": "This exception occurs when there is an internal failure in the AWS Resilience Hub\n service.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.resiliencehub#ListAlarmRecommendations": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#ListAlarmRecommendationsRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#ListAlarmRecommendationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the alarm recommendations for a AWS Resilience Hub application.
", + "smithy.api#http": { + "method": "POST", + "uri": "/list-alarm-recommendations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken" + } + } + }, + "com.amazonaws.resiliencehub#ListAlarmRecommendationsRequest": { + "type": "structure", + "members": { + "assessmentArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
Null, or the token from a previous call to get the next set of results.
" + } + }, + "maxResults": { + "target": "com.amazonaws.resiliencehub#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.
The alarm recommendations for an AWS Resilience Hub application, returned as an object. This\n object includes application component names, descriptions, information about whether a\n recommendation has already been implemented or not, prerequisites, and more.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" + } + } + } + }, + "com.amazonaws.resiliencehub#ListAppAssessments": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#ListAppAssessmentsRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#ListAppAssessmentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the assessments for an AWS Resilience Hub application. You can use request parameters to\n refine the results for the response object.
", + "smithy.api#http": { + "method": "GET", + "uri": "/list-app-assessments", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.resiliencehub#ListAppAssessmentsRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The name for the assessment.
", + "smithy.api#httpQuery": "assessmentName" + } + }, + "assessmentStatus": { + "target": "com.amazonaws.resiliencehub#AssessmentStatusList", + "traits": { + "smithy.api#documentation": "The current status of the assessment for the resiliency policy.
", + "smithy.api#httpQuery": "assessmentStatus" + } + }, + "complianceStatus": { + "target": "com.amazonaws.resiliencehub#ComplianceStatus", + "traits": { + "smithy.api#documentation": "The current status of compliance for the resiliency policy.
", + "smithy.api#httpQuery": "complianceStatus" + } + }, + "invoker": { + "target": "com.amazonaws.resiliencehub#AssessmentInvoker", + "traits": { + "smithy.api#documentation": "Specifies the entity that invoked a specific assessment, either a User or the\n System.
The default is to sort by ascending startTime.\nTo sort by descending startTime, set reverseOrder to true.
Null, or the token from a previous call to get the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.resiliencehub#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.
The token for the next set of results, or null if there are no more results.
" + } + }, + "assessmentSummaries": { + "target": "com.amazonaws.resiliencehub#AppAssessmentSummaryList", + "traits": { + "smithy.api#documentation": "The summaries for the specified assessments, returned as an object. This object includes\n application versions, associated Amazon Resource Numbers (ARNs), cost, messages, resiliency\n scores, and more.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#ListAppComponentCompliances": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#ListAppComponentCompliancesRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#ListAppComponentCompliancesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the compliances for an AWS Resilience Hub component.
", + "smithy.api#http": { + "method": "POST", + "uri": "/list-app-component-compliances", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken" + } + } + }, + "com.amazonaws.resiliencehub#ListAppComponentCompliancesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "Null, or the token from a previous call to get the next set of results.
" + } + }, + "maxResults": { + "target": "com.amazonaws.resiliencehub#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The compliances for an AWS Resilience Hub application component, returned as an object. This\n object contains component names, compliances, costs, resiliency scores, outage scores, and\n more.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" + } + } + } + }, + "com.amazonaws.resiliencehub#ListAppComponentRecommendations": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#ListAppComponentRecommendationsRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#ListAppComponentRecommendationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the recommendations for an AWS Resilience Hub component.
", + "smithy.api#http": { + "method": "POST", + "uri": "/list-app-component-recommendations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken" + } + } + }, + "com.amazonaws.resiliencehub#ListAppComponentRecommendationsRequest": { + "type": "structure", + "members": { + "assessmentArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
Null, or the token from a previous call to get the next set of results.
" + } + }, + "maxResults": { + "target": "com.amazonaws.resiliencehub#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.
The recommendations for an Resilience Hub application component, returned as an object. This\n object contains component names, configuration recommendations, and recommendation\n statuses.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" + } + } + } + }, + "com.amazonaws.resiliencehub#ListAppVersionResourceMappings": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#ListAppVersionResourceMappingsRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#ListAppVersionResourceMappingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists how the resources in an application version are mapped/sourced from. Mappings can be\n physical resource identifiers, CloudFormation stacks, resource-groups, or an application registry\n app.
", + "smithy.api#http": { + "method": "POST", + "uri": "/list-app-version-resource-mappings", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken" + } + } + }, + "com.amazonaws.resiliencehub#ListAppVersionResourceMappingsRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The version of the application.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "Null, or the token from a previous call to get the next set of results.
" + } + }, + "maxResults": { + "target": "com.amazonaws.resiliencehub#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.
Mappings used to map logical resources from the template to physical resources. You can\n use the mapping type CFN_STACK if the application template uses\n a logical stack name. Or you can map individual resources by using the mapping type\n RESOURCE. We recommend using the mapping type CFN_STACK if the\n application is backed by a CloudFormation stack.
The token for the next set of results, or null if there are no more results.
" + } + } + } + }, + "com.amazonaws.resiliencehub#ListAppVersionResources": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#ListAppVersionResourcesRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#ListAppVersionResourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all the resources in an application version.
", + "smithy.api#http": { + "method": "POST", + "uri": "/list-app-version-resources", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken" + } + } + }, + "com.amazonaws.resiliencehub#ListAppVersionResourcesRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The version of the application.
", + "smithy.api#required": {} + } + }, + "resolutionId": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "The identifier for a specific resolution.
" + } + }, + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "Null, or the token from a previous call to get the next set of results.
" + } + }, + "maxResults": { + "target": "com.amazonaws.resiliencehub#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.
The physical resources in the application version.
", + "smithy.api#required": {} + } + }, + "resolutionId": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "The identifier for a specific resolution.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" + } + } + } + }, + "com.amazonaws.resiliencehub#ListAppVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#ListAppVersionsRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#ListAppVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the different versions for the Resilience Hub applications.
", + "smithy.api#http": { + "method": "POST", + "uri": "/list-app-versions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken" + } + } + }, + "com.amazonaws.resiliencehub#ListAppVersionsRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
Null, or the token from a previous call to get the next set of results.
" + } + }, + "maxResults": { + "target": "com.amazonaws.resiliencehub#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.
The version of the application.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" + } + } + } + }, + "com.amazonaws.resiliencehub#ListApps": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#ListAppsRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#ListAppsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists your Resilience Hub applications.
", + "smithy.api#http": { + "method": "GET", + "uri": "/list-apps", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.resiliencehub#ListAppsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "Null, or the token from a previous call to get the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.resiliencehub#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.
The name for the one of the listed applications.
", + "smithy.api#httpQuery": "name" + } + }, + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
Summaries for the Resilience Hub application.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" + } + } + } + }, + "com.amazonaws.resiliencehub#ListRecommendationTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#ListRecommendationTemplatesRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#ListRecommendationTemplatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the recommendation templates for the Resilience Hub applications.
", + "smithy.api#http": { + "method": "GET", + "uri": "/list-recommendation-templates", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.resiliencehub#ListRecommendationTemplatesRequest": { + "type": "structure", + "members": { + "assessmentArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The default is to sort by ascending startTime.\nTo sort by descending startTime, set reverseOrder to true.
The status of the action.
", + "smithy.api#httpQuery": "status" + } + }, + "recommendationTemplateArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for a recommendation template.
", + "smithy.api#httpQuery": "recommendationTemplateArn" + } + }, + "name": { + "target": "com.amazonaws.resiliencehub#EntityName", + "traits": { + "smithy.api#documentation": "The name for one of the listed recommendation templates.
", + "smithy.api#httpQuery": "name" + } + }, + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "Null, or the token from a previous call to get the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.resiliencehub#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.
The token for the next set of results, or null if there are no more results.
" + } + }, + "recommendationTemplates": { + "target": "com.amazonaws.resiliencehub#RecommendationTemplateList", + "traits": { + "smithy.api#documentation": "The recommendation templates for the Resilience Hub applications.
" + } + } + } + }, + "com.amazonaws.resiliencehub#ListResiliencyPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#ListResiliencyPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#ListResiliencyPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the resiliency policies for the Resilience Hub applications.
", + "smithy.api#http": { + "method": "GET", + "uri": "/list-resiliency-policies", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.resiliencehub#ListResiliencyPoliciesRequest": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.resiliencehub#EntityName", + "traits": { + "smithy.api#documentation": "The name of the policy
", + "smithy.api#httpQuery": "policyName" + } + }, + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "Null, or the token from a previous call to get the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.resiliencehub#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.
The resiliency policies for the Resilience Hub applications.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" + } + } + } + }, + "com.amazonaws.resiliencehub#ListSopRecommendations": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#ListSopRecommendationsRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#ListSopRecommendationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the standard operating procedure (SOP) recommendations for the Resilience Hub\n applications.
", + "smithy.api#http": { + "method": "POST", + "uri": "/list-sop-recommendations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken" + } + } + }, + "com.amazonaws.resiliencehub#ListSopRecommendationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "Null, or the token from a previous call to get the next set of results.
" + } + }, + "maxResults": { + "target": "com.amazonaws.resiliencehub#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The token for the next set of results, or null if there are no more results.
" + } + }, + "sopRecommendations": { + "target": "com.amazonaws.resiliencehub#SopRecommendationList", + "traits": { + "smithy.api#documentation": "The standard operating procedure (SOP) recommendations for the Resilience Hub\n applications.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#ListSuggestedResiliencyPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#ListSuggestedResiliencyPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#ListSuggestedResiliencyPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the suggested resiliency policies for the Resilience Hub applications.
", + "smithy.api#http": { + "method": "GET", + "uri": "/list-suggested-resiliency-policies", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.resiliencehub#ListSuggestedResiliencyPoliciesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "Null, or the token from a previous call to get the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.resiliencehub#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.
The suggested resiliency policies for the Resilience Hub applications.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" + } + } + } + }, + "com.amazonaws.resiliencehub#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the tags for your resources in your Resilience Hub applications.
", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.resiliencehub#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for a specific resource in your Resilience Hub\n application.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.resiliencehub#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.
" + } + } + } + }, + "com.amazonaws.resiliencehub#ListTestRecommendations": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#ListTestRecommendationsRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#ListTestRecommendationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the test recommendations for the Resilience Hub application.
", + "smithy.api#http": { + "method": "POST", + "uri": "/list-test-recommendations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken" + } + } + }, + "com.amazonaws.resiliencehub#ListTestRecommendationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "Null, or the token from a previous call to get the next set of results.
" + } + }, + "maxResults": { + "target": "com.amazonaws.resiliencehub#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The token for the next set of results, or null if there are no more results.
" + } + }, + "testRecommendations": { + "target": "com.amazonaws.resiliencehub#TestRecommendationList", + "traits": { + "smithy.api#documentation": "The test recommendations for the Resilience Hub application.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#ListUnsupportedAppVersionResources": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#ListUnsupportedAppVersionResourcesRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#ListUnsupportedAppVersionResourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the resources that are not currently supported in AWS Resilience Hub. An unsupported\n resource is a resource that exists in the object that was used to create an app, but is not\n supported by Resilience Hub.
", + "smithy.api#http": { + "method": "POST", + "uri": "/list-unsupported-app-version-resources", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken" + } + } + }, + "com.amazonaws.resiliencehub#ListUnsupportedAppVersionResourcesRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The version of the application.
", + "smithy.api#required": {} + } + }, + "resolutionId": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "The identifier for a specific resolution.
" + } + }, + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "Null, or the token from a previous call to get the next set of results.
" + } + }, + "maxResults": { + "target": "com.amazonaws.resiliencehub#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.
The unsupported resources for the application.
", + "smithy.api#required": {} + } + }, + "resolutionId": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "The identifier for a specific resolution.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" + } + } + } + }, + "com.amazonaws.resiliencehub#LogicalResourceId": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "The identifier of the resource.
", + "smithy.api#required": {} + } + }, + "logicalStackName": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "The name of the CloudFormation stack this resource belongs to.
" + } + }, + "resourceGroupName": { + "target": "com.amazonaws.resiliencehub#EntityName", + "traits": { + "smithy.api#documentation": "The name of the resource group that this resource belongs to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a logical resource identifier.
" + } + }, + "com.amazonaws.resiliencehub#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.resiliencehub#NextToken": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\S{1,2000}$" + } + }, + "com.amazonaws.resiliencehub#PhysicalIdentifierType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Arn", + "name": "ARN" + }, + { + "value": "Native", + "name": "NATIVE" + } + ] + } + }, + "com.amazonaws.resiliencehub#PhysicalResource": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.resiliencehub#EntityName", + "traits": { + "smithy.api#documentation": "The name of the resource.
" + } + }, + "logicalResourceId": { + "target": "com.amazonaws.resiliencehub#LogicalResourceId", + "traits": { + "smithy.api#documentation": "The logical identifier of the resource.
", + "smithy.api#required": {} + } + }, + "physicalResourceId": { + "target": "com.amazonaws.resiliencehub#PhysicalResourceId", + "traits": { + "smithy.api#documentation": "The physical identifier of the resource.
", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "The type of resource.
", + "smithy.api#required": {} + } + }, + "appComponents": { + "target": "com.amazonaws.resiliencehub#AppComponentList", + "traits": { + "smithy.api#documentation": "The application components that belong to this resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a physical resource. A physical resource is a resource that exists in your\n account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native\n identifier.
" + } + }, + "com.amazonaws.resiliencehub#PhysicalResourceId": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "The identifier of the physical resource.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.resiliencehub#PhysicalIdentifierType", + "traits": { + "smithy.api#documentation": "Specifies the type of physical resource identifier.
\nThe resource identifier is an Amazon Resource Name (ARN) .
\nThe resource identifier is a Resilience Hub-native identifier.
\nThe Amazon Web Services Region that the physical resource is located in.
" + } + }, + "awsAccountId": { + "target": "com.amazonaws.resiliencehub#CustomerId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account that owns the physical resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a physical resource identifier.
" + } + }, + "com.amazonaws.resiliencehub#PhysicalResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#PhysicalResource" + } + }, + "com.amazonaws.resiliencehub#PublishAppVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#PublishAppVersionRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#PublishAppVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Publishes a new version of a specific Resilience Hub application.
", + "smithy.api#http": { + "method": "POST", + "uri": "/publish-app-version", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#PublishAppVersionRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The version of the application.
" + } + } + } + }, + "com.amazonaws.resiliencehub#PutDraftAppVersionTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#PutDraftAppVersionTemplateRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#PutDraftAppVersionTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Adds or updates the app template for a draft version of a Resilience Hub app.
", + "smithy.api#http": { + "method": "POST", + "uri": "/put-draft-app-version-template", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#PutDraftAppVersionTemplateRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
A JSON string that contains the body of the app template.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#PutDraftAppVersionTemplateResponse": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The version of the application.
" + } + } + } + }, + "com.amazonaws.resiliencehub#RecommendationCompliance": { + "type": "map", + "key": { + "target": "com.amazonaws.resiliencehub#DisruptionType" + }, + "value": { + "target": "com.amazonaws.resiliencehub#RecommendationDisruptionCompliance" + } + }, + "com.amazonaws.resiliencehub#RecommendationComplianceStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "BreachedUnattainable", + "name": "BREACHED_UNATTAINABLE" + }, + { + "value": "BreachedCanMeet", + "name": "BREACHED_CAN_MEET" + }, + { + "value": "MetCanImprove", + "name": "MET_CAN_IMPROVE" + } + ] + } + }, + "com.amazonaws.resiliencehub#RecommendationDisruptionCompliance": { + "type": "structure", + "members": { + "expectedComplianceStatus": { + "target": "com.amazonaws.resiliencehub#ComplianceStatus", + "traits": { + "smithy.api#documentation": "The expected compliance status after applying the recommended configuration change.
", + "smithy.api#required": {} + } + }, + "expectedRtoInSecs": { + "target": "com.amazonaws.resiliencehub#Seconds", + "traits": { + "smithy.api#documentation": "The expected RTO after applying the recommended configuration change.
" + } + }, + "expectedRtoDescription": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "The expected Recovery Time Objective (RTO) description after applying the recommended\n configuration change.
" + } + }, + "expectedRpoInSecs": { + "target": "com.amazonaws.resiliencehub#Seconds", + "traits": { + "smithy.api#documentation": "The expected RPO after applying the recommended configuration change.
" + } + }, + "expectedRpoDescription": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "The expected Recovery Point Objective (RPO) description after applying the recommended\n configuration change.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a disruption compliance recommendation.
" + } + }, + "com.amazonaws.resiliencehub#RecommendationIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#Uuid" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.resiliencehub#RecommendationItem": { + "type": "structure", + "members": { + "resourceId": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "The resource identifier.
" + } + }, + "targetAccountId": { + "target": "com.amazonaws.resiliencehub#CustomerId", + "traits": { + "smithy.api#documentation": "The target account identifier.
" + } + }, + "targetRegion": { + "target": "com.amazonaws.resiliencehub#AwsRegion", + "traits": { + "smithy.api#documentation": "The target region.
" + } + }, + "alreadyImplemented": { + "target": "com.amazonaws.resiliencehub#BooleanOptional", + "traits": { + "smithy.api#documentation": "Specifies if the recommendation has already been implemented.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a recommendation.
" + } + }, + "com.amazonaws.resiliencehub#RecommendationItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#RecommendationItem" + } + }, + "com.amazonaws.resiliencehub#RecommendationTemplate": { + "type": "structure", + "members": { + "templatesLocation": { + "target": "com.amazonaws.resiliencehub#S3Location", + "traits": { + "smithy.api#documentation": "The file location of the template.
" + } + }, + "assessmentArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
Identifiers for the recommendations used in the recommendation template.
" + } + }, + "recommendationTypes": { + "target": "com.amazonaws.resiliencehub#RenderRecommendationTypeList", + "traits": { + "smithy.api#documentation": "An array of strings that specify the recommendation template type or types.
\nThe template is an AlarmRecommendation template.
\nThe template is a SopRecommendation template.
\nThe template is a TestRecommendation template.
\nThe format of the recommendation template.
\nThe template is CloudFormation JSON.
\nThe template is CloudFormation YAML.
\nThe Amazon Resource Name (ARN) for the recommendation template.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "The message for the recommendation template.
" + } + }, + "status": { + "target": "com.amazonaws.resiliencehub#RecommendationTemplateStatus", + "traits": { + "smithy.api#documentation": "The status of the action.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.resiliencehub#EntityName", + "traits": { + "smithy.api#documentation": "The name for the recommendation template.
", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.resiliencehub#TimeStamp", + "traits": { + "smithy.api#documentation": "The start time for the action.
" + } + }, + "endTime": { + "target": "com.amazonaws.resiliencehub#TimeStamp", + "traits": { + "smithy.api#documentation": "The end time for the action.
" + } + }, + "tags": { + "target": "com.amazonaws.resiliencehub#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.
" + } + }, + "needsReplacements": { + "target": "com.amazonaws.resiliencehub#BooleanOptional", + "traits": { + "smithy.api#documentation": "Indicates if replacements are needed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a recommendation template created with the CreateRecommendationTemplate action.
" + } + }, + "com.amazonaws.resiliencehub#RecommendationTemplateList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#RecommendationTemplate" + } + }, + "com.amazonaws.resiliencehub#RecommendationTemplateStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Pending", + "name": "PENDING" + }, + { + "value": "InProgress", + "name": "IN_PROGRESS" + }, + { + "value": "Failed", + "name": "FAILED" + }, + { + "value": "Success", + "name": "SUCCESS" + } + ] + } + }, + "com.amazonaws.resiliencehub#RecommendationTemplateStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#RecommendationTemplateStatus" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4 + } + } + }, + "com.amazonaws.resiliencehub#RemoveDraftAppVersionResourceMappings": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#RemoveDraftAppVersionResourceMappingsRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#RemoveDraftAppVersionResourceMappingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes resource mappings from a draft application version.
", + "smithy.api#http": { + "method": "POST", + "uri": "/remove-draft-app-version-resource-mappings", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#RemoveDraftAppVersionResourceMappingsRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The names of the resources to remove from the resource mappings.
" + } + }, + "logicalStackNames": { + "target": "com.amazonaws.resiliencehub#String255List", + "traits": { + "smithy.api#documentation": "The names of the CloudFormation stacks to remove from the resource mappings.
" + } + }, + "appRegistryAppNames": { + "target": "com.amazonaws.resiliencehub#EntityNameList", + "traits": { + "smithy.api#documentation": "The names of the registered applications to remove from the resource mappings.
" + } + }, + "resourceGroupNames": { + "target": "com.amazonaws.resiliencehub#EntityNameList", + "traits": { + "smithy.api#documentation": "The names of the resource groups to remove from the resource mappings.
" + } + } + } + }, + "com.amazonaws.resiliencehub#RemoveDraftAppVersionResourceMappingsResponse": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The version of the application.
" + } + } + } + }, + "com.amazonaws.resiliencehub#RenderRecommendationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Alarm", + "name": "ALARM" + }, + { + "value": "Sop", + "name": "SOP" + }, + { + "value": "Test", + "name": "TEST" + } + ] + } + }, + "com.amazonaws.resiliencehub#RenderRecommendationTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#RenderRecommendationType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4 + } + } + }, + "com.amazonaws.resiliencehub#ResiliencyPolicies": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#ResiliencyPolicy" + } + }, + "com.amazonaws.resiliencehub#ResiliencyPolicy": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:dcps:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The name of the policy
" + } + }, + "policyDescription": { + "target": "com.amazonaws.resiliencehub#EntityDescription", + "traits": { + "smithy.api#documentation": "The description for the policy.
" + } + }, + "dataLocationConstraint": { + "target": "com.amazonaws.resiliencehub#DataLocationConstraint", + "traits": { + "smithy.api#documentation": "Specifies a high-level geographical location constraint for where your resilience policy\n data can be stored.
" + } + }, + "tier": { + "target": "com.amazonaws.resiliencehub#ResiliencyPolicyTier", + "traits": { + "smithy.api#documentation": "The tier for this resiliency policy, ranging from the highest severity\n (MissionCritical) to lowest (NonCritical).
Specifies the estimated cost tier of the resiliency policy.
" + } + }, + "policy": { + "target": "com.amazonaws.resiliencehub#DisruptionPolicy", + "traits": { + "smithy.api#documentation": "The resiliency policy.
" + } + }, + "creationTime": { + "target": "com.amazonaws.resiliencehub#TimeStamp", + "traits": { + "smithy.api#documentation": "The timestamp for when the resiliency policy was created.
" + } + }, + "tags": { + "target": "com.amazonaws.resiliencehub#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a resiliency policy.
" + } + }, + "com.amazonaws.resiliencehub#ResiliencyPolicyTier": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MissionCritical", + "name": "MISSION_CRITICAL" + }, + { + "value": "Critical", + "name": "CRITICAL" + }, + { + "value": "Important", + "name": "IMPORTANT" + }, + { + "value": "CoreServices", + "name": "CORE_SERVICES" + }, + { + "value": "NonCritical", + "name": "NON_CRITICAL" + } + ] + } + }, + "com.amazonaws.resiliencehub#ResiliencyScore": { + "type": "structure", + "members": { + "score": { + "target": "com.amazonaws.resiliencehub#Double", + "traits": { + "smithy.api#documentation": "The outage score for a valid key.
", + "smithy.api#required": {} + } + }, + "disruptionScore": { + "target": "com.amazonaws.resiliencehub#DisruptionResiliencyScore", + "traits": { + "smithy.api#documentation": "The disruption score for a valid key.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The overall resiliency score, returned as an object that includes the disruption score and\n outage score.
" + } + }, + "com.amazonaws.resiliencehub#ResolveAppVersionResources": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#ResolveAppVersionResourcesRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#ResolveAppVersionResourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Resolves the resources for an application version.
", + "smithy.api#http": { + "method": "POST", + "uri": "/resolve-app-version-resources", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#ResolveAppVersionResourcesRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The version of the application.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#ResolveAppVersionResourcesResponse": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The version of the application.
", + "smithy.api#required": {} + } + }, + "resolutionId": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "The identifier for a specific resolution.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.resiliencehub#ResourceResolutionStatusType", + "traits": { + "smithy.api#documentation": "The status of the action.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#ResourceId": { + "type": "string", + "traits": { + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.resiliencehub#ResourceImportStatusType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Pending", + "name": "PENDING" + }, + { + "value": "InProgress", + "name": "IN_PROGRESS" + }, + { + "value": "Failed", + "name": "FAILED" + }, + { + "value": "Success", + "name": "SUCCESS" + } + ] + } + }, + "com.amazonaws.resiliencehub#ResourceMapping": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.resiliencehub#EntityName", + "traits": { + "smithy.api#documentation": "The name of the resource this resource is mapped to.
" + } + }, + "logicalStackName": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "The name of the CloudFormation stack this resource is mapped to.
" + } + }, + "appRegistryAppName": { + "target": "com.amazonaws.resiliencehub#EntityName", + "traits": { + "smithy.api#documentation": "The name of the application this resource is mapped to.
" + } + }, + "resourceGroupName": { + "target": "com.amazonaws.resiliencehub#EntityName", + "traits": { + "smithy.api#documentation": "The name of the resource group this resource is mapped to.
" + } + }, + "mappingType": { + "target": "com.amazonaws.resiliencehub#ResourceMappingType", + "traits": { + "smithy.api#documentation": "Specifies the type of resource mapping.
\nThe resource is mapped to another application. The name of the application is\n contained in the appRegistryAppName property.
The resource is mapped to a CloudFormation stack. The name of the CloudFormation stack is contained in\n the logicalStackName property.
The resource is mapped to another resource. The name of the resource is contained in\n the resourceName property.
The resource is mapped to a resource group. The name of the resource group is\n contained in the resourceGroupName property.
The identifier of this resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a resource mapping.
" + } + }, + "com.amazonaws.resiliencehub#ResourceMappingList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#ResourceMapping" + } + }, + "com.amazonaws.resiliencehub#ResourceMappingType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CfnStack", + "name": "CFN_STACK" + }, + { + "value": "Resource", + "name": "RESOURCE" + }, + { + "value": "AppRegistryApp", + "name": "APP_REGISTRY_APP" + }, + { + "value": "ResourceGroup", + "name": "RESOURCE_GROUP" + } + ] + } + }, + "com.amazonaws.resiliencehub#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.resiliencehub#String500" + }, + "resourceId": { + "target": "com.amazonaws.resiliencehub#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier of the resource that the exception applies to.
" + } + }, + "resourceType": { + "target": "com.amazonaws.resiliencehub#ResourceType", + "traits": { + "smithy.api#documentation": "The type of the resource that the exception applies to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified resource could not be found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.resiliencehub#ResourceResolutionStatusType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Pending", + "name": "PENDING" + }, + { + "value": "InProgress", + "name": "IN_PROGRESS" + }, + { + "value": "Failed", + "name": "FAILED" + }, + { + "value": "Success", + "name": "SUCCESS" + } + ] + } + }, + "com.amazonaws.resiliencehub#ResourceType": { + "type": "string", + "traits": { + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.resiliencehub#RetryAfterSeconds": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.resiliencehub#S3Location": { + "type": "structure", + "members": { + "bucket": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "The name of the Amazon S3 bucket.
" + } + }, + "prefix": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "The prefix for the Amazon S3 bucket.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The location of the Amazon S3 bucket.
" + } + }, + "com.amazonaws.resiliencehub#Seconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.resiliencehub#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.resiliencehub#String500" + } + }, + "traits": { + "smithy.api#documentation": "You have exceeded your service quota. To perform the requested action, remove some of the\n relevant resources, or use Service Quotas to request a service quota increase.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.resiliencehub#SopRecommendation": { + "type": "structure", + "members": { + "serviceType": { + "target": "com.amazonaws.resiliencehub#SopServiceType", + "traits": { + "smithy.api#documentation": "The service type.
", + "smithy.api#required": {} + } + }, + "appComponentName": { + "target": "com.amazonaws.resiliencehub#EntityId", + "traits": { + "smithy.api#documentation": "The application component name.
" + } + }, + "description": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "The description of the SOP recommendation.
" + } + }, + "recommendationId": { + "target": "com.amazonaws.resiliencehub#Uuid", + "traits": { + "smithy.api#documentation": "Identifier for the SOP recommendation.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.resiliencehub#DocumentName", + "traits": { + "smithy.api#documentation": "The name of the SOP recommendation.
" + } + }, + "items": { + "target": "com.amazonaws.resiliencehub#RecommendationItemList", + "traits": { + "smithy.api#documentation": "The recommendation items.
" + } + }, + "referenceId": { + "target": "com.amazonaws.resiliencehub#SpecReferenceId", + "traits": { + "smithy.api#documentation": "The reference identifier for the SOP recommendation.
", + "smithy.api#required": {} + } + }, + "prerequisite": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "The prerequisite for the SOP recommendation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a standard operating procedure (SOP) recommendation.
" + } + }, + "com.amazonaws.resiliencehub#SopRecommendationList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#SopRecommendation" + } + }, + "com.amazonaws.resiliencehub#SopServiceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SSM", + "name": "SSM" + } + ] + } + }, + "com.amazonaws.resiliencehub#SpecReferenceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.resiliencehub#StartAppAssessment": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#StartAppAssessmentRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#StartAppAssessmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new application assessment for an application.
", + "smithy.api#http": { + "method": "POST", + "uri": "/start-app-assessment", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#StartAppAssessmentRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The version of the application.
", + "smithy.api#required": {} + } + }, + "assessmentName": { + "target": "com.amazonaws.resiliencehub#EntityName", + "traits": { + "smithy.api#documentation": "The name for the assessment.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.resiliencehub#ClientToken", + "traits": { + "smithy.api#documentation": "Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. \nYou should not reuse the same client token for other API requests.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.resiliencehub#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.
" + } + } + } + }, + "com.amazonaws.resiliencehub#StartAppAssessmentResponse": { + "type": "structure", + "members": { + "assessment": { + "target": "com.amazonaws.resiliencehub#AppAssessment", + "traits": { + "smithy.api#documentation": "The assessment created.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#String255": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.resiliencehub#String255List": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#String255" + } + }, + "com.amazonaws.resiliencehub#String500": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.resiliencehub#SuggestedChangesList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#EntityDescription" + } + }, + "com.amazonaws.resiliencehub#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:).+$" + } + }, + "com.amazonaws.resiliencehub#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.resiliencehub#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.resiliencehub#TagKey" + }, + "value": { + "target": "com.amazonaws.resiliencehub#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.resiliencehub#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Applies one or more tags to a resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.resiliencehub#TagMap", + "traits": { + "smithy.api#documentation": "The tags to assign to the resource. Each tag consists of a key/value pair.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.resiliencehub#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.resiliencehub#TemplateFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CfnYaml", + "name": "CFN_YAML" + }, + { + "value": "CfnJson", + "name": "CFN_JSON" + } + ] + } + }, + "com.amazonaws.resiliencehub#TestRecommendation": { + "type": "structure", + "members": { + "recommendationId": { + "target": "com.amazonaws.resiliencehub#Uuid", + "traits": { + "smithy.api#documentation": "Identifier for the test recommendation.
" + } + }, + "referenceId": { + "target": "com.amazonaws.resiliencehub#SpecReferenceId", + "traits": { + "smithy.api#documentation": "The reference identifier for the test recommendation.
", + "smithy.api#required": {} + } + }, + "appComponentName": { + "target": "com.amazonaws.resiliencehub#EntityId", + "traits": { + "smithy.api#documentation": "The name of the application component.
" + } + }, + "name": { + "target": "com.amazonaws.resiliencehub#DocumentName", + "traits": { + "smithy.api#documentation": "The name of the test recommendation.
" + } + }, + "intent": { + "target": "com.amazonaws.resiliencehub#EntityDescription", + "traits": { + "smithy.api#documentation": "The intent of the test recommendation.
" + } + }, + "risk": { + "target": "com.amazonaws.resiliencehub#TestRisk", + "traits": { + "smithy.api#documentation": "The level of risk for this test recommendation.
" + } + }, + "type": { + "target": "com.amazonaws.resiliencehub#TestType", + "traits": { + "smithy.api#documentation": "The type of test recommendation.
" + } + }, + "description": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "The description for the test recommendation.
" + } + }, + "items": { + "target": "com.amazonaws.resiliencehub#RecommendationItemList", + "traits": { + "smithy.api#documentation": "The test recommendation items.
" + } + }, + "prerequisite": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "The prerequisite of the test recommendation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a test recommendation.
" + } + }, + "com.amazonaws.resiliencehub#TestRecommendationList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#TestRecommendation" + } + }, + "com.amazonaws.resiliencehub#TestRisk": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Small", + "name": "SMALL" + }, + { + "value": "Medium", + "name": "MEDIUM" + }, + { + "value": "High", + "name": "HIGH" + } + ] + } + }, + "com.amazonaws.resiliencehub#TestType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Software", + "name": "SOFTWARE" + }, + { + "value": "Hardware", + "name": "HARDWARE" + }, + { + "value": "AZ", + "name": "AZ" + }, + { + "value": "Region", + "name": "REGION" + } + ] + } + }, + "com.amazonaws.resiliencehub#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.resiliencehub#String500" + }, + "retryAfterSeconds": { + "target": "com.amazonaws.resiliencehub#RetryAfterSeconds", + "traits": { + "smithy.api#documentation": "The number of seconds to wait before retrying the operation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The limit on the number of requests per second was exceeded.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.resiliencehub#TimeStamp": { + "type": "timestamp" + }, + "com.amazonaws.resiliencehub#UnsupportedResource": { + "type": "structure", + "members": { + "logicalResourceId": { + "target": "com.amazonaws.resiliencehub#LogicalResourceId", + "traits": { + "smithy.api#documentation": "The logical resource identifier for the unsupported resource.
", + "smithy.api#required": {} + } + }, + "physicalResourceId": { + "target": "com.amazonaws.resiliencehub#PhysicalResourceId", + "traits": { + "smithy.api#documentation": "The physical resource identifier for the unsupported resource.
", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "The type of resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a resource that is not supported by Resilience Hub.
" + } + }, + "com.amazonaws.resiliencehub#UnsupportedResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#UnsupportedResource" + } + }, + "com.amazonaws.resiliencehub#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes one or more tags from a resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.resiliencehub#TagKeyList", + "traits": { + "smithy.api#documentation": "The keys of the tags to remove.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.resiliencehub#UpdateApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#UpdateAppRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#UpdateAppResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an application.
", + "smithy.api#http": { + "method": "POST", + "uri": "/update-app", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#UpdateAppRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition:dcps:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The optional description for an app.
" + } + }, + "policyArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:dcps:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
Specifies if the resiliency policy ARN should be cleared.
" + } + } + } + }, + "com.amazonaws.resiliencehub#UpdateAppResponse": { + "type": "structure", + "members": { + "app": { + "target": "com.amazonaws.resiliencehub#App", + "traits": { + "smithy.api#documentation": "The specified application, returned as an object with details including compliance status,\n creation time, description, resiliency score, and more.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#UpdateResiliencyPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#UpdateResiliencyPolicyRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#UpdateResiliencyPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#ConflictException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a resiliency policy.
", + "smithy.api#http": { + "method": "POST", + "uri": "/update-resiliency-policy", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#UpdateResiliencyPolicyRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:dcps:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The name of the policy
" + } + }, + "policyDescription": { + "target": "com.amazonaws.resiliencehub#EntityDescription", + "traits": { + "smithy.api#documentation": "The description for the policy.
" + } + }, + "dataLocationConstraint": { + "target": "com.amazonaws.resiliencehub#DataLocationConstraint", + "traits": { + "smithy.api#documentation": "Specifies a high-level geographical location constraint for where your resilience policy\n data can be stored.
" + } + }, + "tier": { + "target": "com.amazonaws.resiliencehub#ResiliencyPolicyTier", + "traits": { + "smithy.api#documentation": "The tier for this resiliency policy, ranging from the highest severity\n (MissionCritical) to lowest (NonCritical).
The type of resiliency policy to be created, including the recovery time objective (RTO)\n and recovery point objective (RPO) in seconds.
" + } + } + } + }, + "com.amazonaws.resiliencehub#UpdateResiliencyPolicyResponse": { + "type": "structure", + "members": { + "policy": { + "target": "com.amazonaws.resiliencehub#ResiliencyPolicy", + "traits": { + "smithy.api#documentation": "The type of resiliency policy that was updated, including the recovery time objective\n (RTO) and recovery point objective (RPO) in seconds.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.resiliencehub#Uuid": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$" + } + }, + "com.amazonaws.resiliencehub#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.resiliencehub#String500" + } + }, + "traits": { + "smithy.api#documentation": "Indicates that a request was not valid.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + } + } +} diff --git a/aws/sdk/aws-models/rum.json b/aws/sdk/aws-models/rum.json new file mode 100644 index 0000000000000000000000000000000000000000..c7bd49142d35b0258985c764049b9cfe27afa4cb --- /dev/null +++ b/aws/sdk/aws-models/rum.json @@ -0,0 +1,1536 @@ +{ + "smithy": "1.0", + "shapes": { + "com.amazonaws.rum#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "You don't have sufficient permissions to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.rum#AppMonitor": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rum#AppMonitorName", + "traits": { + "smithy.api#documentation": "The name of the app monitor.
" + } + }, + "Domain": { + "target": "com.amazonaws.rum#AppMonitorDomain", + "traits": { + "smithy.api#documentation": "The top-level internet domain name for which your application has administrative authority.
" + } + }, + "Id": { + "target": "com.amazonaws.rum#AppMonitorId", + "traits": { + "smithy.api#documentation": "The unique ID of this app monitor.
" + } + }, + "Created": { + "target": "com.amazonaws.rum#ISOTimestampString", + "traits": { + "smithy.api#documentation": "The date and time that this app monitor was created.
" + } + }, + "LastModified": { + "target": "com.amazonaws.rum#ISOTimestampString", + "traits": { + "smithy.api#documentation": "The date and time of the most recent changes to this app monitor's configuration.
" + } + }, + "Tags": { + "target": "com.amazonaws.rum#TagMap", + "traits": { + "smithy.api#documentation": "The list of tag keys and values associated with this app monitor.
" + } + }, + "State": { + "target": "com.amazonaws.rum#StateEnum", + "traits": { + "smithy.api#documentation": "The current state of the app monitor.
" + } + }, + "AppMonitorConfiguration": { + "target": "com.amazonaws.rum#AppMonitorConfiguration", + "traits": { + "smithy.api#documentation": "A structure that contains much of the configuration data for the app monitor.
" + } + }, + "DataStorage": { + "target": "com.amazonaws.rum#DataStorage", + "traits": { + "smithy.api#documentation": "A structure that contains information about whether this app monitor stores a copy of\n the telemetry data that RUM collects using CloudWatch Logs.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A RUM app monitor collects telemetry data from your application and sends that\n data to RUM. The data includes performance and reliability information such as page load time, client-side errors, \n and user behavior.
" + } + }, + "com.amazonaws.rum#AppMonitorConfiguration": { + "type": "structure", + "members": { + "IdentityPoolId": { + "target": "com.amazonaws.rum#IdentityPoolId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Cognito identity pool \n that is used to authorize the sending of data to RUM.
" + } + }, + "ExcludedPages": { + "target": "com.amazonaws.rum#Pages", + "traits": { + "smithy.api#documentation": "A list of URLs in your website or application to exclude from RUM data collection.
\nYou can't include both ExcludedPages and IncludedPages in the same operation.
If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.
\n \nYou can't include both ExcludedPages and IncludedPages in the same operation.
A list of pages in the CloudWatch RUM console that are to be displayed with a \"favorite\" icon.
" + } + }, + "SessionSampleRate": { + "target": "com.amazonaws.rum#SessionSampleRate", + "traits": { + "smithy.api#documentation": "Specifies the percentage of user sessions to use for RUM data collection. Choosing a higher percentage gives you\n more data but also incurs more costs.
\nThe number you specify is the percentage of user sessions that will be used.
\nIf you omit this parameter, the default of 10 is used.
" + } + }, + "GuestRoleArn": { + "target": "com.amazonaws.rum#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool \n that is used to authorize the sending of data to RUM.
" + } + }, + "AllowCookies": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "If you set this to true, the RUM web client sets two cookies, a session\n cookie and a user cookie. The cookies allow the RUM web client to collect data relating to\n the number of users an application has and the behavior of the application across a\n sequence of events. Cookies are stored in the top-level domain of the current page.
An array that lists the types of telemetry data that this app monitor is to collect.
\n\n errors indicates that RUM collects data about unhandled JavaScript errors raised\n by your application.
\n performance indicates that RUM collects performance data about how your application\n and its resources are loaded and rendered. This includes Core Web Vitals.
\n http indicates that RUM collects data about HTTP errors thrown by your application.
If you set this to true, RUM enables X-Ray tracing for\n the user sessions that RUM samples. RUM adds an X-Ray trace header to allowed\n HTTP requests. It also records an X-Ray segment for allowed HTTP requests.\n You can see traces and segments from these user sessions in the X-Ray console\n and the CloudWatch ServiceLens console. For more information, see What is X-Ray?\n
This structure contains much of the configuration data for the app monitor.
" + } + }, + "com.amazonaws.rum#AppMonitorDetails": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the app monitor.
" + } + }, + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique ID of the app monitor.
" + } + }, + "version": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The version of the app monitor.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains information about the RUM app monitor.
" + } + }, + "com.amazonaws.rum#AppMonitorDomain": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 253 + }, + "smithy.api#pattern": "^(localhost)|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?![-.])([A-Za-z0-9-\\.\\-]{0,63})((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))\\.(?![-])[A-Za-z-0-9]{1,63}((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))|^(\\*\\.)(?![-.])([A-Za-z0-9-\\.\\-]{0,63})((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))\\.(?![-])[A-Za-z-0-9]{1,63}((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))" + } + }, + "com.amazonaws.rum#AppMonitorId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" + } + }, + "com.amazonaws.rum#AppMonitorName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^(?!\\.)[\\.\\-_#A-Za-z0-9]+$" + } + }, + "com.amazonaws.rum#AppMonitorResource": { + "type": "resource", + "identifiers": { + "Name": { + "target": "com.amazonaws.rum#AppMonitorName" + } + }, + "read": { + "target": "com.amazonaws.rum#GetAppMonitor" + }, + "update": { + "target": "com.amazonaws.rum#UpdateAppMonitor" + }, + "delete": { + "target": "com.amazonaws.rum#DeleteAppMonitor" + }, + "list": { + "target": "com.amazonaws.rum#ListAppMonitors" + }, + "operations": [ + { + "target": "com.amazonaws.rum#CreateAppMonitor" + }, + { + "target": "com.amazonaws.rum#GetAppMonitorData" + } + ], + "traits": { + "aws.api#arn": { + "template": "appmonitor/{Name}", + "absolute": false, + "noAccount": false, + "noRegion": false + } + } + }, + "com.amazonaws.rum#AppMonitorSummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rum#AppMonitorName", + "traits": { + "smithy.api#documentation": "The name of this app monitor.
" + } + }, + "Id": { + "target": "com.amazonaws.rum#AppMonitorId", + "traits": { + "smithy.api#documentation": "The unique ID of this app monitor.
" + } + }, + "Created": { + "target": "com.amazonaws.rum#ISOTimestampString", + "traits": { + "smithy.api#documentation": "The date and time that the app monitor was created.
" + } + }, + "LastModified": { + "target": "com.amazonaws.rum#ISOTimestampString", + "traits": { + "smithy.api#documentation": "The date and time of the most recent changes to this app monitor's configuration.
" + } + }, + "State": { + "target": "com.amazonaws.rum#StateEnum", + "traits": { + "smithy.api#documentation": "The current state of this app monitor.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that includes some data about app monitors and their settings.
" + } + }, + "com.amazonaws.rum#AppMonitorSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.rum#AppMonitorSummary" + } + }, + "com.amazonaws.rum#Arn": { + "type": "string", + "traits": { + "smithy.api#pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:.*" + } + }, + "com.amazonaws.rum#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the resource that is associated with the error.
", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of the resource that is associated with the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This operation attempted to create a resource that already exists.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.rum#CreateAppMonitor": { + "type": "operation", + "input": { + "target": "com.amazonaws.rum#CreateAppMonitorRequest" + }, + "output": { + "target": "com.amazonaws.rum#CreateAppMonitorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rum#AccessDeniedException" + }, + { + "target": "com.amazonaws.rum#ConflictException" + }, + { + "target": "com.amazonaws.rum#InternalServerException" + }, + { + "target": "com.amazonaws.rum#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.rum#ThrottlingException" + }, + { + "target": "com.amazonaws.rum#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that\n data to RUM. The data includes performance and reliability information such as page load time, client-side errors, \n and user behavior.
\nYou use this operation only to create a new app monitor. To update an existing app monitor, use UpdateAppMonitor instead.
\nAfter you create an app monitor, sign in to the CloudWatch RUM console to get \n the JavaScript code snippet to add to your web application. For more information, see\n How do I find a code snippet\n that I've already generated?\n
", + "smithy.api#externalDocumentation": { + "API Reference": "https://docs.aws.amazon.com/rum/latest/developerguide/CreateAppMonitor.html" + }, + "smithy.api#http": { + "method": "POST", + "uri": "/appmonitor", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.rum#CreateAppMonitorRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rum#AppMonitorName", + "traits": { + "smithy.api#documentation": "A name for the app monitor.
", + "smithy.api#required": {} + } + }, + "Domain": { + "target": "com.amazonaws.rum#AppMonitorDomain", + "traits": { + "smithy.api#documentation": "The top-level internet domain name for which your application has administrative authority.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rum#TagMap", + "traits": { + "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the app monitor.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.
\nTags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
\n \nYou can associate as many as 50 tags with an app monitor.
\nFor more information, see Tagging Amazon Web Services resources.
" + } + }, + "AppMonitorConfiguration": { + "target": "com.amazonaws.rum#AppMonitorConfiguration", + "traits": { + "smithy.api#documentation": "A structure that contains much of the configuration data for the app monitor. If you are using \n Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the \n Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration, you must set up your own \n authorization method. For more information, see \n Authorize your application\n to send data to Amazon Web Services.
If you omit this argument, the sample rate used for RUM is set to 10% of the user sessions.
" + } + }, + "CwLogEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM \n sends a copy of this telemetry data to Amazon CloudWatch Logs\n in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur\n Amazon CloudWatch Logs charges.
\nIf you omit this parameter, the default is false.
The unique ID of the new app monitor.
" + } + } + } + }, + "com.amazonaws.rum#CwLog": { + "type": "structure", + "members": { + "CwLogEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicated whether the app monitor stores copies of the data\n that RUM collects in CloudWatch Logs.
" + } + }, + "CwLogGroup": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the log group where the copies are stored.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains the information about whether the app monitor stores copies of the data\n that RUM collects in CloudWatch Logs. If it does, this structure also contains the name of the log group.
" + } + }, + "com.amazonaws.rum#DataStorage": { + "type": "structure", + "members": { + "CwLog": { + "target": "com.amazonaws.rum#CwLog", + "traits": { + "smithy.api#documentation": "A structure that contains the information about whether the app monitor stores copies of the data\n that RUM collects in CloudWatch Logs. If it does, this structure also contains the name of the log group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains information about whether this app monitor stores a copy of\n the telemetry data that RUM collects using CloudWatch Logs.
" + } + }, + "com.amazonaws.rum#DeleteAppMonitor": { + "type": "operation", + "input": { + "target": "com.amazonaws.rum#DeleteAppMonitorRequest" + }, + "output": { + "target": "com.amazonaws.rum#DeleteAppMonitorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rum#AccessDeniedException" + }, + { + "target": "com.amazonaws.rum#ConflictException" + }, + { + "target": "com.amazonaws.rum#InternalServerException" + }, + { + "target": "com.amazonaws.rum#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rum#ThrottlingException" + }, + { + "target": "com.amazonaws.rum#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an existing app monitor. This immediately stops the collection of data.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/appmonitor/{Name}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.rum#DeleteAppMonitorRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rum#AppMonitorName", + "traits": { + "smithy.api#documentation": "The name of the app monitor to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.rum#DeleteAppMonitorResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.rum#EventData": { + "type": "string" + }, + "com.amazonaws.rum#EventDataList": { + "type": "list", + "member": { + "target": "com.amazonaws.rum#EventData" + } + }, + "com.amazonaws.rum#FavoritePages": { + "type": "list", + "member": { + "target": "smithy.api#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.rum#GetAppMonitor": { + "type": "operation", + "input": { + "target": "com.amazonaws.rum#GetAppMonitorRequest" + }, + "output": { + "target": "com.amazonaws.rum#GetAppMonitorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rum#AccessDeniedException" + }, + { + "target": "com.amazonaws.rum#InternalServerException" + }, + { + "target": "com.amazonaws.rum#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rum#ThrottlingException" + }, + { + "target": "com.amazonaws.rum#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the complete configuration information for one app monitor.
", + "smithy.api#http": { + "method": "GET", + "uri": "/appmonitor/{Name}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.rum#GetAppMonitorData": { + "type": "operation", + "input": { + "target": "com.amazonaws.rum#GetAppMonitorDataRequest" + }, + "output": { + "target": "com.amazonaws.rum#GetAppMonitorDataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rum#AccessDeniedException" + }, + { + "target": "com.amazonaws.rum#InternalServerException" + }, + { + "target": "com.amazonaws.rum#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rum#ThrottlingException" + }, + { + "target": "com.amazonaws.rum#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the raw performance events that RUM has collected from your web application,\n so that you can do your own processing or analysis of this data.
", + "smithy.api#http": { + "method": "POST", + "uri": "/appmonitor/{Name}/data", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Events", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.rum#GetAppMonitorDataRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rum#AppMonitorName", + "traits": { + "smithy.api#documentation": "The name of the app monitor that collected the data that you want to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TimeRange": { + "target": "com.amazonaws.rum#TimeRange", + "traits": { + "smithy.api#documentation": "A structure that defines the time range that you want to retrieve results from.
", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.rum#QueryFilters", + "traits": { + "smithy.api#documentation": "An array of structures that you can use to filter the results to those that match one or\n more sets of key-value pairs that you specify.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.rum#MaxQueryResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in one operation.
" + } + }, + "NextToken": { + "target": "com.amazonaws.rum#Token", + "traits": { + "smithy.api#documentation": "Use the token returned by the previous operation to request the next page of results.
" + } + } + } + }, + "com.amazonaws.rum#GetAppMonitorDataResponse": { + "type": "structure", + "members": { + "Events": { + "target": "com.amazonaws.rum#EventDataList", + "traits": { + "smithy.api#documentation": "The events that RUM collected that match your request.
" + } + }, + "NextToken": { + "target": "com.amazonaws.rum#Token", + "traits": { + "smithy.api#documentation": "A token that you can use in a subsequent operation to retrieve the next set of\n results.
" + } + } + } + }, + "com.amazonaws.rum#GetAppMonitorRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rum#AppMonitorName", + "traits": { + "smithy.api#documentation": "The app monitor to retrieve information for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.rum#GetAppMonitorResponse": { + "type": "structure", + "members": { + "AppMonitor": { + "target": "com.amazonaws.rum#AppMonitor", + "traits": { + "smithy.api#documentation": "A structure containing all the configuration information for the app monitor.
" + } + } + } + }, + "com.amazonaws.rum#ISOTimestampString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 19, + "max": 19 + }, + "smithy.api#pattern": "/d{4}-[01]/d-[0-3]/dT[0-2]/d:[0-5]/d:[0-5]/d/./d+([+-][0-2]/d:[0-5]/d|Z)" + } + }, + "com.amazonaws.rum#IdentityPoolId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 55 + }, + "smithy.api#pattern": "[\\w-]+:[0-9a-f-]+" + } + }, + "com.amazonaws.rum#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "retryAfterSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The value of a parameter in the request caused an error.
", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "Internal service exception.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.rum#JsonValue": { + "type": "string", + "traits": { + "smithy.api#mediaType": "application/json" + } + }, + "com.amazonaws.rum#ListAppMonitors": { + "type": "operation", + "input": { + "target": "com.amazonaws.rum#ListAppMonitorsRequest" + }, + "output": { + "target": "com.amazonaws.rum#ListAppMonitorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rum#AccessDeniedException" + }, + { + "target": "com.amazonaws.rum#InternalServerException" + }, + { + "target": "com.amazonaws.rum#ThrottlingException" + }, + { + "target": "com.amazonaws.rum#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of the Amazon CloudWatch RUM app monitors in the account.
", + "smithy.api#http": { + "method": "POST", + "uri": "/appmonitors", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AppMonitorSummaries", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.rum#ListAppMonitorsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in one operation.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Use the token returned by the previous operation to request the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.rum#ListAppMonitorsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A token that you can use in a subsequent operation to retrieve the next set of\n results.
" + } + }, + "AppMonitorSummaries": { + "target": "com.amazonaws.rum#AppMonitorSummaryList", + "traits": { + "smithy.api#documentation": "An array of structures that contain information about the returned app monitors.
" + } + } + } + }, + "com.amazonaws.rum#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.rum#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.rum#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rum#InternalServerException" + }, + { + "target": "com.amazonaws.rum#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rum#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Displays the tags associated with a CloudWatch RUM resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{ResourceArn}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.rum#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.rum#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the resource that you want to see the tags of.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.rum#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.rum#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the resource that you are viewing.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rum#TagMap", + "traits": { + "smithy.api#documentation": "The list of tag keys and values associated with the resource you specified.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.rum#MaxQueryResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.rum#Pages": { + "type": "list", + "member": { + "target": "com.amazonaws.rum#Url" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.rum#PutRumEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.rum#PutRumEventsRequest" + }, + "output": { + "target": "com.amazonaws.rum#PutRumEventsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rum#AccessDeniedException" + }, + { + "target": "com.amazonaws.rum#InternalServerException" + }, + { + "target": "com.amazonaws.rum#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rum#ThrottlingException" + }, + { + "target": "com.amazonaws.rum#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Sends telemetry events about your application performance and user behavior to CloudWatch RUM. The code \n snippet that RUM generates for you to add to your application includes PutRumEvents operations to \n send this data to RUM.
Each PutRumEvents operation can send a batch of events from one user session.
The ID of the app monitor that is sending this data.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BatchId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A unique identifier for this batch of RUM event data.
", + "smithy.api#required": {} + } + }, + "AppMonitorDetails": { + "target": "com.amazonaws.rum#AppMonitorDetails", + "traits": { + "smithy.api#documentation": "A structure that contains information about the app monitor that collected this telemetry information.
", + "smithy.api#required": {} + } + }, + "UserDetails": { + "target": "com.amazonaws.rum#UserDetails", + "traits": { + "smithy.api#documentation": "A structure that contains information about the user session that this batch of events was collected from.
", + "smithy.api#required": {} + } + }, + "RumEvents": { + "target": "com.amazonaws.rum#RumEventList", + "traits": { + "smithy.api#documentation": "An array of structures that contain the telemetry event data.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.rum#PutRumEventsResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.rum#QueryFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rum#QueryFilterKey", + "traits": { + "smithy.api#documentation": "The name of a key to search for. \n The filter returns only the events that match the Name\n and Values that you specify.\n
Valid values for Name are Browser | Device | Country |\n Page | OS | EventType | Invert\n
The values of the Name that are to be be included in the returned results.
A structure that defines a key and values that you can use to filter the results. The\n only performance events that are returned are those that have values matching the ones that\n you specify in one of your QueryFilter structures.
For example, you could specify Browser as the Name\n and specify Chrome,Firefox as the Values to return \n events generated only from those browsers.
Specifying Invert as the Name\n works as a \"not equal to\" filter. For example, specify Invert as the Name\n and specify Chrome as the value to return all events except events from \n user sessions with the Chrome browser.
With Amazon CloudWatch RUM, you can perform real-user monitoring to collect client-side data about \n your web application performance from actual user sessions in real time. The data collected includes page load \n times, client-side errors, and user behavior. When you view this data, you can see it all aggregated together and \n also see breakdowns by the browsers and devices that your customers use.
\n \nYou can use the collected data to quickly identify and debug client-side performance issues. CloudWatch \n RUM helps you visualize anomalies in your application performance and find relevant debugging data such as error \n messages, stack traces, and user sessions. You can also use RUM to \n understand the range of end-user impact including the number of users, geolocations, and browsers used.
", + "smithy.api#title": "CloudWatch RUM" + }, + "version": "2018-05-10", + "operations": [ + { + "target": "com.amazonaws.rum#ListTagsForResource" + }, + { + "target": "com.amazonaws.rum#PutRumEvents" + }, + { + "target": "com.amazonaws.rum#TagResource" + }, + { + "target": "com.amazonaws.rum#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.rum#AppMonitorResource" + } + ] + }, + "com.amazonaws.rum#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the resource that is associated with the error.
", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of the resource that is associated with the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Resource not found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rum#RumEvent": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A unique ID for this event.
", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The exact time that this event occurred.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The JSON schema that denotes the type of event this is, such as a page load or a new session.
", + "smithy.api#required": {} + } + }, + "metadata": { + "target": "com.amazonaws.rum#JsonValue", + "traits": { + "smithy.api#documentation": "Metadata about this event, which contains a JSON serialization of the identity of the user for\n this session. The user information comes from information such as the HTTP user-agent request header\n and document interface.
" + } + }, + "details": { + "target": "com.amazonaws.rum#JsonValue", + "traits": { + "smithy.api#documentation": "A string containing details about the event.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains the information for one performance event that RUM collects from a user session with your\n application.
" + } + }, + "com.amazonaws.rum#RumEventList": { + "type": "list", + "member": { + "target": "com.amazonaws.rum#RumEvent" + } + }, + "com.amazonaws.rum#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "This request exceeds a service quota.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.rum#SessionSampleRate": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.rum#StateEnum": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATED", + "name": "CREATED" + }, + { + "value": "DELETING", + "name": "DELETING" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + } + ] + } + }, + "com.amazonaws.rum#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" + } + }, + "com.amazonaws.rum#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.rum#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.rum#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.rum#TagKey" + }, + "value": { + "target": "com.amazonaws.rum#TagValue" + } + }, + "com.amazonaws.rum#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.rum#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.rum#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rum#InternalServerException" + }, + { + "target": "com.amazonaws.rum#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rum#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource. Currently, \n the only resources that \n can be tagged app monitors.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.
\nTags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
\nYou can use the TagResource action with a resource that already has tags. \n If you specify a new tag key for the resource, \n this tag is appended to the list of tags associated\n with the alarm. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces\n the previous value for that tag.
You can associate as many as 50 tags with a resource.
\nFor more information, see Tagging Amazon Web Services resources.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{ResourceArn}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.rum#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.rum#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the CloudWatch RUM resource that you're adding tags to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rum#TagMap", + "traits": { + "smithy.api#documentation": "The list of key-value pairs to associate with the resource.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.rum#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.rum#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.rum#Telemetries": { + "type": "list", + "member": { + "target": "com.amazonaws.rum#Telemetry" + } + }, + "com.amazonaws.rum#Telemetry": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "errors", + "name": "ERRORS", + "documentation": "Includes JS error event plugin" + }, + { + "value": "performance", + "name": "PERFORMANCE", + "documentation": "Includes navigation, paint, resource and web vital event plugins" + }, + { + "value": "http", + "name": "HTTP", + "documentation": "Includes X-Ray Xhr and X-Ray Fetch plugin" + } + ] + } + }, + "com.amazonaws.rum#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "serviceCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the service that is associated with the error.
" + } + }, + "quotaCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the service quota that was exceeded.
" + } + }, + "retryAfterSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The value of a parameter in the request caused an error.
", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "The request was throttled because of quota limits.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": { + "throttling": true + } + } + }, + "com.amazonaws.rum#TimeRange": { + "type": "structure", + "members": { + "After": { + "target": "com.amazonaws.rum#QueryTimestamp", + "traits": { + "smithy.api#documentation": "The beginning of the time range to retrieve performance events from.
", + "smithy.api#required": {} + } + }, + "Before": { + "target": "com.amazonaws.rum#QueryTimestamp", + "traits": { + "smithy.api#documentation": "The end of the time range to retrieve performance events from. If you omit this, the time \n range extends to the time that this operation is performed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that defines the time range that you want to retrieve results from.
" + } + }, + "com.amazonaws.rum#Token": { + "type": "string" + }, + "com.amazonaws.rum#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.rum#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.rum#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rum#InternalServerException" + }, + { + "target": "com.amazonaws.rum#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rum#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes one or more tags from the specified resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{ResourceArn}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.rum#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.rum#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the CloudWatch RUM resource that you're removing tags from.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.rum#TagKeyList", + "traits": { + "smithy.api#documentation": "The list of tag keys to remove from the resource.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.rum#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.rum#UpdateAppMonitor": { + "type": "operation", + "input": { + "target": "com.amazonaws.rum#UpdateAppMonitorRequest" + }, + "output": { + "target": "com.amazonaws.rum#UpdateAppMonitorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rum#AccessDeniedException" + }, + { + "target": "com.amazonaws.rum#ConflictException" + }, + { + "target": "com.amazonaws.rum#InternalServerException" + }, + { + "target": "com.amazonaws.rum#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rum#ThrottlingException" + }, + { + "target": "com.amazonaws.rum#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the configuration of an existing app monitor. When you use this operation, only the parts of the app monitor\n configuration that you specify in this operation are changed. For any parameters that you omit, the existing\n values are kept.
\nYou can't use this operation to change the tags of an existing app monitor. To change the tags of an existing app monitor, use\n TagResource.
\nTo create a new app monitor, use CreateAppMonitor.
\nAfter you update an app monitor, sign in to the CloudWatch RUM console to get \n the updated JavaScript code snippet to add to your web application. For more information, see\n How do I find a code snippet\n that I've already generated?\n
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/appmonitor/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.rum#UpdateAppMonitorRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rum#AppMonitorName", + "traits": { + "smithy.api#documentation": "The name of the app monitor to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Domain": { + "target": "com.amazonaws.rum#AppMonitorDomain", + "traits": { + "smithy.api#documentation": "The top-level internet domain name for which your application has administrative authority.
" + } + }, + "AppMonitorConfiguration": { + "target": "com.amazonaws.rum#AppMonitorConfiguration", + "traits": { + "smithy.api#documentation": "A structure that contains much of the configuration data for the app monitor. If you are using \n Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the \n Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration, you must set up your own \n authorization method. For more information, see \n Authorize your application\n to send data to Amazon Web Services.
Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM \n sends a copy of this telemetry data to Amazon CloudWatch Logs\n in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur\n Amazon CloudWatch Logs charges.
" + } + } + } + }, + "com.amazonaws.rum#UpdateAppMonitorResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.rum#Url": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1260 + }, + "smithy.api#pattern": "https?:\\/\\/(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b([-a-zA-Z0-9()@:%_\\+.~#?&//=]*)" + } + }, + "com.amazonaws.rum#UserDetails": { + "type": "structure", + "members": { + "userId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the user for this user session. This ID is generated by RUM and does not include any \n personally identifiable information about the user.
" + } + }, + "sessionId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The session ID that the performance events are from.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains information about the user session that this batch of events was collected from.
" + } + }, + "com.amazonaws.rum#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "One of the arguments for the request is not valid.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + } + } +} diff --git a/aws/sdk/aws-models/runtime.lex.v2.json b/aws/sdk/aws-models/runtime.lex.v2.json index fd28f6ce5d7610d47ba56724b0b6733964ee53fe..d06e5f045ae70dd142da971283e18363631c7ecd 100644 --- a/aws/sdk/aws-models/runtime.lex.v2.json +++ b/aws/sdk/aws-models/runtime.lex.v2.json @@ -31,6 +31,21 @@ "shapes": { "com.amazonaws.lexruntimev2#AWSDeepSenseRunTimeServiceApi2_0": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Lex Runtime V2", + "arnNamespace": "lex", + "cloudFormationName": "LexRuntimeV2", + "cloudTrailEventSource": "lexruntimev2.amazonaws.com", + "endpointPrefix": "runtime-v2-lex" + }, + "aws.auth#sigv4": { + "name": "lex" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "", + "smithy.api#title": "Amazon Lex Runtime V2" + }, "version": "2020-08-07", "operations": [ { @@ -51,22 +66,7 @@ { "target": "com.amazonaws.lexruntimev2#StartConversation" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Lex Runtime V2", - "arnNamespace": "lex", - "cloudFormationName": "LexRuntimeV2", - "cloudTrailEventSource": "lexruntimev2.amazonaws.com", - "endpointPrefix": "runtime-v2-lex" - }, - "aws.auth#sigv4": { - "name": "lex" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "", - "smithy.api#title": "Amazon Lex Runtime V2" - } + ] }, "com.amazonaws.lexruntimev2#AccessDeniedException": { "type": "structure", @@ -646,6 +646,12 @@ "traits": { "smithy.api#documentation": "The name of the slot that should be elicited from the user.
" } + }, + "slotElicitationStyle": { + "target": "com.amazonaws.lexruntimev2#StyleType", + "traits": { + "smithy.api#documentation": "Configures the slot to use spell-by-letter or spell-by-word style.\n When you use a style on a slot, users can spell out their input to make\n it clear to your bot.
\nSpell by letter - \"b\" \"o\" \"b\"
\nSpell by word - \"b as in boy\" \"o as in oscar\" \"b as in\n boy\"
\nFor more information, see \n Using spelling to enter slot values .
" + } } }, "traits": { @@ -2090,6 +2096,25 @@ "target": "com.amazonaws.lexruntimev2#String" } }, + "com.amazonaws.lexruntimev2#StyleType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Default", + "name": "DEFAULT" + }, + { + "value": "SpellByLetter", + "name": "SPELL_BY_LETTER" + }, + { + "value": "SpellByWord", + "name": "SPELL_BY_WORD" + } + ] + } + }, "com.amazonaws.lexruntimev2#Text": { "type": "string", "traits": { diff --git a/aws/sdk/aws-models/runtime.sagemaker.json b/aws/sdk/aws-models/runtime.sagemaker.json index 37c333aeafa0ae3c74f7a89626250b15a71edd01..336ace505cc365f103ea151ca11c52a8e18259e3 100644 --- a/aws/sdk/aws-models/runtime.sagemaker.json +++ b/aws/sdk/aws-models/runtime.sagemaker.json @@ -31,15 +31,6 @@ "shapes": { "com.amazonaws.sagemakerruntime#AmazonSageMakerRuntime": { "type": "service", - "version": "2017-05-13", - "operations": [ - { - "target": "com.amazonaws.sagemakerruntime#InvokeEndpoint" - }, - { - "target": "com.amazonaws.sagemakerruntime#InvokeEndpointAsync" - } - ], "traits": { "aws.api#service": { "sdkId": "SageMaker Runtime", @@ -54,7 +45,16 @@ "aws.protocols#restJson1": {}, "smithy.api#documentation": "The Amazon SageMaker runtime API.
", "smithy.api#title": "Amazon SageMaker Runtime" - } + }, + "version": "2017-05-13", + "operations": [ + { + "target": "com.amazonaws.sagemakerruntime#InvokeEndpoint" + }, + { + "target": "com.amazonaws.sagemakerruntime#InvokeEndpointAsync" + } + ] }, "com.amazonaws.sagemakerruntime#BodyBlob": { "type": "blob", @@ -117,6 +117,19 @@ "smithy.api#pattern": "^(https|s3)://([^/]+)/?(.*)$" } }, + "com.amazonaws.sagemakerruntime#InternalDependencyException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.sagemakerruntime#Message" + } + }, + "traits": { + "smithy.api#documentation": "Your request caused an exception with an internal dependency. Contact customer support.
", + "smithy.api#error": "server", + "smithy.api#httpError": 530 + } + }, "com.amazonaws.sagemakerruntime#InternalFailure": { "type": "structure", "members": { @@ -139,12 +152,18 @@ "target": "com.amazonaws.sagemakerruntime#InvokeEndpointOutput" }, "errors": [ + { + "target": "com.amazonaws.sagemakerruntime#InternalDependencyException" + }, { "target": "com.amazonaws.sagemakerruntime#InternalFailure" }, { "target": "com.amazonaws.sagemakerruntime#ModelError" }, + { + "target": "com.amazonaws.sagemakerruntime#ModelNotReadyException" + }, { "target": "com.amazonaws.sagemakerruntime#ServiceUnavailable" }, @@ -153,7 +172,7 @@ } ], "traits": { - "smithy.api#documentation": "After you deploy a model into production using Amazon SageMaker hosting services, your\n client applications use this API to get inferences from the model hosted at the\n specified endpoint.
\nFor an overview of Amazon SageMaker, see How It Works.
\nAmazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add\n additional headers. You should not rely on the behavior of headers outside those\n enumerated in the request syntax.
\nCalls to InvokeEndpoint are authenticated by using AWS Signature Version\n 4. For information, see Authenticating\n Requests (AWS Signature Version 4) in the Amazon S3 API\n Reference.
A customer's model containers must respond to requests within 60 seconds. The model\n itself can have a maximum processing time of 60 seconds before responding to\n invocations. If your model is going to take 50-60 seconds of processing time, the SDK\n socket timeout should be set to be 70 seconds.
\nEndpoints are scoped to an individual account, and are not public. The URL does\n not contain the account ID, but Amazon SageMaker determines the account ID from the\n authentication token that is supplied by the caller.
\nAfter you deploy a model into production using Amazon SageMaker hosting services, your\n client applications use this API to get inferences from the model hosted at the\n specified endpoint.
\nFor an overview of Amazon SageMaker, see How It Works.
\nAmazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add\n additional headers. You should not rely on the behavior of headers outside those\n enumerated in the request syntax.
\nCalls to InvokeEndpoint are authenticated by using Amazon Web Services Signature Version\n 4. For information, see Authenticating\n Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API\n Reference.
A customer's model containers must respond to requests within 60 seconds. The model\n itself can have a maximum processing time of 60 seconds before responding to\n invocations. If your model is going to take 50-60 seconds of processing time, the SDK\n socket timeout should be set to be 70 seconds.
\nEndpoints are scoped to an individual account, and are not public. The URL does\n not contain the account ID, but Amazon SageMaker determines the account ID from the\n authentication token that is supplied by the caller.
\nAfter you deploy a model into production using Amazon SageMaker hosting services, \n your client applications use this API to get inferences from the model hosted at \n the specified endpoint in an asynchronous manner.
\n \nInference requests sent to this API are enqueued for asynchronous processing. \n The processing of the inference request may or may not complete before the \n you receive a response from this API. The response from this API will \n not contain the result of the inference request but contain information \n about where you can locate it.
\n \nAmazon SageMaker strips all POST headers except those supported by the API. \n Amazon SageMaker might add additional headers. You should not rely on the behavior \n of headers outside those enumerated in the request syntax.
Calls to InvokeEndpointAsync are authenticated by using AWS Signature\n Version 4. For information, see Authenticating Requests (AWS Signature Version 4) in the Amazon S3 API\n Reference.
After you deploy a model into production using Amazon SageMaker hosting services, \n your client applications use this API to get inferences from the model hosted at \n the specified endpoint in an asynchronous manner.
\n \nInference requests sent to this API are enqueued for asynchronous processing. \n The processing of the inference request may or may not complete before the \n you receive a response from this API. The response from this API will \n not contain the result of the inference request but contain information \n about where you can locate it.
\n \nAmazon SageMaker strips all POST headers except those supported by the API. \n Amazon SageMaker might add additional headers. You should not rely on the behavior \n of headers outside those enumerated in the request syntax.
Calls to InvokeEndpointAsync are authenticated by using Amazon Web Services Signature\n Version 4. For information, see Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API\n Reference.
Provides additional information about a request for an inference submitted to \n a model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is \n forwarded verbatim. You could use this value, for example, to provide an ID that you \n can use to track a request or to provide other metadata that a service endpoint was \n programmed to process. The value must consist of no more than 1024 \n visible US-ASCII characters as specified in \n Section 3.3.6. \n Field Value Components of the Hypertext Transfer Protocol (HTTP/1.1).
\n \nThe code in your model is responsible for setting or updating any custom attributes \n in the response. If your code does not set this value in the response, an empty \n value is returned. For example, if a custom attribute represents the trace ID, \n your model can prepend the custom attribute with Trace ID: in your post-processing function.
This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker Python SDK.
", + "smithy.api#documentation": "Provides additional information about a request for an inference submitted to \n a model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is \n forwarded verbatim. You could use this value, for example, to provide an ID that you \n can use to track a request or to provide other metadata that a service endpoint was \n programmed to process. The value must consist of no more than 1024 \n visible US-ASCII characters as specified in \n Section 3.3.6. \n Field Value Components of the Hypertext Transfer Protocol (HTTP/1.1).
\n \nThe code in your model is responsible for setting or updating any custom attributes \n in the response. If your code does not set this value in the response, an empty \n value is returned. For example, if a custom attribute represents the trace ID, \n your model can prepend the custom attribute with Trace ID: in your post-processing function.
This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker Python SDK.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-Custom-Attributes" } }, @@ -299,7 +318,7 @@ "CustomAttributes": { "target": "com.amazonaws.sagemakerruntime#CustomAttributesHeader", "traits": { - "smithy.api#documentation": "Provides additional information about a request for an inference submitted to a model\n hosted at an Amazon SageMaker endpoint. The information is an opaque value that is\n forwarded verbatim. You could use this value, for example, to provide an ID that you can\n use to track a request or to provide other metadata that a service endpoint was\n programmed to process. The value must consist of no more than 1024 visible US-ASCII\n characters as specified in Section 3.3.6. Field Value\n Components of the Hypertext Transfer Protocol (HTTP/1.1).
\nThe code in your model is responsible for setting or updating any custom attributes in\n the response. If your code does not set this value in the response, an empty value is\n returned. For example, if a custom attribute represents the trace ID, your model can\n prepend the custom attribute with Trace ID: in your post-processing\n function.
This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker Python\n SDK.
", + "smithy.api#documentation": "Provides additional information about a request for an inference submitted to a model\n hosted at an Amazon SageMaker endpoint. The information is an opaque value that is\n forwarded verbatim. You could use this value, for example, to provide an ID that you can\n use to track a request or to provide other metadata that a service endpoint was\n programmed to process. The value must consist of no more than 1024 visible US-ASCII\n characters as specified in Section 3.3.6. Field Value\n Components of the Hypertext Transfer Protocol (HTTP/1.1).
\nThe code in your model is responsible for setting or updating any custom attributes in\n the response. If your code does not set this value in the response, an empty value is\n returned. For example, if a custom attribute represents the trace ID, your model can\n prepend the custom attribute with Trace ID: in your post-processing\n function.
This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker Python\n SDK.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-Custom-Attributes" } }, @@ -361,7 +380,7 @@ "CustomAttributes": { "target": "com.amazonaws.sagemakerruntime#CustomAttributesHeader", "traits": { - "smithy.api#documentation": "Provides additional information in the response about the inference returned by a\n model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is\n forwarded verbatim. You could use this value, for example, to return an ID received in\n the CustomAttributes header of a request or other metadata that a service\n endpoint was programmed to produce. The value must consist of no more than 1024 visible\n US-ASCII characters as specified in Section 3.3.6. Field Value\n Components of the Hypertext Transfer Protocol (HTTP/1.1). If the customer\n wants the custom attribute returned, the model must set the custom attribute to be\n included on the way back.
The code in your model is responsible for setting or updating any custom attributes in\n the response. If your code does not set this value in the response, an empty value is\n returned. For example, if a custom attribute represents the trace ID, your model can\n prepend the custom attribute with Trace ID: in your post-processing\n function.
This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker Python\n SDK.
", + "smithy.api#documentation": "Provides additional information in the response about the inference returned by a\n model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is\n forwarded verbatim. You could use this value, for example, to return an ID received in\n the CustomAttributes header of a request or other metadata that a service\n endpoint was programmed to produce. The value must consist of no more than 1024 visible\n US-ASCII characters as specified in Section 3.3.6. Field Value\n Components of the Hypertext Transfer Protocol (HTTP/1.1). If the customer\n wants the custom attribute returned, the model must set the custom attribute to be\n included on the way back.
The code in your model is responsible for setting or updating any custom attributes in\n the response. If your code does not set this value in the response, an empty value is\n returned. For example, if a custom attribute represents the trace ID, your model can\n prepend the custom attribute with Trace ID: in your post-processing\n function.
This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker Python\n SDK.
", "smithy.api#httpHeader": "X-Amzn-SageMaker-Custom-Attributes" } } @@ -410,6 +429,23 @@ "smithy.api#httpError": 424 } }, + "com.amazonaws.sagemakerruntime#ModelNotReadyException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.sagemakerruntime#Message" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ModelNotReadyException", + "httpResponseCode": 429 + }, + "smithy.api#documentation": "Either a serverless endpoint variant's resources are still being provisioned, or a multi-model endpoint is still downloading or loading the target model. Wait and try your request again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, "com.amazonaws.sagemakerruntime#RequestTTLSecondsHeader": { "type": "integer", "traits": { diff --git a/aws/sdk/aws-models/s3.json b/aws/sdk/aws-models/s3.json index 32ab20ff528450a5554c12ec841459f120aa5e1e..0cf4f2945f31a226537900587a09d1630a60a960 100644 --- a/aws/sdk/aws-models/s3.json +++ b/aws/sdk/aws-models/s3.json @@ -215,6 +215,26 @@ }, "com.amazonaws.s3#AmazonS3": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "S3", + "arnNamespace": "s3", + "cloudFormationName": "S3", + "cloudTrailEventSource": "s3.amazonaws.com", + "endpointPrefix": "s3" + }, + "aws.auth#sigv4": { + "name": "s3" + }, + "aws.protocols#restXml": { + "noErrorWrapping": true + }, + "smithy.api#documentation": "", + "smithy.api#title": "Amazon Simple Storage Service", + "smithy.api#xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + } + }, "version": "2006-03-01", "operations": [ { @@ -493,27 +513,7 @@ { "target": "com.amazonaws.s3#WriteGetObjectResponse" } - ], - "traits": { - "aws.api#service": { - "sdkId": "S3", - "arnNamespace": "s3", - "cloudFormationName": "S3", - "cloudTrailEventSource": "s3.amazonaws.com", - "endpointPrefix": "s3" - }, - "aws.auth#sigv4": { - "name": "s3" - }, - "aws.protocols#restXml": { - "noErrorWrapping": true - }, - "smithy.api#documentation": "", - "smithy.api#title": "Amazon Simple Storage Service", - "smithy.api#xmlNamespace": { - "uri": "http://s3.amazonaws.com/doc/2006-03-01/" - } - } + ] }, "com.amazonaws.s3#AnalyticsAndOperator": { "type": "structure", @@ -1151,7 +1151,7 @@ "target": "com.amazonaws.s3#CompleteMultipartUploadOutput" }, "traits": { - "smithy.api#documentation": "Completes a multipart upload by assembling previously uploaded parts.
\nYou first initiate the multipart upload and then upload all parts using the UploadPart\n operation. After successfully uploading all relevant parts of an upload, you call this\n action to complete the upload. Upon receiving this request, Amazon S3 concatenates all\n the parts in ascending order by part number to create a new object. In the Complete\n Multipart Upload request, you must provide the parts list. You must ensure that the parts\n list is complete. This action concatenates the parts that you provide in the list. For\n each part in the list, you must provide the part number and the ETag value,\n returned after that part was uploaded.
Processing of a Complete Multipart Upload request could take several minutes to\n complete. After Amazon S3 begins processing the request, it sends an HTTP response header that\n specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white\n space characters to keep the connection from timing out. Because a request could fail after\n the initial 200 OK response has been sent, it is important that you check the response body\n to determine whether the request succeeded.
\nNote that if CompleteMultipartUpload fails, applications should be prepared\n to retry the failed requests. For more information, see Amazon S3 Error Best Practices.
For more information about multipart uploads, see Uploading Objects Using Multipart\n Upload.
\nFor information about permissions required to use the multipart upload API, see Multipart Upload and\n Permissions.
\n\n\n\n CompleteMultipartUpload has the following special errors:
Error code: EntityTooSmall\n
Description: Your proposed upload is smaller than the minimum allowed object\n size. Each part must be at least 5 MB in size, except the last part.
\n400 Bad Request
\nError code: InvalidPart\n
Description: One or more of the specified parts could not be found. The part\n might not have been uploaded, or the specified entity tag might not have\n matched the part's entity tag.
\n400 Bad Request
\nError code: InvalidPartOrder\n
Description: The list of parts was not in ascending order. The parts list\n must be specified in order by part number.
\n400 Bad Request
\nError code: NoSuchUpload\n
Description: The specified multipart upload does not exist. The upload ID\n might be invalid, or the multipart upload might have been aborted or\n completed.
\n404 Not Found
\nThe following operations are related to CompleteMultipartUpload:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nCompletes a multipart upload by assembling previously uploaded parts.
\nYou first initiate the multipart upload and then upload all parts using the UploadPart\n operation. After successfully uploading all relevant parts of an upload, you call this\n action to complete the upload. Upon receiving this request, Amazon S3 concatenates all\n the parts in ascending order by part number to create a new object. In the Complete\n Multipart Upload request, you must provide the parts list. You must ensure that the parts\n list is complete. This action concatenates the parts that you provide in the list. For\n each part in the list, you must provide the part number and the ETag value,\n returned after that part was uploaded.
Processing of a Complete Multipart Upload request could take several minutes to\n complete. After Amazon S3 begins processing the request, it sends an HTTP response header that\n specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white\n space characters to keep the connection from timing out. Because a request could fail after\n the initial 200 OK response has been sent, it is important that you check the response body\n to determine whether the request succeeded.
\nNote that if CompleteMultipartUpload fails, applications should be prepared\n to retry the failed requests. For more information, see Amazon S3 Error Best Practices.
You cannot use Content-Type: application/x-www-form-urlencoded with Complete\n Multipart Upload requests. Also, if you do not provide a Content-Type header, CompleteMultipartUpload returns a 200 OK response.
For more information about multipart uploads, see Uploading Objects Using Multipart\n Upload.
\nFor information about permissions required to use the multipart upload API, see Multipart Upload and\n Permissions.
\n\n\n\n CompleteMultipartUpload has the following special errors:
Error code: EntityTooSmall\n
Description: Your proposed upload is smaller than the minimum allowed object\n size. Each part must be at least 5 MB in size, except the last part.
\n400 Bad Request
\nError code: InvalidPart\n
Description: One or more of the specified parts could not be found. The part\n might not have been uploaded, or the specified entity tag might not have\n matched the part's entity tag.
\n400 Bad Request
\nError code: InvalidPartOrder\n
Description: The list of parts was not in ascending order. The parts list\n must be specified in order by part number.
\n400 Bad Request
\nError code: NoSuchUpload\n
Description: The specified multipart upload does not exist. The upload ID\n might be invalid, or the multipart upload might have been aborted or\n completed.
\n404 Not Found
\nThe following operations are related to CompleteMultipartUpload:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nArray of CompletedPart data types.
", + "smithy.api#documentation": "Array of CompletedPart data types.
\nIf you do not supply a valid Part with your request, the service sends back an HTTP\n 400 response.
Creates a copy of an object that is already stored in Amazon S3.
\nYou can store individual objects of up to 5 TB in Amazon S3. You create a copy of your\n object up to 5 GB in size in a single atomic action using this API. However, to copy\n an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API.\n For more information, see Copy Object Using the REST Multipart Upload API.
\nAll copy requests must be authenticated. Additionally, you must have\n read access to the source object and write\n access to the destination bucket. For more information, see REST Authentication. Both the Region\n that you want to copy the object from and the Region that you want to copy the object to\n must be enabled for your account.
\nA copy request might return an error when Amazon S3 receives the copy request or while Amazon S3\n is copying the files. If the error occurs before the copy action starts, you receive a\n standard Amazon S3 error. If the error occurs during the copy operation, the error response is\n embedded in the 200 OK response. This means that a 200 OK\n response can contain either a success or an error. Design your application to parse the\n contents of the response and handle it appropriately.
If the copy is successful, you receive a response with information about the copied\n object.
\nIf the request is an HTTP 1.1 request, the response is chunk encoded. If it were not,\n it would not contain the content-length, and you would need to read the entire\n body.
\nThe copy request charge is based on the storage class and Region that you specify for\n the destination object. For pricing information, see Amazon S3 pricing.
\nAmazon S3 transfer acceleration does not support cross-Region copies. If you request a\n cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad\n Request error. For more information, see Transfer Acceleration.
\n Metadata\n
\nWhen copying an object, you can preserve all metadata (default) or specify new metadata.\n However, the ACL is not preserved and is set to private for the user making the request. To\n override the default ACL setting, specify a new ACL when generating a copy request. For\n more information, see Using ACLs.
\nTo specify whether you want the object metadata copied from the source object or\n replaced with metadata provided in the request, you can optionally add the\n x-amz-metadata-directive header. When you grant permissions, you can use\n the s3:x-amz-metadata-directive condition key to enforce certain metadata\n behavior when objects are uploaded. For more information, see Specifying Conditions in a\n Policy in the Amazon S3 User Guide. For a complete list of\n Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for\n Amazon S3.
\n \n x-amz-copy-source-if Headers\n
To only copy an object under certain conditions, such as whether the Etag\n matches or whether the object was modified before or after a specified date, use the\n following request parameters:
\n x-amz-copy-source-if-match\n
\n x-amz-copy-source-if-none-match\n
\n x-amz-copy-source-if-unmodified-since\n
\n x-amz-copy-source-if-modified-since\n
If both the x-amz-copy-source-if-match and\n x-amz-copy-source-if-unmodified-since headers are present in the request\n and evaluate as follows, Amazon S3 returns 200 OK and copies the data:
\n x-amz-copy-source-if-match condition evaluates to true
\n x-amz-copy-source-if-unmodified-since condition evaluates to\n false
If both the x-amz-copy-source-if-none-match and\n x-amz-copy-source-if-modified-since headers are present in the request and\n evaluate as follows, Amazon S3 returns the 412 Precondition Failed response\n code:
\n x-amz-copy-source-if-none-match condition evaluates to false
\n x-amz-copy-source-if-modified-since condition evaluates to\n true
All headers with the x-amz- prefix, including\n x-amz-copy-source, must be signed.
\n Server-side encryption\n
\nWhen you perform a CopyObject operation, you can optionally use the appropriate encryption-related \n headers to encrypt the object using server-side encryption with Amazon Web Services managed encryption keys \n (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, Amazon S3 \n encrypts your data as it writes it to disks in its data centers and decrypts the data when \n you access it. For more information about server-side encryption, see Using\n Server-Side Encryption.
\nIf a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more\n information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.
\n\n Access Control List (ACL)-Specific Request\n Headers\n
\nWhen copying an object, you can optionally use headers to grant ACL-based permissions.\n By default, all objects are private. Only the owner has full access control. When adding a\n new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups\n defined by Amazon S3. These permissions are then added to the ACL on the object. For more\n information, see Access Control List (ACL) Overview and Managing ACLs Using the REST\n API.
\n\n\n Storage Class Options\n
\nYou can use the CopyObject action to change the storage class of an\n object that is already stored in Amazon S3 using the StorageClass parameter. For\n more information, see Storage\n Classes in the Amazon S3 User Guide.
\n Versioning\n
\nBy default, x-amz-copy-source identifies the current version of an object\n to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was\n deleted. To copy a different version, use the versionId subresource.
If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for\n the object being copied. This version ID is different from the version ID of the source\n object. Amazon S3 returns the version ID of the copied object in the\n x-amz-version-id response header in the response.
If you do not enable versioning or suspend it on the target bucket, the version ID that\n Amazon S3 generates is always null.
\nIf the source object's storage class is GLACIER, you must restore a copy of this object\n before you can use it as a source object for the copy operation. For more information, see\n RestoreObject.
\nThe following operations are related to CopyObject:
For more information, see Copying\n Objects.
", + "smithy.api#documentation": "Creates a copy of an object that is already stored in Amazon S3.
\nYou can store individual objects of up to 5 TB in Amazon S3. You create a copy of your\n object up to 5 GB in size in a single atomic action using this API. However, to copy\n an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API.\n For more information, see Copy Object Using the REST Multipart Upload API.
\nAll copy requests must be authenticated. Additionally, you must have\n read access to the source object and write\n access to the destination bucket. For more information, see REST Authentication. Both the Region\n that you want to copy the object from and the Region that you want to copy the object to\n must be enabled for your account.
\nA copy request might return an error when Amazon S3 receives the copy request or while Amazon S3\n is copying the files. If the error occurs before the copy action starts, you receive a\n standard Amazon S3 error. If the error occurs during the copy operation, the error response is\n embedded in the 200 OK response. This means that a 200 OK\n response can contain either a success or an error. Design your application to parse the\n contents of the response and handle it appropriately.
If the copy is successful, you receive a response with information about the copied\n object.
\nIf the request is an HTTP 1.1 request, the response is chunk encoded. If it were not,\n it would not contain the content-length, and you would need to read the entire\n body.
\nThe copy request charge is based on the storage class and Region that you specify for\n the destination object. For pricing information, see Amazon S3 pricing.
\nAmazon S3 transfer acceleration does not support cross-Region copies. If you request a\n cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad\n Request error. For more information, see Transfer Acceleration.
\n Metadata\n
\nWhen copying an object, you can preserve all metadata (default) or specify new metadata.\n However, the ACL is not preserved and is set to private for the user making the request. To\n override the default ACL setting, specify a new ACL when generating a copy request. For\n more information, see Using ACLs.
\nTo specify whether you want the object metadata copied from the source object or\n replaced with metadata provided in the request, you can optionally add the\n x-amz-metadata-directive header. When you grant permissions, you can use\n the s3:x-amz-metadata-directive condition key to enforce certain metadata\n behavior when objects are uploaded. For more information, see Specifying Conditions in a\n Policy in the Amazon S3 User Guide. For a complete list of\n Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for\n Amazon S3.
\n \n x-amz-copy-source-if Headers\n
To only copy an object under certain conditions, such as whether the Etag\n matches or whether the object was modified before or after a specified date, use the\n following request parameters:
\n x-amz-copy-source-if-match\n
\n x-amz-copy-source-if-none-match\n
\n x-amz-copy-source-if-unmodified-since\n
\n x-amz-copy-source-if-modified-since\n
If both the x-amz-copy-source-if-match and\n x-amz-copy-source-if-unmodified-since headers are present in the request\n and evaluate as follows, Amazon S3 returns 200 OK and copies the data:
\n x-amz-copy-source-if-match condition evaluates to true
\n x-amz-copy-source-if-unmodified-since condition evaluates to\n false
If both the x-amz-copy-source-if-none-match and\n x-amz-copy-source-if-modified-since headers are present in the request and\n evaluate as follows, Amazon S3 returns the 412 Precondition Failed response\n code:
\n x-amz-copy-source-if-none-match condition evaluates to false
\n x-amz-copy-source-if-modified-since condition evaluates to\n true
All headers with the x-amz- prefix, including\n x-amz-copy-source, must be signed.
\n Server-side encryption\n
\nWhen you perform a CopyObject operation, you can optionally use the appropriate encryption-related \n headers to encrypt the object using server-side encryption with Amazon Web Services managed encryption keys \n (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, Amazon S3 \n encrypts your data as it writes it to disks in its data centers and decrypts the data when \n you access it. For more information about server-side encryption, see Using\n Server-Side Encryption.
\nIf a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more\n information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.
\n\n Access Control List (ACL)-Specific Request\n Headers\n
\nWhen copying an object, you can optionally use headers to grant ACL-based permissions.\n By default, all objects are private. Only the owner has full access control. When adding a\n new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups\n defined by Amazon S3. These permissions are then added to the ACL on the object. For more\n information, see Access Control List (ACL) Overview and Managing ACLs Using the REST\n API.
\nIf the bucket that you're copying objects to uses the bucket owner enforced setting for\n S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that\n use this setting only accept PUT requests that don't specify an ACL or PUT requests that\n specify bucket owner full control ACLs, such as the bucket-owner-full-control canned\n ACL or an equivalent form of this ACL expressed in the XML format.
For more information, see Controlling ownership of\n objects and disabling ACLs in the Amazon S3 User Guide.
\nIf your bucket uses the bucket owner enforced setting for Object Ownership, \n all objects written to the bucket by any account will be owned by the bucket owner.
\n\n Storage Class Options\n
\nYou can use the CopyObject action to change the storage class of an\n object that is already stored in Amazon S3 using the StorageClass parameter. For\n more information, see Storage\n Classes in the Amazon S3 User Guide.
\n Versioning\n
\nBy default, x-amz-copy-source identifies the current version of an object\n to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was\n deleted. To copy a different version, use the versionId subresource.
If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for\n the object being copied. This version ID is different from the version ID of the source\n object. Amazon S3 returns the version ID of the copied object in the\n x-amz-version-id response header in the response.
If you do not enable versioning or suspend it on the target bucket, the version ID that\n Amazon S3 generates is always null.
\nIf the source object's storage class is GLACIER, you must restore a copy of this object\n before you can use it as a source object for the copy operation. For more information, see\n RestoreObject.
\nThe following operations are related to CopyObject:
For more information, see Copying\n Objects.
", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}/{Key+}?x-id=CopyObject", @@ -1877,7 +1877,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a\n valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to\n create buckets. By creating the bucket, you become the bucket owner.
\nNot every string is an acceptable bucket name. For information about bucket naming\n restrictions, see Bucket naming rules.
\nIf you want to create an Amazon S3 on Outposts bucket, see Create Bucket.
\nBy default, the bucket is created in the US East (N. Virginia) Region. You can\n optionally specify a Region in the request body. You might choose a Region to optimize\n latency, minimize costs, or address regulatory requirements. For example, if you reside in\n Europe, you will probably find it advantageous to create buckets in the Europe (Ireland)\n Region. For more information, see Accessing a\n bucket.
\nIf you send your create bucket request to the s3.amazonaws.com endpoint,\n the request goes to the us-east-1 Region. Accordingly, the signature calculations in\n Signature Version 4 must use us-east-1 as the Region, even if the location constraint in\n the request specifies another Region where the bucket is to be created. If you create a\n bucket in a Region other than US East (N. Virginia), your application must be able to\n handle 307 redirect. For more information, see Virtual hosting of buckets.
When creating a bucket using this operation, you can optionally specify the accounts or\n groups that should be granted specific permissions on the bucket. There are two ways to\n grant the appropriate permissions using the request headers.
\nSpecify a canned ACL using the x-amz-acl request header. Amazon S3\n supports a set of predefined ACLs, known as canned ACLs. Each\n canned ACL has a predefined set of grantees and permissions. For more information,\n see Canned ACL.
Specify access permissions explicitly using the x-amz-grant-read,\n x-amz-grant-write, x-amz-grant-read-acp,\n x-amz-grant-write-acp, and x-amz-grant-full-control\n headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For\n more information, see Access control list\n (ACL) overview.
You specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id – if the value specified is the canonical user ID of an Amazon Web Services account
\n uri – if you are granting permissions to a predefined\n group
\n emailAddress – if the value specified is the email address of\n an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" \n
You can use either a canned ACL or specify access permissions explicitly. You cannot\n do both.
\n\n Permissions\n
\nIf your CreateBucket request specifies ACL permissions and the ACL is public-read, public-read-write, \n authenticated-read, or if you specify access permissions explicitly through any other ACL, both \n s3:CreateBucket and s3:PutBucketAcl permissions are needed. If the ACL the \n CreateBucket request is private, only s3:CreateBucket permission is needed.
If ObjectLockEnabledForBucket is set to true in your CreateBucket request, \n s3:PutBucketObjectLockConfiguration and s3:PutBucketVersioning permissions are required.
The following operations are related to CreateBucket:
\n PutObject\n
\n\n DeleteBucket\n
\nCreates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a\n valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to\n create buckets. By creating the bucket, you become the bucket owner.
\nNot every string is an acceptable bucket name. For information about bucket naming\n restrictions, see Bucket naming rules.
\nIf you want to create an Amazon S3 on Outposts bucket, see Create Bucket.
\nBy default, the bucket is created in the US East (N. Virginia) Region. You can\n optionally specify a Region in the request body. You might choose a Region to optimize\n latency, minimize costs, or address regulatory requirements. For example, if you reside in\n Europe, you will probably find it advantageous to create buckets in the Europe (Ireland)\n Region. For more information, see Accessing a\n bucket.
\nIf you send your create bucket request to the s3.amazonaws.com endpoint,\n the request goes to the us-east-1 Region. Accordingly, the signature calculations in\n Signature Version 4 must use us-east-1 as the Region, even if the location constraint in\n the request specifies another Region where the bucket is to be created. If you create a\n bucket in a Region other than US East (N. Virginia), your application must be able to\n handle 307 redirect. For more information, see Virtual hosting of buckets.
\n Access control lists (ACLs)\n
\nWhen creating a bucket using this operation, you can optionally configure the bucket ACL to specify the accounts or\n groups that should be granted specific permissions on the bucket.
\nIf your CreateBucket request includes the BucketOwnerEnforced value for\n the x-amz-object-ownership header, your request can either not specify\n an ACL or specify bucket owner full control ACLs, such as the bucket-owner-full-control\n canned ACL or an equivalent ACL expressed in the XML format. For\n more information, see Controlling object\n ownership in the Amazon S3 User Guide.
There are two ways to grant the appropriate permissions using the request headers.
\nSpecify a canned ACL using the x-amz-acl request header. Amazon S3\n supports a set of predefined ACLs, known as canned ACLs. Each\n canned ACL has a predefined set of grantees and permissions. For more information,\n see Canned ACL.
Specify access permissions explicitly using the x-amz-grant-read,\n x-amz-grant-write, x-amz-grant-read-acp,\n x-amz-grant-write-acp, and x-amz-grant-full-control\n headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For\n more information, see Access control list\n (ACL) overview.
You specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id – if the value specified is the canonical user ID of an Amazon Web Services account
\n uri – if you are granting permissions to a predefined\n group
\n emailAddress – if the value specified is the email address of\n an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" \n
You can use either a canned ACL or specify access permissions explicitly. You cannot\n do both.
\n\n Permissions\n
\nIn addition to s3:CreateBucket, the following permissions are required when your CreateBucket includes specific headers:
\n ACLs - If your CreateBucket request specifies ACL permissions and the ACL is public-read, public-read-write, \n authenticated-read, or if you specify access permissions explicitly through any other ACL, both \n s3:CreateBucket and s3:PutBucketAcl permissions are needed. If the ACL the \n CreateBucket request is private or doesn't specify any ACLs, only s3:CreateBucket permission is needed.
\n Object Lock - If\n ObjectLockEnabledForBucket is set to true in your\n CreateBucket request,\n s3:PutBucketObjectLockConfiguration and\n s3:PutBucketVersioning permissions are required.
\n S3 Object Ownership - If your CreateBucket\n request includes the the x-amz-object-ownership header,\n s3:PutBucketOwnershipControls permission is required.
The following operations are related to CreateBucket:
\n PutObject\n
\n\n DeleteBucket\n
\nSpecifies whether you want S3 Object Lock to be enabled for the new bucket.
", "smithy.api#httpHeader": "x-amz-bucket-object-lock-enabled" } + }, + "ObjectOwnership": { + "target": "com.amazonaws.s3#ObjectOwnership", + "traits": { + "smithy.api#httpHeader": "x-amz-object-ownership" + } } } }, @@ -2490,7 +2496,7 @@ "target": "com.amazonaws.s3#DeleteBucketIntelligentTieringConfigurationRequest" }, "traits": { - "smithy.api#documentation": "Deletes the S3 Intelligent-Tiering configuration from the specified bucket.
\nThe S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in two low latency and high throughput access tiers. For data that can be accessed asynchronously, you can choose to activate automatic archiving capabilities within the S3 Intelligent-Tiering storage class.
\nThe S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
\nFor more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to\n DeleteBucketIntelligentTieringConfiguration include:
Deletes the S3 Intelligent-Tiering configuration from the specified bucket.
\nThe S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.
\nThe S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
\nFor more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to\n DeleteBucketIntelligentTieringConfiguration include:
A container for specifying the configuration for Amazon EventBridge.
" + } + }, "com.amazonaws.s3#EventList": { "type": "list", "member": { @@ -3700,7 +3743,7 @@ "target": "com.amazonaws.s3#GetBucketAclOutput" }, "traits": { - "smithy.api#documentation": "This implementation of the GET action uses the acl\n subresource to return the access control list (ACL) of a bucket. To use GET to\n return the ACL of the bucket, you must have READ_ACP access to the bucket. If\n READ_ACP permission is granted to the anonymous user, you can return the\n ACL of the bucket without using an authorization header.
\n Related Resources\n
\n\n ListObjects\n
\nThis implementation of the GET action uses the acl\n subresource to return the access control list (ACL) of a bucket. To use GET to\n return the ACL of the bucket, you must have READ_ACP access to the bucket. If\n READ_ACP permission is granted to the anonymous user, you can return the\n ACL of the bucket without using an authorization header.
If your bucket uses the bucket owner enforced setting for S3 Object Ownership, \n requests to read ACLs are still supported and return the bucket-owner-full-control \n ACL with the owner being the account that created the bucket. For more information, see \n \n Controlling object ownership and disabling ACLs in the Amazon S3 User Guide.
\n Related Resources\n
\n\n ListObjects\n
\nGets the S3 Intelligent-Tiering configuration from the specified bucket.
\nThe S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in two low latency and high throughput access tiers. For data that can be accessed asynchronously, you can choose to activate automatic archiving capabilities within the S3 Intelligent-Tiering storage class.
\nThe S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
\nFor more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to\n GetBucketIntelligentTieringConfiguration include:
Gets the S3 Intelligent-Tiering configuration from the specified bucket.
\nThe S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.
\nThe S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
\nFor more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to\n GetBucketIntelligentTieringConfiguration include:
Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you\n must have the s3:GetBucketOwnershipControls permission. For more information\n about Amazon S3 permissions, see Specifying\n Permissions in a Policy.
For information about Amazon S3 Object Ownership, see Using Object Ownership.
\nThe following operations are related to GetBucketOwnershipControls:
Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you\n must have the s3:GetBucketOwnershipControls permission. For more information\n about Amazon S3 permissions, see Specifying\n permissions in a policy.
For information about Amazon S3 Object Ownership, see Using Object Ownership.
\nThe following operations are related to GetBucketOwnershipControls:
The OwnershipControls (BucketOwnerPreferred or ObjectWriter) currently in\n effect for this Amazon S3 bucket.
The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) currently in\n effect for this Amazon S3 bucket.
Retrieves objects from Amazon S3. To use GET, you must have READ\n access to the object. If you grant READ access to the anonymous user, you can\n return the object without using an authorization header.
An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer\n file system. You can, however, create a logical hierarchy by using object key names that\n imply a folder structure. For example, instead of naming an object sample.jpg,\n you can name it photos/2006/February/sample.jpg.
To get an object from such a logical hierarchy, specify the full key name for the object\n in the GET operation. For a virtual hosted-style request example, if you have\n the object photos/2006/February/sample.jpg, specify the resource as\n /photos/2006/February/sample.jpg. For a path-style request example, if you\n have the object photos/2006/February/sample.jpg in the bucket named\n examplebucket, specify the resource as\n /examplebucket/photos/2006/February/sample.jpg. For more information about\n request types, see HTTP Host Header Bucket Specification.
To distribute large files to many people, you can save bandwidth costs by using\n BitTorrent. For more information, see Amazon S3\n Torrent. For more information about returning the ACL of an object, see GetObjectAcl.
\n\nIf the object you are retrieving is stored in the S3 Glacier or\n S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a\n copy using RestoreObject. Otherwise, this action returns an\n InvalidObjectStateError error. For information about restoring archived\n objects, see Restoring Archived\n Objects.
Encryption request headers, like x-amz-server-side-encryption, should not\n be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS) \n or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your\n object does use these types of keys, you’ll get an HTTP 400 BadRequest error.
If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,\n you must use the following headers:
\nx-amz-server-side-encryption-customer-algorithm
\nx-amz-server-side-encryption-customer-key
\nx-amz-server-side-encryption-customer-key-MD5
\nFor more information about SSE-C, see Server-Side Encryption (Using\n Customer-Provided Encryption Keys).
\n\nAssuming you have the relevant permission to read object tags, the response also returns the\n x-amz-tagging-count header that provides the count of number of tags\n associated with the object. You can use GetObjectTagging to retrieve\n the tag set associated with an object.
\n Permissions\n
\nYou need the relevant read object (or version) permission for this operation. For more\n information, see Specifying Permissions\n in a Policy. If the object you request does not exist, the error Amazon S3 returns\n depends on whether you also have the s3:ListBucket permission.
If you have the s3:ListBucket permission on the bucket, Amazon S3 will\n return an HTTP status code 404 (\"no such key\") error.
If you don’t have the s3:ListBucket permission, Amazon S3 will return an\n HTTP status code 403 (\"access denied\") error.
\n Versioning\n
\nBy default, the GET action returns the current version of an object. To return a\n different version, use the versionId subresource.
You need the s3:GetObjectVersion permission to access a specific version of an object.\n
If the current version of the object is a delete marker, Amazon S3 behaves as if the\n object was deleted and includes x-amz-delete-marker: true in the\n response.
For more information about versioning, see PutBucketVersioning.
\n\n\n Overriding Response Header Values\n
\nThere are times when you want to override certain response header values in a GET\n response. For example, you might override the Content-Disposition response header value in\n your GET request.
\n\nYou can override values for a set of response headers using the following query\n parameters. These response header values are sent only on a successful request, that is,\n when status code 200 OK is returned. The set of headers you can override using these\n parameters is a subset of the headers that Amazon S3 accepts when you create an object. The\n response headers that you can override for the GET response are Content-Type,\n Content-Language, Expires, Cache-Control,\n Content-Disposition, and Content-Encoding. To override these\n header values in the GET response, you use the following request parameters.
You must sign the request, either using an Authorization header or a presigned URL,\n when using these parameters. They cannot be used with an unsigned (anonymous)\n request.
\n\n response-content-type\n
\n response-content-language\n
\n response-expires\n
\n response-cache-control\n
\n response-content-disposition\n
\n response-content-encoding\n
\n Additional Considerations about Request Headers\n
\n\nIf both of the If-Match and If-Unmodified-Since headers are\n present in the request as follows: If-Match condition evaluates to\n true, and; If-Unmodified-Since condition evaluates to\n false; then, S3 returns 200 OK and the data requested.
If both of the If-None-Match and If-Modified-Since headers are\n present in the request as follows: If-None-Match condition evaluates to\n false, and; If-Modified-Since condition evaluates to\n true; then, S3 returns 304 Not Modified response code.
For more information about conditional requests, see RFC 7232.
\n\nThe following operations are related to GetObject:
\n ListBuckets\n
\n\n GetObjectAcl\n
\nRetrieves objects from Amazon S3. To use GET, you must have READ\n access to the object. If you grant READ access to the anonymous user, you can\n return the object without using an authorization header.
An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer\n file system. You can, however, create a logical hierarchy by using object key names that\n imply a folder structure. For example, instead of naming an object sample.jpg,\n you can name it photos/2006/February/sample.jpg.
To get an object from such a logical hierarchy, specify the full key name for the object\n in the GET operation. For a virtual hosted-style request example, if you have\n the object photos/2006/February/sample.jpg, specify the resource as\n /photos/2006/February/sample.jpg. For a path-style request example, if you\n have the object photos/2006/February/sample.jpg in the bucket named\n examplebucket, specify the resource as\n /examplebucket/photos/2006/February/sample.jpg. For more information about\n request types, see HTTP Host Header Bucket Specification.
To distribute large files to many people, you can save bandwidth costs by using\n BitTorrent. For more information, see Amazon S3\n Torrent. For more information about returning the ACL of an object, see GetObjectAcl.
\n\nIf the object you are retrieving is stored in the S3 Glacier or\n S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a\n copy using RestoreObject. Otherwise, this action returns an\n InvalidObjectStateError error. For information about restoring archived\n objects, see Restoring Archived\n Objects.
Encryption request headers, like x-amz-server-side-encryption, should not\n be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS) \n or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your\n object does use these types of keys, you’ll get an HTTP 400 BadRequest error.
If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,\n you must use the following headers:
\nx-amz-server-side-encryption-customer-algorithm
\nx-amz-server-side-encryption-customer-key
\nx-amz-server-side-encryption-customer-key-MD5
\nFor more information about SSE-C, see Server-Side Encryption (Using\n Customer-Provided Encryption Keys).
\n\nAssuming you have the relevant permission to read object tags, the response also returns the\n x-amz-tagging-count header that provides the count of number of tags\n associated with the object. You can use GetObjectTagging to retrieve\n the tag set associated with an object.
\n Permissions\n
\nYou need the relevant read object (or version) permission for this operation. For more\n information, see Specifying Permissions\n in a Policy. If the object you request does not exist, the error Amazon S3 returns\n depends on whether you also have the s3:ListBucket permission.
If you have the s3:ListBucket permission on the bucket, Amazon S3 will\n return an HTTP status code 404 (\"no such key\") error.
If you don’t have the s3:ListBucket permission, Amazon S3 will return an\n HTTP status code 403 (\"access denied\") error.
\n Versioning\n
\nBy default, the GET action returns the current version of an object. To return a\n different version, use the versionId subresource.
\n If you supply a versionId, you need the s3:GetObjectVersion permission to\n access a specific version of an object. If you request a specific version, you do not need to have\n the s3:GetObject permission.\n
If the current version of the object is a delete marker, Amazon S3 behaves as if the\n object was deleted and includes x-amz-delete-marker: true in the\n response.
For more information about versioning, see PutBucketVersioning.
\n\n\n Overriding Response Header Values\n
\nThere are times when you want to override certain response header values in a GET\n response. For example, you might override the Content-Disposition response header value in\n your GET request.
\n\nYou can override values for a set of response headers using the following query\n parameters. These response header values are sent only on a successful request, that is,\n when status code 200 OK is returned. The set of headers you can override using these\n parameters is a subset of the headers that Amazon S3 accepts when you create an object. The\n response headers that you can override for the GET response are Content-Type,\n Content-Language, Expires, Cache-Control,\n Content-Disposition, and Content-Encoding. To override these\n header values in the GET response, you use the following request parameters.
You must sign the request, either using an Authorization header or a presigned URL,\n when using these parameters. They cannot be used with an unsigned (anonymous)\n request.
\n\n response-content-type\n
\n response-content-language\n
\n response-expires\n
\n response-cache-control\n
\n response-content-disposition\n
\n response-content-encoding\n
\n Additional Considerations about Request Headers\n
\n\nIf both of the If-Match and If-Unmodified-Since headers are\n present in the request as follows: If-Match condition evaluates to\n true, and; If-Unmodified-Since condition evaluates to\n false; then, S3 returns 200 OK and the data requested.
If both of the If-None-Match and If-Modified-Since headers are\n present in the request as follows: If-None-Match condition evaluates to\n false, and; If-Modified-Since condition evaluates to\n true; then, S3 returns 304 Not Modified response code.
For more information about conditional requests, see RFC 7232.
\n\nThe following operations are related to GetObject:
\n ListBuckets\n
\n\n GetObjectAcl\n
\nReturns the access control list (ACL) of an object. To use this operation, you must have\n READ_ACP access to the object.
This action is not supported by Amazon S3 on Outposts.
\n\n Versioning\n
\nBy default, GET returns ACL information about the current version of an object. To\n return ACL information about a different version, use the versionId subresource.
\n\nThe following operations are related to GetObjectAcl:
\n GetObject\n
\n\n DeleteObject\n
\n\n PutObject\n
\nReturns the access control list (ACL) of an object. To use this operation, you must have\n READ_ACP access to the object.
This action is not supported by Amazon S3 on Outposts.
\n\n Versioning\n
\nBy default, GET returns ACL information about the current version of an object. To\n return ACL information about a different version, use the versionId subresource.
\nIf your bucket uses the bucket owner enforced setting for S3 Object Ownership, \n requests to read ACLs are still supported and return the bucket-owner-full-control \n ACL with the owner being the account that created the bucket. For more information, see \n \n Controlling object ownership and disabling ACLs in the Amazon S3 User Guide.
The following operations are related to GetObjectAcl:
\n GetObject\n
\n\n DeleteObject\n
\n\n PutObject\n
\nMinimum object size to which the rule applies.
" + } + }, + "ObjectSizeLessThan": { + "target": "com.amazonaws.s3#ObjectSizeLessThanBytes", + "traits": { + "smithy.api#documentation": "Maximum object size to which the rule applies.
" + } } }, "traits": { @@ -6860,6 +6915,18 @@ "smithy.api#documentation": "This tag must exist in the object's tag set in order for the rule to apply.
" } }, + "ObjectSizeGreaterThan": { + "target": "com.amazonaws.s3#ObjectSizeGreaterThanBytes", + "traits": { + "smithy.api#documentation": "Minimum object size to which the rule applies.
" + } + }, + "ObjectSizeLessThan": { + "target": "com.amazonaws.s3#ObjectSizeLessThanBytes", + "traits": { + "smithy.api#documentation": "Maximum object size to which the rule applies.
" + } + }, "And": { "target": "com.amazonaws.s3#LifecycleRuleAndOperator" } @@ -6961,7 +7028,7 @@ "target": "com.amazonaws.s3#ListBucketIntelligentTieringConfigurationsOutput" }, "traits": { - "smithy.api#documentation": "Lists the S3 Intelligent-Tiering configuration from the specified bucket.
\nThe S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in two low latency and high throughput access tiers. For data that can be accessed asynchronously, you can choose to activate automatic archiving capabilities within the S3 Intelligent-Tiering storage class.
\nThe S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
\nFor more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to\n ListBucketIntelligentTieringConfigurations include:
Lists the S3 Intelligent-Tiering configuration from the specified bucket.
\nThe S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.
\nThe S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
\nFor more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to\n ListBucketIntelligentTieringConfigurations include:
Container for granting information.
" + "smithy.api#documentation": "Container for granting information.
\nBuckets that use the bucket owner enforced setting for Object\n Ownership don't support target grants. For more information, see Permissions for server access log delivery in the\n Amazon S3 User Guide.
" } }, "TargetPrefix": { @@ -8423,6 +8490,12 @@ "traits": { "smithy.api#documentation": "Specifies the number of days an object is noncurrent before Amazon S3 can perform the\n associated action. For information about the noncurrent days calculations, see How\n Amazon S3 Calculates When an Object Became Noncurrent in the Amazon S3 User Guide.
" } + }, + "NewerNoncurrentVersions": { + "target": "com.amazonaws.s3#VersionCount", + "traits": { + "smithy.api#documentation": "Specifies how many noncurrent versions Amazon S3 will retain. If there are this many more recent\n noncurrent versions, Amazon S3 will take the associated action. For more information about noncurrent\n versions, see Lifecycle configuration elements\n in the Amazon S3 User Guide.
" + } } }, "traits": { @@ -8443,10 +8516,16 @@ "traits": { "smithy.api#documentation": "The class of storage used to store the object.
" } + }, + "NewerNoncurrentVersions": { + "target": "com.amazonaws.s3#VersionCount", + "traits": { + "smithy.api#documentation": "Specifies how many noncurrent versions Amazon S3 will retain. If there are this many more recent\n noncurrent versions, Amazon S3 will take the associated action. For more information about noncurrent\n versions, see Lifecycle configuration elements\n in the Amazon S3 User Guide.
" + } } }, "traits": { - "smithy.api#documentation": "Container for the transition rule that describes when noncurrent objects transition to\n the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING,\n GLACIER, or DEEP_ARCHIVE storage class. If your bucket is\n versioning-enabled (or versioning is suspended), you can set this action to request that\n Amazon S3 transition noncurrent object versions to the STANDARD_IA,\n ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, or\n DEEP_ARCHIVE storage class at a specific period in the object's\n lifetime.
Container for the transition rule that describes when noncurrent objects transition to\n the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING,\n GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage class. If your bucket is\n versioning-enabled (or versioning is suspended), you can set this action to request that\n Amazon S3 transition noncurrent object versions to the STANDARD_IA,\n ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or\n DEEP_ARCHIVE storage class at a specific period in the object's\n lifetime.
Enables delivery of events to Amazon EventBridge.
" + } } }, "traits": { @@ -8790,7 +8875,7 @@ "com.amazonaws.s3#ObjectOwnership": { "type": "string", "traits": { - "smithy.api#documentation": "The container element for object ownership for a bucket's ownership controls.
\nBucketOwnerPreferred - Objects uploaded to the bucket change ownership to the bucket\n owner if the objects are uploaded with the bucket-owner-full-control canned\n ACL.
ObjectWriter - The uploading account will own the object if the object is uploaded with\n the bucket-owner-full-control canned ACL.
The container element for object ownership for a bucket's ownership controls.
\nBucketOwnerPreferred - Objects uploaded to the bucket change ownership to the bucket\n owner if the objects are uploaded with the bucket-owner-full-control canned\n ACL.
ObjectWriter - The uploading account will own the object if the object is uploaded with\n the bucket-owner-full-control canned ACL.
BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect permissions. \n The bucket owner automatically owns and has full control over every object in the bucket. The bucket only\n accepts PUT requests that don't specify an ACL or bucket owner full control\n ACLs, such as the bucket-owner-full-control canned\n ACL or an equivalent form of this ACL expressed in the XML format.
Sets the permissions on an existing bucket using access control lists (ACL). For more\n information, see Using ACLs. To set\n the ACL of a bucket, you must have WRITE_ACP permission.
You can use one of the following two ways to set a bucket's permissions:
\nSpecify the ACL in the request body
\nSpecify permissions using request headers
\nYou cannot specify access permission using both the body and the request\n headers.
\nDepending on your application needs, you may choose to set the ACL on a bucket using\n either the request body or the headers. For example, if you have an existing application\n that updates a bucket ACL using the request body, then you can continue to use that\n approach.
\n\n\n\n Access Permissions\n
\nYou can set access permissions using one of the following methods:
\nSpecify a canned ACL with the x-amz-acl request header. Amazon S3 supports\n a set of predefined ACLs, known as canned ACLs. Each canned ACL\n has a predefined set of grantees and permissions. Specify the canned ACL name as the\n value of x-amz-acl. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read,\n x-amz-grant-read-acp, x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. When using these headers, you\n specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who\n will receive the permission. If you use these ACL-specific headers, you cannot use\n the x-amz-acl header to set a canned ACL. These parameters map to the\n set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL)\n Overview.
You specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id – if the value specified is the canonical user ID of an Amazon Web Services account
\n uri – if you are granting permissions to a predefined\n group
\n emailAddress – if the value specified is the email address of\n an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor example, the following x-amz-grant-write header grants create,\n overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and\n two Amazon Web Services accounts identified by their email addresses.
\n x-amz-grant-write: uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\",\n id=\"111122223333\", id=\"555566667777\" \n
You can use either a canned ACL or specify access permissions explicitly. You cannot do\n both.
\n\n Grantee Values\n
\nYou can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:
\nBy the person's ID:
\n\n
DisplayName is optional and ignored in the request
\nBy URI:
\n\n
By Email address:
\n\n
The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.
\nUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\n\n Related Resources\n
\n\n CreateBucket\n
\n\n DeleteBucket\n
\n\n GetObjectAcl\n
\nSets the permissions on an existing bucket using access control lists (ACL). For more\n information, see Using ACLs. To set\n the ACL of a bucket, you must have WRITE_ACP permission.
You can use one of the following two ways to set a bucket's permissions:
\nSpecify the ACL in the request body
\nSpecify permissions using request headers
\nYou cannot specify access permission using both the body and the request\n headers.
\nDepending on your application needs, you may choose to set the ACL on a bucket using\n either the request body or the headers. For example, if you have an existing application\n that updates a bucket ACL using the request body, then you can continue to use that\n approach.
\n\nIf your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. \n You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and \n return the AccessControlListNotSupported error code. Requests to read ACLs are still supported.\n For more information, see Controlling object ownership\n in the Amazon S3 User Guide.
\n Access Permissions\n
\nYou can set access permissions using one of the following methods:
\nSpecify a canned ACL with the x-amz-acl request header. Amazon S3 supports\n a set of predefined ACLs, known as canned ACLs. Each canned ACL\n has a predefined set of grantees and permissions. Specify the canned ACL name as the\n value of x-amz-acl. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read,\n x-amz-grant-read-acp, x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. When using these headers, you\n specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who\n will receive the permission. If you use these ACL-specific headers, you cannot use\n the x-amz-acl header to set a canned ACL. These parameters map to the\n set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL)\n Overview.
You specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id – if the value specified is the canonical user ID of an Amazon Web Services account
\n uri – if you are granting permissions to a predefined\n group
\n emailAddress – if the value specified is the email address of\n an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor example, the following x-amz-grant-write header grants create,\n overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and\n two Amazon Web Services accounts identified by their email addresses.
\n x-amz-grant-write: uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\",\n id=\"111122223333\", id=\"555566667777\" \n
You can use either a canned ACL or specify access permissions explicitly. You cannot do\n both.
\n\n Grantee Values\n
\nYou can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:
\nBy the person's ID:
\n\n
DisplayName is optional and ignored in the request
\nBy URI:
\n\n
By Email address:
\n\n
The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.
\nUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\n\n Related Resources\n
\n\n CreateBucket\n
\n\n DeleteBucket\n
\n\n GetObjectAcl\n
\nPuts a S3 Intelligent-Tiering configuration to the specified bucket.\n You can have up to 1,000 S3 Intelligent-Tiering configurations per bucket.
\nThe S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in two low latency and high throughput access tiers. For data that can be accessed asynchronously, you can choose to activate automatic archiving capabilities within the S3 Intelligent-Tiering storage class.
\nThe S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
\nFor more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to\n PutBucketIntelligentTieringConfiguration include:
You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically\n move objects stored in the S3 Intelligent-Tiering storage class to the\n Archive Access or Deep Archive Access tier.
\n\n Special Errors\n
\n\n HTTP 400 Bad Request Error\n
\n\n Code: InvalidArgument
\n\n Cause: Invalid Argument
\n\n HTTP 400 Bad Request Error\n
\n\n Code: TooManyConfigurations
\n\n Cause: You are attempting to create a new configuration\n but have already reached the 1,000-configuration limit.
\n\n HTTP 403 Forbidden Error\n
\n\n Code: AccessDenied
\n\n Cause: You are not the owner of the specified bucket,\n or you do not have the s3:PutIntelligentTieringConfiguration bucket\n permission to set the configuration on the bucket.
Puts a S3 Intelligent-Tiering configuration to the specified bucket.\n You can have up to 1,000 S3 Intelligent-Tiering configurations per bucket.
\nThe S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.
\nThe S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
\nFor more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to\n PutBucketIntelligentTieringConfiguration include:
You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically\n move objects stored in the S3 Intelligent-Tiering storage class to the\n Archive Access or Deep Archive Access tier.
\n\n Special Errors\n
\n\n HTTP 400 Bad Request Error\n
\n\n Code: InvalidArgument
\n\n Cause: Invalid Argument
\n\n HTTP 400 Bad Request Error\n
\n\n Code: TooManyConfigurations
\n\n Cause: You are attempting to create a new configuration\n but have already reached the 1,000-configuration limit.
\n\n HTTP 403 Forbidden Error\n
\n\n Code: AccessDenied
\n\n Cause: You are not the owner of the specified bucket,\n or you do not have the s3:PutIntelligentTieringConfiguration bucket\n permission to set the configuration on the bucket.
Set the logging parameters for a bucket and to specify permissions for who can view and\n modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as the\n source bucket. To set the logging status of a bucket, you must be the bucket owner.
\n\nThe bucket owner is automatically granted FULL_CONTROL to all logs. You use the\n Grantee request element to grant access to other people. The\n Permissions request element specifies the kind of access the grantee has to\n the logs.
\n Grantee Values\n
\nYou can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:
\n\nBy the person's ID:
\n\n
DisplayName is optional and ignored in the request.
\nBy Email address:
\n\n \n
The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.
\nBy URI:
\n\n
To enable logging, you use LoggingEnabled and its children request elements. To disable\n logging, you use an empty BucketLoggingStatus request element:
\n\n\n
For more information about server access logging, see Server Access Logging.
\n\nFor more information about creating a bucket, see CreateBucket. For more\n information about returning the logging status of a bucket, see GetBucketLogging.
\n\nThe following operations are related to PutBucketLogging:
\n PutObject\n
\n\n DeleteBucket\n
\n\n CreateBucket\n
\n\n GetBucketLogging\n
\nSet the logging parameters for a bucket and to specify permissions for who can view and\n modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as the\n source bucket. To set the logging status of a bucket, you must be the bucket owner.
\n\nThe bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee request element to grant access to other people. The\n Permissions request element specifies the kind of access the grantee has to\n the logs.
If the target bucket for log delivery uses the bucket owner enforced\n setting for S3 Object Ownership, you can't use the Grantee request element\n to grant access to others. Permissions can only be granted using policies. For more information, see Permissions for server access log delivery in the\n Amazon S3 User Guide.
\n Grantee Values\n
\nYou can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:
\n\nBy the person's ID:
\n\n
DisplayName is optional and ignored in the request.
\nBy Email address:
\n\n \n
The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.
\nBy URI:
\n\n
To enable logging, you use LoggingEnabled and its children request elements. To disable\n logging, you use an empty BucketLoggingStatus request element:
\n\n\n
For more information about server access logging, see Server Access Logging in the Amazon S3 User Guide.
\n\nFor more information about creating a bucket, see CreateBucket. For more\n information about returning the logging status of a bucket, see GetBucketLogging.
\n\nThe following operations are related to PutBucketLogging:
\n PutObject\n
\n\n DeleteBucket\n
\n\n CreateBucket\n
\n\n GetBucketLogging\n
\nThe account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Skips validation of Amazon SQS, Amazon SNS, and Lambda destinations. True or false value.
", + "smithy.api#httpHeader": "x-amz-skip-destination-validation" + } } } }, @@ -9807,7 +9913,7 @@ "target": "com.amazonaws.s3#PutBucketOwnershipControlsRequest" }, "traits": { - "smithy.api#documentation": "Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this\n operation, you must have the s3:PutBucketOwnershipControls permission. For\n more information about Amazon S3 permissions, see Specifying Permissions in a Policy.
For information about Amazon S3 Object Ownership, see Using Object Ownership.
\nThe following operations are related to PutBucketOwnershipControls:
Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this\n operation, you must have the s3:PutBucketOwnershipControls permission. For\n more information about Amazon S3 permissions, see Specifying permissions in a policy.
For information about Amazon S3 Object Ownership, see Using object ownership.
\nThe following operations are related to PutBucketOwnershipControls:
The OwnershipControls (BucketOwnerPreferred or ObjectWriter) that you want\n to apply to this Amazon S3 bucket.
The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) that you want\n to apply to this Amazon S3 bucket.
Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object\n to it.
\n\n\nAmazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the\n entire object to the bucket.
\n\nAmazon S3 is a distributed system. If it receives multiple write requests for the same object\n simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object\n locking; if you need this, make sure to build it into your application layer or use\n versioning instead.
\n\nTo ensure that data is not corrupted traversing the network, use the\n Content-MD5 header. When you use this header, Amazon S3 checks the object\n against the provided MD5 value and, if they do not match, returns an error. Additionally,\n you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to\n the calculated MD5 value.
To successfully complete the PutObject request, you must have the \n s3:PutObject in your IAM permissions.
To successfully change the objects acl of your PutObject request, \n you must have the s3:PutObjectAcl in your IAM permissions.
The Content-MD5 header is required for any request to upload an object\n with a retention period configured using Amazon S3 Object Lock. For more information about\n Amazon S3 Object Lock, see Amazon S3 Object Lock Overview\n in the Amazon S3 User Guide.
\n Server-side Encryption\n
\nYou can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts \n your data as it writes it to disks in its data centers and decrypts the data\n when you access it. You have the option to provide your own encryption key or use Amazon Web Services\n managed encryption keys (SSE-S3 or SSE-KMS). For more information, see Using Server-Side\n Encryption.
\nIf you request server-side encryption using Amazon Web Services Key Management Service (SSE-KMS), you can enable \n an S3 Bucket Key at the object-level. For more information, see Amazon S3 Bucket Keys in the \n Amazon S3 User Guide.
\n\n Access Control List (ACL)-Specific Request\n Headers\n
\nYou can use headers to grant ACL- based permissions. By default, all objects are\n private. Only the owner has full access control. When adding a new object, you can grant\n permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These\n permissions are then added to the ACL on the object. For more information, see Access Control List\n (ACL) Overview and Managing ACLs Using the REST\n API.
\n\n\n Storage Class Options\n
\nBy default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the\n Amazon S3 User Guide.
\n\n\n\n Versioning\n
\nIf you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID\n for the object being stored. Amazon S3 returns this ID in the response. When you enable\n versioning for a bucket, if Amazon S3 receives multiple write requests for the same object\n simultaneously, it stores all of the objects.
\nFor more information about versioning, see Adding Objects to\n Versioning Enabled Buckets. For information about returning the versioning state\n of a bucket, see GetBucketVersioning.
\n\n\n\n Related Resources\n
\n\n CopyObject\n
\n\n DeleteObject\n
\nAdds an object to a bucket. You must have WRITE permissions on a bucket to add an object\n to it.
\n\n\nAmazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the\n entire object to the bucket.
\n\nAmazon S3 is a distributed system. If it receives multiple write requests for the same object\n simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object\n locking; if you need this, make sure to build it into your application layer or use\n versioning instead.
\n\nTo ensure that data is not corrupted traversing the network, use the\n Content-MD5 header. When you use this header, Amazon S3 checks the object\n against the provided MD5 value and, if they do not match, returns an error. Additionally,\n you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to\n the calculated MD5 value.
To successfully complete the PutObject request, you must have the \n s3:PutObject in your IAM permissions.
To successfully change the objects acl of your PutObject request, \n you must have the s3:PutObjectAcl in your IAM permissions.
The Content-MD5 header is required for any request to upload an object\n with a retention period configured using Amazon S3 Object Lock. For more information about\n Amazon S3 Object Lock, see Amazon S3 Object Lock Overview\n in the Amazon S3 User Guide.
\n Server-side Encryption\n
\nYou can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts \n your data as it writes it to disks in its data centers and decrypts the data\n when you access it. You have the option to provide your own encryption key or use Amazon Web Services\n managed encryption keys (SSE-S3 or SSE-KMS). For more information, see Using Server-Side\n Encryption.
\nIf you request server-side encryption using Amazon Web Services Key Management Service (SSE-KMS), you can enable \n an S3 Bucket Key at the object-level. For more information, see Amazon S3 Bucket Keys in the \n Amazon S3 User Guide.
\n\n Access Control List (ACL)-Specific Request\n Headers\n
\nYou can use headers to grant ACL- based permissions. By default, all objects are\n private. Only the owner has full access control. When adding a new object, you can grant\n permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These\n permissions are then added to the ACL on the object. For more information, see Access Control List\n (ACL) Overview and Managing ACLs Using the REST\n API.
\nIf the bucket that you're uploading objects to uses the bucket owner enforced setting\n for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that\n use this setting only accept PUT requests that don't specify an ACL or PUT requests that\n specify bucket owner full control ACLs, such as the bucket-owner-full-control canned\n ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other\n ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a\n 400 error with the error code\n AccessControlListNotSupported.
For more information, see Controlling ownership of\n objects and disabling ACLs in the Amazon S3 User Guide.
\nIf your bucket uses the bucket owner enforced setting for Object Ownership, \n all objects written to the bucket by any account will be owned by the bucket owner.
\n\n Storage Class Options\n
\nBy default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the\n Amazon S3 User Guide.
\n\n\n\n Versioning\n
\nIf you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID\n for the object being stored. Amazon S3 returns this ID in the response. When you enable\n versioning for a bucket, if Amazon S3 receives multiple write requests for the same object\n simultaneously, it stores all of the objects.
\nFor more information about versioning, see Adding Objects to\n Versioning Enabled Buckets. For information about returning the versioning state\n of a bucket, see GetBucketVersioning.
\n\n\n\n Related Resources\n
\n\n CopyObject\n
\n\n DeleteObject\n
\nUses the acl subresource to set the access control list (ACL) permissions\n for a new or existing object in an S3 bucket. You must have WRITE_ACP\n permission to set the ACL of an object. For more information, see What\n permissions can I grant? in the Amazon S3 User Guide.
This action is not supported by Amazon S3 on Outposts.
\nDepending on your application needs, you can choose to set\n the ACL on an object using either the request body or the headers. For example, if you have\n an existing application that updates a bucket ACL using the request body, you can continue\n to use that approach. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
\n\n\n\n\n Access Permissions\n
\nYou can set access permissions using one of the following methods:
\nSpecify a canned ACL with the x-amz-acl request header. Amazon S3 supports\n a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set\n of grantees and permissions. Specify the canned ACL name as the value of\n x-amz-acl. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read,\n x-amz-grant-read-acp, x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. When using these headers, you\n specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who\n will receive the permission. If you use these ACL-specific headers, you cannot use\n x-amz-acl header to set a canned ACL. These parameters map to the set\n of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL)\n Overview.
You specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id – if the value specified is the canonical user ID of an Amazon Web Services account
\n uri – if you are granting permissions to a predefined\n group
\n emailAddress – if the value specified is the email address of\n an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor example, the following x-amz-grant-read header grants list\n objects permission to the two Amazon Web Services accounts identified by their email\n addresses.
\n x-amz-grant-read: emailAddress=\"xyz@amazon.com\",\n emailAddress=\"abc@amazon.com\" \n
You can use either a canned ACL or specify access permissions explicitly. You cannot do\n both.
\n\n Grantee Values\n
\nYou can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:
\nBy the person's ID:
\n\n
DisplayName is optional and ignored in the request.
\nBy URI:
\n\n
By Email address:
\n\n
The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.
\nUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\n\n Versioning\n
\nThe ACL of an object is set at the object version level. By default, PUT sets the ACL of\n the current version of an object. To set the ACL of a different version, use the\n versionId subresource.
\n Related Resources\n
\n\n CopyObject\n
\n\n GetObject\n
\nUses the acl subresource to set the access control list (ACL) permissions\n for a new or existing object in an S3 bucket. You must have WRITE_ACP\n permission to set the ACL of an object. For more information, see What\n permissions can I grant? in the Amazon S3 User Guide.
This action is not supported by Amazon S3 on Outposts.
\nDepending on your application needs, you can choose to set\n the ACL on an object using either the request body or the headers. For example, if you have\n an existing application that updates a bucket ACL using the request body, you can continue\n to use that approach. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
\nIf your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. \n You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and \n return the AccessControlListNotSupported error code. Requests to read ACLs are still supported.\n For more information, see Controlling object ownership\n in the Amazon S3 User Guide.
\n Access Permissions\n
\nYou can set access permissions using one of the following methods:
\nSpecify a canned ACL with the x-amz-acl request header. Amazon S3 supports\n a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set\n of grantees and permissions. Specify the canned ACL name as the value of\n x-amz-acl. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read,\n x-amz-grant-read-acp, x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. When using these headers, you\n specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who\n will receive the permission. If you use these ACL-specific headers, you cannot use\n x-amz-acl header to set a canned ACL. These parameters map to the set\n of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL)\n Overview.
You specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id – if the value specified is the canonical user ID of an Amazon Web Services account
\n uri – if you are granting permissions to a predefined\n group
\n emailAddress – if the value specified is the email address of\n an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor example, the following x-amz-grant-read header grants list\n objects permission to the two Amazon Web Services accounts identified by their email\n addresses.
\n x-amz-grant-read: emailAddress=\"xyz@amazon.com\",\n emailAddress=\"abc@amazon.com\" \n
You can use either a canned ACL or specify access permissions explicitly. You cannot do\n both.
\n\n Grantee Values\n
\nYou can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:
\nBy the person's ID:
\n\n
DisplayName is optional and ignored in the request.
\nBy URI:
\n\n
By Email address:
\n\n
The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.
\nUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\n\n Versioning\n
\nThe ACL of an object is set at the object version level. By default, PUT sets the ACL of\n the current version of an object. To set the ACL of a different version, use the\n versionId subresource.
\n Related Resources\n
\n\n CopyObject\n
\n\n GetObject\n
\nContainer for granting information.
" + "smithy.api#documentation": "Container for granting information.
\nBuckets that use the bucket owner enforced setting for Object\n Ownership don't support target grants. For more information, see Permissions server access log delivery in the\n Amazon S3 User Guide.
" } }, "com.amazonaws.s3#TargetGrants": { @@ -12561,6 +12674,10 @@ { "value": "DEEP_ARCHIVE", "name": "DEEP_ARCHIVE" + }, + { + "value": "GLACIER_IR", + "name": "GLACIER_IR" } ] } @@ -12983,6 +13100,9 @@ "com.amazonaws.s3#Value": { "type": "string" }, + "com.amazonaws.s3#VersionCount": { + "type": "integer" + }, "com.amazonaws.s3#VersionIdMarker": { "type": "string" }, diff --git a/aws/sdk/aws-models/s3control.json b/aws/sdk/aws-models/s3control.json index f432e9b31c20029e729bd50672ba8b4d936788c4..bce826ade4446c0e8807df29bf65549ce5dad5be 100644 --- a/aws/sdk/aws-models/s3control.json +++ b/aws/sdk/aws-models/s3control.json @@ -31,6 +31,24 @@ "shapes": { "com.amazonaws.s3control#AWSS3ControlServiceV20180820": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "S3 Control", + "arnNamespace": "s3", + "cloudFormationName": "S3Control", + "cloudTrailEventSource": "s3control.amazonaws.com", + "endpointPrefix": "s3-control" + }, + "aws.auth#sigv4": { + "name": "s3" + }, + "aws.protocols#restXml": {}, + "smithy.api#documentation": "\n Amazon Web Services S3 Control provides access to Amazon S3 control plane actions.\n \n
", + "smithy.api#title": "AWS S3 Control", + "smithy.api#xmlNamespace": { + "uri": "http://awss3control.amazonaws.com/doc/2018-08-20/" + } + }, "version": "2018-08-20", "operations": [ { @@ -204,25 +222,7 @@ { "target": "com.amazonaws.s3control#UpdateJobStatus" } - ], - "traits": { - "aws.api#service": { - "sdkId": "S3 Control", - "arnNamespace": "s3", - "cloudFormationName": "S3Control", - "cloudTrailEventSource": "s3control.amazonaws.com", - "endpointPrefix": "s3-control" - }, - "aws.auth#sigv4": { - "name": "s3" - }, - "aws.protocols#restXml": {}, - "smithy.api#documentation": "\n Amazon Web Services S3 Control provides access to Amazon S3 control plane actions.\n \n
", - "smithy.api#title": "AWS S3 Control", - "smithy.api#xmlNamespace": { - "uri": "http://awss3control.amazonaws.com/doc/2018-08-20/" - } - } + ] }, "com.amazonaws.s3control#AbortIncompleteMultipartUpload": { "type": "structure", @@ -692,6 +692,21 @@ } } }, + "com.amazonaws.s3control#CloudWatchMetrics": { + "type": "structure", + "members": { + "IsEnabled": { + "target": "com.amazonaws.s3control#IsEnabled", + "traits": { + "smithy.api#documentation": "A container that indicates whether CloudWatch publishing for S3 Storage Lens metrics is enabled. A value of true indicates that CloudWatch publishing for S3 Storage Lens metrics is enabled.
A container for enabling Amazon CloudWatch publishing for S3 Storage Lens metrics.
\nFor more information about publishing S3 Storage Lens metrics to CloudWatch, see Monitor S3 Storage Lens metrics in CloudWatch in the Amazon S3 User Guide.
" + } + }, "com.amazonaws.s3control#ConfigId": { "type": "string", "traits": { @@ -907,6 +922,14 @@ "smithy.api#required": {} } }, + "CreateBucketConfiguration": { + "target": "com.amazonaws.s3control#CreateBucketConfiguration", + "traits": { + "smithy.api#documentation": "The configuration information for the bucket.
\nThis is not supported by Amazon S3 on Outposts buckets.
\nThe ID of the Outposts where the bucket is being created.
\nThis is required by Amazon S3 on Outposts buckets.
\nThe configuration information for the bucket.
\nThis is not supported by Amazon S3 on Outposts buckets.
\nThe account ID for the Amazon Web Services account whose PublicAccessBlock configuration you want\n to set.
The account ID for the Amazon Web Services account whose PublicAccessBlock configuration you want\n to set.
A container for the bucket where the S3 Storage Lens metrics export will be located.
\nThis bucket must be located in the same Region as the storage lens configuration.
\nA container for the bucket where the S3 Storage Lens metrics export will be located.
\nThis bucket must be located in the same Region as the storage lens configuration.
\nA container for enabling Amazon CloudWatch publishing for S3 Storage Lens metrics.
" } } }, diff --git a/aws/sdk/aws-models/sagemaker.json b/aws/sdk/aws-models/sagemaker.json index d3c8743b7f5fb89d238fafc76519361feedade0a..97ebbc273797aeb2dc6a818e90336619c21de0d1 100644 --- a/aws/sdk/aws-models/sagemaker.json +++ b/aws/sdk/aws-models/sagemaker.json @@ -285,6 +285,70 @@ } } }, + "com.amazonaws.sagemaker#AdditionalInferenceSpecificationDefinition": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#documentation": "A unique name to identify the additional inference specification. The name must \n be unique within the list of your additional inference specifications for a \n particular model package.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "A description of the additional Inference specification
" + } + }, + "Containers": { + "target": "com.amazonaws.sagemaker#ModelPackageContainerDefinitionList", + "traits": { + "smithy.api#documentation": "The Amazon ECR registry path of the Docker image that contains the inference code.
", + "smithy.api#required": {} + } + }, + "SupportedTransformInstanceTypes": { + "target": "com.amazonaws.sagemaker#TransformInstanceTypes", + "traits": { + "smithy.api#documentation": "A list of the instance types on which a transformation job can be run \n or on which an endpoint can be deployed.
" + } + }, + "SupportedRealtimeInferenceInstanceTypes": { + "target": "com.amazonaws.sagemaker#RealtimeInferenceInstanceTypes", + "traits": { + "smithy.api#documentation": "A list of the instance types that are used to generate inferences in real-time.
" + } + }, + "SupportedContentTypes": { + "target": "com.amazonaws.sagemaker#ContentTypes", + "traits": { + "smithy.api#documentation": "The supported MIME types for the input data.
" + } + }, + "SupportedResponseMIMETypes": { + "target": "com.amazonaws.sagemaker#ResponseMIMETypes", + "traits": { + "smithy.api#documentation": "The supported MIME types for the output data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure of additional Inference Specification. Additional Inference Specification \n specifies details about inference jobs that can be run with models based on\n this model package
" + } + }, + "com.amazonaws.sagemaker#AdditionalInferenceSpecifications": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecificationDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 15 + } + } + }, "com.amazonaws.sagemaker#AgentVersion": { "type": "structure", "members": { @@ -2575,6 +2639,12 @@ "traits": { "smithy.api#documentation": "The bias report for a model
" } + }, + "PreTrainingReport": { + "target": "com.amazonaws.sagemaker#MetricsSource" + }, + "PostTrainingReport": { + "target": "com.amazonaws.sagemaker#MetricsSource" } }, "traits": { @@ -2979,6 +3049,28 @@ "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" } }, + "com.amazonaws.sagemaker#CategoricalParameter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#String64", + "traits": { + "smithy.api#documentation": "The Name of the environment variable.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#CategoricalParameterRangeValues", + "traits": { + "smithy.api#documentation": "The list of values you can pass.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Environment parameters you want to benchmark your load test against.
" + } + }, "com.amazonaws.sagemaker#CategoricalParameterRange": { "type": "structure", "members": { @@ -3016,6 +3108,18 @@ "smithy.api#documentation": "Defines the possible values for a categorical hyperparameter.
" } }, + "com.amazonaws.sagemaker#CategoricalParameterRangeValues": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#String128" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } + } + }, "com.amazonaws.sagemaker#CategoricalParameterRanges": { "type": "list", "member": { @@ -3028,6 +3132,18 @@ } } }, + "com.amazonaws.sagemaker#CategoricalParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#CategoricalParameter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, "com.amazonaws.sagemaker#Cents": { "type": "integer", "traits": { @@ -3198,6 +3314,62 @@ "target": "com.amazonaws.sagemaker#Cidr" } }, + "com.amazonaws.sagemaker#ClarifyCheckStepMetadata": { + "type": "structure", + "members": { + "CheckType": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The type of the Clarify Check step
" + } + }, + "BaselineUsedForDriftCheckConstraints": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "The Amazon S3 URI of baseline constraints file to be used for the drift check.
" + } + }, + "CalculatedBaselineConstraints": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "The Amazon S3 URI of the newly calculated baseline constraints file.
" + } + }, + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The model package group name.
" + } + }, + "ViolationReport": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "The Amazon S3 URI of the violation report if violations are detected.
" + } + }, + "CheckJobArn": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the check processing job that was run by this step's execution.
" + } + }, + "SkipCheck": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "This flag indicates if the drift check against the previous baseline will be skipped or not. \n If it is set to False, the previous baseline of the configured check type must be available.
This flag indicates if a newly calculated baseline can be accessed through step properties \n BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. \n If it is set to False, the previous baseline of the configured check type must also be available. \n These can be accessed through the BaselineUsedForDriftCheckConstraints property.
The container for the metadata for the ClarifyCheck step. For more information, \n see the topic on ClarifyCheck step in the Amazon SageMaker Developer Guide.\n
" + } + }, "com.amazonaws.sagemaker#ClientId": { "type": "string", "traits": { @@ -3763,6 +3935,12 @@ "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model package to use to create the\n model.
" } }, + "InferenceSpecificationName": { + "target": "com.amazonaws.sagemaker#InferenceSpecificationName", + "traits": { + "smithy.api#documentation": "The inference specification name in the model package version.
" + } + }, "MultiModelConfig": { "target": "com.amazonaws.sagemaker#MultiModelConfig", "traits": { @@ -4589,11 +4767,16 @@ "smithy.api#required": {} } }, + "ModelPackageVersionArn": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a versioned model package. Provide either a \n ModelPackageVersionArn or an InputConfig object in the \n request syntax. The presence of both objects in the CreateCompilationJob \n request will return an exception.
Provides information about the location of input model artifacts, the name and shape\n of the expected data inputs, and the framework in which the model was trained.
", - "smithy.api#required": {} + "smithy.api#documentation": "Provides information about the location of input model artifacts, the name and shape\n of the expected data inputs, and the framework in which the model was trained.
" } }, "OutputConfig": { @@ -5677,6 +5860,89 @@ } } }, + "com.amazonaws.sagemaker#CreateInferenceRecommendationsJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateInferenceRecommendationsJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateInferenceRecommendationsJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Starts a recommendation job. You can create either an instance \n recommendation or load test job.
" + } + }, + "com.amazonaws.sagemaker#CreateInferenceRecommendationsJobRequest": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobName", + "traits": { + "smithy.api#documentation": "A name for the recommendation job. The name must be unique within \n the Amazon Web Services Region and within your Amazon Web Services account.
", + "smithy.api#required": {} + } + }, + "JobType": { + "target": "com.amazonaws.sagemaker#RecommendationJobType", + "traits": { + "smithy.api#documentation": "Defines the type of recommendation job. Specify Default to initiate an instance \n recommendation and Advanced to initiate a load test. If left unspecified, \n Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker \n to perform tasks on your behalf.
", + "smithy.api#required": {} + } + }, + "InputConfig": { + "target": "com.amazonaws.sagemaker#RecommendationJobInputConfig", + "traits": { + "smithy.api#documentation": "Provides information about the versioned model package Amazon Resource Name (ARN), \n the traffic pattern, and endpoint configurations.
", + "smithy.api#required": {} + } + }, + "JobDescription": { + "target": "com.amazonaws.sagemaker#RecommendationJobDescription", + "traits": { + "smithy.api#documentation": "Description of the recommendation job.
" + } + }, + "StoppingConditions": { + "target": "com.amazonaws.sagemaker#RecommendationJobStoppingConditions", + "traits": { + "smithy.api#documentation": "A set of conditions for stopping a recommendation job. If any of \n the conditions are met, the job is automatically stopped.
" + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "The metadata that you apply to Amazon Web Services resources to help you \n categorize and organize them. Each tag consists of a key and a value, both of \n which you define. For more information, see \n Tagging Amazon Web Services Resources \n in the Amazon Web Services General Reference.
" + } + } + } + }, + "com.amazonaws.sagemaker#CreateInferenceRecommendationsJobResponse": { + "type": "structure", + "members": { + "JobArn": { + "target": "com.amazonaws.sagemaker#RecommendationJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recommendation job.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.sagemaker#CreateLabelingJob": { "type": "operation", "input": { @@ -6211,6 +6477,36 @@ "traits": { "smithy.api#documentation": "The metadata properties associated with the model package versions.
" } + }, + "DriftCheckBaselines": { + "target": "com.amazonaws.sagemaker#DriftCheckBaselines", + "traits": { + "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set using the model package.\n For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.\n
" + } + }, + "Domain": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The machine learning domain of your model package and its components. Common \n machine learning domains include computer vision and natural language processing.
" + } + }, + "Task": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The machine learning task your model package accomplishes. Common machine \n learning tasks include object detection and image classification.
" + } + }, + "SamplePayloadUrl": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path must point \n to a single gzip compressed tar archive (.tar.gz suffix).
" + } + }, + "AdditionalInferenceSpecifications": { + "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecifications", + "traits": { + "smithy.api#documentation": "An array of additional Inference Specification objects. Each additional \n Inference Specification specifies artifacts based on this model package that can \n be used on inference endpoints. Generally used with SageMaker Neo to store the \n compiled artifacts.
" + } } } }, @@ -9531,7 +9827,7 @@ "type": "structure", "members": { "ActionName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "target": "com.amazonaws.sagemaker#ExperimentEntityNameOrArn", "traits": { "smithy.api#documentation": "The name of the action.
" } @@ -9592,6 +9888,12 @@ }, "MetadataProperties": { "target": "com.amazonaws.sagemaker#MetadataProperties" + }, + "LineageGroupArn": { + "target": "com.amazonaws.sagemaker#LineageGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lineage group.
" + } } } }, @@ -9914,7 +10216,7 @@ "type": "structure", "members": { "ArtifactName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "target": "com.amazonaws.sagemaker#ExperimentEntityNameOrArn", "traits": { "smithy.api#documentation": "The name of the artifact.
" } @@ -9963,6 +10265,12 @@ }, "MetadataProperties": { "target": "com.amazonaws.sagemaker#MetadataProperties" + }, + "LineageGroupArn": { + "target": "com.amazonaws.sagemaker#LineageGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lineage group.
" + } } } }, @@ -10276,6 +10584,12 @@ "smithy.api#documentation": "The inference image to use when compiling a model. \n Specify an image only if the target device is a cloud instance.
" } }, + "ModelPackageVersionArn": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the versioned model package that was \n provided to SageMaker Neo when you initiated a compilation job.
" + } + }, "CreationTime": { "target": "com.amazonaws.sagemaker#CreationTime", "traits": { @@ -10360,7 +10674,7 @@ "type": "structure", "members": { "ContextName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "target": "com.amazonaws.sagemaker#ExperimentEntityNameOrArn", "traits": { "smithy.api#documentation": "The name of the context to describe.
", "smithy.api#required": {} @@ -10424,6 +10738,12 @@ }, "LastModifiedBy": { "target": "com.amazonaws.sagemaker#UserContext" + }, + "LineageGroupArn": { + "target": "com.amazonaws.sagemaker#LineageGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lineage group.
" + } } } }, @@ -12107,6 +12427,126 @@ } } }, + "com.amazonaws.sagemaker#DescribeInferenceRecommendationsJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeInferenceRecommendationsJobRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeInferenceRecommendationsJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Provides the results of the Inference Recommender job. \n One or more recommendation jobs are returned.
" + } + }, + "com.amazonaws.sagemaker#DescribeInferenceRecommendationsJobRequest": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobName", + "traits": { + "smithy.api#documentation": "The name of the job. The name must be unique within an \n Amazon Web Services Region in the Amazon Web Services account.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.sagemaker#DescribeInferenceRecommendationsJobResponse": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobName", + "traits": { + "smithy.api#documentation": "The name of the job. The name must be unique within an \n Amazon Web Services Region in the Amazon Web Services account.
", + "smithy.api#required": {} + } + }, + "JobDescription": { + "target": "com.amazonaws.sagemaker#RecommendationJobDescription", + "traits": { + "smithy.api#documentation": "The job description that you provided when you initiated the job.
" + } + }, + "JobType": { + "target": "com.amazonaws.sagemaker#RecommendationJobType", + "traits": { + "smithy.api#documentation": "The job type that you provided when you initiated the job.
", + "smithy.api#required": {} + } + }, + "JobArn": { + "target": "com.amazonaws.sagemaker#RecommendationJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the job.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services \n Identity and Access Management (IAM) role you provided when you initiated the job.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#RecommendationJobStatus", + "traits": { + "smithy.api#documentation": "The status of the job.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A timestamp that shows when the job was created.
", + "smithy.api#required": {} + } + }, + "CompletionTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that shows when the job completed.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "A timestamp that shows when the job was last modified.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "If the job fails, provides information why the job failed.
" + } + }, + "InputConfig": { + "target": "com.amazonaws.sagemaker#RecommendationJobInputConfig", + "traits": { + "smithy.api#documentation": "Returns information about the versioned model package Amazon Resource Name (ARN), \n the traffic pattern, and endpoint configurations you provided when you initiated the job.
", + "smithy.api#required": {} + } + }, + "StoppingConditions": { + "target": "com.amazonaws.sagemaker#RecommendationJobStoppingConditions", + "traits": { + "smithy.api#documentation": "The stopping conditions that you provided when you initiated the job.
" + } + }, + "InferenceRecommendations": { + "target": "com.amazonaws.sagemaker#InferenceRecommendations", + "traits": { + "smithy.api#documentation": "The recommendations made by Inference Recommender.
" + } + } + } + }, "com.amazonaws.sagemaker#DescribeLabelingJob": { "type": "operation", "input": { @@ -12260,6 +12700,82 @@ } } }, + "com.amazonaws.sagemaker#DescribeLineageGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeLineageGroupRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeLineageGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Provides a list of properties for the requested lineage group. \n For more information, see \n Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.
" + } + }, + "com.amazonaws.sagemaker#DescribeLineageGroupRequest": { + "type": "structure", + "members": { + "LineageGroupName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the lineage group.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.sagemaker#DescribeLineageGroupResponse": { + "type": "structure", + "members": { + "LineageGroupName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name of the lineage group.
" + } + }, + "LineageGroupArn": { + "target": "com.amazonaws.sagemaker#LineageGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lineage group.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The display name of the lineage group.
" + } + }, + "Description": { + "target": "com.amazonaws.sagemaker#ExperimentDescription", + "traits": { + "smithy.api#documentation": "The description of the lineage group.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The creation time of lineage group.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The last modified time of the lineage group.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + } + } + }, "com.amazonaws.sagemaker#DescribeModel": { "type": "operation", "input": { @@ -12764,6 +13280,36 @@ "traits": { "smithy.api#documentation": "The metadata properties associated with the model package versions.
" } + }, + "DriftCheckBaselines": { + "target": "com.amazonaws.sagemaker#DriftCheckBaselines", + "traits": { + "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set using the model package. \n For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.\n
" + } + }, + "Domain": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The machine learning domain of the model package you specified. Common machine \n learning domains include computer vision and natural language processing.
" + } + }, + "Task": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The machine learning task you specified that your model package accomplishes. \n Common machine learning tasks include object detection and image classification.
" + } + }, + "SamplePayloadUrl": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single \n gzip compressed tar archive (.tar.gz suffix).
" + } + }, + "AdditionalInferenceSpecifications": { + "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecifications", + "traits": { + "smithy.api#documentation": "An array of additional Inference Specification objects. Each additional \n Inference Specification specifies artifacts based on this model package that can \n be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
" + } } } }, @@ -14469,7 +15015,7 @@ "type": "structure", "members": { "TrialComponentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "target": "com.amazonaws.sagemaker#ExperimentEntityNameOrArn", "traits": { "smithy.api#documentation": "The name of the trial component to describe.
", "smithy.api#required": {} @@ -14572,6 +15118,12 @@ "traits": { "smithy.api#documentation": "The metrics for the component.
" } + }, + "LineageGroupArn": { + "target": "com.amazonaws.sagemaker#LineageGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lineage group.
" + } } } }, @@ -15163,6 +15715,25 @@ ] } }, + "com.amazonaws.sagemaker#Direction": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Both", + "name": "BOTH" + }, + { + "value": "Ascendants", + "name": "ASCENDANTS" + }, + { + "value": "Descendants", + "name": "DESCENDANTS" + } + ] + } + }, "com.amazonaws.sagemaker#DirectoryPath": { "type": "string", "traits": { @@ -15442,6 +16013,129 @@ "smithy.api#box": {} } }, + "com.amazonaws.sagemaker#DriftCheckBaselines": { + "type": "structure", + "members": { + "Bias": { + "target": "com.amazonaws.sagemaker#DriftCheckBias", + "traits": { + "smithy.api#documentation": "Represents the drift check bias baselines that can be used when the model monitor is set using the model \n package.
" + } + }, + "Explainability": { + "target": "com.amazonaws.sagemaker#DriftCheckExplainability", + "traits": { + "smithy.api#documentation": "Represents the drift check explainability baselines that can be used when the model monitor is set using \n the model package.
" + } + }, + "ModelQuality": { + "target": "com.amazonaws.sagemaker#DriftCheckModelQuality", + "traits": { + "smithy.api#documentation": "Represents the drift check model quality baselines that can be used when the model monitor is set using \n the model package.
" + } + }, + "ModelDataQuality": { + "target": "com.amazonaws.sagemaker#DriftCheckModelDataQuality", + "traits": { + "smithy.api#documentation": "Represents the drift check model data quality baselines that can be used when the model monitor is set \n using the model package.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set using the model \n package.
" + } + }, + "com.amazonaws.sagemaker#DriftCheckBias": { + "type": "structure", + "members": { + "ConfigFile": { + "target": "com.amazonaws.sagemaker#FileSource", + "traits": { + "smithy.api#documentation": "The bias config file for a model.
" + } + }, + "PreTrainingConstraints": { + "target": "com.amazonaws.sagemaker#MetricsSource" + }, + "PostTrainingConstraints": { + "target": "com.amazonaws.sagemaker#MetricsSource" + } + }, + "traits": { + "smithy.api#documentation": "Represents the drift check bias baselines that can be used when the model monitor is set using the \n model package.
" + } + }, + "com.amazonaws.sagemaker#DriftCheckExplainability": { + "type": "structure", + "members": { + "Constraints": { + "target": "com.amazonaws.sagemaker#MetricsSource" + }, + "ConfigFile": { + "target": "com.amazonaws.sagemaker#FileSource", + "traits": { + "smithy.api#documentation": "The explainability config file for the model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the drift check explainability baselines that can be used when the model monitor is set \n using the model package.
" + } + }, + "com.amazonaws.sagemaker#DriftCheckModelDataQuality": { + "type": "structure", + "members": { + "Statistics": { + "target": "com.amazonaws.sagemaker#MetricsSource" + }, + "Constraints": { + "target": "com.amazonaws.sagemaker#MetricsSource" + } + }, + "traits": { + "smithy.api#documentation": "Represents the drift check data quality baselines that can be used when the model monitor is set using \n the model package.
" + } + }, + "com.amazonaws.sagemaker#DriftCheckModelQuality": { + "type": "structure", + "members": { + "Statistics": { + "target": "com.amazonaws.sagemaker#MetricsSource" + }, + "Constraints": { + "target": "com.amazonaws.sagemaker#MetricsSource" + } + }, + "traits": { + "smithy.api#documentation": "Represents the drift check model quality baselines that can be used when the model monitor is set using \n the model package.
" + } + }, + "com.amazonaws.sagemaker#Edge": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source lineage entity of the directed edge.
" + } + }, + "DestinationArn": { + "target": "com.amazonaws.sagemaker#AssociationEntityArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination lineage entity of the directed edge.
" + } + }, + "AssociationType": { + "target": "com.amazonaws.sagemaker#AssociationEdgeType", + "traits": { + "smithy.api#documentation": "The type of the Association(Edge) between the source and destination. For example ContributedTo, \n Produced, or DerivedFrom.
A directed edge connecting two lineage entities.
" + } + }, "com.amazonaws.sagemaker#EdgeModel": { "type": "structure", "members": { @@ -15783,6 +16477,12 @@ "smithy.api#pattern": "^[a-zA-Z0-9\\ \\_\\.]+$" } }, + "com.amazonaws.sagemaker#Edges": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Edge" + } + }, "com.amazonaws.sagemaker#EfsUid": { "type": "string", "traits": { @@ -16059,6 +16759,45 @@ "smithy.api#documentation": "Input object for the endpoint
" } }, + "com.amazonaws.sagemaker#EndpointInputConfiguration": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.sagemaker#ProductionVariantInstanceType", + "traits": { + "smithy.api#documentation": "The instance types to use for the load test.
", + "smithy.api#required": {} + } + }, + "InferenceSpecificationName": { + "target": "com.amazonaws.sagemaker#InferenceSpecificationName", + "traits": { + "smithy.api#documentation": "The inference specification name in the model package version.
" + } + }, + "EnvironmentParameterRanges": { + "target": "com.amazonaws.sagemaker#EnvironmentParameterRanges", + "traits": { + "smithy.api#documentation": "The parameter you want to benchmark against.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The endpoint configuration for the load test.
" + } + }, + "com.amazonaws.sagemaker#EndpointInputConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EndpointInputConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.sagemaker#EndpointName": { "type": "string", "traits": { @@ -16079,6 +16818,42 @@ "smithy.api#pattern": "^[a-zA-Z0-9-]+$" } }, + "com.amazonaws.sagemaker#EndpointOutputConfiguration": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The name of the endpoint made during a recommendation job.
", + "smithy.api#required": {} + } + }, + "VariantName": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The name of the production variant (deployed model) made during a recommendation job.
", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ProductionVariantInstanceType", + "traits": { + "smithy.api#documentation": "The instance type recommended by Amazon SageMaker Inference Recommender.
", + "smithy.api#required": {} + } + }, + "InitialInstanceCount": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The number of instances recommended to launch initially.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The endpoint configuration made by Inference Recommender during a recommendation job.
" + } + }, "com.amazonaws.sagemaker#EndpointSortKey": { "type": "string", "traits": { @@ -16231,6 +17006,61 @@ } } }, + "com.amazonaws.sagemaker#EnvironmentParameter": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The environment key suggested by the Amazon SageMaker Inference Recommender.
", + "smithy.api#required": {} + } + }, + "ValueType": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The value type suggested by the Amazon SageMaker Inference Recommender.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The value suggested by the Amazon SageMaker Inference Recommender.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A list of environment parameters suggested by the Amazon SageMaker Inference Recommender.
" + } + }, + "com.amazonaws.sagemaker#EnvironmentParameterRanges": { + "type": "structure", + "members": { + "CategoricalParameterRanges": { + "target": "com.amazonaws.sagemaker#CategoricalParameters", + "traits": { + "smithy.api#documentation": "Specified a list of parameters for each category.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the range of environment parameters
" + } + }, + "com.amazonaws.sagemaker#EnvironmentParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#EnvironmentParameter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.sagemaker#EnvironmentValue": { "type": "string", "traits": { @@ -16404,6 +17234,16 @@ "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}$" } }, + "com.amazonaws.sagemaker#ExperimentEntityNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:(experiment|experiment-trial|experiment-trial-component|artifact|action|context)\\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})$" + } + }, "com.amazonaws.sagemaker#ExperimentSource": { "type": "structure", "members": { @@ -16818,6 +17658,33 @@ ] } }, + "com.amazonaws.sagemaker#FileSource": { + "type": "structure", + "members": { + "ContentType": { + "target": "com.amazonaws.sagemaker#ContentType", + "traits": { + "smithy.api#documentation": "The type of content stored in the file source.
" + } + }, + "ContentDigest": { + "target": "com.amazonaws.sagemaker#ContentDigest", + "traits": { + "smithy.api#documentation": "The digest of the file source.
" + } + }, + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "The Amazon S3 URI for the file source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details regarding the file source.
" + } + }, "com.amazonaws.sagemaker#FileSystemAccessMode": { "type": "string", "traits": { @@ -17360,6 +18227,52 @@ } } }, + "com.amazonaws.sagemaker#GetLineageGroupPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#GetLineageGroupPolicyRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#GetLineageGroupPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "The resource policy for the lineage group.
" + } + }, + "com.amazonaws.sagemaker#GetLineageGroupPolicyRequest": { + "type": "structure", + "members": { + "LineageGroupName": { + "target": "com.amazonaws.sagemaker#LineageGroupNameOrArn", + "traits": { + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the lineage group.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.sagemaker#GetLineageGroupPolicyResponse": { + "type": "structure", + "members": { + "LineageGroupArn": { + "target": "com.amazonaws.sagemaker#LineageGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lineage group.
" + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.sagemaker#ResourcePolicyString", + "traits": { + "smithy.api#documentation": "The resource policy that gives access to the lineage group in another account.
" + } + } + } + }, "com.amazonaws.sagemaker#GetModelPackageGroupPolicy": { "type": "operation", "input": { @@ -17711,14 +18624,14 @@ "TaskTimeLimitInSeconds": { "target": "com.amazonaws.sagemaker#TaskTimeLimitInSeconds", "traits": { - "smithy.api#documentation": "The amount of time that a worker has to complete a task.
\nIf you create a custom labeling job, the maximum value for this parameter is 8 hours\n (28,800 seconds).
\nIf you create a labeling job using a built-in task type the maximum\n for this parameter depends on the task type you use:
\nFor image and \n text labeling jobs,\n the maximum is 8 hours (28,800 seconds).
\nFor 3D point cloud and video frame labeling jobs, the maximum is 30 days (2952,000 seconds) for non-AL mode. For most users, the maximum is also 30 days. If you want to change these limits,\n contact Amazon Web Services Support.
\nThe amount of time that a worker has to complete a task.
\nIf you create a custom labeling job, the maximum value for this parameter is 8 hours\n (28,800 seconds).
\nIf you create a labeling job using a built-in task type the maximum\n for this parameter depends on the task type you use:
\nFor image and \n text labeling jobs,\n the maximum is 8 hours (28,800 seconds).
\nFor 3D point cloud and video frame labeling jobs, the maximum is 30 days (2952,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.
\nThe length of time that a task remains available for labeling by human workers. The\n default and maximum values for this parameter depend on the type of workforce you\n use.
\nIf you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43,200 seconds).\n The default is 6 hours (21,600 seconds).
\nIf you choose a private or vendor workforce, the default value is 30 days (2592,000 seconds) for non-AL mode. For most users, the maximum is also 30 days. If you want to\n change this limit, contact Amazon Web Services Support.
\nThe length of time that a task remains available for labeling by human workers. The\n default and maximum values for this parameter depend on the type of workforce you\n use.
\nIf you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43,200 seconds).\n The default is 6 hours (21,600 seconds).
\nIf you choose a private or vendor workforce, the default value is 30 days (2592,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.
\nThe metrics used to decide what recommendation to make.
", + "smithy.api#required": {} + } + }, + "EndpointConfiguration": { + "target": "com.amazonaws.sagemaker#EndpointOutputConfiguration", + "traits": { + "smithy.api#documentation": "Defines the endpoint configuration parameters.
", + "smithy.api#required": {} + } + }, + "ModelConfiguration": { + "target": "com.amazonaws.sagemaker#ModelConfiguration", + "traits": { + "smithy.api#documentation": "Defines the model configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A list of recommendations made by Amazon SageMaker Inference Recommender.
" + } + }, + "com.amazonaws.sagemaker#InferenceRecommendations": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#InferenceRecommendation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#InferenceRecommendationsJob": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobName", + "traits": { + "smithy.api#documentation": "The name of the job.
", + "smithy.api#required": {} + } + }, + "JobDescription": { + "target": "com.amazonaws.sagemaker#RecommendationJobDescription", + "traits": { + "smithy.api#documentation": "The job description.
", + "smithy.api#required": {} + } + }, + "JobType": { + "target": "com.amazonaws.sagemaker#RecommendationJobType", + "traits": { + "smithy.api#documentation": "The recommendation job type.
", + "smithy.api#required": {} + } + }, + "JobArn": { + "target": "com.amazonaws.sagemaker#RecommendationJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recommendation job.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#RecommendationJobStatus", + "traits": { + "smithy.api#documentation": "The status of the job.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A timestamp that shows when the job was created.
", + "smithy.api#required": {} + } + }, + "CompletionTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp that shows when the job completed.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker \n to perform tasks on your behalf.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "A timestamp that shows when the job was last modified.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "If the job fails, provides information why the job failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains a list of recommendation jobs.
" + } + }, + "com.amazonaws.sagemaker#InferenceRecommendationsJobs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#InferenceRecommendationsJob" + } + }, "com.amazonaws.sagemaker#InferenceSpecification": { "type": "structure", "members": { @@ -18970,6 +20006,25 @@ "smithy.api#documentation": "Defines how to perform inference generation after a training job is run.
" } }, + "com.amazonaws.sagemaker#InferenceSpecificationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + } + }, + "com.amazonaws.sagemaker#InitialNumberOfUsers": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1 + } + } + }, "com.amazonaws.sagemaker#InitialTaskCount": { "type": "integer", "traits": { @@ -19401,6 +20456,15 @@ "smithy.api#pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:rolealias/?[a-zA-Z_0-9+=,.@\\-_/]+$" } }, + "com.amazonaws.sagemaker#JobDurationInSeconds": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1 + } + } + }, "com.amazonaws.sagemaker#JobReferenceCode": { "type": "string", "traits": { @@ -20132,6 +21196,93 @@ } } }, + "com.amazonaws.sagemaker#LineageGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group/" + } + }, + "com.amazonaws.sagemaker#LineageGroupNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group\\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})$" + } + }, + "com.amazonaws.sagemaker#LineageGroupSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#LineageGroupSummary" + } + }, + "com.amazonaws.sagemaker#LineageGroupSummary": { + "type": "structure", + "members": { + "LineageGroupArn": { + "target": "com.amazonaws.sagemaker#LineageGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lineage group resource.
" + } + }, + "LineageGroupName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the lineage group.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "The display name of the lineage group summary.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The creation time of the lineage group summary.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The last modified time of the lineage group summary.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity \n resources.
" + } + }, + "com.amazonaws.sagemaker#LineageType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TrialComponent", + "name": "TRIAL_COMPONENT" + }, + { + "value": "Artifact", + "name": "ARTIFACT" + }, + { + "value": "Context", + "name": "CONTEXT" + }, + { + "value": "Action", + "name": "ACTION" + } + ] + } + }, "com.amazonaws.sagemaker#ListActions": { "type": "operation", "input": { @@ -22412,6 +23563,125 @@ } } }, + "com.amazonaws.sagemaker#ListInferenceRecommendationsJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsResponse" + }, + "traits": { + "smithy.api#documentation": "Lists recommendation jobs that satisfy various filters.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A filter that returns only jobs created after the specified time (timestamp).
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "A filter that returns only jobs created before the specified time (timestamp).
" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "A filter that returns only jobs that were last modified after the specified time (timestamp).
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "A filter that returns only jobs that were last modified before the specified time (timestamp).
" + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "A string in the job name. This filter returns only recommendations whose name contains the specified string.
" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#RecommendationJobStatus", + "traits": { + "smithy.api#documentation": "A filter that retrieves only inference recommendations jobs with a specific status.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsSortBy", + "traits": { + "smithy.api#documentation": "The parameter by which to sort the results.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "The sort order for the results.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response to a previous ListInferenceRecommendationsJobsRequest request \n was truncated, the response includes a NextToken. To retrieve the next set \n of recommendations, use the token in the next request.
The maximum number of recommendations to return in the response.
" + } + } + } + }, + "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsResponse": { + "type": "structure", + "members": { + "InferenceRecommendationsJobs": { + "target": "com.amazonaws.sagemaker#InferenceRecommendationsJobs", + "traits": { + "smithy.api#documentation": "The recommendations created from the Amazon SageMaker Inference Recommender job.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token for getting the next set of recommendations, if there are any.
" + } + } + } + }, + "com.amazonaws.sagemaker#ListInferenceRecommendationsJobsSortBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Name", + "name": "NAME" + }, + { + "value": "CreationTime", + "name": "CREATION_TIME" + }, + { + "value": "Status", + "name": "STATUS" + } + ] + } + }, "com.amazonaws.sagemaker#ListLabelingJobs": { "type": "operation", "input": { @@ -22622,6 +23892,81 @@ "target": "com.amazonaws.sagemaker#StringParameterValue" } }, + "com.amazonaws.sagemaker#ListLineageGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListLineageGroupsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListLineageGroupsResponse" + }, + "traits": { + "smithy.api#documentation": "A list of lineage groups shared with your Amazon Web Services account. \n For more information, see \n Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListLineageGroupsRequest": { + "type": "structure", + "members": { + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp to filter against lineage groups created after a certain point in time.
" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp to filter against lineage groups created before a certain point in time.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#SortLineageGroupsBy", + "traits": { + "smithy.api#documentation": "The parameter by which to sort the results. The default is\n CreationTime.
The sort order for the results. The default is Ascending.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n algorithms, use it in the subsequent request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of endpoints to return in the response. This value defaults to\n 10.
" + } + } + } + }, + "com.amazonaws.sagemaker#ListLineageGroupsResponse": { + "type": "structure", + "members": { + "LineageGroupSummaries": { + "target": "com.amazonaws.sagemaker#LineageGroupSummaries", + "traits": { + "smithy.api#documentation": "A list of lineage groups and their properties.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of\n algorithms, use it in the subsequent request.
" + } + } + } + }, "com.amazonaws.sagemaker#ListMaxResults": { "type": "integer", "traits": { @@ -22806,6 +24151,64 @@ } } }, + "com.amazonaws.sagemaker#ListModelMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListModelMetadataRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListModelMetadataResponse" + }, + "traits": { + "smithy.api#documentation": "Lists the domain, framework, task, and model name of standard \n machine learning models found in common model zoos.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListModelMetadataRequest": { + "type": "structure", + "members": { + "SearchExpression": { + "target": "com.amazonaws.sagemaker#ModelMetadataSearchExpression", + "traits": { + "smithy.api#documentation": "One or more filters that searches for the specified resource or resources \n in a search. All resource objects that satisfy the expression's condition are \n included in the search results. Specify the Framework, FrameworkVersion, Domain \n or Task to filter supported. Filter names and values are case-sensitive.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "If the response to a previous ListModelMetadataResponse request was truncated, \n the response includes a NextToken. To retrieve the next set of model metadata, \n use the token in the next request.
The maximum number of models to return in the response.
" + } + } + } + }, + "com.amazonaws.sagemaker#ListModelMetadataResponse": { + "type": "structure", + "members": { + "ModelMetadataSummaries": { + "target": "com.amazonaws.sagemaker#ModelMetadataSummaries", + "traits": { + "smithy.api#documentation": "A structure that holds model metadata.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token for getting the next set of recommendations, if there are any.
" + } + } + } + }, "com.amazonaws.sagemaker#ListModelPackageGroups": { "type": "operation", "input": { @@ -25114,6 +26517,15 @@ } } }, + "com.amazonaws.sagemaker#MaxNumberOfTests": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1 + } + } + }, "com.amazonaws.sagemaker#MaxNumberOfTrainingJobs": { "type": "integer", "traits": { @@ -25122,6 +26534,15 @@ } } }, + "com.amazonaws.sagemaker#MaxParallelOfTests": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1 + } + } + }, "com.amazonaws.sagemaker#MaxParallelTrainingJobs": { "type": "integer", "traits": { @@ -25601,6 +27022,26 @@ "smithy.api#documentation": "Configures the timeout and maximum number of retries for processing a transform job\n invocation.
" } }, + "com.amazonaws.sagemaker#ModelConfiguration": { + "type": "structure", + "members": { + "InferenceSpecificationName": { + "target": "com.amazonaws.sagemaker#InferenceSpecificationName", + "traits": { + "smithy.api#documentation": "The inference specification name in the model package version.
" + } + }, + "EnvironmentParameters": { + "target": "com.amazonaws.sagemaker#EnvironmentParameters", + "traits": { + "smithy.api#documentation": "Defines the environment parameters that includes key, value types, and values.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the model configuration. Includes the specification name and environment parameters.
" + } + }, "com.amazonaws.sagemaker#ModelDataQuality": { "type": "structure", "members": { @@ -25728,6 +27169,173 @@ "smithy.api#documentation": "Inputs for the model explainability job.
" } }, + "com.amazonaws.sagemaker#ModelInput": { + "type": "structure", + "members": { + "DataInputConfig": { + "target": "com.amazonaws.sagemaker#DataInputConfig", + "traits": { + "smithy.api#documentation": "The input configuration object for the model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Input object for the model.
" + } + }, + "com.amazonaws.sagemaker#ModelLatencyThreshold": { + "type": "structure", + "members": { + "Percentile": { + "target": "com.amazonaws.sagemaker#String64", + "traits": { + "smithy.api#documentation": "The model latency percentile threshold.
" + } + }, + "ValueInMilliseconds": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The model latency percentile value in milliseconds.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The model latency threshold.
" + } + }, + "com.amazonaws.sagemaker#ModelLatencyThresholds": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelLatencyThreshold" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.sagemaker#ModelMetadataFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sagemaker#ModelMetadataFilterType", + "traits": { + "smithy.api#documentation": "The name of the of the model to filter by.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The value to filter the model metadata.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Part of the search expression. You can specify the name and value \n (domain, task, framework, framework version, task, and model).
" + } + }, + "com.amazonaws.sagemaker#ModelMetadataFilterType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Domain", + "name": "DOMAIN" + }, + { + "value": "Framework", + "name": "FRAMEWORK" + }, + { + "value": "Task", + "name": "TASK" + }, + { + "value": "FrameworkVersion", + "name": "FRAMEWORKVERSION" + } + ] + } + }, + "com.amazonaws.sagemaker#ModelMetadataFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelMetadataFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4 + } + } + }, + "com.amazonaws.sagemaker#ModelMetadataSearchExpression": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.sagemaker#ModelMetadataFilters", + "traits": { + "smithy.api#documentation": "A list of filter objects.
" + } + } + }, + "traits": { + "smithy.api#documentation": "One or more filters that searches for the specified resource or resources in \n a search. All resource objects that satisfy the expression's condition are \n included in the search results
" + } + }, + "com.amazonaws.sagemaker#ModelMetadataSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ModelMetadataSummary" + } + }, + "com.amazonaws.sagemaker#ModelMetadataSummary": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The machine learning domain of the model.
", + "smithy.api#required": {} + } + }, + "Framework": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The machine learning framework of the model.
", + "smithy.api#required": {} + } + }, + "Task": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The machine learning task of the model.
", + "smithy.api#required": {} + } + }, + "Model": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The name of the model.
", + "smithy.api#required": {} + } + }, + "FrameworkVersion": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The framework version of the model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of the model metadata.
" + } + }, "com.amazonaws.sagemaker#ModelMetrics": { "type": "structure", "members": { @@ -25876,6 +27484,30 @@ "smithy.api#documentation": "A description provided when the model approval is set.
" } }, + "Domain": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The machine learning domain of your model package and its components. Common \n machine learning domains include computer vision and natural language processing.
" + } + }, + "Task": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The machine learning task your model package accomplishes. Common machine \n learning tasks include object detection and image classification.
" + } + }, + "SamplePayloadUrl": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The Amazon Simple Storage Service path where the sample payload are stored. This path must point to \n a single gzip compressed tar archive (.tar.gz suffix).
" + } + }, + "AdditionalInferenceSpecifications": { + "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecifications", + "traits": { + "smithy.api#documentation": "An array of additional Inference Specification objects.
" + } + }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { @@ -25887,6 +27519,12 @@ "traits": { "smithy.api#documentation": "The metadata properties for the model package.
" } + }, + "DriftCheckBaselines": { + "target": "com.amazonaws.sagemaker#DriftCheckBaselines", + "traits": { + "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set using the model package.
" + } } }, "traits": { @@ -25954,6 +27592,30 @@ "traits": { "smithy.api#documentation": "The environment variables to set in the Docker container. Each key and value in the\n Environment string to string map can have length of up to 1024. We\n support up to 16 entries in the map.
A structure with Model Input details.
" + } + }, + "Framework": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The machine learning framework of the model package container image.
" + } + }, + "FrameworkVersion": { + "target": "com.amazonaws.sagemaker#FrameworkVersion", + "traits": { + "smithy.api#documentation": "The framework version of the Model Package Container Image.
" + } + }, + "NearestModelName": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "The name of a pre-trained machine learning benchmarked by \n Amazon SageMaker Inference Recommender model that matches your model. \n You can find a list of benchmarked models by calling ListModelMetadata.
The endpoint variant status which describes the current deployment stage status or operational status.
" } + }, + "CurrentServerlessConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig", + "traits": { + "smithy.api#documentation": "The serverless configuration for the endpoint.
\nServerless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.
\nThe serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.
\nServerless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.
\nSpecifies how many concurrent users to start with.
" + } + }, + "SpawnRate": { + "target": "com.amazonaws.sagemaker#SpawnRate", + "traits": { + "smithy.api#documentation": "Specified how many new users to spawn in a minute.
" + } + }, + "DurationInSeconds": { + "target": "com.amazonaws.sagemaker#TrafficDurationInSeconds", + "traits": { + "smithy.api#documentation": "Specifies how long traffic phase should be.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the traffic pattern.
" + } + }, + "com.amazonaws.sagemaker#Phases": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Phase" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.sagemaker#Pipeline": { "type": "structure", "members": { @@ -29123,6 +30834,18 @@ "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of\n output parameters.
" } + }, + "QualityCheck": { + "target": "com.amazonaws.sagemaker#QualityCheckStepMetadata", + "traits": { + "smithy.api#documentation": "The configurations and outcomes of the check step execution. This includes:
\nThe type of the check conducted,
\nThe Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
\nThe Amazon S3 URIs of newly calculated baseline constraints and statistics.
\nThe model package group name provided.
\nThe Amazon S3 URI of the violation report if violations detected.
\nThe Amazon Resource Name (ARN) of check processing job initiated by the step execution.
\nThe boolean flags indicating if the drift check is skipped.
\nIf step property BaselineUsedForDriftCheck is set the same as \n CalculatedBaseline.
Container for the metadata for a Clarify check step. The configurations \n and outcomes of the check step execution. This includes:
\nThe type of the check conducted,
\nThe Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
\nThe Amazon S3 URIs of newly calculated baseline constraints and statistics.
\nThe model package group name provided.
\nThe Amazon S3 URI of the violation report if violations detected.
\nThe Amazon Resource Name (ARN) of check processing job initiated by the step execution.
\nThe boolean flags indicating if the drift check is skipped.
\nIf step property BaselineUsedForDriftCheck is set the same as \n CalculatedBaseline.
Number of instances to launch initially.
", - "smithy.api#required": {} + "smithy.api#documentation": "Number of instances to launch initially.
" } }, "InstanceType": { "target": "com.amazonaws.sagemaker#ProductionVariantInstanceType", "traits": { - "smithy.api#documentation": "The ML compute instance type.
", - "smithy.api#required": {} + "smithy.api#documentation": "The ML compute instance type.
" } }, "InitialVariantWeight": { @@ -30257,6 +31978,12 @@ "traits": { "smithy.api#documentation": "Specifies configuration for a core dump from the model container when the process\n crashes.
" } + }, + "ServerlessConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig", + "traits": { + "smithy.api#documentation": "The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.
\nServerless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.
\nThe memory size of your serverless endpoint. Valid values are in 1 GB increments: 1024 MB, 2048 MB, 3072 MB, 4096 MB, 5120 MB, or 6144 MB.
", + "smithy.api#required": {} + } + }, + "MaxConcurrency": { + "target": "com.amazonaws.sagemaker#ServerlessMaxConcurrency", + "traits": { + "smithy.api#documentation": "The maximum number of concurrent invocations your serverless endpoint can process.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Serverless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.
\nSpecifies the serverless configuration for an endpoint variant.
" + } + }, "com.amazonaws.sagemaker#ProductionVariantStatus": { "type": "structure", "members": { @@ -30682,6 +32431,18 @@ "traits": { "smithy.api#documentation": "The endpoint variant status which describes the current deployment stage status or operational status.
" } + }, + "CurrentServerlessConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig", + "traits": { + "smithy.api#documentation": "The serverless configuration for the endpoint.
\nServerless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.
\nThe serverless configuration requested for the endpoint update.
\nServerless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.
\nThe type of the Quality check step.
" + } + }, + "BaselineUsedForDriftCheckStatistics": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "The Amazon S3 URI of the baseline statistics file used for the drift check.
" + } + }, + "BaselineUsedForDriftCheckConstraints": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "The Amazon S3 URI of the baseline constraints file used for the drift check.
" + } + }, + "CalculatedBaselineStatistics": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "The Amazon S3 URI of the newly calculated baseline statistics file.
" + } + }, + "CalculatedBaselineConstraints": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "The Amazon S3 URI of the newly calculated baseline constraints file.
" + } + }, + "ModelPackageGroupName": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The model package group name.
" + } + }, + "ViolationReport": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "The Amazon S3 URI of violation report if violations are detected.
" + } + }, + "CheckJobArn": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.
" + } + }, + "SkipCheck": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "This flag indicates if the drift check against the previous baseline will be skipped or not. \n If it is set to False, the previous baseline of the configured check type must be available.
This flag indicates if a newly calculated baseline can be accessed through step properties \n BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. \n If it is set to False, the previous baseline of the configured check type must also be available. \n These can be accessed through the BaselineUsedForDriftCheckConstraints and \n BaselineUsedForDriftCheckStatistics properties.
Container for the metadata for a Quality check step. For more information, see \n the topic on QualityCheck step in the Amazon SageMaker Developer Guide.\n
" + } + }, + "com.amazonaws.sagemaker#QueryFilters": { + "type": "structure", + "members": { + "Types": { + "target": "com.amazonaws.sagemaker#QueryTypes", + "traits": { + "smithy.api#documentation": "Filter the lineage entities connected to the StartArn by type. For example: DataSet, \n Model, Endpoint, or ModelDeployment.
Filter the lineage entities connected to the StartArn(s) by the type of the lineage entity.
Filter the lineage entities connected to the StartArn(s) by created date.
Filter the lineage entities connected to the StartArn(s) after the create date.
Filter the lineage entities connected to the StartArn(s) before the last modified date.
Filter the lineage entities connected to the StartArn(s) after the last modified date.
Filter the lineage entities connected to the StartArn(s) by a set if property key value pairs. \n If multiple pairs are provided, an entity will be included in the results if it matches any of the provided pairs.
A set of filters to narrow the set of lineage entities connected to the StartArn(s) returned by the \n QueryLineage API action.
Use this action to inspect your lineage and discover relationships between entities. \n For more information, see \n Querying Lineage Entities in the Amazon SageMaker Developer Guide.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#QueryLineageMaxDepth": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#QueryLineageMaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#QueryLineageRequest": { + "type": "structure", + "members": { + "StartArns": { + "target": "com.amazonaws.sagemaker#QueryLineageStartArns", + "traits": { + "smithy.api#documentation": "A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.
", + "smithy.api#required": {} + } + }, + "Direction": { + "target": "com.amazonaws.sagemaker#Direction", + "traits": { + "smithy.api#documentation": "Associations between lineage entities are directed. This parameter determines the direction from the \n StartArn(s) the query will look.
" + } + }, + "IncludeEdges": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": " Setting this value to True will retrieve not only the entities of interest but also the \n Associations and \n lineage entities on the path. Set to False to only return lineage entities that match your query.
A set of filtering parameters that allow you to specify which entities should be returned.
\nProperties - Key-value pairs to match on the lineage entities' properties.
\nLineageTypes - A set of lineage entity types to match on. For example: TrialComponent, \n Artifact, or Context.
CreatedBefore - Filter entities created before this date.
\nModifiedBefore - Filter entities modified before this date.
\nModifiedAfter - Filter entities modified after this date.
\nThe maximum depth in lineage relationships from the StartArns that will be traversed. Depth is a measure of the number \n of Associations from the StartArn entity to the matched results.
Limits the number of vertices in the results. Use the NextToken in a response to to retrieve the next page of results.
Limits the number of vertices in the request. Use the NextToken in a response to to retrieve the next page of results.
A list of vertices connected to the start entity(ies) in the lineage graph.
" + } + }, + "Edges": { + "target": "com.amazonaws.sagemaker#Edges", + "traits": { + "smithy.api#documentation": "A list of edges that connect vertices in the response.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#String8192", + "traits": { + "smithy.api#documentation": "Limits the number of vertices in the response. Use the NextToken in a response to to retrieve the next page of results.
The Amazon Resource Name (ARN) of a versioned model package.
", + "smithy.api#required": {} + } + }, + "JobDurationInSeconds": { + "target": "com.amazonaws.sagemaker#JobDurationInSeconds", + "traits": { + "smithy.api#documentation": "Specifies the maximum duration of the job, in seconds.>
" + } + }, + "TrafficPattern": { + "target": "com.amazonaws.sagemaker#TrafficPattern", + "traits": { + "smithy.api#documentation": "Specifies the traffic pattern of the job.
" + } + }, + "ResourceLimit": { + "target": "com.amazonaws.sagemaker#RecommendationJobResourceLimit", + "traits": { + "smithy.api#documentation": "Defines the resource limit of the job.
" + } + }, + "EndpointConfigurations": { + "target": "com.amazonaws.sagemaker#EndpointInputConfigurations", + "traits": { + "smithy.api#documentation": "Specifies the endpoint configuration to use for a job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input configuration of the recommendation job.
" + } + }, + "com.amazonaws.sagemaker#RecommendationJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}$" + } + }, + "com.amazonaws.sagemaker#RecommendationJobResourceLimit": { + "type": "structure", + "members": { + "MaxNumberOfTests": { + "target": "com.amazonaws.sagemaker#MaxNumberOfTests", + "traits": { + "smithy.api#documentation": "Defines the maximum number of load tests.
" + } + }, + "MaxParallelOfTests": { + "target": "com.amazonaws.sagemaker#MaxParallelOfTests", + "traits": { + "smithy.api#documentation": "Defines the maximum number of parallel load tests.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the maximum number of jobs that can run in parallel \n and the maximum number of jobs that can run.
" + } + }, + "com.amazonaws.sagemaker#RecommendationJobStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "STOPPING", + "name": "STOPPING" + }, + { + "value": "STOPPED", + "name": "STOPPED" + } + ] + } + }, + "com.amazonaws.sagemaker#RecommendationJobStoppingConditions": { + "type": "structure", + "members": { + "MaxInvocations": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of requests per minute expected for the endpoint.
" + } + }, + "ModelLatencyThresholds": { + "target": "com.amazonaws.sagemaker#ModelLatencyThresholds", + "traits": { + "smithy.api#documentation": "The interval of time taken by a model to respond as viewed from SageMaker. \n The interval includes the local communication time taken to send the request \n and to fetch the response from the container of a model and the time taken to \n complete the inference in the container.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies conditions for stopping a job. When a job reaches a \n stopping condition limit, SageMaker ends the job.
" + } + }, + "com.amazonaws.sagemaker#RecommendationJobType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Default", + "name": "DEFAULT" + }, + { + "value": "Advanced", + "name": "ADVANCED" + } + ] + } + }, + "com.amazonaws.sagemaker#RecommendationMetrics": { + "type": "structure", + "members": { + "CostPerHour": { + "target": "com.amazonaws.sagemaker#Float", + "traits": { + "smithy.api#documentation": "Defines the cost per hour for the instance.
", + "smithy.api#required": {} + } + }, + "CostPerInference": { + "target": "com.amazonaws.sagemaker#Float", + "traits": { + "smithy.api#documentation": "Defines the cost per inference for the instance .
", + "smithy.api#required": {} + } + }, + "MaxInvocations": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The expected maximum number of requests per minute for the instance.
", + "smithy.api#required": {} + } + }, + "ModelLatency": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#documentation": "The expected model latency at maximum invocation per minute for the instance.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The metrics of recommendations.
" + } + }, "com.amazonaws.sagemaker#RecordWrapper": { "type": "string", "traits": { @@ -31905,6 +34136,16 @@ "smithy.api#error": "client" } }, + "com.amazonaws.sagemaker#ResourcePolicyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20480 + }, + "smithy.api#pattern": "(?:[ \\r\\n\\t].*)*$" + } + }, "com.amazonaws.sagemaker#ResourcePropertyName": { "type": "string", "traits": { @@ -32398,6 +34639,9 @@ { "target": "com.amazonaws.sagemaker#CreateImageVersion" }, + { + "target": "com.amazonaws.sagemaker#CreateInferenceRecommendationsJob" + }, { "target": "com.amazonaws.sagemaker#CreateLabelingJob" }, @@ -32653,9 +34897,15 @@ { "target": "com.amazonaws.sagemaker#DescribeImageVersion" }, + { + "target": "com.amazonaws.sagemaker#DescribeInferenceRecommendationsJob" + }, { "target": "com.amazonaws.sagemaker#DescribeLabelingJob" }, + { + "target": "com.amazonaws.sagemaker#DescribeLineageGroup" + }, { "target": "com.amazonaws.sagemaker#DescribeModel" }, @@ -32737,6 +34987,9 @@ { "target": "com.amazonaws.sagemaker#GetDeviceFleetReport" }, + { + "target": "com.amazonaws.sagemaker#GetLineageGroupPolicy" + }, { "target": "com.amazonaws.sagemaker#GetModelPackageGroupPolicy" }, @@ -32821,18 +35074,27 @@ { "target": "com.amazonaws.sagemaker#ListImageVersions" }, + { + "target": "com.amazonaws.sagemaker#ListInferenceRecommendationsJobs" + }, { "target": "com.amazonaws.sagemaker#ListLabelingJobs" }, { "target": "com.amazonaws.sagemaker#ListLabelingJobsForWorkteam" }, + { + "target": "com.amazonaws.sagemaker#ListLineageGroups" + }, { "target": "com.amazonaws.sagemaker#ListModelBiasJobDefinitions" }, { "target": "com.amazonaws.sagemaker#ListModelExplainabilityJobDefinitions" }, + { + "target": "com.amazonaws.sagemaker#ListModelMetadata" + }, { "target": "com.amazonaws.sagemaker#ListModelPackageGroups" }, @@ -32911,6 +35173,9 @@ { "target": "com.amazonaws.sagemaker#PutModelPackageGroupPolicy" }, + { + "target": "com.amazonaws.sagemaker#QueryLineage" + }, { "target": "com.amazonaws.sagemaker#RegisterDevices" }, @@ -32950,6 +35215,9 @@ { "target": "com.amazonaws.sagemaker#StopHyperParameterTuningJob" }, + { + "target": "com.amazonaws.sagemaker#StopInferenceRecommendationsJob" + }, { "target": "com.amazonaws.sagemaker#StopLabelingJob" }, @@ -33576,6 +35844,26 @@ } } }, + "com.amazonaws.sagemaker#ServerlessMaxConcurrency": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.sagemaker#ServerlessMemorySizeInMB": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1024, + "max": 6144 + } + } + }, "com.amazonaws.sagemaker#ServiceCatalogEntityId": { "type": "string", "traits": { @@ -33828,6 +36116,21 @@ ] } }, + "com.amazonaws.sagemaker#SortLineageGroupsBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Name", + "name": "NAME" + }, + { + "value": "CreationTime", + "name": "CREATION_TIME" + } + ] + } + }, "com.amazonaws.sagemaker#SortOrder": { "type": "string", "traits": { @@ -33985,6 +36288,15 @@ "smithy.api#pattern": ".*" } }, + "com.amazonaws.sagemaker#SpawnRate": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.sagemaker#SplitType": { "type": "string", "traits": { @@ -34282,6 +36594,32 @@ } } }, + "com.amazonaws.sagemaker#StopInferenceRecommendationsJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#StopInferenceRecommendationsJobRequest" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Stops an Inference Recommender job.
" + } + }, + "com.amazonaws.sagemaker#StopInferenceRecommendationsJobRequest": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobName", + "traits": { + "smithy.api#documentation": "The name of the job you want to stop.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.sagemaker#StopLabelingJob": { "type": "operation", "input": { @@ -34513,6 +36851,15 @@ } } }, + "com.amazonaws.sagemaker#String128": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, "com.amazonaws.sagemaker#String200": { "type": "string", "traits": { @@ -34541,6 +36888,15 @@ } } }, + "com.amazonaws.sagemaker#String40": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 40 + } + } + }, "com.amazonaws.sagemaker#String64": { "type": "string", "traits": { @@ -34550,6 +36906,15 @@ } } }, + "com.amazonaws.sagemaker#String8192": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 8192 + } + } + }, "com.amazonaws.sagemaker#StringParameterValue": { "type": "string", "traits": { @@ -35246,6 +37611,35 @@ "com.amazonaws.sagemaker#Timestamp": { "type": "timestamp" }, + "com.amazonaws.sagemaker#TrafficDurationInSeconds": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#TrafficPattern": { + "type": "structure", + "members": { + "TrafficType": { + "target": "com.amazonaws.sagemaker#TrafficType", + "traits": { + "smithy.api#documentation": "Defines the traffic patterns.
" + } + }, + "Phases": { + "target": "com.amazonaws.sagemaker#Phases", + "traits": { + "smithy.api#documentation": "Defines the phases traffic specification.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the traffic pattern of the load test.
" + } + }, "com.amazonaws.sagemaker#TrafficRoutingConfig": { "type": "structure", "members": { @@ -35299,6 +37693,17 @@ ] } }, + "com.amazonaws.sagemaker#TrafficType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PHASES", + "name": "PHASES" + } + ] + } + }, "com.amazonaws.sagemaker#TrainingEnvironmentKey": { "type": "string", "traits": { @@ -36852,6 +39257,12 @@ "smithy.api#documentation": "Details of the source of the component.
" } }, + "LineageGroupArn": { + "target": "com.amazonaws.sagemaker#LineageGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lineage group resource.
" + } + }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { @@ -38172,6 +40583,12 @@ "traits": { "smithy.api#documentation": "The metadata properties associated with the model package versions to remove.
" } + }, + "AdditionalInferenceSpecificationsToAdd": { + "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecifications", + "traits": { + "smithy.api#documentation": "An array of additional Inference Specification objects to be added to the \n existing array additional Inference Specification. Total number of additional \n Inference Specifications can not exceed 15. Each additional Inference Specification \n specifies artifacts based on this model package that can be used on inference endpoints. \n Generally used with SageMaker Neo to store the compiled artifacts.
" + } } } }, @@ -38962,7 +41379,7 @@ } }, "traits": { - "smithy.api#documentation": "Information about the user who created or modified an experiment, trial, trial\n component, or project.
" + "smithy.api#documentation": "Information about the user who created or modified an experiment, trial, trial\n component, lineage group, or project.
" } }, "com.amazonaws.sagemaker#UserProfileArn": { @@ -39246,6 +41663,38 @@ "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(?The Amazon Resource Name (ARN) of the lineage entity resource." + } + }, + "Type": { + "target": "com.amazonaws.sagemaker#String40", + "traits": { + "smithy.api#documentation": "The type of the lineage entity resource. For example: DataSet, Model, Endpoint, \n etc...
The type of resource of the lineage entity.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A lineage entity connected to the starting entity(ies).
" + } + }, + "com.amazonaws.sagemaker#Vertices": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#Vertex" + } + }, "com.amazonaws.sagemaker#VolumeSizeInGB": { "type": "integer", "traits": { diff --git a/aws/sdk/aws-models/shield.json b/aws/sdk/aws-models/shield.json index 7baa4bac8bc1ba70fb8e62546690e9157bb8312c..7dab9f0c7df1a8e5e61bde21d40875665ff3f1e8 100644 --- a/aws/sdk/aws-models/shield.json +++ b/aws/sdk/aws-models/shield.json @@ -31,6 +31,24 @@ "shapes": { "com.amazonaws.shield#AWSShield_20160616": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Shield", + "arnNamespace": "shield", + "cloudFormationName": "Shield", + "cloudTrailEventSource": "shield.amazonaws.com", + "endpointPrefix": "shield" + }, + "aws.auth#sigv4": { + "name": "shield" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "This is the Shield Advanced API Reference. This guide is for developers who need detailed information about the Shield Advanced API actions, \n data types, and errors. For detailed information about WAF and Shield Advanced features and an overview of how to use the WAF and Shield Advanced APIs, see the \n WAF and Shield Developer Guide.
", + "smithy.api#title": "AWS Shield", + "smithy.api#xmlNamespace": { + "uri": "http://ddp.amazonaws.com/doc/2016-06-02/" + } + }, "version": "2016-06-02", "operations": [ { @@ -84,6 +102,9 @@ { "target": "com.amazonaws.shield#DescribeSubscription" }, + { + "target": "com.amazonaws.shield#DisableApplicationLayerAutomaticResponse" + }, { "target": "com.amazonaws.shield#DisableProactiveEngagement" }, @@ -96,6 +117,9 @@ { "target": "com.amazonaws.shield#DisassociateHealthCheck" }, + { + "target": "com.amazonaws.shield#EnableApplicationLayerAutomaticResponse" + }, { "target": "com.amazonaws.shield#EnableProactiveEngagement" }, @@ -123,6 +147,9 @@ { "target": "com.amazonaws.shield#UntagResource" }, + { + "target": "com.amazonaws.shield#UpdateApplicationLayerAutomaticResponse" + }, { "target": "com.amazonaws.shield#UpdateEmergencyContactSettings" }, @@ -132,25 +159,7 @@ { "target": "com.amazonaws.shield#UpdateSubscription" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Shield", - "arnNamespace": "shield", - "cloudFormationName": "Shield", - "cloudTrailEventSource": "shield.amazonaws.com", - "endpointPrefix": "shield" - }, - "aws.auth#sigv4": { - "name": "shield" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "This is the Shield Advanced API Reference. This guide is for developers who need detailed information about the Shield Advanced API actions, \n data types, and errors. For detailed information about WAF and Shield Advanced features and an overview of how to use the WAF and Shield Advanced APIs, see the \n WAF and Shield Developer Guide.
", - "smithy.api#title": "AWS Shield", - "smithy.api#xmlNamespace": { - "uri": "http://ddp.amazonaws.com/doc/2016-06-02/" - } - } + ] }, "com.amazonaws.shield#AccessDeniedException": { "type": "structure", @@ -176,6 +185,42 @@ "smithy.api#error": "client" } }, + "com.amazonaws.shield#ApplicationLayerAutomaticResponseConfiguration": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.shield#ApplicationLayerAutomaticResponseStatus", + "traits": { + "smithy.api#documentation": "Indicates whether automatic application layer DDoS mitigation is enabled for the protection.
", + "smithy.api#required": {} + } + }, + "Action": { + "target": "com.amazonaws.shield#ResponseAction", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The automatic application layer DDoS mitigation settings for a Protection. \n This configuration determines whether Shield Advanced automatically \n manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks.
" + } + }, + "com.amazonaws.shield#ApplicationLayerAutomaticResponseStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "DISABLED", + "name": "DISABLED" + } + ] + } + }, "com.amazonaws.shield#AssociateDRTLogBucket": { "type": "operation", "input": { @@ -211,7 +256,7 @@ } ], "traits": { - "smithy.api#documentation": "Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.
\n\tTo use the services of the SRT and make an AssociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan.
Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.
\nTo use the services of the SRT and make an AssociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan.
Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your WAF configuration and create or update WAF rules and web ACLs.
\nYou can associate only one RoleArn with your subscription. If you submit an AssociateDRTRole request for an account that already has an associated role, the new RoleArn will replace the existing RoleArn.
Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to the role you will specify in the request. For more information see Attaching and Detaching IAM Policies. The role must also trust the service principal drt.shield.amazonaws.com. For more information, see IAM JSON Policy Elements: Principal.
The SRT will have access only to your WAF and Shield resources. By submitting this request, you authorize the SRT to inspect your WAF and Shield configuration and create and update WAF rules and web ACLs on your behalf. The SRT takes these actions only if explicitly authorized by you.
\nYou must have the iam:PassRole permission to make an AssociateDRTRole request. For more information, see Granting a User Permissions to Pass a Role to an Amazon Web Services Service.
To use the services of the SRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan.
Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your WAF configuration and create or update WAF rules and web ACLs.
\nYou can associate only one RoleArn with your subscription. If you submit an AssociateDRTRole request for an account that already has an associated role, the new RoleArn will replace the existing RoleArn.
Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to the role that you'll specify in the request. You can access this policy in the IAM console at AWSShieldDRTAccessPolicy. For more information see Adding and removing IAM identity permissions. The role must also trust the service principal \ndrt.shield.amazonaws.com. For more information, see IAM JSON policy elements: Principal.
The SRT will have access only to your WAF and Shield resources. By submitting this request, you authorize the SRT to inspect your WAF and Shield configuration and create and update WAF rules and web ACLs on your behalf. The SRT takes these actions only if explicitly authorized by you.
\nYou must have the iam:PassRole permission to make an AssociateDRTRole request. For more information, see Granting a user permissions to pass a role to an Amazon Web Services service.
To use the services of the SRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan.
Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and mitigation.
\nYou define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.
" + "smithy.api#documentation": "Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.
\nYou define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.
" } }, "com.amazonaws.shield#AssociateHealthCheckRequest": { @@ -399,13 +447,13 @@ "StartTime": { "target": "com.amazonaws.shield#AttackTimestamp", "traits": { - "smithy.api#documentation": "The time the attack started, in Unix time in seconds. For more information see timestamp.
" + "smithy.api#documentation": "The time the attack started, in Unix time in seconds.
" } }, "EndTime": { "target": "com.amazonaws.shield#AttackTimestamp", "traits": { - "smithy.api#documentation": "The time the attack ended, in Unix time in seconds. For more information see timestamp.
" + "smithy.api#documentation": "The time the attack ended, in Unix time in seconds.
" } }, "AttackCounters": { @@ -417,7 +465,7 @@ "AttackProperties": { "target": "com.amazonaws.shield#AttackProperties", "traits": { - "smithy.api#documentation": "The array of objects that provide details of the Shield event.
\nFor infrastructure \n layer events (L3 and L4 events) after January 25, 2021, you can view metrics for top contributors in Amazon CloudWatch metrics. \n For more information, see Shield metrics and alarms \n in the WAF Developer Guide.
" + "smithy.api#documentation": "The array of objects that provide details of the Shield event.
\nFor infrastructure \n layer events (L3 and L4 events), you can view metrics for top contributors in Amazon CloudWatch metrics. \n For more information, see Shield metrics and alarms \n in the WAF Developer Guide.
" } }, "Mitigations": { @@ -468,7 +516,7 @@ "AttackLayer": { "target": "com.amazonaws.shield#AttackLayer", "traits": { - "smithy.api#documentation": "The type of Shield event that was observed. NETWORK indicates layer 3 and layer 4 events and APPLICATION\n indicates layer 7 events.
For infrastructure \n layer events (L3 and L4 events) after January 25, 2021, you can view metrics for top contributors in Amazon CloudWatch metrics. \n For more information, see Shield metrics and alarms \n in the WAF Developer Guide.
" + "smithy.api#documentation": "The type of Shield event that was observed. NETWORK indicates layer 3 and layer 4 events and APPLICATION\n indicates layer 7 events.
For infrastructure \n layer events (L3 and L4 events), you can view metrics for top contributors in Amazon CloudWatch metrics. \n For more information, see Shield metrics and alarms \n in the WAF Developer Guide.
" } }, "AttackPropertyIdentifier": { @@ -480,7 +528,7 @@ "TopContributors": { "target": "com.amazonaws.shield#TopContributors", "traits": { - "smithy.api#documentation": "Contributor objects for the top five contributors to a Shield event.
" + "smithy.api#documentation": "Contributor objects for the top five contributors to a Shield event. A contributor is a source of traffic that Shield Advanced identifies as responsible for some or all of an event.
" } }, "Unit": { @@ -590,13 +638,13 @@ "StartTime": { "target": "com.amazonaws.shield#AttackTimestamp", "traits": { - "smithy.api#documentation": "The start time of the attack, in Unix time in seconds. For more information see timestamp.
" + "smithy.api#documentation": "The start time of the attack, in Unix time in seconds.
" } }, "EndTime": { "target": "com.amazonaws.shield#AttackTimestamp", "traits": { - "smithy.api#documentation": "The end time of the attack, in Unix time in seconds. For more information see timestamp.
" + "smithy.api#documentation": "The end time of the attack, in Unix time in seconds.
" } }, "AttackVectors": { @@ -690,6 +738,13 @@ ] } }, + "com.amazonaws.shield#BlockAction": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Specifies that Shield Advanced should configure its WAF rules with the WAF Block action.
This is only used in the context of the ResponseAction setting.
JSON specification: \"Block\": {}\n
The name of the contributor. This is dependent on the AttackPropertyIdentifier. For example, if the AttackPropertyIdentifier is SOURCE_COUNTRY, the Name could be United States.
The name of the contributor. The type of name that you'll find here depends on the AttackPropertyIdentifier setting in the AttackProperty where this contributor is defined. For example, if the AttackPropertyIdentifier is SOURCE_COUNTRY, the Name could be United States.
A contributor to the attack and their contribution.
" + "smithy.api#documentation": "A contributor to the attack and their contribution.
" + } + }, + "com.amazonaws.shield#CountAction": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Specifies that Shield Advanced should configure its WAF rules with the WAF Count action.
This is only used in the context of the ResponseAction setting.
JSON specification: \"Count\": {}\n
Enables Shield Advanced for a specific Amazon Web Services resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, Global Accelerator accelerator, Elastic IP Address, or an Amazon Route 53 hosted zone.
\nYou can add protection to only a single resource with each CreateProtection request. If you want to add protection to multiple resources at once, use the WAF console. For more information see Getting Started with Shield Advanced and Add Shield Advanced Protection to more Amazon Web Services Resources.
" + "smithy.api#documentation": "Enables Shield Advanced for a specific Amazon Web Services resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, Global Accelerator accelerator, Elastic IP Address, or an Amazon Route 53 hosted zone.
\nYou can add protection to only a single resource with each CreateProtection request. You can add protection to multiple resources \n at once through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/.\n For more information see \n Getting Started with Shield Advanced \n and Adding Shield Advanced protection to Amazon Web Services resources.
The ARN (Amazon Resource Name) of the resource to be protected.
\nThe ARN should be in one of the following formats:
\nFor an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n
For an Elastic Load Balancer (Classic Load Balancer): arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name\n \n
For an Amazon CloudFront distribution: arn:aws:cloudfront::account-id:distribution/distribution-id\n \n
For an Global Accelerator accelerator: arn:aws:globalaccelerator::account-id:accelerator/accelerator-id\n \n
For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id\n \n
For an Elastic IP address: arn:aws:ec2:region:account-id:eip-allocation/allocation-id\n \n
The ARN (Amazon Resource Name) of the resource to be protected.
\nThe ARN should be in one of the following formats:
\nFor an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n
For an Elastic Load Balancer (Classic Load Balancer): arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name\n \n
For an Amazon CloudFront distribution: arn:aws:cloudfront::account-id:distribution/distribution-id\n \n
For an Global Accelerator accelerator: arn:aws:globalaccelerator::account-id:accelerator/accelerator-id\n \n
For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id\n \n
For an Elastic IP address: arn:aws:ec2:region:account-id:eip-allocation/allocation-id\n \n
The unique identifier (ID) for the attack that to be described.
", + "smithy.api#documentation": "The unique identifier (ID) for the attack.
", "smithy.api#required": {} } } @@ -1306,6 +1368,51 @@ } } }, + "com.amazonaws.shield#DisableApplicationLayerAutomaticResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.shield#DisableApplicationLayerAutomaticResponseRequest" + }, + "output": { + "target": "com.amazonaws.shield#DisableApplicationLayerAutomaticResponseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.shield#InternalErrorException" + }, + { + "target": "com.amazonaws.shield#InvalidOperationException" + }, + { + "target": "com.amazonaws.shield#InvalidParameterException" + }, + { + "target": "com.amazonaws.shield#OptimisticLockException" + }, + { + "target": "com.amazonaws.shield#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Disable the Shield Advanced automatic application layer DDoS mitigation feature for the resource. This \n stops Shield Advanced from creating, verifying, and applying WAF rules for attacks that it detects for the resource.
" + } + }, + "com.amazonaws.shield#DisableApplicationLayerAutomaticResponseRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.shield#ResourceArn", + "traits": { + "smithy.api#documentation": "The ARN (Amazon Resource Name) of the resource.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.shield#DisableApplicationLayerAutomaticResponseResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.shield#DisableProactiveEngagement": { "type": "operation", "input": { @@ -1372,7 +1479,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.
\n\tTo make a DisassociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the SRT access to your account, you can submit a DisassociateDRTLogBucket request to remove this access.
Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.
" } }, "com.amazonaws.shield#DisassociateDRTLogBucketRequest": { @@ -1414,7 +1521,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.
\n\tTo make a DisassociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the SRT access to your account, you can submit a DisassociateDRTRole request to remove this access.
Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.
" } }, "com.amazonaws.shield#DisassociateDRTRoleRequest": { @@ -1440,6 +1547,9 @@ { "target": "com.amazonaws.shield#InvalidParameterException" }, + { + "target": "com.amazonaws.shield#InvalidResourceException" + }, { "target": "com.amazonaws.shield#OptimisticLockException" }, @@ -1448,7 +1558,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and mitigation.
\nYou define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.
" + "smithy.api#documentation": "Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.
\nYou define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.
" } }, "com.amazonaws.shield#DisassociateHealthCheckRequest": { @@ -1534,6 +1644,61 @@ } } }, + "com.amazonaws.shield#EnableApplicationLayerAutomaticResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.shield#EnableApplicationLayerAutomaticResponseRequest" + }, + "output": { + "target": "com.amazonaws.shield#EnableApplicationLayerAutomaticResponseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.shield#InternalErrorException" + }, + { + "target": "com.amazonaws.shield#InvalidOperationException" + }, + { + "target": "com.amazonaws.shield#InvalidParameterException" + }, + { + "target": "com.amazonaws.shield#LimitsExceededException" + }, + { + "target": "com.amazonaws.shield#OptimisticLockException" + }, + { + "target": "com.amazonaws.shield#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Enable the Shield Advanced automatic application layer DDoS mitigation for the resource.
\nThis feature is available for Amazon CloudFront distributions only.
\nThis causes Shield Advanced to create, verify, and apply WAF rules for DDoS attacks that it detects for the \n resource. Shield Advanced applies the rules in a Shield rule group inside the web ACL that you've associated \n with the resource. For information about how automatic mitigation works and the requirements for using it, see \n Shield Advanced automatic application layer DDoS mitigation.
\nDon't use this action to make changes to automatic mitigation settings when it's already enabled for a resource. Instead, use UpdateApplicationLayerAutomaticResponse.
\nTo use this feature, you must associate a web ACL with the protected resource. The web ACL must be created using the latest version of WAF (v2). You can associate the web ACL through the Shield Advanced console \n at https://console.aws.amazon.com/wafv2/shieldv2#/. For more information, \n see Getting Started with Shield Advanced.
\nYou can also do this through the WAF console or the WAF API, but you must manage Shield Advanced automatic mitigation through Shield Advanced. For information about WAF, see \n WAF Developer Guide.
" + } + }, + "com.amazonaws.shield#EnableApplicationLayerAutomaticResponseRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.shield#ResourceArn", + "traits": { + "smithy.api#documentation": "The ARN (Amazon Resource Name) of the resource.
", + "smithy.api#required": {} + } + }, + "Action": { + "target": "com.amazonaws.shield#ResponseAction", + "traits": { + "smithy.api#documentation": "Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the \n protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, \n when you enable or update automatic mitigation. Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.shield#EnableApplicationLayerAutomaticResponseResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.shield#EnableProactiveEngagement": { "type": "operation", "input": { @@ -1634,7 +1799,7 @@ } }, "traits": { - "smithy.api#documentation": "Exception that indicates that a problem occurred with the service infrastructure. You\n can retry the request.
", + "smithy.api#documentation": "Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
", "smithy.api#error": "server" } }, @@ -1658,7 +1823,7 @@ } }, "traits": { - "smithy.api#documentation": "Exception that indicates that the NextToken specified in the request is invalid. Submit the request using the NextToken value that was returned in the response.
", + "smithy.api#documentation": "Exception that indicates that the NextToken specified in the request is invalid. Submit the request using the NextToken value that was returned in the prior response.
The ARN (Amazon Resource Name) of the resource that was attacked. If this is left\n blank, all applicable resources for this account will be included.
" + "smithy.api#documentation": "The ARNs (Amazon Resource Names) of the resources that were attacked. If you leave this \n blank, all applicable resources for this account will be included.
" } }, "StartTime": { "target": "com.amazonaws.shield#TimeRange", "traits": { - "smithy.api#documentation": "The start of the time period for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by WAF is Unix time in seconds. However any valid timestamp format is allowed.
The start of the time period for the attacks. This is a timestamp type. The request syntax listing for this call indicates a number type,\n but you can provide the time in any valid timestamp format setting.
The end of the time period for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by WAF is Unix time in seconds. However any valid timestamp format is allowed.
The end of the time period for the attacks. This is a timestamp type. The request syntax listing for this call indicates a number type,\n but you can provide the time in any valid timestamp format setting.
The ListAttacksRequest.NextMarker value from a previous call to ListAttacksRequest. Pass null if this is the first call.
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, \n Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and \n providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults\n setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.
On your first call to a list operation, leave this setting empty.
" } }, "MaxResults": { "target": "com.amazonaws.shield#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of AttackSummary objects to return. If you leave this blank, \n Shield Advanced returns the first 20 results.
\nThis is a maximum value. Shield Advanced might return the results in smaller batches. That is, the number of objects returned could be less than MaxResults, even if there are still more objects yet to return. If there are more objects to return, Shield Advanced returns a value in NextToken that you can use in your next request, to get the next batch of objects.
The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects\n than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value \n in the response.
The default setting is 20.
" } } } @@ -1830,7 +1995,7 @@ "NextToken": { "target": "com.amazonaws.shield#Token", "traits": { - "smithy.api#documentation": "The token returned by a previous call to indicate that there is more data available.\n If not null, more results are available. Pass this value for the NextMarker\n parameter in a subsequent call to ListAttacks to retrieve the next set of\n items.
Shield Advanced might return the list of AttackSummary objects in batches smaller than the number specified by MaxResults. If there are more attack summary objects to return, Shield Advanced will always also return a NextToken.
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, \n Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and \n providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults\n setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.
The next token value from a previous call to ListProtectionGroups. Pass null if this is the first call.
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, \n Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and \n providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults\n setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.
On your first call to a list operation, leave this setting empty.
" } }, "MaxResults": { "target": "com.amazonaws.shield#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of ProtectionGroup objects to return. If you leave this blank, \n Shield Advanced returns the first 20 results.
\nThis is a maximum value. Shield Advanced might return the results in smaller batches. That is, the number of objects returned could be less than MaxResults, even if there are still more objects yet to return. If there are more objects to return, Shield Advanced returns a value in NextToken that you can use in your next request, to get the next batch of objects.
The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects\n than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value \n in the response.
The default setting is 20.
" } } } @@ -1893,7 +2058,7 @@ "NextToken": { "target": "com.amazonaws.shield#Token", "traits": { - "smithy.api#documentation": "If you specify a value for MaxResults and you have more protection groups than the value of MaxResults, Shield Advanced returns this token that you can use in your next request, to get the next batch of objects.
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, \n Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and \n providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults\n setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.
The ListProtectionsRequest.NextToken value from a previous call to ListProtections. Pass null if this is the first call.
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, \n Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and \n providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults\n setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.
On your first call to a list operation, leave this setting empty.
" } }, "MaxResults": { "target": "com.amazonaws.shield#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of Protection objects to return. If you leave this blank, \n Shield Advanced returns the first 20 results.
\nThis is a maximum value. Shield Advanced might return the results in smaller batches. That is, the number of objects returned could be less than MaxResults, even if there are still more objects yet to return. If there are more objects to return, Shield Advanced returns a value in NextToken that you can use in your next request, to get the next batch of objects.
The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects\n than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value \n in the response.
The default setting is 20.
" } } } @@ -1956,7 +2121,7 @@ "NextToken": { "target": "com.amazonaws.shield#Token", "traits": { - "smithy.api#documentation": "If you specify a value for MaxResults and you have more Protections than the value of MaxResults, Shield Advanced returns a NextToken value in the response that allows you to list another group of Protections. For the second and subsequent ListProtections requests, specify the value of NextToken from the previous response to get information about another batch of Protections.
Shield Advanced might return the list of Protection objects in batches smaller than the number specified by MaxResults. If there are more Protection objects to return, Shield Advanced will always also return a NextToken.
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, \n Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and \n providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults\n setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.
The next token value from a previous call to ListResourcesInProtectionGroup. Pass null if this is the first call.
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, \n Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and \n providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults\n setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.
On your first call to a list operation, leave this setting empty.
" } }, "MaxResults": { "target": "com.amazonaws.shield#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of resource ARN objects to return. If you leave this blank, \n Shield Advanced returns the first 20 results.
\nThis is a maximum value. Shield Advanced might return the results in smaller batches. That is, the number of objects returned could be less than MaxResults, even if there are still more objects yet to return. If there are more objects to return, Shield Advanced returns a value in NextToken that you can use in your next request, to get the next batch of objects.
The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects\n than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value \n in the response.
The default setting is 20.
" } } } @@ -2026,7 +2191,7 @@ "NextToken": { "target": "com.amazonaws.shield#Token", "traits": { - "smithy.api#documentation": "If you specify a value for MaxResults and you have more resources in the protection group than the value of MaxResults, Shield Advanced returns this token that you can use in your next request, to get the next batch of objects.
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, \n Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and \n providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults\n setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.
The unique identifier (ID) for the Route 53 health check that's associated with the protection.
" + "smithy.api#documentation": "The unique identifier (ID) for the Route 53 health check that's associated with the protection.
" } }, "ProtectionArn": { @@ -2260,6 +2425,12 @@ "traits": { "smithy.api#documentation": "The ARN (Amazon Resource Name) of the protection.
" } + }, + "ApplicationLayerAutomaticResponseConfiguration": { + "target": "com.amazonaws.shield#ApplicationLayerAutomaticResponseConfiguration", + "traits": { + "smithy.api#documentation": "The automatic application layer DDoS mitigation settings for the protection. \n This configuration determines whether Shield Advanced automatically \n manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks.
" + } } }, "traits": { @@ -2436,7 +2607,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, + "min": 36, "max": 36 }, "smithy.api#pattern": "^[a-zA-Z0-9\\\\-]*$" @@ -2531,6 +2702,26 @@ "smithy.api#error": "client" } }, + "com.amazonaws.shield#ResponseAction": { + "type": "structure", + "members": { + "Block": { + "target": "com.amazonaws.shield#BlockAction", + "traits": { + "smithy.api#documentation": "Specifies that Shield Advanced should configure its WAF rules with the WAF Block action.
You must specify exactly one action, either Block or Count.
Specifies that Shield Advanced should configure its WAF rules with the WAF Count action.
You must specify exactly one action, either Block or Count.
Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the \n protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, \n when you enable or update automatic mitigation. Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.
" + } + }, "com.amazonaws.shield#RoleArn": { "type": "string", "traits": { @@ -2603,7 +2794,7 @@ "StartTime": { "target": "com.amazonaws.shield#Timestamp", "traits": { - "smithy.api#documentation": "The start time of the subscription, in Unix time in seconds. For more information see timestamp.
" + "smithy.api#documentation": "The start time of the subscription, in Unix time in seconds.
" } }, "EndTime": { @@ -2883,15 +3074,15 @@ "type": "structure", "members": { "FromInclusive": { - "target": "com.amazonaws.shield#AttackTimestamp", + "target": "com.amazonaws.shield#Timestamp", "traits": { - "smithy.api#documentation": "The start time, in Unix time in seconds. For more information see timestamp.
" + "smithy.api#documentation": "The start time, in Unix time in seconds.
" } }, "ToExclusive": { - "target": "com.amazonaws.shield#AttackTimestamp", + "target": "com.amazonaws.shield#Timestamp", "traits": { - "smithy.api#documentation": "The end time, in Unix time in seconds. For more information see timestamp.
" + "smithy.api#documentation": "The end time, in Unix time in seconds.
" } } }, @@ -2990,6 +3181,58 @@ "type": "structure", "members": {} }, + "com.amazonaws.shield#UpdateApplicationLayerAutomaticResponse": { + "type": "operation", + "input": { + "target": "com.amazonaws.shield#UpdateApplicationLayerAutomaticResponseRequest" + }, + "output": { + "target": "com.amazonaws.shield#UpdateApplicationLayerAutomaticResponseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.shield#InternalErrorException" + }, + { + "target": "com.amazonaws.shield#InvalidOperationException" + }, + { + "target": "com.amazonaws.shield#InvalidParameterException" + }, + { + "target": "com.amazonaws.shield#OptimisticLockException" + }, + { + "target": "com.amazonaws.shield#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.
" + } + }, + "com.amazonaws.shield#UpdateApplicationLayerAutomaticResponseRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.shield#ResourceArn", + "traits": { + "smithy.api#documentation": "The ARN (Amazon Resource Name) of the resource.
", + "smithy.api#required": {} + } + }, + "Action": { + "target": "com.amazonaws.shield#ResponseAction", + "traits": { + "smithy.api#documentation": "Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the \n protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, \n when you enable or update automatic mitigation. Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.shield#UpdateApplicationLayerAutomaticResponseResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.shield#UpdateEmergencyContactSettings": { "type": "operation", "input": { diff --git a/aws/sdk/aws-models/snowball.json b/aws/sdk/aws-models/snowball.json index 652e54f1d5f6e581addebcbb30c7dd69ecc52382..1e6bb0902ca577d7c74946389bf35c5bb9a1f4f6 100644 --- a/aws/sdk/aws-models/snowball.json +++ b/aws/sdk/aws-models/snowball.json @@ -31,6 +31,21 @@ "shapes": { "com.amazonaws.snowball#AWSIESnowballJobManagementService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Snowball", + "arnNamespace": "snowball", + "cloudFormationName": "Snowball", + "cloudTrailEventSource": "snowball.amazonaws.com", + "endpointPrefix": "snowball" + }, + "aws.auth#sigv4": { + "name": "snowball" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "The Amazon Web Services Snow Family provides a petabyte-scale data transport solution that uses\n secure devices to transfer large amounts of data between your on-premises data centers and\n Amazon Simple Storage Service (Amazon S3). The Snow Family commands described here provide access to the same\n functionality that is available in the Amazon Web Services Snow Family Management Console, which enables you to create\n and manage jobs for a Snow Family device. To transfer data locally with a Snow Family device,\n you'll need to use the Snowball Edge client or the Amazon S3 API Interface for Snowball or OpsHub for Snow Family. For more information, see the User Guide.
", + "smithy.api#title": "Amazon Import/Export Snowball" + }, "version": "2016-06-30", "operations": [ { @@ -108,22 +123,7 @@ { "target": "com.amazonaws.snowball#UpdateLongTermPricing" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Snowball", - "arnNamespace": "snowball", - "cloudFormationName": "Snowball", - "cloudTrailEventSource": "snowball.amazonaws.com", - "endpointPrefix": "snowball" - }, - "aws.auth#sigv4": { - "name": "snowball" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "AWS Snow Family is a petabyte-scale data transport solution that uses secure devices to\n transfer large amounts of data between your on-premises data centers and Amazon Simple Storage\n Service (Amazon S3). The Snow commands described here provide access to the same\n functionality that is available in the AWS Snow Family Management Console, which enables you to\n create and manage jobs for a Snow device. To transfer data locally with a Snow device, you'll\n need to use the Snowball Edge client or the Amazon S3 API Interface for Snowball or AWS OpsHub for Snow Family. For more\n information, see the User Guide.
", - "smithy.api#title": "Amazon Import/Export Snowball" - } + ] }, "com.amazonaws.snowball#Address": { "type": "structure", @@ -214,7 +214,7 @@ } }, "traits": { - "smithy.api#documentation": "The address that you want the Snow device(s) associated with a specific job to\n be shipped to. Addresses are validated at the time of creation. The address you provide must\n be located within the serviceable area of your region. Although no individual elements of the\n Address are required, if the address is invalid or unsupported, then an\n exception is thrown.
The address that you want the Snow device(s) associated with a specific job to be\n shipped to. Addresses are validated at the time of creation. The address you provide must be\n located within the serviceable area of your region. Although no individual elements of the\n Address are required, if the address is invalid or unsupported, then an\n exception is thrown.
The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster.\n This ARN was created using the CreateKey API action in AWS Key\n Management Service (AWS KMS).
The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster.\n This ARN was created using the CreateKey API action in Key Management Service (KMS.
The role ARN associated with this cluster. This ARN was created using the CreateRole\n API action in AWS Identity and Access Management (IAM).
" + "smithy.api#documentation": "The role ARN associated with this cluster. This ARN was created using the CreateRole\n API action in Identity and Access Management (IAM).
" } }, "ClusterState": { @@ -426,7 +426,7 @@ "SnowballType": { "target": "com.amazonaws.snowball#SnowballType", "traits": { - "smithy.api#documentation": "The type of AWS Snow device to use for this cluster. \n
\nFor cluster jobs, AWS Snow Family currently supports only the EDGE device type.
The type of Snowcone device to use for this cluster.\n
\nFor cluster jobs, Amazon Web Services Snow Family currently supports only the\n EDGE device type.
The shipping speed for each node in this cluster. This speed doesn't dictate how soon\n you'll get each device, rather it represents how quickly each device moves to\n its destination while in transit. Regional shipping speeds are as follows:
\n\nIn Australia, you have access to express shipping. Typically, devices shipped\n express are delivered in about a day.
\nIn the European Union (EU), you have access to express shipping. Typically,\n Snow devices shipped express are delivered in about a day. In addition, most countries\n in the EU have access to standard shipping, which typically takes less than a week, one\n way.
\nIn India, Snow devices are delivered in one to seven days.
\nIn the US, you have access to one-day shipping and two-day shipping.
\nThe shipping speed for each node in this cluster. This speed doesn't dictate how soon\n you'll get each device, rather it represents how quickly each device moves to its destination\n while in transit. Regional shipping speeds are as follows:
\n\nIn Australia, you have access to express shipping. Typically, devices shipped\n express are delivered in about a day.
\nIn the European Union (EU), you have access to express shipping. Typically, Snow\n devices shipped express are delivered in about a day. In addition, most countries in the\n EU have access to standard shipping, which typically takes less than a week, one\n way.
\nIn India, Snow devices are delivered in one to seven days.
\nIn the US, you have access to one-day shipping and two-day shipping.
\nThe tax documents required in your AWS Region.
" + "smithy.api#documentation": "The tax documents required in your Amazon Web Services Region.
" } }, "OnDeviceServiceConfiguration": { "target": "com.amazonaws.snowball#OnDeviceServiceConfiguration", "traits": { - "smithy.api#documentation": "Represents metadata and configuration settings for services on an AWS Snow Family device.
" + "smithy.api#documentation": "Represents metadata and configuration settings for services on an Amazon Web Services Snow Family\n device.
" } } }, @@ -546,7 +546,7 @@ } }, "traits": { - "smithy.api#documentation": "You get this exception when you call CreateReturnShippingLabel more than once when other requests are not completed.
You get this exception when you call CreateReturnShippingLabel more than once\n when other requests are not completed.
The automatically generated ID for a specific address. You'll use this ID when you\n create a job to specify which address you want the Snow device for that job shipped to.
" + "smithy.api#documentation": "The automatically generated ID for a specific address. You'll use this ID when you\n create a job to specify which address you want the Snow device for that job shipped\n to.
" } } } @@ -632,14 +632,14 @@ "Resources": { "target": "com.amazonaws.snowball#JobResource", "traits": { - "smithy.api#documentation": "The resources associated with the cluster job. These resources include Amazon S3\n buckets and optional AWS Lambda functions written in the Python language.
", + "smithy.api#documentation": "The resources associated with the cluster job. These resources include Amazon S3\n buckets and optional Lambda functions written in the Python language.\n
", "smithy.api#required": {} } }, "OnDeviceServiceConfiguration": { "target": "com.amazonaws.snowball#OnDeviceServiceConfiguration", "traits": { - "smithy.api#documentation": "Specifies the service or services on the Snow Family device that your\n transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).
" + "smithy.api#documentation": "Specifies the service or services on the Snow Family device that your transferred data\n will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS\n (Network File System).
" } }, "Description": { @@ -658,27 +658,27 @@ "KmsKeyARN": { "target": "com.amazonaws.snowball#KmsKeyARN", "traits": { - "smithy.api#documentation": "The KmsKeyARN value that you want to associate with this cluster.\n KmsKeyARN values are created by using the CreateKey API action in AWS Key\n Management Service (AWS KMS).
The KmsKeyARN value that you want to associate with this cluster.\n KmsKeyARN values are created by using the CreateKey API action in Key Management Service (KMS).
The RoleARN that you want to associate with this cluster.\n RoleArn values are created by using the CreateRole API action in AWS\n Identity and Access Management (IAM).
The RoleARN that you want to associate with this cluster.\n RoleArn values are created by using the CreateRole API action in Identity and Access Management (IAM).
The type of AWS Snow Family device to use for this cluster. \n
\nFor cluster jobs, AWS Snow Family currently supports only the EDGE device type.
For more information, see\n \"https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html\" (Snow\n Family Devices and Capacity) in the Snowcone User Guide or\n \"https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html\" (Snow\n Family Devices and Capacity) in the Snowcone User Guide.
", + "smithy.api#documentation": "The type of Snow Family Devices to use for this cluster.
\nFor cluster jobs, Amazon Web Services Snow Family currently supports only the\n EDGE device type.
For more information, see\n \"https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html\" (Snow\n Family Devices and Capacity) in the Snowcone User Guide or\n \"https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html\" (Snow\n Family Devices and Capacity) in the Snowcone User Guide.
", "smithy.api#required": {} } }, "ShippingOption": { "target": "com.amazonaws.snowball#ShippingOption", "traits": { - "smithy.api#documentation": "The shipping speed for each node in this cluster. This speed doesn't dictate how soon\n you'll get each Snowball Edge device, rather it represents how quickly each device moves to\n its destination while in transit. Regional shipping speeds are as follows:\n
\nIn Australia, you have access to express shipping. Typically, Snow devices shipped\n express are delivered in about a day.
\nIn the European Union (EU), you have access to express shipping. Typically,\n Snow devices shipped express are delivered in about a day. In addition, most countries in the\n EU have access to standard shipping, which typically takes less than a week, one\n way.
\nIn India, Snow devices are delivered in one to seven days.
\nIn the United States of America (US), you have access to one-day shipping and\n two-day shipping.
\nIn Australia, you have access to express shipping. Typically, devices shipped\n express are delivered in about a day.
\nIn the European Union (EU), you have access to express shipping. Typically,\n Snow devices shipped express are delivered in about a day. In addition, most countries\n in the EU have access to standard shipping, which typically takes less than a week, one\n way.
\nIn India, Snow devices are delivered in one to seven days.
\nIn the US, you have access to one-day shipping and two-day shipping.
\nThe shipping speed for each node in this cluster. This speed doesn't dictate how soon\n you'll get each Snowball Edge device, rather it represents how quickly each device moves to\n its destination while in transit. Regional shipping speeds are as follows:
\nIn Australia, you have access to express shipping. Typically, Snow devices shipped\n express are delivered in about a day.
\nIn the European Union (EU), you have access to express shipping. Typically, Snow\n devices shipped express are delivered in about a day. In addition, most countries in the\n EU have access to standard shipping, which typically takes less than a week, one\n way.
\nIn India, Snow devices are delivered in one to seven days.
\nIn the United States of America (US), you have access to one-day shipping and\n two-day shipping.
\nIn Australia, you have access to express shipping. Typically, devices shipped\n express are delivered in about a day.
\nIn the European Union (EU), you have access to express shipping. Typically, Snow\n devices shipped express are delivered in about a day. In addition, most countries in the\n EU have access to standard shipping, which typically takes less than a week, one\n way.
\nIn India, Snow devices are delivered in one to seven days.
\nIn the US, you have access to one-day shipping and two-day shipping.
\nThe tax documents required in your AWS Region.
" + "smithy.api#documentation": "The tax documents required in your Amazon Web Services Region.
" } }, "RemoteManagement": { @@ -745,7 +745,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a job to import or export data between Amazon S3 and your on-premises data\n center. Your AWS account must have the right trust policies and permissions in place to create\n a job for a Snow device. If you're creating a job for a node in a cluster, you only need to provide\n the clusterId value; the other job attributes are inherited from the cluster.\n
Only the Snowball; Edge device type is supported when ordering clustered jobs.
\nThe device capacity is optional.
\nAvailability of device types differ by AWS Region. For more information about Region\n availability, see AWS Regional Services.
\n\n AWS Snow Family device types and their capacities.\n
\nSnow Family device type: SNC1_SSD\n
\nCapacity: T14
\nDescription: Snowcone
\nSnow Family device type: SNC1_HDD\n
\nCapacity: T8
\nDescription: Snowcone
\nDevice type: EDGE_S\n
\nCapacity: T98
\nDescription: Snowball Edge Storage Optimized for data transfer only
\nDevice type: EDGE_CG\n
\nCapacity: T42
\nDescription: Snowball Edge Compute Optimized with GPU
\nDevice type: EDGE_C\n
\nCapacity: T42
\nDescription: Snowball Edge Compute Optimized without GPU
\nDevice type: EDGE\n
\nCapacity: T100
\nDescription: Snowball Edge Storage Optimized with EC2 Compute
\nDevice type: STANDARD\n
\nCapacity: T50
\nDescription: Original Snowball device
\nThis device is only available in the Ningxia, Beijing, and Singapore AWS Regions.
\nDevice type: STANDARD\n
\nCapacity: T80
\nDescription: Original Snowball device
\nThis device is only available in the Ningxia, Beijing, and Singapore AWS Regions.
\nCreates a job to import or export data between Amazon S3 and your on-premises data\n center. Your Amazon Web Services account must have the right trust policies and permissions in\n place to create a job for a Snow device. If you're creating a job for a node in a cluster, you\n only need to provide the clusterId value; the other job attributes are inherited\n from the cluster.
Only the Snowball; Edge device type is supported when ordering clustered jobs.
\nThe device capacity is optional.
\nAvailability of device types differ by Amazon Web Services Region. For more information\n about Region availability, see Amazon Web Services Regional Services.
\n\n Snow Family Devices and their capacities.\n
\nSnow Family device type: SNC1_SSD\n
\nCapacity: T14
\nDescription: Snowcone
\nSnow Family device type: SNC1_HDD\n
\nCapacity: T8
\nDescription: Snowcone
\nDevice type: EDGE_S\n
\nCapacity: T98
\nDescription: Snowball Edge Storage Optimized for data transfer only
\nDevice type: EDGE_CG\n
\nCapacity: T42
\nDescription: Snowball Edge Compute Optimized with GPU
\nDevice type: EDGE_C\n
\nCapacity: T42
\nDescription: Snowball Edge Compute Optimized without GPU
\nDevice type: EDGE\n
\nCapacity: T100
\nDescription: Snowball Edge Storage Optimized with EC2 Compute
\nDevice type: STANDARD\n
\nCapacity: T50
\nDescription: Original Snowball device
\nThis device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region\n
\nDevice type: STANDARD\n
\nCapacity: T80
\nDescription: Original Snowball device
\nThis device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region.
\nSpecifies the service or services on the Snow Family device that your\n transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).
" + "smithy.api#documentation": "Specifies the service or services on the Snow Family device that your transferred data\n will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File\n System) and the Amazon Web Services Storage Gateway service Tape Gateway type.
" } }, "Description": { @@ -784,13 +784,13 @@ "KmsKeyARN": { "target": "com.amazonaws.snowball#KmsKeyARN", "traits": { - "smithy.api#documentation": "The KmsKeyARN that you want to associate with this job.\n KmsKeyARNs are created using the CreateKey AWS Key Management\n Service (KMS) API action.
The KmsKeyARN that you want to associate with this job.\n KmsKeyARNs are created using the CreateKey\n Key Management Service (KMS) API action.
The RoleARN that you want to associate with this job.\n RoleArns are created using the CreateRole AWS Identity and\n Access Management (IAM) API action.
The RoleARN that you want to associate with this job.\n RoleArns are created using the CreateRole\n Identity and Access Management (IAM) API action.
The shipping speed for this job. This speed doesn't dictate how soon you'll get the\n Snow device, rather it represents how quickly the Snow device moves to its destination while in\n transit. Regional shipping speeds are as follows:
\n\nIn Australia, you have access to express shipping. Typically, Snow devices shipped\n express are delivered in about a day.
\nIn the European Union (EU), you have access to express shipping. Typically,\n Snow devices shipped express are delivered in about a day. In addition, most countries in the\n EU have access to standard shipping, which typically takes less than a week, one\n way.
\nIn India, Snow devices are delivered in one to seven days.
\nIn the US, you have access to one-day shipping and two-day shipping.
\nThe shipping speed for this job. This speed doesn't dictate how soon you'll get the\n Snow device, rather it represents how quickly the Snow device moves to its destination while\n in transit. Regional shipping speeds are as follows:
\n\nIn Australia, you have access to express shipping. Typically, Snow devices shipped\n express are delivered in about a day.
\nIn the European Union (EU), you have access to express shipping. Typically, Snow\n devices shipped express are delivered in about a day. In addition, most countries in the\n EU have access to standard shipping, which typically takes less than a week, one\n way.
\nIn India, Snow devices are delivered in one to seven days.
\nIn the US, you have access to one-day shipping and two-day shipping.
\nThe type of AWS Snow Family device to use for this job. \n
\nFor cluster jobs, AWS Snow Family currently supports only the EDGE device type.
The type of AWS Snow device to use for this job. Currently, the only supported\n device type for cluster jobs is EDGE.
For more information, see Snowball Edge Device\n Options in the Snowball Edge Developer Guide.
\n \nFor more information, see\n \"https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html\" (Snow\n Family Devices and Capacity) in the Snowcone User Guide or\n \"https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html\" (Snow\n Family Devices and Capacity) in the Snowcone User Guide.
" + "smithy.api#documentation": "The type of Snow Family Devices to use for this job.\n
\nFor cluster jobs, Amazon Web Services Snow Family currently supports only the\n EDGE device type.
The type of Amazon Web Services Snow device to use for this job. Currently, the only\n supported device type for cluster jobs is EDGE.
For more information, see Snowball Edge Device\n Options in the Snowball Edge Developer Guide.
\n \nFor more information, see\n \"https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html\" (Snow\n Family Devices and Capacity) in the Snowcone User Guide or\n \"https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html\" (Snow\n Family Devices and Capacity) in the Snowcone User Guide.
" } }, "ForwardingAddressId": { @@ -832,13 +832,13 @@ "TaxDocuments": { "target": "com.amazonaws.snowball#TaxDocuments", "traits": { - "smithy.api#documentation": "The tax documents required in your AWS Region.
" + "smithy.api#documentation": "The tax documents required in your Amazon Web Services Region.
" } }, "DeviceConfiguration": { "target": "com.amazonaws.snowball#DeviceConfiguration", "traits": { - "smithy.api#documentation": "Defines the device configuration for an AWS Snowcone job.
\n \nFor more information, see\n \"https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html\" (Snow\n Family Devices and Capacity) in the Snowcone User Guide or\n \"https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html\" (Snow\n Family Devices and Capacity) in the Snowcone User Guide.
" + "smithy.api#documentation": "Defines the device configuration for an Snowcone job.
\n \nFor more information, see\n \"https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html\" (Snow\n Family Devices and Capacity) in the Snowcone User Guide or\n \"https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html\" (Snow\n Family Devices and Capacity) in the Snowcone User Guide.
" } }, "RemoteManagement": { @@ -880,7 +880,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a job with the long-term usage option for a device. The long-term usage is a\n 1-year or 3-year long-term pricing type for the device. You are billed upfront, and AWS\n provides discounts for long-term pricing.\n
" + "smithy.api#documentation": "Creates a job with the long-term usage option for a device. The long-term usage is a\n 1-year or 3-year long-term pricing type for the device. You are billed upfront, and Amazon Web Services provides discounts for long-term pricing.\n
" } }, "com.amazonaws.snowball#CreateLongTermPricingRequest": { @@ -896,13 +896,13 @@ "IsLongTermPricingAutoRenew": { "target": "com.amazonaws.snowball#JavaBoolean", "traits": { - "smithy.api#documentation": "Specifies whether the current long-term pricing type for the device should be renewed.
" + "smithy.api#documentation": "Specifies whether the current long-term pricing type for the device should be\n renewed.
" } }, "SnowballType": { "target": "com.amazonaws.snowball#SnowballType", "traits": { - "smithy.api#documentation": "The type of AWS Snow Family device to use for the long-term pricing job.
" + "smithy.api#documentation": "The type of Snow Family Devices to use for the long-term pricing job.
" } } } @@ -944,7 +944,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a shipping label that will be used to return the Snow device to AWS.
" + "smithy.api#documentation": "Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
" } }, "com.amazonaws.snowball#CreateReturnShippingLabelRequest": { @@ -960,7 +960,7 @@ "ShippingOption": { "target": "com.amazonaws.snowball#ShippingOption", "traits": { - "smithy.api#documentation": "The shipping speed for a particular job. This speed doesn't dictate how soon the device is returned to AWS.\n This speed represents how quickly it moves to its\n destination while in transit. Regional shipping speeds are as follows:
" + "smithy.api#documentation": "The shipping speed for a particular job. This speed doesn't dictate how soon the device\n is returned to Amazon Web Services. This speed represents how quickly it moves to its\n destination while in transit. Regional shipping speeds are as follows:
" } } } @@ -971,7 +971,7 @@ "Status": { "target": "com.amazonaws.snowball#ShippingLabelStatus", "traits": { - "smithy.api#documentation": "The status information of the task on a Snow device that is being returned to AWS.
" + "smithy.api#documentation": "The status information of the task on a Snow device that is being returned to Amazon Web Services.
" } } } @@ -994,18 +994,18 @@ "TotalBytes": { "target": "com.amazonaws.snowball#Long", "traits": { - "smithy.api#documentation": "The total bytes of data for a transfer between a Snow device and Amazon S3. This value is\n set to 0 (zero) until all the keys that will be transferred have been listed.
" + "smithy.api#documentation": "The total bytes of data for a transfer between a Snow device and Amazon S3. This value\n is set to 0 (zero) until all the keys that will be transferred have been listed.
" } }, "TotalObjects": { "target": "com.amazonaws.snowball#Long", "traits": { - "smithy.api#documentation": "The total number of objects for a transfer between a Snow device and Amazon S3. This value\n is set to 0 (zero) until all the keys that will be transferred have been listed.
" + "smithy.api#documentation": "The total number of objects for a transfer between a Snow device and Amazon S3. This\n value is set to 0 (zero) until all the keys that will be transferred have been\n listed.
" } } }, "traits": { - "smithy.api#documentation": "Defines the real-time status of a Snow device's data transfer while the device is at AWS.\n This data is only available while a job has a JobState value of\n InProgress, for both import and export jobs.
Defines the real-time status of a Snow device's data transfer while the device is at\n Amazon Web Services. This data is only available while a job has a JobState\n value of InProgress, for both import and export jobs.
The address that you want the Snow device(s) associated with a specific job to\n be shipped to.
" + "smithy.api#documentation": "The address that you want the Snow device(s) associated with a specific job to be\n shipped to.
" } } } @@ -1214,7 +1214,7 @@ } ], "traits": { - "smithy.api#documentation": "Information on the shipping label of a Snow device that is being returned to AWS.
" + "smithy.api#documentation": "Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
" } }, "com.amazonaws.snowball#DescribeReturnShippingLabelRequest": { @@ -1223,7 +1223,7 @@ "JobId": { "target": "com.amazonaws.snowball#JobId", "traits": { - "smithy.api#documentation": "The automatically generated ID for a job, for example\n JID123e4567-e89b-12d3-a456-426655440000.
The automatically generated ID for a job, for example\n JID123e4567-e89b-12d3-a456-426655440000.
The status information of the task on a Snow device that is being returned to AWS.
" + "smithy.api#documentation": "The status information of the task on a Snow device that is being returned to Amazon Web Services.
" } }, "ExpirationDate": { @@ -1243,6 +1243,12 @@ "traits": { "smithy.api#documentation": "The expiration date of the current return shipping label.
" } + }, + "ReturnShippingLabelURI": { + "target": "com.amazonaws.snowball#String", + "traits": { + "smithy.api#documentation": "The pre-signed Amazon S3 URI used to download the return shipping label.
" + } } } }, @@ -1252,7 +1258,7 @@ "SnowconeDeviceConfiguration": { "target": "com.amazonaws.snowball#SnowconeDeviceConfiguration", "traits": { - "smithy.api#documentation": "Returns information about the device configuration for an AWS Snowcone job.
" + "smithy.api#documentation": "Returns information about the device configuration for an Snowcone\n job.
" } } }, @@ -1293,7 +1299,7 @@ } }, "traits": { - "smithy.api#documentation": "A JSON-formatted object that contains the IDs for an Amazon Machine Image (AMI),\n including the Amazon EC2 AMI ID and the Snow device AMI ID. Each AMI has these two IDs to\n simplify identifying the AMI in both the AWS Cloud and on the device.
" + "smithy.api#documentation": "A JSON-formatted object that contains the IDs for an Amazon Machine Image (AMI),\n including the Amazon EC2 AMI ID and the Snow device AMI ID. Each AMI has these two IDs to\n simplify identifying the AMI in both the Amazon Web Services Cloud and on the device.
" } }, "com.amazonaws.snowball#Ec2AmiResourceList": { @@ -1320,7 +1326,7 @@ "EventResourceARN": { "target": "com.amazonaws.snowball#ResourceARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an AWS Lambda\n function's event trigger associated with this job.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.
" } } }, @@ -1357,7 +1363,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a link to an Amazon S3 presigned URL for the manifest file associated with the\n specified JobId value. You can access the manifest file for up to 60 minutes\n after this request has been made. To access the manifest file after 60 minutes have passed,\n you'll have to make another call to the GetJobManifest action.
The manifest is an encrypted file that you can download after your job enters the\n WithCustomer status. The manifest is decrypted by using the\n UnlockCode code value, when you pass both values to the Snow device through the\n Snowball client when the client is started for the first time.
As a best practice, we recommend that you don't save a copy of an\n UnlockCode value in the same location as the manifest file for that job. Saving\n these separately helps prevent unauthorized parties from gaining access to the Snow device\n associated with that job.
The credentials of a given job, including its manifest file and unlock code, expire 360\n days after the job is created.
" + "smithy.api#documentation": "Returns a link to an Amazon S3 presigned URL for the manifest file associated with the\n specified JobId value. You can access the manifest file for up to 60 minutes\n after this request has been made. To access the manifest file after 60 minutes have passed,\n you'll have to make another call to the GetJobManifest action.
The manifest is an encrypted file that you can download after your job enters the\n WithCustomer status. The manifest is decrypted by using the\n UnlockCode code value, when you pass both values to the Snow device through the\n Snowball client when the client is started for the first time.
As a best practice, we recommend that you don't save a copy of an\n UnlockCode value in the same location as the manifest file for that job. Saving\n these separately helps prevent unauthorized parties from gaining access to the Snow device\n associated with that job.
The credentials of a given job, including its manifest file and unlock code, expire 360\n days after the job is created.
" } }, "com.amazonaws.snowball#GetJobManifestRequest": { @@ -1400,7 +1406,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the UnlockCode code value for the specified job. A particular\n UnlockCode value can be accessed for up to 360 days after the associated job\n has been created.
The UnlockCode value is a 29-character code with 25 alphanumeric\n characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed\n along with the manifest to the Snow device through the Snowball client when the client is started\n for the first time.
As a best practice, we recommend that you don't save a copy of the\n UnlockCode in the same location as the manifest file for that job. Saving these\n separately helps prevent unauthorized parties from gaining access to the Snow device associated\n with that job.
Returns the UnlockCode code value for the specified job. A particular\n UnlockCode value can be accessed for up to 360 days after the associated job\n has been created.
The UnlockCode value is a 29-character code with 25 alphanumeric\n characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed\n along with the manifest to the Snow device through the Snowball client when the client is\n started for the first time.
As a best practice, we recommend that you don't save a copy of the\n UnlockCode in the same location as the manifest file for that job. Saving these\n separately helps prevent unauthorized parties from gaining access to the Snow device\n associated with that job.
Returns information about the Snow Family service limit for your account, and also the\n number of Snow devices your account has in use.
\n\nThe default service limit for the number of Snow devices that you can have at one time is\n 1. If you want to increase your service limit, contact AWS Support.
" + "smithy.api#documentation": "Returns information about the Snow Family service limit for your account, and also the\n number of Snow devices your account has in use.
\n\nThe default service limit for the number of Snow devices that you can have at one time\n is 1. If you want to increase your service limit, contact Amazon Web Services Support.
" } }, "com.amazonaws.snowball#GetSnowballUsageRequest": { @@ -1476,7 +1482,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns an Amazon S3 presigned URL for an update file associated with a specified\n JobId.
Returns an Amazon S3 presigned URL for an update file associated with a specified\n JobId.
The ID for a job that you want to get the software update file for, for example\n JID123e4567-e89b-12d3-a456-426655440000.
The ID for a job that you want to get the software update file for, for example\n JID123e4567-e89b-12d3-a456-426655440000.
The Amazon S3 presigned URL for the update file associated with the specified\n JobId value. The software update will be available for 2 days after this request is made. \n To access an update after the 2 days have passed, you'll have to make another call to GetSoftwareUpdates.
The Amazon S3 presigned URL for the update file associated with the specified\n JobId value. The software update will be available for 2 days after this\n request is made. To access an update after the 2 days have passed, you'll have to make another\n call to GetSoftwareUpdates.
The Goods and Services Tax (GST) documents required in AWS Regions in India.
" + "smithy.api#documentation": "The Goods and Services Tax (GST) documents required in Amazon Web Services Region in\n India.
" } } }, "traits": { - "smithy.api#documentation": "The tax documents required in AWS Regions in India.
" + "smithy.api#documentation": "The tax documents required in Amazon Web Services Region in India.
" } }, "com.amazonaws.snowball#Integer": { @@ -1542,7 +1548,7 @@ } }, "traits": { - "smithy.api#documentation": "Job or cluster creation failed. One or more inputs were invalid. Confirm that the\n CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.
", + "smithy.api#documentation": "Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.
", "smithy.api#error": "client" } }, @@ -1622,7 +1628,7 @@ "IsMaster": { "target": "com.amazonaws.snowball#Boolean", "traits": { - "smithy.api#documentation": "A value that indicates that this job is a main job. A main job represents a\n successful request to create an export job. Main jobs aren't associated with any Snowballs.\n Instead, each main job will have at least one job part, and each job part is associated with\n a Snowball. It might take some time before the job parts associated with a particular main\n job are listed, because they are created after the main job is created.
" + "smithy.api#documentation": "A value that indicates that this job is a main job. A main job represents a successful\n request to create an export job. Main jobs aren't associated with any Snowballs. Instead, each\n main job will have at least one job part, and each job part is associated with a Snowball. It\n might take some time before the job parts associated with a particular main job are listed,\n because they are created after the main job is created.
" } }, "JobType": { @@ -1683,7 +1689,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains job logs. Whenever a Snow device is used to import data into or export data out of\n Amazon S3, you'll have the option of downloading a PDF job report. Job logs are returned as a\n part of the response syntax of the DescribeJob action in the\n JobMetadata data type. The job logs can be accessed for up to 60 minutes after\n this request has been made. To access any of the job logs after 60 minutes have passed, you'll\n have to make another call to the DescribeJob action.
For import jobs, the PDF job report becomes available at the end of the import process.\n For export jobs, your job report typically becomes available while the Snow device for your job\n part is being delivered to you.
\n\nThe job report provides you insight into the state of your Amazon S3 data transfer. The\n report includes details about your job or job part for your records.
\n\nFor deeper visibility into the status of your transferred objects, you can look at the\n two associated logs: a success log and a failure log. The logs are saved in comma-separated\n value (CSV) format, and the name of each log includes the ID of the job or job part that the\n log describes.
" + "smithy.api#documentation": "Contains job logs. Whenever a Snow device is used to import data into or export data\n out of Amazon S3, you'll have the option of downloading a PDF job report. Job logs are\n returned as a part of the response syntax of the DescribeJob action in the\n JobMetadata data type. The job logs can be accessed for up to 60 minutes after\n this request has been made. To access any of the job logs after 60 minutes have passed, you'll\n have to make another call to the DescribeJob action.
For import jobs, the PDF job report becomes available at the end of the import process.\n For export jobs, your job report typically becomes available while the Snow device for your\n job part is being delivered to you.
\n\nThe job report provides you insight into the state of your Amazon S3 data transfer. The\n report includes details about your job or job part for your records.
\n\nFor deeper visibility into the status of your transferred objects, you can look at the\n two associated logs: a success log and a failure log. The logs are saved in comma-separated\n value (CSV) format, and the name of each log includes the ID of the job or job part that the\n log describes.
" } }, "com.amazonaws.snowball#JobMetadata": { @@ -1734,13 +1740,13 @@ "KmsKeyARN": { "target": "com.amazonaws.snowball#KmsKeyARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key\n associated with this job. This ARN was created using the CreateKey API action in AWS\n KMS.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the Key Management Service (KMS) key\n associated with this job. This ARN was created using the CreateKey API action in KMS.
" } }, "RoleARN": { "target": "com.amazonaws.snowball#RoleARN", "traits": { - "smithy.api#documentation": "The role ARN associated with this job. This ARN was created using the CreateRole\n API action in AWS Identity and Access Management (IAM).
" + "smithy.api#documentation": "The role ARN associated with this job. This ARN was created using the CreateRole\n API action in Identity and Access Management.
" } }, "AddressId": { @@ -1770,13 +1776,13 @@ "DataTransferProgress": { "target": "com.amazonaws.snowball#DataTransfer", "traits": { - "smithy.api#documentation": "A value that defines the real-time status of a Snow device's data transfer while the\n device is at AWS. This data is only available while a job has a JobState value of\n InProgress, for both import and export jobs.
A value that defines the real-time status of a Snow device's data transfer while the\n device is at Amazon Web Services. This data is only available while a job has a\n JobState value of InProgress, for both import and export\n jobs.
Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, the PDF\n job report becomes available at the end of the import process. For export jobs, your job\n report typically becomes available while the Snow device for your job part is being delivered to\n you.
" + "smithy.api#documentation": "Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, the PDF\n job report becomes available at the end of the import process. For export jobs, your job\n report typically becomes available while the Snow device for your job part is being delivered\n to you.
" } }, "ClusterId": { @@ -1794,7 +1800,7 @@ "TaxDocuments": { "target": "com.amazonaws.snowball#TaxDocuments", "traits": { - "smithy.api#documentation": "The metadata associated with the tax documents required in your AWS Region.
" + "smithy.api#documentation": "The metadata associated with the tax documents required in your Amazon Web Services Region.
" } }, "DeviceConfiguration": { @@ -1815,7 +1821,7 @@ "OnDeviceServiceConfiguration": { "target": "com.amazonaws.snowball#OnDeviceServiceConfiguration", "traits": { - "smithy.api#documentation": "Represents metadata and configuration settings for services on an AWS Snow Family device.
" + "smithy.api#documentation": "Represents metadata and configuration settings for services on an Amazon Web Services Snow Family\n device.
" } } }, @@ -1852,7 +1858,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains an array of AWS resource objects. Each object represents an Amazon S3 bucket,\n an AWS Lambda function, or an Amazon Machine Image (AMI) based on Amazon EC2 that is\n associated with a particular job.
" + "smithy.api#documentation": "Contains an array of Amazon Web Services resource objects. Each object represents an\n Amazon S3 bucket, an Lambda function, or an Amazon Machine Image (AMI) based\n on Amazon EC2 that is associated with a particular job.
" } }, "com.amazonaws.snowball#JobState": { @@ -1947,7 +1953,7 @@ } }, "traits": { - "smithy.api#documentation": "The provided AWS Key Management Service key lacks the permissions to perform the\n specified CreateJob or UpdateJob action.
", + "smithy.api#documentation": "The provided Key Management Service key lacks the permissions to perform the specified\n CreateJob or UpdateJob action.
", "smithy.api#error": "client" } }, @@ -1987,7 +1993,7 @@ "LambdaArn": { "target": "com.amazonaws.snowball#ResourceARN", "traits": { - "smithy.api#documentation": "An Amazon Resource Name (ARN) that represents an AWS Lambda function to be triggered by\n PUT object actions on the associated local Amazon S3 resource.
" + "smithy.api#documentation": "An Amazon Resource Name (ARN) that represents an Lambda function to be\n triggered by PUT object actions on the associated local Amazon S3 resource.
" } }, "EventTriggers": { @@ -2136,7 +2142,7 @@ } ], "traits": { - "smithy.api#documentation": "This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs)\n that are owned by your AWS account that would be supported for use on a Snow device.\n Currently, supported AMIs are based on the CentOS 7 (x86_64) - with Updates HVM, Ubuntu Server\n 14.04 LTS (HVM), and Ubuntu 16.04 LTS - Xenial (HVM) images, available on the AWS\n Marketplace.
" + "smithy.api#documentation": "This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs)\n that are owned by your Amazon Web Services accountthat would be supported for use on a Snow\n device. Currently, supported AMIs are based on the CentOS 7 (x86_64) - with Updates HVM,\n Ubuntu Server 14.04 LTS (HVM), and Ubuntu 16.04 LTS - Xenial (HVM) images, available on the\n Amazon Web Services Marketplace.
" } }, "com.amazonaws.snowball#ListCompatibleImagesRequest": { @@ -2272,7 +2278,7 @@ "NextToken": { "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "Because HTTP requests are stateless, this is the starting point for your next list of\n ListLongTermPricing to return.
Because HTTP requests are stateless, this is the starting point for your next list of\n ListLongTermPricing to return.
The type of AWS Snow Family device associated with this long-term pricing job.
" + "smithy.api#documentation": "The type of Snow Family Devices associated with this long-term pricing job.
" } }, "JobIds": { @@ -2384,7 +2390,7 @@ } }, "traits": { - "smithy.api#documentation": "Each LongTermPricingListEntry object contains information about a long-term pricing type.
Each LongTermPricingListEntry object contains information about a long-term\n pricing type.
The maximum NFS storage for one Snowball Family device.
" + "smithy.api#documentation": "The maximum NFS storage for one Snow Family device.
" } }, "StorageUnit": { @@ -2419,7 +2425,7 @@ } }, "traits": { - "smithy.api#documentation": "An object that represents metadata and configuration settings for NFS service on an AWS Snow Family device.
" + "smithy.api#documentation": "An object that represents the metadata and configuration settings for the NFS (Network\n File System) service on an Amazon Web Services Snow Family device.
" } }, "com.amazonaws.snowball#Notification": { @@ -2428,7 +2434,7 @@ "SnsTopicARN": { "target": "com.amazonaws.snowball#SnsTopicARN", "traits": { - "smithy.api#documentation": "The new SNS TopicArn that you want to associate with this job. You can\n create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API\n action.
You can subscribe email addresses to an Amazon SNS topic through the AWS Management\n Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.
" + "smithy.api#documentation": "The new SNS TopicArn that you want to associate with this job. You can\n create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API\n action.
You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification\n Service (Amazon SNS) API action.
" } }, "JobStatesToNotify": { @@ -2454,12 +2460,18 @@ "NFSOnDeviceService": { "target": "com.amazonaws.snowball#NFSOnDeviceServiceConfiguration", "traits": { - "smithy.api#documentation": "Represents the NFS service on a Snow Family device.
" + "smithy.api#documentation": "Represents the NFS (Network File System) service on a Snow Family device.
" + } + }, + "TGWOnDeviceService": { + "target": "com.amazonaws.snowball#TGWOnDeviceServiceConfiguration", + "traits": { + "smithy.api#documentation": "Represents the Storage Gateway service Tape Gateway type on a Snow Family device.
" } } }, "traits": { - "smithy.api#documentation": "An object that represents metadata and configuration settings for services on an AWS Snow Family device.
" + "smithy.api#documentation": "An object that represents the metadata and configuration settings for services on an Amazon Web Services\n Snow Family device.
" } }, "com.amazonaws.snowball#RemoteManagement": { @@ -2495,7 +2507,7 @@ } }, "traits": { - "smithy.api#documentation": "You get this exception if you call CreateReturnShippingLabel and a valid return\n shipping label already exists. In this case, use\n DescribeReturnShippingLabel to get the url.
You get this exception if you call CreateReturnShippingLabel and a valid\n return shipping label already exists. In this case, use\n DescribeReturnShippingLabel to get the URL.
Specifies the service or services on the Snow Family device that your\n transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).
" + "smithy.api#documentation": "Specifies the service or services on the Snow Family device that your transferred data\n will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File\n System).
" } } }, @@ -2582,13 +2594,13 @@ "ShippingOption": { "target": "com.amazonaws.snowball#ShippingOption", "traits": { - "smithy.api#documentation": "The shipping speed for a particular job. This speed doesn't dictate how soon you'll get\n the Snow device from the job's creation date. This speed represents how quickly it moves to its\n destination while in transit. Regional shipping speeds are as follows:
\n\nIn Australia, you have access to express shipping. Typically, Snow devices shipped\n express are delivered in about a day.
\nIn the European Union (EU), you have access to express shipping. Typically,\n Snow devices shipped express are delivered in about a day. In addition, most countries in the\n EU have access to standard shipping, which typically takes less than a week, one\n way.
\nIn India, Snow devices are delivered in one to seven days.
\nIn the United States of America (US), you have access to one-day shipping and\n two-day shipping.
\nThe shipping speed for a particular job. This speed doesn't dictate how soon you'll get\n the Snow device from the job's creation date. This speed represents how quickly it moves to\n its destination while in transit. Regional shipping speeds are as follows:
\n\nIn Australia, you have access to express shipping. Typically, Snow devices shipped\n express are delivered in about a day.
\nIn the European Union (EU), you have access to express shipping. Typically, Snow\n devices shipped express are delivered in about a day. In addition, most countries in the\n EU have access to standard shipping, which typically takes less than a week, one\n way.
\nIn India, Snow devices are delivered in one to seven days.
\nIn the United States of America (US), you have access to one-day shipping and\n two-day shipping.
\nThe Status and TrackingNumber values for a Snow device being\n returned to AWS for a particular job.
The Status and TrackingNumber values for a Snow device being\n returned to Amazon Web Services for a particular job.
Configures the wireless connection for the AWS Snowcone device.
" + "smithy.api#documentation": "Configures the wireless connection for the Snowcone device.
" } } }, "traits": { - "smithy.api#documentation": "Specifies the device configuration for an AWS Snowcone job.
" + "smithy.api#documentation": "Specifies the device configuration for an Snowcone job.
" } }, "com.amazonaws.snowball#SnsTopicARN": { @@ -2774,24 +2786,44 @@ } } }, + "com.amazonaws.snowball#TGWOnDeviceServiceConfiguration": { + "type": "structure", + "members": { + "StorageLimit": { + "target": "com.amazonaws.snowball#StorageLimit", + "traits": { + "smithy.api#documentation": "The maximum number of virtual tapes to store on one Snow Family device. Due to physical\n resource limitations, this value must be set to 80 for Snowball Edge.
" + } + }, + "StorageUnit": { + "target": "com.amazonaws.snowball#StorageUnit", + "traits": { + "smithy.api#documentation": "The scale unit of the virtual tapes on the device.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that represents the metadata and configuration settings for the Storage Gateway\n service Tape Gateway type on an Amazon Web Services Snow Family device.
" + } + }, "com.amazonaws.snowball#TargetOnDeviceService": { "type": "structure", "members": { "ServiceName": { "target": "com.amazonaws.snowball#DeviceServiceName", "traits": { - "smithy.api#documentation": "Specifies the name of the service on the Snow Family device that your\n transferred data will be exported from or imported into.
" + "smithy.api#documentation": "Specifies the name of the service on the Snow Family device that your transferred data\n will be exported from or imported into.
" } }, "TransferOption": { "target": "com.amazonaws.snowball#TransferOption", "traits": { - "smithy.api#documentation": "Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.
" + "smithy.api#documentation": "Specifies whether the data is being imported or exported. You can import or export the\n data, or use it locally on the device.
" } } }, "traits": { - "smithy.api#documentation": "An object that represents the service or services on the Snow Family device that your\n transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).
" + "smithy.api#documentation": "An object that represents the service or services on the Snow Family device that your\n transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and\n NFS (Network File System).
" } }, "com.amazonaws.snowball#TargetOnDeviceServiceList": { @@ -2808,7 +2840,7 @@ } }, "traits": { - "smithy.api#documentation": "The tax documents required in your AWS Region.
" + "smithy.api#documentation": "The tax documents required in your Amazon Web Services Region.
" } }, "com.amazonaws.snowball#Timestamp": { @@ -2841,7 +2873,7 @@ } }, "traits": { - "smithy.api#documentation": "The address is either outside the serviceable area for your region, or an error\n occurred. Check the address with your region's carrier and try again. If the issue persists,\n contact AWS Support.
", + "smithy.api#documentation": "The address is either outside the serviceable area for your region, or an error\n occurred. Check the address with your region's carrier and try again. If the issue persists,\n contact Amazon Web Services Support.
", "smithy.api#error": "client" } }, @@ -2887,7 +2919,7 @@ "RoleARN": { "target": "com.amazonaws.snowball#RoleARN", "traits": { - "smithy.api#documentation": "The new role Amazon Resource Name (ARN) that you want to associate with this cluster.\n To create a role ARN, use the CreateRole API action in AWS\n Identity and Access Management (IAM).
" + "smithy.api#documentation": "The new role Amazon Resource Name (ARN) that you want to associate with this cluster.\n To create a role ARN, use the CreateRole API action in Identity and Access Management (IAM).
" } }, "Description": { @@ -2905,7 +2937,7 @@ "OnDeviceServiceConfiguration": { "target": "com.amazonaws.snowball#OnDeviceServiceConfiguration", "traits": { - "smithy.api#documentation": "Specifies the service or services on the Snow Family device that your\n transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).
" + "smithy.api#documentation": "Specifies the service or services on the Snow Family device that your transferred data\n will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS\n (Network File System).
" } }, "AddressId": { @@ -2983,7 +3015,7 @@ "RoleARN": { "target": "com.amazonaws.snowball#RoleARN", "traits": { - "smithy.api#documentation": "The new role Amazon Resource Name (ARN) that you want to associate with this job. To\n create a role ARN, use the CreateRoleAWS Identity and Access\n Management (IAM) API action.
" + "smithy.api#documentation": "The new role Amazon Resource Name (ARN) that you want to associate with this job. To\n create a role ARN, use the CreateRoleIdentity and Access Management\n (IAM) API action.
" } }, "Notification": { @@ -3001,7 +3033,7 @@ "OnDeviceServiceConfiguration": { "target": "com.amazonaws.snowball#OnDeviceServiceConfiguration", "traits": { - "smithy.api#documentation": "Specifies the service or services on the Snow Family device that your\n transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).
" + "smithy.api#documentation": "Specifies the service or services on the Snow Family device that your transferred data\n will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File\n System) and the Amazon Web Services Storage Gateway service Tape Gateway type.
" } }, "AddressId": { @@ -3066,14 +3098,14 @@ "JobId": { "target": "com.amazonaws.snowball#JobId", "traits": { - "smithy.api#documentation": "The job ID of the job whose shipment date you want to update, for example\n JID123e4567-e89b-12d3-a456-426655440000.
The job ID of the job whose shipment date you want to update, for example\n JID123e4567-e89b-12d3-a456-426655440000.
The state of a device when it is being shipped.
\nSet to RECEIVED when the device arrives at your location.
Set to RETURNED when you have returned the device to AWS.
The state of a device when it is being shipped.
\nSet to RECEIVED when the device arrives at your location.
Set to RETURNED when you have returned the device to Amazon Web Services.
Specifies that a device that is ordered with long-term pricing should be replaced with a new device.
" + "smithy.api#documentation": "Specifies that a device that is ordered with long-term pricing should be replaced with a\n new device.
" } }, "IsLongTermPricingAutoRenew": { @@ -3134,12 +3166,12 @@ "IsWifiEnabled": { "target": "com.amazonaws.snowball#Boolean", "traits": { - "smithy.api#documentation": "Enables the Wi-Fi adapter on an AWS Snowcone device.
" + "smithy.api#documentation": "Enables the Wi-Fi adapter on an Snowcone device.
" } } }, "traits": { - "smithy.api#documentation": "Configures the wireless connection on an AWS Snowcone device.
" + "smithy.api#documentation": "Configures the wireless connection on an Snowcone device.
" } } } diff --git a/aws/sdk/aws-models/sqs.json b/aws/sdk/aws-models/sqs.json index 6fd6d74e9b7be78efa9102e9fbb114f962d01c4f..1c5848d6420ac38c207495e288b87b419924e6da 100644 --- a/aws/sdk/aws-models/sqs.json +++ b/aws/sdk/aws-models/sqs.json @@ -75,7 +75,7 @@ "AWSAccountIds": { "target": "com.amazonaws.sqs#AWSAccountIdList", "traits": { - "smithy.api#documentation": "The account numbers of the principals who are to receive\n permission. For information about locating the account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer\n Guide.
", + "smithy.api#documentation": "The Amazon Web Services account numbers of the principals who are to receive\n permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer\n Guide.
", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "AWSAccountId" @@ -97,6 +97,24 @@ }, "com.amazonaws.sqs#AmazonSQS": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "SQS", + "arnNamespace": "sqs", + "cloudFormationName": "SQS", + "cloudTrailEventSource": "sqs.amazonaws.com", + "endpointPrefix": "sqs" + }, + "aws.auth#sigv4": { + "name": "sqs" + }, + "aws.protocols#awsQuery": {}, + "smithy.api#documentation": "Welcome to the Amazon SQS API Reference.
\nAmazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.
\nFor information on the permissions you need to use this API, see\n Identity and\n access management in the Amazon SQS Developer Guide.\n
\nYou can use Amazon Web Services SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:
\nCryptographically sign your service requests
\nRetry requests
\nHandle error responses
\n\n Additional information\n
\n\n Amazon SQS Developer Guide\n
\n\n Making API Requests\n
\n\n Amazon Web Services General Reference\n
\nWelcome to the Amazon SQS API Reference.
\nAmazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.
\nFor information on the permissions you need to use this API, see\n Identity and\n access management in the Amazon SQS Developer Guide.\n
\nYou can use Amazon Web Services SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:
\nCryptographically sign your service requests
\nRetry requests
\nHandle error responses
\n\n Additional information\n
\n\n Amazon SQS Developer Guide\n
\n\n Making API Requests\n
\n\n Amazon Web Services General Reference\n
\nA map of attributes with their corresponding values.
\nThe following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses:
\n DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.\n
\n MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).\n
\n MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days).\n
\n Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the Amazon IAM User Guide.\n
\n ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a \n ReceiveMessage\n action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.\n
\n VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see \n Visibility Timeout in the Amazon SQS Developer Guide.
The following attributes apply only to dead-letter queues:\n
\n\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
\n maxReceiveCount – The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount \n for a queue, Amazon SQS moves the message to the dead-letter-queue.
\n RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
\n redrivePermission – The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:
\n allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.
\n denyAll – No source queues can specify this queue as the dead-letter\n queue.
\n byQueue – Only queues specified by the sourceQueueArns parameter can specify \n this queue as the dead-letter queue.
\n sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter\n to allowAll.
The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.
\nThe following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.\n While the alias of the Amazon Web Services managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias\n .\n For more examples, see KeyId in the Key Management Service API Reference.\n
\n KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt \n or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security \n but results in more calls to KMS which might incur charges after Free Tier. For more information, see \n How Does the Data Key Reuse Period Work?.\n
The following attributes apply only to FIFO (first-in-first-out) queues:
\n\n FifoQueue – Designates a queue as FIFO. Valid values are true and false. If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. \n You can provide this attribute only during queue creation. You can't change it for an existing queue. \n When you set this attribute, you must also provide the MessageGroupId for your messages explicitly.
For more information, see \n FIFO queue logic \n in the Amazon SQS Developer Guide.
\n\n ContentBasedDeduplication – Enables content-based deduplication. Valid values are true and false. For more information, see Exactly-once processing in the \n Amazon SQS Developer Guide. Note the following:\n
Every message must have a unique MessageDeduplicationId.
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, \n Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,\n the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates \n and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same \n as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.\n
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\n\n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.
\n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", + "smithy.api#documentation": "A map of attributes with their corresponding values.
\nThe following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses:
\n DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.\n
\n MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).\n
\n MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days).\n
\n Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the Amazon IAM User Guide.\n
\n ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a \n ReceiveMessage\n action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.\n
\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues \n in the Amazon SQS Developer Guide.
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
\n maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue.\n When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
\n\n VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see \n Visibility Timeout in the Amazon SQS Developer Guide.
The following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.\n While the alias of the Amazon Web Services managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias\n .\n For more examples, see KeyId in the Key Management Service API Reference.\n
\n KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt \n or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security \n but results in more calls to KMS which might incur charges after Free Tier. For more information, see \n How Does the Data Key Reuse Period Work?.\n
\n SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).
The following attributes apply only to FIFO (first-in-first-out) queues:
\n\n FifoQueue – Designates a queue as FIFO. Valid values are true and false. If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. \n You can provide this attribute only during queue creation. You can't change it for an existing queue. \n When you set this attribute, you must also provide the MessageGroupId for your messages explicitly.
For more information, see \n FIFO queue logic \n in the Amazon SQS Developer Guide.
\n\n ContentBasedDeduplication – Enables content-based deduplication. Valid values are true and false. For more information, see Exactly-once processing in the \n Amazon SQS Developer Guide. Note the following:\n
Every message must have a unique MessageDeduplicationId.
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, \n Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,\n the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates \n and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same \n as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.\n
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\n\n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.
\n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Attribute" } @@ -743,7 +743,7 @@ "AttributeNames": { "target": "com.amazonaws.sqs#AttributeNameList", "traits": { - "smithy.api#documentation": "A list of attributes for which to retrieve information.
\nThe AttributeName.N parameter is optional, but if you don't specify values for this parameter,\n the request returns empty results.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
\nThe following attributes are supported:
\nThe ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, \n and ApproximateNumberOfMessagesVisible metrics may not achieve consistency\n until at least 1 minute after the producers stop sending messages. This period is required for \n the queue metadata to reach eventual consistency.
\n All – Returns all values.
\n ApproximateNumberOfMessages – Returns the approximate number of\n messages available for retrieval from the queue.
\n ApproximateNumberOfMessagesDelayed – Returns the approximate number\n of messages in the queue that are delayed and not available for reading\n immediately. This can happen when the queue is configured as a delay queue or\n when a message has been sent with a delay parameter.
\n ApproximateNumberOfMessagesNotVisible – Returns the approximate\n number of messages that are in flight. Messages are considered to be\n in flight if they have been sent to a client but have\n not yet been deleted or have not yet reached the end of their visibility window.
\n CreatedTimestamp – Returns the time when the queue was created in\n seconds (epoch\n time).
\n DelaySeconds – Returns the default delay on the queue in\n seconds.
\n LastModifiedTimestamp – Returns the time when the queue was last\n changed in seconds (epoch\n time).
\n MaximumMessageSize – Returns the limit of how many bytes a message\n can contain before Amazon SQS rejects it.
\n MessageRetentionPeriod – Returns the length of time, in seconds,\n for which Amazon SQS retains a message.
\n Policy – Returns the policy of the queue.
\n QueueArn – Returns the Amazon resource name (ARN) of the\n queue.
\n ReceiveMessageWaitTimeSeconds – Returns the length of time, in\n seconds, for which the ReceiveMessage action waits for a message to\n arrive.
\n VisibilityTimeout – Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.\n
The following attributes apply only to dead-letter queues:\n
\n\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
\n maxReceiveCount – The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount \n for a queue, Amazon SQS moves the message to the dead-letter-queue.
\n RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
\n redrivePermission – The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:
\n allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.
\n denyAll – No source queues can specify this queue as the dead-letter\n queue.
\n byQueue – Only queues specified by the sourceQueueArns parameter can specify \n this queue as the dead-letter queue.
\n sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter\n to allowAll.
The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.
\nThe following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – Returns the ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.\n
\n KmsDataKeyReusePeriodSeconds – Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again.\n For more information, see How Does the Data Key Reuse Period Work?.\n
The following attributes apply only to FIFO (first-in-first-out) queues:
\n\n FifoQueue – Returns information about whether the queue is FIFO. For more information, see FIFO queue logic in the Amazon SQS Developer Guide.
To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
\n ContentBasedDeduplication – Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.\n
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\n\n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.
\n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", + "smithy.api#documentation": "A list of attributes for which to retrieve information.
\nThe AttributeName.N parameter is optional, but if you don't specify values for this parameter,\n the request returns empty results.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
\nThe following attributes are supported:
\nThe ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, \n and ApproximateNumberOfMessagesVisible metrics may not achieve consistency\n until at least 1 minute after the producers stop sending messages. This period is required for \n the queue metadata to reach eventual consistency.
\n All – Returns all values.
\n ApproximateNumberOfMessages – Returns the approximate number of\n messages available for retrieval from the queue.
\n ApproximateNumberOfMessagesDelayed – Returns the approximate number\n of messages in the queue that are delayed and not available for reading\n immediately. This can happen when the queue is configured as a delay queue or\n when a message has been sent with a delay parameter.
\n ApproximateNumberOfMessagesNotVisible – Returns the approximate\n number of messages that are in flight. Messages are considered to be\n in flight if they have been sent to a client but have\n not yet been deleted or have not yet reached the end of their visibility window.
\n CreatedTimestamp – Returns the time when the queue was created in\n seconds (epoch\n time).
\n DelaySeconds – Returns the default delay on the queue in\n seconds.
\n LastModifiedTimestamp – Returns the time when the queue was last\n changed in seconds (epoch\n time).
\n MaximumMessageSize – Returns the limit of how many bytes a message\n can contain before Amazon SQS rejects it.
\n MessageRetentionPeriod – Returns the length of time, in seconds,\n for which Amazon SQS retains a message.
\n Policy – Returns the policy of the queue.
\n QueueArn – Returns the Amazon resource name (ARN) of the\n queue.
\n ReceiveMessageWaitTimeSeconds – Returns the length of time, in\n seconds, for which the ReceiveMessage action waits for a message to\n arrive.
\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues \n in the Amazon SQS Developer Guide.
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
\n maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue.\n When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
\n VisibilityTimeout – Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.\n
The following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – Returns the ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.\n
\n KmsDataKeyReusePeriodSeconds – Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again.\n For more information, see How Does the Data Key Reuse Period Work?.\n
\n SqsManagedSseEnabled – Returns information about whether the queue is using SSE-SQS encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).
The following attributes apply only to FIFO (first-in-first-out) queues:
\n\n FifoQueue – Returns information about whether the queue is FIFO. For more information, see FIFO queue logic in the Amazon SQS Developer Guide.
To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
\n ContentBasedDeduplication – Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.\n
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\n\n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.
\n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "AttributeName" } @@ -799,7 +799,7 @@ "QueueOwnerAWSAccountId": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "The account ID of the account that created the queue.
" + "smithy.api#documentation": "The Amazon Web Services account ID of the account that created the queue.
" } } }, @@ -1043,7 +1043,7 @@ "MessageId": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "A unique identifier for the message. A MessageIdis considered unique across all accounts for an extended period of time.
A unique identifier for the message. A MessageIdis considered unique across all Amazon Web Services accounts for an extended period of time.
A list of attributes that need to be returned along with each message. These attributes\n include:
\n\n All – Returns all values.
\n ApproximateFirstReceiveTimestamp – Returns the time the message was first received from the queue (epoch time in milliseconds).
\n ApproximateReceiveCount – Returns the number of times a message has been received across all queues but not deleted.
\n AWSTraceHeader – Returns the X-Ray trace header string.\n
\n SenderId\n
For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.
For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
\n SentTimestamp – Returns the time the message was sent to the queue (epoch time in milliseconds).
\n MessageDeduplicationId – Returns the value provided by the\n producer that calls the \n SendMessage\n \n action.
\n MessageGroupId – Returns the value provided by the producer that\n calls the \n SendMessage\n action. Messages with the\n same MessageGroupId are returned in sequence.
\n SequenceNumber – Returns the value provided by Amazon SQS.
A list of attributes that need to be returned along with each message. These attributes\n include:
\n\n All – Returns all values.
\n ApproximateFirstReceiveTimestamp – Returns the time the message was first received from the queue (epoch time in milliseconds).
\n ApproximateReceiveCount – Returns the number of times a message has been received across all queues but not deleted.
\n AWSTraceHeader – Returns the X-Ray trace header string.\n
\n SenderId\n
For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.
For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
\n SentTimestamp – Returns the time the message was sent to the queue (epoch time in milliseconds).
\n SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).
\n MessageDeduplicationId – Returns the value provided by the\n producer that calls the \n SendMessage\n \n action.
\n MessageGroupId – Returns the value provided by the producer that\n calls the \n SendMessage\n action. Messages with the\n same MessageGroupId are returned in sequence.
\n SequenceNumber – Returns the value provided by Amazon SQS.
A map of attributes to set.
\nThe following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses:
\n DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). Default: 0.\n
\n MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).\n
\n MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).\n
\n Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies \n in the Identity and Access Management User Guide.\n
\n ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a \n ReceiveMessage\n action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.\n
\n VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout,\n see Visibility Timeout in the Amazon SQS Developer Guide.
The following attributes apply only to dead-letter queues:\n
\n\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
\n maxReceiveCount – The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount \n for a queue, Amazon SQS moves the message to the dead-letter-queue.
\n RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
\n redrivePermission – The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:
\n allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.
\n denyAll – No source queues can specify this queue as the dead-letter\n queue.
\n byQueue – Only queues specified by the sourceQueueArns parameter can specify \n this queue as the dead-letter queue.
\n sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter\n to allowAll.
The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.
\nThe following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.\n While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias\n .\n For more examples, see KeyId in the Key Management Service API Reference.\n
\n KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt \n or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security \n but results in more calls to KMS which might incur charges after Free Tier. For more information, see \n How Does the Data Key Reuse Period Work?.\n
The following attribute applies only to FIFO (first-in-first-out) queues:
\n\n ContentBasedDeduplication – Enables content-based deduplication. For more information, see Exactly-once processing in the \n Amazon SQS Developer Guide. Note the following:\n
Every message must have a unique MessageDeduplicationId.
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, \n Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,\n the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates \n and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same \n as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.\n
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\n\n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.
\n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", + "smithy.api#documentation": "A map of attributes to set.
\nThe following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses:
\n DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). Default: 0.\n
\n MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).\n
\n MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).\n
\n Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies \n in the Identity and Access Management User Guide.\n
\n ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a \n ReceiveMessage\n action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.\n
\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues \n in the Amazon SQS Developer Guide.
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
\n maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue.\n When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
\n\n VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout,\n see Visibility Timeout in the Amazon SQS Developer Guide.
The following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.\n While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias\n .\n For more examples, see KeyId in the Key Management Service API Reference.\n
\n KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt \n or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security \n but results in more calls to KMS which might incur charges after Free Tier. For more information, see \n How Does the Data Key Reuse Period Work?.\n
\n SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).
The following attribute applies only to FIFO (first-in-first-out) queues:
\n\n ContentBasedDeduplication – Enables content-based deduplication. For more information, see Exactly-once processing in the \n Amazon SQS Developer Guide. Note the following:\n
Every message must have a unique MessageDeduplicationId.
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, \n Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,\n the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates \n and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same \n as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.\n
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\n\n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.
\n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Attribute" diff --git a/aws/sdk/aws-models/ssm.json b/aws/sdk/aws-models/ssm.json index 44f7bcf1e449c4f5552db270dbc80b04df3ffd16..8cca61e59e39c231a60ab2057fa57af0e15148cf 100644 --- a/aws/sdk/aws-models/ssm.json +++ b/aws/sdk/aws-models/ssm.json @@ -115,31 +115,31 @@ "DefaultInstanceName": { "target": "com.amazonaws.ssm#DefaultInstanceName", "traits": { - "smithy.api#documentation": "A name for the managed instance when it is created.
" + "smithy.api#documentation": "A name for the managed node when it is created.
" } }, "IamRole": { "target": "com.amazonaws.ssm#IamRole", "traits": { - "smithy.api#documentation": "The Identity and Access Management (IAM) role to assign to the managed\n instance.
" + "smithy.api#documentation": "The Identity and Access Management (IAM) role to assign to the managed\n node.
" } }, "RegistrationLimit": { "target": "com.amazonaws.ssm#RegistrationLimit", "traits": { - "smithy.api#documentation": "The maximum number of managed instances that can be registered using this activation.
" + "smithy.api#documentation": "The maximum number of managed nodes that can be registered using this activation.
" } }, "RegistrationsCount": { "target": "com.amazonaws.ssm#RegistrationsCount", "traits": { - "smithy.api#documentation": "The number of managed instances already registered with this activation.
" + "smithy.api#documentation": "The number of managed nodes already registered with this activation.
" } }, "ExpirationDate": { "target": "com.amazonaws.ssm#ExpirationDate", "traits": { - "smithy.api#documentation": "The date when this activation can no longer be used to register managed instances.
" + "smithy.api#documentation": "The date when this activation can no longer be used to register managed nodes.
" } }, "Expired": { @@ -162,7 +162,7 @@ } }, "traits": { - "smithy.api#documentation": "An activation registers one or more on-premises servers or virtual machines (VMs) with Amazon Web Services\n so that you can configure those servers or VMs using Run Command. A server or VM that has been\n registered with Amazon Web Services Systems Manager is called a managed instance.
" + "smithy.api#documentation": "An activation registers one or more on-premises servers or virtual machines (VMs) with Amazon Web Services\n so that you can configure those servers or VMs using Run Command. A server or VM that has been\n registered with Amazon Web Services Systems Manager is called a managed node.
" } }, "com.amazonaws.ssm#ActivationCode": { @@ -221,7 +221,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds or overwrites one or more tags for the specified resource. Tags are metadata that you\n can assign to your documents, managed instances, maintenance windows, Parameter Store parameters,\n and patch baselines. Tags enable you to categorize your resources in different ways, for example,\n by purpose, owner, or environment. Each tag consists of a key and an optional value, both of\n which you define. For example, you could define a set of tags for your account's managed\n instances that helps you track each instance's owner and stack level. For example:
\n\n Key=Owner,Value=DbAdmin\n
\n Key=Owner,Value=SysAdmin\n
\n Key=Owner,Value=Dev\n
\n Key=Stack,Value=Production\n
\n Key=Stack,Value=Pre-Production\n
\n Key=Stack,Value=Test\n
Each resource can have a maximum of 50 tags.
\nWe recommend that you devise a set of tag keys that meets your needs for each resource type.\n Using a consistent set of tag keys makes it easier for you to manage your resources. You can\n search and filter the resources based on the tags you add. Tags don't have any semantic meaning\n to and are interpreted strictly as a string of characters.
\nFor more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tagging your Amazon EC2\n resources in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Adds or overwrites one or more tags for the specified resource. Tags are metadata that you\n can assign to your documents, managed nodes, maintenance windows, Parameter Store parameters, and\n patch baselines. Tags enable you to categorize your resources in different ways, for example, by\n purpose, owner, or environment. Each tag consists of a key and an optional value, both of which\n you define. For example, you could define a set of tags for your account's managed nodes that\n helps you track each node's owner and stack level. For example:
\n\n Key=Owner,Value=DbAdmin\n
\n Key=Owner,Value=SysAdmin\n
\n Key=Owner,Value=Dev\n
\n Key=Stack,Value=Production\n
\n Key=Stack,Value=Pre-Production\n
\n Key=Stack,Value=Test\n
Each resource can have a maximum of 50 tags.
\nWe recommend that you devise a set of tag keys that meets your needs for each resource type.\n Using a consistent set of tag keys makes it easier for you to manage your resources. You can\n search and filter the resources based on the tags you add. Tags don't have any semantic meaning\n to and are interpreted strictly as a string of characters.
\nFor more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tagging your Amazon EC2\n resources in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ssm#AddTagsToResourceRequest": { @@ -230,14 +230,14 @@ "ResourceType": { "target": "com.amazonaws.ssm#ResourceTypeForTagging", "traits": { - "smithy.api#documentation": "Specifies the type of resource you are tagging.
\nThe ManagedInstance type for this API operation is for on-premises managed\n instances. You must specify the name of the managed instance in the following format:\n mi-ID_number\n . For example,\n mi-1a2b3c4d5e6f.
Specifies the type of resource you are tagging.
\nThe ManagedInstance type for this API operation is for on-premises managed\n nodes. You must specify the name of the managed node in the following format:\n mi-ID_number\n . For example,\n mi-1a2b3c4d5e6f.
The resource ID you want to tag.
\nUse the ID of the resource. Here are some examples:
\n\n MaintenanceWindow: mw-012345abcde\n
\n PatchBaseline: pb-012345abcde\n
\n OpsMetadata object: ResourceID for tagging is created from the\n Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from\n the strings that come after the word opsmetadata in the ARN. For example, an\n OpsMetadata object with an ARN of\n arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a\n ResourceID of either aws/ssm/MyGroup/appmanager or\n /aws/ssm/MyGroup/appmanager.
For the Document and Parameter values, use the name of the\n resource.
\n ManagedInstance: mi-012345abcde\n
The ManagedInstance type for this API operation is only for on-premises\n managed instances. You must specify the name of the managed instance in the following format:\n mi-ID_number\n . For example,\n mi-1a2b3c4d5e6f.
The resource ID you want to tag.
\nUse the ID of the resource. Here are some examples:
\n\n MaintenanceWindow: mw-012345abcde\n
\n PatchBaseline: pb-012345abcde\n
\n OpsMetadata object: ResourceID for tagging is created from the\n Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from\n the strings that come after the word opsmetadata in the ARN. For example, an\n OpsMetadata object with an ARN of\n arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a\n ResourceID of either aws/ssm/MyGroup/appmanager or\n /aws/ssm/MyGroup/appmanager.
For the Document and Parameter values, use the name of the\n resource.
\n ManagedInstance: mi-012345abcde\n
The ManagedInstance type for this API operation is only for on-premises\n managed nodes. You must specify the name of the managed node in the following format:\n mi-ID_number\n . For example,\n mi-1a2b3c4d5e6f.
Amazon Web Services Systems Manager is a collection of capabilities that helps you automate management tasks such as\n collecting system inventory, applying operating system (OS) patches, automating the creation of\n Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale.\n Systems Manager lets you remotely and securely manage the configuration of your managed instances. A\n managed instance is any Amazon Elastic Compute Cloud instance (EC2 instance), or any\n on-premises server or virtual machine (VM) in your hybrid environment that has been configured\n for Systems Manager.
\nThis reference is intended to be used with the Amazon Web Services Systems Manager User Guide.
\nTo get started, verify prerequisites and configure managed instances. For more information,\n see Setting up\n Amazon Web Services Systems Manager in the Amazon Web Services Systems Manager User Guide.
\n\n Related resources\n
\nFor information about how to use a Query API, see Making API requests.
\nFor information about other API operations you can perform on EC2 instances, see the\n Amazon EC2 API Reference.
\nFor information about AppConfig, a capability of Systems Manager, see the AppConfig User Guide and the AppConfig API\n Reference.
\nFor information about Incident Manager, a capability of Systems Manager, see the Incident Manager User Guide\n and the Incident Manager API\n Reference.
\nAmazon Web Services Systems Manager is a collection of capabilities that helps you automate management tasks such as\n collecting system inventory, applying operating system (OS) patches, automating the creation of\n Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale.\n Systems Manager lets you remotely and securely manage the configuration of your managed nodes. A\n managed node is any Amazon Elastic Compute Cloud (Amazon EC2) instance, edge\n device, or on-premises server or virtual machine (VM) that has been configured for\n Systems Manager.
\nWith support for IoT Greengrass Version 2 devices, the phrase managed\n instance has been changed to managed node in most of the Systems Manager\n documentation. The Systems Manager console, API\n calls, error messages, and SSM documents still use the term instance.
\nThis reference is intended to be used with the Amazon Web Services Systems Manager User Guide.
\nTo get started, verify prerequisites and configure managed nodes. For more information, see\n Setting up\n Amazon Web Services Systems Manager in the Amazon Web Services Systems Manager User Guide.
\n\n Related resources\n
\nFor information about how to use a Query API, see Making API requests.
\nFor information about other API operations you can perform on EC2 instances, see the\n Amazon EC2 API Reference.
\nFor information about AppConfig, a capability of Systems Manager, see the AppConfig User Guide and the AppConfig API\n Reference.
\nFor information about Incident Manager, a capability of Systems Manager, see the Incident Manager User Guide\n and the Incident Manager API\n Reference.
\nYou must disassociate a document from all instances before you can delete it.
", + "smithy.api#documentation": "You must disassociate a document from all managed nodes before you can delete it.
", "smithy.api#error": "client" } }, @@ -829,7 +829,7 @@ "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "The instance ID.
" + "smithy.api#documentation": "The managed node ID.
" } }, "AssociationId": { @@ -853,7 +853,7 @@ "Targets": { "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "The instances targeted by the request to create an association. You can target all instances\n in an Amazon Web Services account by specifying the InstanceIds key with a value of\n *.
The managed nodes targeted by the request to create an association. You can target all\n managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of\n *.
Describes an association of a Amazon Web Services Systems Manager document (SSM document) and an instance.
" + "smithy.api#documentation": "Describes an association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.
" } }, "com.amazonaws.ssm#AssociationAlreadyExists": { @@ -936,7 +936,7 @@ "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "The instance ID.
" + "smithy.api#documentation": "The managed node ID.
" } }, "AssociationVersion": { @@ -996,7 +996,7 @@ "Targets": { "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "The instances targeted by the request.
" + "smithy.api#documentation": "The managed nodes targeted by the request.
" } }, "ScheduleExpression": { @@ -1032,13 +1032,13 @@ "MaxErrors": { "target": "com.amazonaws.ssm#MaxErrors", "traits": { - "smithy.api#documentation": "The number of errors that are allowed before the system stops sending requests to run the\n association on additional targets. You can specify either an absolute number of errors, for\n example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,\n the system stops sending requests when the fourth error is received. If you specify 0, then the\n system stops sending requests after the first error is returned. If you run an association on 50\n instances and set MaxError to 10%, then the system stops sending the request when\n the sixth error is received.
Executions that are already running an association when MaxErrors is reached\n are allowed to complete, but some of these executions may fail as well. If you need to ensure\n that there won't be more than max-errors failed executions, set MaxConcurrency to 1\n so that executions proceed one at a time.
The number of errors that are allowed before the system stops sending requests to run the\n association on additional targets. You can specify either an absolute number of errors, for\n example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,\n the system stops sending requests when the fourth error is received. If you specify 0, then the\n system stops sending requests after the first error is returned. If you run an association on 50\n managed nodes and set MaxError to 10%, then the system stops sending the request\n when the sixth error is received.
Executions that are already running an association when MaxErrors is reached\n are allowed to complete, but some of these executions may fail as well. If you need to ensure\n that there won't be more than max-errors failed executions, set MaxConcurrency to 1\n so that executions proceed one at a time.
The maximum number of targets allowed to run the association at the same time. You can\n specify a number, for example 10, or a percentage of the target set, for example 10%. The default\n value is 100%, which means all targets run the association at the same time.
\nIf a new instance starts and attempts to run an association while Systems Manager is running\n MaxConcurrency associations, the association is allowed to run. During the next\n association interval, the new instance will process its association within the limit specified\n for MaxConcurrency.
The maximum number of targets allowed to run the association at the same time. You can\n specify a number, for example 10, or a percentage of the target set, for example 10%. The default\n value is 100%, which means all targets run the association at the same time.
\nIf a new managed node starts and attempts to run an association while Systems Manager is running\n MaxConcurrency associations, the association is allowed to run. During the next\n association interval, the new managed node will process its association within the limit specified\n for MaxConcurrency.
The resource ID, for example, the instance ID where the association ran.
" + "smithy.api#documentation": "The resource ID, for example, the managed node ID where the association ran.
" } }, "ResourceType": { "target": "com.amazonaws.ssm#AssociationResourceType", "traits": { - "smithy.api#documentation": "The resource type, for example, instance.
" + "smithy.api#documentation": "The resource type, for example, EC2.
" } }, "Status": { @@ -1557,7 +1557,7 @@ "AssociationStatusAggregatedCount": { "target": "com.amazonaws.ssm#AssociationStatusAggregatedCount", "traits": { - "smithy.api#documentation": "Returns the number of targets for the association status. For example, if you created an\n association with two instances, and one of them was successful, this would return the count of\n instances by status.
" + "smithy.api#documentation": "Returns the number of targets for the association status. For example, if you created an\n association with two managed nodes, and one of them was successful, this would return the count\n of managed nodes by status.
" } } }, @@ -1733,13 +1733,13 @@ "MaxErrors": { "target": "com.amazonaws.ssm#MaxErrors", "traits": { - "smithy.api#documentation": "The number of errors that are allowed before the system stops sending requests to run the\n association on additional targets. You can specify either an absolute number of errors, for\n example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,\n the system stops sending requests when the fourth error is received. If you specify 0, then the\n system stops sending requests after the first error is returned. If you run an association on 50\n instances and set MaxError to 10%, then the system stops sending the request when\n the sixth error is received.
Executions that are already running an association when MaxErrors is reached\n are allowed to complete, but some of these executions may fail as well. If you need to ensure\n that there won't be more than max-errors failed executions, set MaxConcurrency to 1\n so that executions proceed one at a time.
The number of errors that are allowed before the system stops sending requests to run the\n association on additional targets. You can specify either an absolute number of errors, for\n example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,\n the system stops sending requests when the fourth error is received. If you specify 0, then the\n system stops sending requests after the first error is returned. If you run an association on 50\n managed nodes and set MaxError to 10%, then the system stops sending the request\n when the sixth error is received.
Executions that are already running an association when MaxErrors is reached\n are allowed to complete, but some of these executions may fail as well. If you need to ensure\n that there won't be more than max-errors failed executions, set MaxConcurrency to 1\n so that executions proceed one at a time.
The maximum number of targets allowed to run the association at the same time. You can\n specify a number, for example 10, or a percentage of the target set, for example 10%. The default\n value is 100%, which means all targets run the association at the same time.
\nIf a new instance starts and attempts to run an association while Systems Manager is running\n MaxConcurrency associations, the association is allowed to run. During the next\n association interval, the new instance will process its association within the limit specified\n for MaxConcurrency.
The maximum number of targets allowed to run the association at the same time. You can\n specify a number, for example 10, or a percentage of the target set, for example 10%. The default\n value is 100%, which means all targets run the association at the same time.
\nIf a new managed node starts and attempts to run an association while Systems Manager is running\n MaxConcurrency associations, the association is allowed to run. During the next\n association interval, the new managed node will process its association within the limit specified\n for MaxConcurrency.
Indicates whether the list of approved patches includes non-security updates that should be\n applied to the instances. The default value is false. Applies to Linux instances\n only.
Indicates whether the list of approved patches includes non-security updates that should be\n applied to the managed nodes. The default value is false. Applies to Linux managed\n nodes only.
Information about the patches to use to update the instances, including target operating\n systems and source repositories. Applies to Linux instances only.
" + "smithy.api#documentation": "Information about the patches to use to update the managed nodes, including target operating\n systems and source repositories. Applies to Linux managed nodes only.
" } } }, @@ -2915,7 +2915,7 @@ "InstanceIds": { "target": "com.amazonaws.ssm#InstanceIdList", "traits": { - "smithy.api#documentation": "(Optional) A list of instance IDs on which you want to cancel the command. If not provided,\n the command is canceled on every instance on which it was requested.
" + "smithy.api#documentation": "(Optional) A list of managed node IDs on which you want to cancel the command. If not provided,\n the command is canceled on every node on which it was requested.
" } } }, @@ -3074,13 +3074,13 @@ "InstanceIds": { "target": "com.amazonaws.ssm#InstanceIdList", "traits": { - "smithy.api#documentation": "The instance IDs against which this command was requested.
" + "smithy.api#documentation": "The managed node IDs against which this command was requested.
" } }, "Targets": { "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "An array of search criteria that targets instances using a Key,Value combination that you\n specify. Targets is required if you don't provide one or more instance IDs in the call.
" + "smithy.api#documentation": "An array of search criteria that targets managed nodes using a Key,Value combination that\n you specify. Targets is required if you don't provide one or more managed node IDs in the\n call.
" } }, "RequestedDateTime": { @@ -3098,7 +3098,7 @@ "StatusDetails": { "target": "com.amazonaws.ssm#StatusDetails", "traits": { - "smithy.api#documentation": "A detailed status of the command execution. StatusDetails includes more\n information than Status because it includes states resulting from error and\n concurrency control parameters. StatusDetails can show different results than\n Status. For more information about these statuses, see Understanding command\n statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the\n following values:
Pending: The command hasn't been sent to any instances.
\nIn Progress: The command has been sent to at least one instance but hasn't reached a final\n state on all instances.
\nSuccess: The command successfully ran on all invocations. This is a terminal state.
\nDelivery Timed Out: The value of MaxErrors or more command invocations shows a status of\n Delivery Timed Out. This is a terminal state.
\nExecution Timed Out: The value of MaxErrors or more command invocations shows a status of\n Execution Timed Out. This is a terminal state.
\nFailed: The value of MaxErrors or more command invocations shows a status of Failed. This\n is a terminal state.
\nIncomplete: The command was attempted on all instances and one or more invocations doesn't\n have a value of Success but not enough invocations failed for the status to be Failed. This is\n a terminal state.
\nCanceled: The command was terminated before it was completed. This is a terminal\n state.
\nRate Exceeded: The number of instances targeted by the command exceeded the account limit\n for pending invocations. The system has canceled the command before running it on any instance.\n This is a terminal state.
\nA detailed status of the command execution. StatusDetails includes more\n information than Status because it includes states resulting from error and\n concurrency control parameters. StatusDetails can show different results than\n Status. For more information about these statuses, see Understanding command\n statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the\n following values:
Pending: The command hasn't been sent to any managed nodes.
\nIn Progress: The command has been sent to at least one managed node but hasn't reached a final\n state on all managed nodes.
\nSuccess: The command successfully ran on all invocations. This is a terminal state.
\nDelivery Timed Out: The value of MaxErrors or more command invocations shows a status of\n Delivery Timed Out. This is a terminal state.
\nExecution Timed Out: The value of MaxErrors or more command invocations shows a status of\n Execution Timed Out. This is a terminal state.
\nFailed: The value of MaxErrors or more command invocations shows a status of Failed. This\n is a terminal state.
\nIncomplete: The command was attempted on all managed nodes and one or more invocations\n doesn't have a value of Success but not enough invocations failed for the status to be Failed.\n This is a terminal state.
\nCanceled: The command was terminated before it was completed. This is a terminal\n state.
\nRate Exceeded: The number of managed nodes targeted by the command exceeded the account\n limit for pending invocations. The system has canceled the command before running it on any\n managed node. This is a terminal state.
\nThe maximum number of instances that are allowed to run the command at the same time. You\n can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The\n default value is 50. For more information about how to use MaxConcurrency, see\n Running\n commands using Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
The maximum number of managed nodes that are allowed to run the command at the same time.\n You can specify a number of managed nodes, such as 10, or a percentage of nodes, such as 10%. The\n default value is 50. For more information about how to use MaxConcurrency, see\n Running\n commands using Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
The name of the filter.
", + "smithy.api#documentation": "The name of the filter.
\nThe ExecutionStage filter can't be used with the\n ListCommandInvocations operation, only with ListCommands.
The filter value. Valid values for each filter key are as follows:
\n\n InvokedAfter: Specify a timestamp to limit your results.\n For example, specify 2021-07-07T00:00:00Z to see a list of command executions\n occurring July 7, 2021, and later.
\n InvokedBefore: Specify a timestamp to limit your results.\n For example, specify 2021-07-07T00:00:00Z to see a list of command executions from\n before July 7, 2021.
\n Status: Specify a valid command status to see a list of\n all command executions with that status. The status choices depend on the API you call.
\nThe status values you can specify for ListCommands are:
\n Pending\n
\n InProgress\n
\n Success\n
\n Cancelled\n
\n Failed\n
\n TimedOut (this includes both Delivery and Execution time outs)
\n AccessDenied\n
\n DeliveryTimedOut\n
\n ExecutionTimedOut\n
\n Incomplete\n
\n NoInstancesInTag\n
\n LimitExceeded\n
The status values you can specify for ListCommandInvocations are:
\n Pending\n
\n InProgress\n
\n Delayed\n
\n Success\n
\n Cancelled\n
\n Failed\n
\n TimedOut (this includes both Delivery and Execution time outs)
\n AccessDenied\n
\n DeliveryTimedOut\n
\n ExecutionTimedOut\n
\n Undeliverable\n
\n InvalidPlatform\n
\n Terminated\n
\n DocumentName: Specify name of the Amazon Web Services Systems Manager document (SSM\n document) for which you want to see command execution results. For example, specify\n AWS-RunPatchBaseline to see command executions that used this SSM document to\n perform security patching operations on instances.
\n ExecutionStage: Specify one of the following\n values:
\n\n Executing: Returns a list of command executions that are currently still\n running.
\n Complete: Returns a list of command executions that have already completed.\n
The filter value. Valid values for each filter key are as follows:
\n\n InvokedAfter: Specify a timestamp to limit your results.\n For example, specify 2021-07-07T00:00:00Z to see a list of command executions\n occurring July 7, 2021, and later.
\n InvokedBefore: Specify a timestamp to limit your results.\n For example, specify 2021-07-07T00:00:00Z to see a list of command executions from\n before July 7, 2021.
\n Status: Specify a valid command status to see a list of\n all command executions with that status. The status choices depend on the API you call.
\nThe status values you can specify for ListCommands are:
\n Pending\n
\n InProgress\n
\n Success\n
\n Cancelled\n
\n Failed\n
\n TimedOut (this includes both Delivery and Execution time outs)
\n AccessDenied\n
\n DeliveryTimedOut\n
\n ExecutionTimedOut\n
\n Incomplete\n
\n NoInstancesInTag\n
\n LimitExceeded\n
The status values you can specify for ListCommandInvocations are:
\n Pending\n
\n InProgress\n
\n Delayed\n
\n Success\n
\n Cancelled\n
\n Failed\n
\n TimedOut (this includes both Delivery and Execution time outs)
\n AccessDenied\n
\n DeliveryTimedOut\n
\n ExecutionTimedOut\n
\n Undeliverable\n
\n InvalidPlatform\n
\n Terminated\n
\n DocumentName: Specify name of the Amazon Web Services Systems Manager document (SSM\n document) for which you want to see command execution results. For example, specify\n AWS-RunPatchBaseline to see command executions that used this SSM document to\n perform security patching operations on managed nodes.
\n ExecutionStage: Specify one of the following values\n (ListCommands operations only):
\n Executing: Returns a list of command executions that are currently still\n running.
\n Complete: Returns a list of command executions that have already completed.\n
Describes a command filter.
\nAn instance ID can't be specified when a command status is Pending because the\n command hasn't run on the instance yet.
Describes a command filter.
\nA managed node ID can't be specified when a command status is Pending because the\n command hasn't run on the node yet.
The instance ID in which this invocation was requested.
" + "smithy.api#documentation": "The managed node ID in which this invocation was requested.
" } }, "InstanceName": { "target": "com.amazonaws.ssm#InstanceTagName", "traits": { - "smithy.api#documentation": "The fully qualified host name of the managed instance.
" + "smithy.api#documentation": "The fully qualified host name of the managed node.
" } }, "Comment": { @@ -3305,7 +3305,7 @@ "RequestedDateTime": { "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "The time and date the request was sent to this instance.
" + "smithy.api#documentation": "The time and date the request was sent to this managed node.
" } }, "Status": { @@ -3317,7 +3317,7 @@ "StatusDetails": { "target": "com.amazonaws.ssm#StatusDetails", "traits": { - "smithy.api#documentation": "A detailed status of the command execution for each invocation (each instance targeted by\n the command). StatusDetails includes more information than Status because it includes states\n resulting from error and concurrency control parameters. StatusDetails can show different results\n than Status. For more information about these statuses, see Understanding command\n statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the\n following values:
\nPending: The command hasn't been sent to the instance.
\nIn Progress: The command has been sent to the instance but hasn't reached a terminal\n state.
\nSuccess: The execution of the command or plugin was successfully completed. This is a\n terminal state.
\nDelivery Timed Out: The command wasn't delivered to the instance before the delivery\n timeout expired. Delivery timeouts don't count against the parent command's\n MaxErrors limit, but they do contribute to whether the parent command status is\n Success or Incomplete. This is a terminal state.
Execution Timed Out: Command execution started on the instance, but the execution wasn't\n complete before the execution timeout expired. Execution timeouts count against the\n MaxErrors limit of the parent command. This is a terminal state.
Failed: The command wasn't successful on the instance. For a plugin, this indicates that\n the result code wasn't zero. For a command invocation, this indicates that the result code for\n one or more plugins wasn't zero. Invocation failures count against the MaxErrors\n limit of the parent command. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal\n state.
\nUndeliverable: The command can't be delivered to the instance. The instance might not\n exist or might not be responding. Undeliverable invocations don't count against the parent\n command's MaxErrors limit and don't contribute to whether the parent command status is Success\n or Incomplete. This is a terminal state.
\nTerminated: The parent command exceeded its MaxErrors limit and subsequent command\n invocations were canceled by the system. This is a terminal state.
\nA detailed status of the command execution for each invocation (each managed node targeted by\n the command). StatusDetails includes more information than Status because it includes states\n resulting from error and concurrency control parameters. StatusDetails can show different results\n than Status. For more information about these statuses, see Understanding command\n statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the\n following values:
\nPending: The command hasn't been sent to the managed node.
\nIn Progress: The command has been sent to the managed node but hasn't reached a terminal\n state.
\nSuccess: The execution of the command or plugin was successfully completed. This is a\n terminal state.
\nDelivery Timed Out: The command wasn't delivered to the managed node before the delivery\n timeout expired. Delivery timeouts don't count against the parent command's\n MaxErrors limit, but they do contribute to whether the parent command status is\n Success or Incomplete. This is a terminal state.
Execution Timed Out: Command execution started on the managed node, but the execution wasn't\n complete before the execution timeout expired. Execution timeouts count against the\n MaxErrors limit of the parent command. This is a terminal state.
Failed: The command wasn't successful on the managed node. For a plugin, this indicates that\n the result code wasn't zero. For a command invocation, this indicates that the result code for\n one or more plugins wasn't zero. Invocation failures count against the MaxErrors\n limit of the parent command. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal\n state.
\nUndeliverable: The command can't be delivered to the managed node. The managed node might not\n exist or might not be responding. Undeliverable invocations don't count against the parent\n command's MaxErrors limit and don't contribute to whether the parent command status is Success\n or Incomplete. This is a terminal state.
\nTerminated: The parent command exceeded its MaxErrors limit and subsequent command\n invocations were canceled by the system. This is a terminal state.
\nThe Identity and Access Management (IAM) service role that Run Command, a capability\n of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes\n on a per instance basis.
" + "smithy.api#documentation": "The Identity and Access Management (IAM) service role that Run Command, a capability\n of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes\n on a per managed node basis.
" } }, "NotificationConfig": { "target": "com.amazonaws.ssm#NotificationConfig", "traits": { - "smithy.api#documentation": "Configurations for sending notifications about command status changes on a per instance\n basis.
" + "smithy.api#documentation": "Configurations for sending notifications about command status changes on a per managed node\n basis.
" } }, "CloudWatchOutputConfig": { @@ -3364,7 +3364,7 @@ } }, "traits": { - "smithy.api#documentation": "An invocation is copy of a command sent to a specific instance. A command can apply to one\n or more instances. A command invocation applies to one instance. For example, if a user runs\n SendCommand against three instances, then a command invocation is created for each requested\n instance ID. A command invocation returns status and detail information about a command you ran.\n
" + "smithy.api#documentation": "An invocation is a copy of a command sent to a specific managed node. A command can apply to one\n or more managed nodes. A command invocation applies to one managed node. For example, if a user runs\n SendCommand against three managed nodes, then a command invocation is created for\n each requested managed node ID. A command invocation returns status and detail information about a\n command you ran.
A detailed status of the plugin execution. StatusDetails includes more\n information than Status because it includes states resulting from error and concurrency control\n parameters. StatusDetails can show different results than Status. For more information about\n these statuses, see Understanding command\n statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the\n following values:
Pending: The command hasn't been sent to the instance.
\nIn Progress: The command has been sent to the instance but hasn't reached a terminal\n state.
\nSuccess: The execution of the command or plugin was successfully completed. This is a\n terminal state.
\nDelivery Timed Out: The command wasn't delivered to the instance before the delivery\n timeout expired. Delivery timeouts don't count against the parent command's\n MaxErrors limit, but they do contribute to whether the parent command status is\n Success or Incomplete. This is a terminal state.
Execution Timed Out: Command execution started on the instance, but the execution wasn't\n complete before the execution timeout expired. Execution timeouts count against the\n MaxErrors limit of the parent command. This is a terminal state.
Failed: The command wasn't successful on the instance. For a plugin, this indicates that\n the result code wasn't zero. For a command invocation, this indicates that the result code for\n one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of the\n parent command. This is a terminal state.
\nCanceled: The command was terminated before it was completed. This is a terminal\n state.
\nUndeliverable: The command can't be delivered to the instance. The instance might not\n exist, or it might not be responding. Undeliverable invocations don't count against the parent\n command's MaxErrors limit, and they don't contribute to whether the parent command status is\n Success or Incomplete. This is a terminal state.
\nTerminated: The parent command exceeded its MaxErrors limit and subsequent command\n invocations were canceled by the system. This is a terminal state.
\nA detailed status of the plugin execution. StatusDetails includes more\n information than Status because it includes states resulting from error and concurrency control\n parameters. StatusDetails can show different results than Status. For more information about\n these statuses, see Understanding command\n statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the\n following values:
Pending: The command hasn't been sent to the managed node.
\nIn Progress: The command has been sent to the managed node but hasn't reached a terminal\n state.
\nSuccess: The execution of the command or plugin was successfully completed. This is a\n terminal state.
\nDelivery Timed Out: The command wasn't delivered to the managed node before the delivery\n timeout expired. Delivery timeouts don't count against the parent command's\n MaxErrors limit, but they do contribute to whether the parent command status is\n Success or Incomplete. This is a terminal state.
Execution Timed Out: Command execution started on the managed node, but the execution wasn't\n complete before the execution timeout expired. Execution timeouts count against the\n MaxErrors limit of the parent command. This is a terminal state.
Failed: The command wasn't successful on the managed node. For a plugin, this indicates that\n the result code wasn't zero. For a command invocation, this indicates that the result code for\n one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of the\n parent command. This is a terminal state.
\nCanceled: The command was terminated before it was completed. This is a terminal\n state.
\nUndeliverable: The command can't be delivered to the managed node. The managed node might not\n exist, or it might not be responding. Undeliverable invocations don't count against the parent\n command's MaxErrors limit, and they don't contribute to whether the parent command status is\n Success or Incomplete. This is a terminal state.
\nTerminated: The parent command exceeded its MaxErrors limit and subsequent command\n invocations were canceled by the system. This is a terminal state.
\nThe S3 bucket where the responses to the command executions should be stored. This was\n requested when issuing the command. For example, in the following response:
\n\n doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript\n
\n doc-example-bucket is the name of the S3 bucket;
\n ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;
\n i-02573cafcfEXAMPLE is the instance ID;
\n awsrunShellScript is the name of the plugin.
The S3 bucket where the responses to the command executions should be stored. This was\n requested when issuing the command. For example, in the following response:
\n\n doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript\n
\n doc-example-bucket is the name of the S3 bucket;
\n ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;
\n i-02573cafcfEXAMPLE is the managed node ID;
\n awsrunShellScript is the name of the plugin.
The S3 directory path inside the bucket where the responses to the command executions should\n be stored. This was requested when issuing the command. For example, in the following\n response:
\n\n doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript\n
\n doc-example-bucket is the name of the S3 bucket;
\n ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;
\n i-02573cafcfEXAMPLE is the instance ID;
\n awsrunShellScript is the name of the plugin.
The S3 directory path inside the bucket where the responses to the command executions should\n be stored. This was requested when issuing the command. For example, in the following\n response:
\n\n doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript\n
\n doc-example-bucket is the name of the S3 bucket;
\n ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;
\n i-02573cafcfEXAMPLE is the managed node ID;
\n awsrunShellScript is the name of the plugin.
An ID for the resource. For a managed instance, this is the instance ID.
" + "smithy.api#documentation": "An ID for the resource. For a managed node, this is the node ID.
" } }, "Id": { @@ -4118,10 +4118,13 @@ "errors": [ { "target": "com.amazonaws.ssm#InternalServerError" + }, + { + "target": "com.amazonaws.ssm#InvalidParameters" } ], "traits": { - "smithy.api#documentation": "Generates an activation code and activation ID you can use to register your on-premises\n server or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with Systems Manager makes it\n possible to manage them using Systems Manager capabilities. You use the activation code and ID when\n installing SSM Agent on machines in your hybrid environment. For more information about\n requirements for managing on-premises instances and VMs using Systems Manager, see Setting up\n Amazon Web Services Systems Manager for hybrid environments in the Amazon Web Services Systems Manager User Guide.
\nOn-premises servers or VMs that are registered with Systems Manager and Amazon Elastic Compute Cloud (Amazon EC2) instances\n that you manage with Systems Manager are all called managed instances.
\nGenerates an activation code and activation ID you can use to register your on-premises\n servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with\n Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and\n ID when installing SSM Agent on machines in your hybrid environment. For more information about\n requirements for managing on-premises machines using Systems Manager, see Setting up\n Amazon Web Services Systems Manager for hybrid environments in the Amazon Web Services Systems Manager User Guide.
\nAmazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed\n nodes.
\nThe name of the registered, managed instance as it will appear in the Amazon Web Services Systems Manager console or\n when you use the Amazon Web Services command line tools to list Systems Manager resources.
\nDon't enter personally identifiable information in this field.
\nThe name of the registered, managed node as it will appear in the Amazon Web Services Systems Manager console or when\n you use the Amazon Web Services command line tools to list Systems Manager resources.
\nDon't enter personally identifiable information in this field.
\nThe name of the Identity and Access Management (IAM) role that you want to assign to\n the managed instance. This IAM role must provide AssumeRole permissions for the\n Amazon Web Services Systems Manager service principal ssm.amazonaws.com. For more information, see Create an\n IAM service role for a hybrid environment in the\n Amazon Web Services Systems Manager User Guide.
The name of the Identity and Access Management (IAM) role that you want to assign to\n the managed node. This IAM role must provide AssumeRole permissions for the\n Amazon Web Services Systems Manager service principal ssm.amazonaws.com. For more information, see Create an\n IAM service role for a hybrid environment in the\n Amazon Web Services Systems Manager User Guide.
Specify the maximum number of managed instances you want to register. The default value is\n 1.
Specify the maximum number of managed nodes you want to register. The default value is\n 1.
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in\n different ways, such as by purpose, owner, or environment. For example, you might want to tag an\n activation to identify which servers or virtual machines (VMs) in your on-premises environment\n you intend to activate. In this case, you could specify the following key-value pairs:
\n\n Key=OS,Value=Windows\n
\n Key=Environment,Value=Production\n
When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID\n and code. When you specify the activation ID and code, tags assigned to the activation are\n automatically applied to the on-premises servers or VMs.
\nYou can't add tags to or delete tags from an existing activation. You can tag your\n on-premises servers and VMs after they connect to Systems Manager for the first time and are assigned a\n managed instance ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is\n prefixed with \"mi-\". For information about how to add tags to your managed instances, see AddTagsToResource. For information about how to remove tags from your managed\n instances, see RemoveTagsFromResource.
" + "smithy.api#documentation": "Optional metadata that you assign to a resource. Tags enable you to categorize a resource in\n different ways, such as by purpose, owner, or environment. For example, you might want to tag an\n activation to identify which servers or virtual machines (VMs) in your on-premises environment\n you intend to activate. In this case, you could specify the following key-value pairs:
\n\n Key=OS,Value=Windows\n
\n Key=Environment,Value=Production\n
When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID\n and code. When you specify the activation ID and code, tags assigned to the activation are\n automatically applied to the on-premises servers or VMs.
\nYou can't add tags to or delete tags from an existing activation. You can tag your\n on-premises servers, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a\n managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is\n prefixed with \"mi-\". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes,\n see RemoveTagsFromResource.
" + } + }, + "RegistrationMetadata": { + "target": "com.amazonaws.ssm#RegistrationMetadataList", + "traits": { + "smithy.api#documentation": "Reserved for internal use.
" } } } @@ -4228,7 +4237,7 @@ } ], "traits": { - "smithy.api#documentation": "A State Manager association defines the state that you want to maintain on your instances.\n For example, an association can specify that anti-virus software must be installed and running on\n your instances, or that certain ports must be closed. For static targets, the association\n specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an\n Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager\n applies the configuration when new instances are added to the group. The association also\n specifies actions to take when applying the configuration. For example, an association for\n anti-virus software might run once a day. If the software isn't installed, then State Manager\n installs it. If the software is installed, but the service isn't running, then the association\n might instruct State Manager to start the service.
" + "smithy.api#documentation": "A State Manager association defines the state that you want to maintain on your managed\n nodes. For example, an association can specify that anti-virus software must be installed and\n running on your managed nodes, or that certain ports must be closed. For static targets, the\n association specifies a schedule for when the configuration is reapplied. For dynamic targets,\n such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of\n Amazon Web Services Systems Manager applies the configuration when new managed nodes are added to the group. The\n association also specifies actions to take when applying the configuration. For example, an\n association for anti-virus software might run once a day. If the software isn't installed, then\n State Manager installs it. If the software is installed, but the service isn't running, then the\n association might instruct State Manager to start the service.
" } }, "com.amazonaws.ssm#CreateAssociationBatch": { @@ -4275,7 +4284,7 @@ } ], "traits": { - "smithy.api#documentation": "Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified instances or\n targets.
\nWhen you associate a document with one or more instances using instance IDs or tags,\n Amazon Web Services Systems Manager Agent (SSM Agent) running on the instance processes the document and configures the\n instance as specified.
\nIf you associate a document with an instance that already has an associated document, the\n system returns the AssociationAlreadyExists exception.
" + "smithy.api#documentation": "Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes\n or targets.
\nWhen you associate a document with one or more managed nodes using IDs or tags,\n Amazon Web Services Systems Manager Agent (SSM Agent) running on the managed node processes the document and configures the\n node as specified.
\nIf you associate a document with a managed node that already has an associated document, the\n system returns the AssociationAlreadyExists exception.
" } }, "com.amazonaws.ssm#CreateAssociationBatchRequest": { @@ -4310,14 +4319,14 @@ "Name": { "target": "com.amazonaws.ssm#DocumentARN", "traits": { - "smithy.api#documentation": "The name of the SSM document that contains the configuration information for the instance.\n You can specify Command or Automation runbooks.
\nYou can specify Amazon Web Services-predefined documents, documents you created, or a document that is\n shared with you from another account.
\nFor SSM documents that are shared with you from other Amazon Web Services accounts, you must specify the\n complete SSM document ARN, in the following format:
\n\n arn:aws:ssm:region:account-id:document/document-name\n \n
For example:
\n\n arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document\n
For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need\n to specify the document name. For example, AWS-ApplyPatchBaseline or\n My-Document.
The name of the SSM document that contains the configuration information for the managed node.\n You can specify Command or Automation runbooks.
\nYou can specify Amazon Web Services-predefined documents, documents you created, or a document that is\n shared with you from another account.
\nFor SSM documents that are shared with you from other Amazon Web Services accounts, you must specify the\n complete SSM document ARN, in the following format:
\n\n arn:aws:ssm:region:account-id:document/document-name\n \n
For example:
\n\n arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document\n
For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need\n to specify the document name. For example, AWS-ApplyPatchBaseline or\n My-Document.
The instance ID.
\n\n InstanceId has been deprecated. To specify an instance ID for an association,\n use the Targets parameter. Requests that include the\n parameter InstanceID with Systems Manager documents (SSM documents) that use schema version\n 2.0 or later will fail. In addition, if you use the parameter\n InstanceId, you can't use the parameters AssociationName,\n DocumentVersion, MaxErrors, MaxConcurrency,\n OutputLocation, or ScheduleExpression. To use these parameters, you\n must use the Targets parameter.
The managed node ID.
\n\n InstanceId has been deprecated. To specify a managed node ID for an association,\n use the Targets parameter. Requests that include the\n parameter InstanceID with Systems Manager documents (SSM documents) that use schema version\n 2.0 or later will fail. In addition, if you use the parameter\n InstanceId, you can't use the parameters AssociationName,\n DocumentVersion, MaxErrors, MaxConcurrency,\n OutputLocation, or ScheduleExpression. To use these parameters, you\n must use the Targets parameter.
The instances targeted by the request.
" + "smithy.api#documentation": "The managed nodes targeted by the request.
" } }, "ScheduleExpression": { @@ -4365,13 +4374,13 @@ "MaxErrors": { "target": "com.amazonaws.ssm#MaxErrors", "traits": { - "smithy.api#documentation": "The number of errors that are allowed before the system stops sending requests to run the\n association on additional targets. You can specify either an absolute number of errors, for\n example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,\n the system stops sending requests when the fourth error is received. If you specify 0, then the\n system stops sending requests after the first error is returned. If you run an association on 50\n instances and set MaxError to 10%, then the system stops sending the request when\n the sixth error is received.
Executions that are already running an association when MaxErrors is reached\n are allowed to complete, but some of these executions may fail as well. If you need to ensure\n that there won't be more than max-errors failed executions, set MaxConcurrency to 1\n so that executions proceed one at a time.
The number of errors that are allowed before the system stops sending requests to run the\n association on additional targets. You can specify either an absolute number of errors, for\n example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,\n the system stops sending requests when the fourth error is received. If you specify 0, then the\n system stops sending requests after the first error is returned. If you run an association on 50\n managed nodes and set MaxError to 10%, then the system stops sending the request\n when the sixth error is received.
Executions that are already running an association when MaxErrors is reached\n are allowed to complete, but some of these executions may fail as well. If you need to ensure\n that there won't be more than max-errors failed executions, set MaxConcurrency to 1\n so that executions proceed one at a time.
The maximum number of targets allowed to run the association at the same time. You can\n specify a number, for example 10, or a percentage of the target set, for example 10%. The default\n value is 100%, which means all targets run the association at the same time.
\nIf a new instance starts and attempts to run an association while Systems Manager is running\n MaxConcurrency associations, the association is allowed to run. During the next\n association interval, the new instance will process its association within the limit specified\n for MaxConcurrency.
The maximum number of targets allowed to run the association at the same time. You can\n specify a number, for example 10, or a percentage of the target set, for example 10%. The default\n value is 100%, which means all targets run the association at the same time.
\nIf a new managed node starts and attempts to run an association while Systems Manager is running\n MaxConcurrency associations, the association is allowed to run. During the next\n association interval, the new managed node will process its association within the limit specified\n for MaxConcurrency.
Describes the association of a Amazon Web Services Systems Manager document (SSM document) and an instance.
" + "smithy.api#documentation": "Describes the association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.
" } }, "com.amazonaws.ssm#CreateAssociationBatchResult": { @@ -4432,7 +4441,7 @@ "Name": { "target": "com.amazonaws.ssm#DocumentARN", "traits": { - "smithy.api#documentation": "The name of the SSM Command document or Automation runbook that contains the configuration\n information for the instance.
\nYou can specify Amazon Web Services-predefined documents, documents you created, or a document that is\n shared with you from another account.
\nFor Systems Manager documents (SSM documents) that are shared with you from other Amazon Web Services accounts, you\n must specify the complete SSM document ARN, in the following format:
\n\n arn:partition:ssm:region:account-id:document/document-name\n \n
For example:
\n\n arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document\n
For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need\n to specify the document name. For example, AWS-ApplyPatchBaseline or\n My-Document.
The name of the SSM Command document or Automation runbook that contains the configuration\n information for the managed node.
\nYou can specify Amazon Web Services-predefined documents, documents you created, or a document that is\n shared with you from another account.
\nFor Systems Manager documents (SSM documents) that are shared with you from other Amazon Web Services accounts, you\n must specify the complete SSM document ARN, in the following format:
\n\n arn:partition:ssm:region:account-id:document/document-name\n \n
For example:
\n\n arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document\n
For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need\n to specify the document name. For example, AWS-ApplyPatchBaseline or\n My-Document.
The instance ID.
\n\n InstanceId has been deprecated. To specify an instance ID for an association,\n use the Targets parameter. Requests that include the\n parameter InstanceID with Systems Manager documents (SSM documents) that use schema version\n 2.0 or later will fail. In addition, if you use the parameter\n InstanceId, you can't use the parameters AssociationName,\n DocumentVersion, MaxErrors, MaxConcurrency,\n OutputLocation, or ScheduleExpression. To use these parameters, you\n must use the Targets parameter.
The managed node ID.
\n\n InstanceId has been deprecated. To specify a managed node ID for an association,\n use the Targets parameter. Requests that include the\n parameter InstanceID with Systems Manager documents (SSM documents) that use schema version\n 2.0 or later will fail. In addition, if you use the parameter\n InstanceId, you can't use the parameters AssociationName,\n DocumentVersion, MaxErrors, MaxConcurrency,\n OutputLocation, or ScheduleExpression. To use these parameters, you\n must use the Targets parameter.
The targets for the association. You can target instances by using tags, Amazon Web Services resource\n groups, all instances in an Amazon Web Services account, or individual instance IDs. You can target all\n instances in an Amazon Web Services account by specifying the InstanceIds key with a value of\n *. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the\n Amazon Web Services Systems Manager User Guide.
The targets for the association. You can target managed nodes by using tags, Amazon Web Services resource\n groups, all managed nodes in an Amazon Web Services account, or individual managed node IDs. You can target all\n managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of\n *. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the\n Amazon Web Services Systems Manager User Guide.
The number of errors that are allowed before the system stops sending requests to run the\n association on additional targets. You can specify either an absolute number of errors, for\n example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,\n the system stops sending requests when the fourth error is received. If you specify 0, then the\n system stops sending requests after the first error is returned. If you run an association on 50\n instances and set MaxError to 10%, then the system stops sending the request when\n the sixth error is received.
Executions that are already running an association when MaxErrors is reached\n are allowed to complete, but some of these executions may fail as well. If you need to ensure\n that there won't be more than max-errors failed executions, set MaxConcurrency to 1\n so that executions proceed one at a time.
The number of errors that are allowed before the system stops sending requests to run the\n association on additional targets. You can specify either an absolute number of errors, for\n example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,\n the system stops sending requests when the fourth error is received. If you specify 0, then the\n system stops sending requests after the first error is returned. If you run an association on 50\n managed nodes and set MaxError to 10%, then the system stops sending the request\n when the sixth error is received.
Executions that are already running an association when MaxErrors is reached\n are allowed to complete, but some of these executions may fail as well. If you need to ensure\n that there won't be more than max-errors failed executions, set MaxConcurrency to 1\n so that executions proceed one at a time.
The maximum number of targets allowed to run the association at the same time. You can\n specify a number, for example 10, or a percentage of the target set, for example 10%. The default\n value is 100%, which means all targets run the association at the same time.
\nIf a new instance starts and attempts to run an association while Systems Manager is running\n MaxConcurrency associations, the association is allowed to run. During the next\n association interval, the new instance will process its association within the limit specified\n for MaxConcurrency.
The maximum number of targets allowed to run the association at the same time. You can\n specify a number, for example 10, or a percentage of the target set, for example 10%. The default\n value is 100%, which means all targets run the association at the same time.
\nIf a new managed node starts and attempts to run an association while Systems Manager is running\n MaxConcurrency associations, the association is allowed to run. During the next\n association interval, the new managed node will process its association within the limit specified\n for MaxConcurrency.
Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs\n on your managed instances. For more information about SSM documents, including information about\n supported schemas, features, and syntax, see Amazon Web Services Systems Manager Documents in the\n Amazon Web Services Systems Manager User Guide.
" + "smithy.api#documentation": "Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs\n on your managed nodes. For more information about SSM documents, including information about\n supported schemas, features, and syntax, see Amazon Web Services Systems Manager Documents in the\n Amazon Web Services Systems Manager User Guide.
" } }, "com.amazonaws.ssm#CreateDocumentRequest": { @@ -4737,7 +4746,7 @@ "AllowUnassociatedTargets": { "target": "com.amazonaws.ssm#MaintenanceWindowAllowUnassociatedTargets", "traits": { - "smithy.api#documentation": "Enables a maintenance window task to run on managed instances, even if you haven't\n registered those instances as targets. If enabled, then you must specify the unregistered\n instances (by instance ID) when you register a task with the maintenance window.
\nIf you don't enable this option, then you must specify previously-registered targets when\n you register a task with the maintenance window.
", + "smithy.api#documentation": "Enables a maintenance window task to run on managed nodes, even if you haven't registered\n those nodes as targets. If enabled, then you must specify the unregistered managed nodes (by\n node ID) when you register a task with the maintenance window.
\nIf you don't enable this option, then you must specify previously-registered targets when\n you register a task with the maintenance window.
", "smithy.api#required": {} } }, @@ -5033,7 +5042,7 @@ "target": "com.amazonaws.ssm#Boolean", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "Indicates whether the list of approved patches includes non-security updates that should be\n applied to the instances. The default value is false. Applies to Linux instances\n only.
Indicates whether the list of approved patches includes non-security updates that should be\n applied to the managed nodes. The default value is false. Applies to Linux managed\n nodes only.
Information about the patches to use to update the instances, including target operating\n systems and source repositories. Applies to Linux instances only.
" + "smithy.api#documentation": "Information about the patches to use to update the managed nodes, including target operating\n systems and source repositories. Applies to Linux managed nodes only.
" } }, "ClientToken": { @@ -5204,7 +5213,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an activation. You aren't required to delete an activation. If you delete an\n activation, you can no longer use it to register additional managed instances. Deleting an\n activation doesn't de-register managed instances. You must manually de-register managed\n instances.
" + "smithy.api#documentation": "Deletes an activation. You aren't required to delete an activation. If you delete an\n activation, you can no longer use it to register additional managed nodes. Deleting an activation\n doesn't de-register managed nodes. You must manually de-register managed nodes.
" } }, "com.amazonaws.ssm#DeleteActivationRequest": { @@ -5249,7 +5258,7 @@ } ], "traits": { - "smithy.api#documentation": "Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified instance.\n If you created the association by using the Targets parameter, then you must delete\n the association by using the association ID.
When you disassociate a document from an instance, it doesn't change the configuration of\n the instance. To change the configuration state of an instance after you disassociate a document,\n you must create a new document with the desired configuration and associate it with the\n instance.
" + "smithy.api#documentation": "Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node.\n If you created the association by using the Targets parameter, then you must delete\n the association by using the association ID.
When you disassociate a document from a managed node, it doesn't change the configuration of\n the node. To change the configuration state of a managed node after you disassociate a document,\n you must create a new document with the desired configuration and associate it with the\n node.
" } }, "com.amazonaws.ssm#DeleteAssociationRequest": { @@ -5264,7 +5273,7 @@ "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "The instance ID.
\n\n InstanceId has been deprecated. To specify an instance ID for an association,\n use the Targets parameter. Requests that include the\n parameter InstanceID with Systems Manager documents (SSM documents) that use schema version\n 2.0 or later will fail. In addition, if you use the parameter\n InstanceId, you can't use the parameters AssociationName,\n DocumentVersion, MaxErrors, MaxConcurrency,\n OutputLocation, or ScheduleExpression. To use these parameters, you\n must use the Targets parameter.
The managed node ID.
\n\n InstanceId has been deprecated. To specify a managed node ID for an association,\n use the Targets parameter. Requests that include the\n parameter InstanceID with Systems Manager documents (SSM documents) that use schema version\n 2.0 or later will fail. In addition, if you use the parameter\n InstanceId, you can't use the parameters AssociationName,\n DocumentVersion, MaxErrors, MaxConcurrency,\n OutputLocation, or ScheduleExpression. To use these parameters, you\n must use the Targets parameter.
Deletes the Amazon Web Services Systems Manager document (SSM document) and all instance associations to the\n document.
\nBefore you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.
" + "smithy.api#documentation": "Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the\n document.
\nBefore you delete the document, we recommend that you use DeleteAssociation to disassociate all managed nodes that are associated with the document.
" } }, "com.amazonaws.ssm#DeleteDocumentRequest": { @@ -5646,7 +5655,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a resource data sync configuration. After the configuration is deleted, changes to\n data on managed instances are no longer synced to or from the target. Deleting a sync\n configuration doesn't delete data.
" + "smithy.api#documentation": "Deletes a resource data sync configuration. After the configuration is deleted, changes to\n data on managed nodes are no longer synced to or from the target. Deleting a sync configuration\n doesn't delete data.
" } }, "com.amazonaws.ssm#DeleteResourceDataSyncRequest": { @@ -5691,7 +5700,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes the server or virtual machine from the list of registered servers. You can\n reregister the instance again at any time. If you don't plan to use Run Command on the server, we\n suggest uninstalling SSM Agent first.
" + "smithy.api#documentation": "Removes the server or virtual machine from the list of registered servers. You can\n reregister the node again at any time. If you don't plan to use Run Command on the server, we\n suggest uninstalling SSM Agent first.
" } }, "com.amazonaws.ssm#DeregisterManagedInstanceRequest": { @@ -5700,7 +5709,7 @@ "InstanceId": { "target": "com.amazonaws.ssm#ManagedInstanceId", "traits": { - "smithy.api#documentation": "The ID assigned to the managed instance when you registered it using the activation process.\n
", + "smithy.api#documentation": "The ID assigned to the managed node when you registered it using the activation process.\n
", "smithy.api#required": {} } } @@ -5908,7 +5917,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes details about the activation, such as the date and time the activation was\n created, its expiration date, the Identity and Access Management (IAM) role assigned to\n the instances in the activation, and the number of instances registered by using this\n activation.
", + "smithy.api#documentation": "Describes details about the activation, such as the date and time the activation was\n created, its expiration date, the Identity and Access Management (IAM) role assigned to\n the managed nodes in the activation, and the number of nodes registered by using this\n activation.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -6029,7 +6038,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the association for the specified target or instance. If you created the\n association by using the Targets parameter, then you must retrieve the association\n by using the association ID.
Describes the association for the specified target or managed node. If you created the\n association by using the Targets parameter, then you must retrieve the association\n by using the association ID.
The instance ID.
" + "smithy.api#documentation": "The managed node ID.
" } }, "AssociationId": { @@ -6220,7 +6229,7 @@ "AssociationVersion": { "target": "com.amazonaws.ssm#AssociationVersion", "traits": { - "smithy.api#documentation": "Specify the association version to retrieve. To view the latest version, either specify\n $LATEST for this parameter, or omit this parameter. To view a list of all\n associations for an instance, use ListAssociations. To get a list of versions\n for a specific association, use ListAssociationVersions.
Specify the association version to retrieve. To view the latest version, either specify\n $LATEST for this parameter, or omit this parameter. To view a list of all\n associations for a managed node, use ListAssociations. To get a list of versions\n for a specific association, use ListAssociationVersions.
Each element in the array is a structure containing a key-value pair.
\n\n Windows Server\n
\nSupported keys for Windows Server instance patches include the following:
\n\n \n PATCH_SET\n \n
Sample values: OS | APPLICATION\n
\n \n PRODUCT\n \n
Sample values: WindowsServer2012 | Office 2010 |\n MicrosoftDefenderAntivirus\n
\n \n PRODUCT_FAMILY\n \n
Sample values: Windows | Office\n
\n \n MSRC_SEVERITY\n \n
Sample values: ServicePacks | Important | Moderate\n
\n \n CLASSIFICATION\n \n
Sample values: ServicePacks | SecurityUpdates |\n DefinitionUpdates\n
\n \n PATCH_ID\n \n
Sample values: KB123456 | KB4516046\n
\n Linux\n
\nWhen specifying filters for Linux patches, you must specify a key-pair for\n PRODUCT. For example, using the Command Line Interface (CLI), the\n following command fails:
\n aws ssm describe-available-patches --filters Key=CVE_ID,Values=CVE-2018-3615\n
However, the following command succeeds:
\n\n aws ssm describe-available-patches --filters Key=PRODUCT,Values=AmazonLinux2018.03\n Key=CVE_ID,Values=CVE-2018-3615\n
Supported keys for Linux instance patches include the following:
\n\n \n PRODUCT\n \n
Sample values: AmazonLinux2018.03 | AmazonLinux2.0\n
\n \n NAME\n \n
Sample values: kernel-headers | samba-python | php\n
\n \n SEVERITY\n \n
Sample values: Critical | Important | Medium |\n Low\n
\n \n EPOCH\n \n
Sample values: 0 | 1\n
\n \n VERSION\n \n
Sample values: 78.6.1 | 4.10.16\n
\n \n RELEASE\n \n
Sample values: 9.56.amzn1 | 1.amzn2\n
\n \n ARCH\n \n
Sample values: i686 | x86_64\n
\n \n REPOSITORY\n \n
Sample values: Core | Updates\n
\n \n ADVISORY_ID\n \n
Sample values: ALAS-2018-1058 | ALAS2-2021-1594\n
\n \n CVE_ID\n \n
Sample values: CVE-2018-3615 | CVE-2020-1472\n
\n \n BUGZILLA_ID\n \n
Sample values: 1463241\n
Each element in the array is a structure containing a key-value pair.
\n\n Windows Server\n
\nSupported keys for Windows Server managed node patches include the following:
\n\n \n PATCH_SET\n \n
Sample values: OS | APPLICATION\n
\n \n PRODUCT\n \n
Sample values: WindowsServer2012 | Office 2010 |\n MicrosoftDefenderAntivirus\n
\n \n PRODUCT_FAMILY\n \n
Sample values: Windows | Office\n
\n \n MSRC_SEVERITY\n \n
Sample values: ServicePacks | Important | Moderate\n
\n \n CLASSIFICATION\n \n
Sample values: ServicePacks | SecurityUpdates |\n DefinitionUpdates\n
\n \n PATCH_ID\n \n
Sample values: KB123456 | KB4516046\n
\n Linux\n
\nWhen specifying filters for Linux patches, you must specify a key-pair for\n PRODUCT. For example, using the Command Line Interface (CLI), the\n following command fails:
\n aws ssm describe-available-patches --filters Key=CVE_ID,Values=CVE-2018-3615\n
However, the following command succeeds:
\n\n aws ssm describe-available-patches --filters Key=PRODUCT,Values=AmazonLinux2018.03\n Key=CVE_ID,Values=CVE-2018-3615\n
Supported keys for Linux managed node patches include the following:
\n\n \n PRODUCT\n \n
Sample values: AmazonLinux2018.03 | AmazonLinux2.0\n
\n \n NAME\n \n
Sample values: kernel-headers | samba-python | php\n
\n \n SEVERITY\n \n
Sample values: Critical | Important | Medium |\n Low\n
\n \n EPOCH\n \n
Sample values: 0 | 1\n
\n \n VERSION\n \n
Sample values: 78.6.1 | 4.10.16\n
\n \n RELEASE\n \n
Sample values: 9.56.amzn1 | 1.amzn2\n
\n \n ARCH\n \n
Sample values: i686 | x86_64\n
\n \n REPOSITORY\n \n
Sample values: Core | Updates\n
\n \n ADVISORY_ID\n \n
Sample values: ALAS-2018-1058 | ALAS2-2021-1594\n
\n \n CVE_ID\n \n
Sample values: CVE-2018-3615 | CVE-2020-1472\n
\n \n BUGZILLA_ID\n \n
Sample values: 1463241\n
All associations for the instance(s).
", + "smithy.api#documentation": "All associations for the managed node(s).
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -6640,7 +6649,7 @@ "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "The instance ID for which you want to view all associations.
", + "smithy.api#documentation": "The managed node ID for which you want to view all associations.
", "smithy.api#required": {} } }, @@ -6665,7 +6674,7 @@ "Associations": { "target": "com.amazonaws.ssm#InstanceAssociationList", "traits": { - "smithy.api#documentation": "The associations for the requested instance.
" + "smithy.api#documentation": "The associations for the requested managed node.
" } }, "NextToken": { @@ -6770,7 +6779,7 @@ } ], "traits": { - "smithy.api#documentation": "The status of the associations for the instance(s).
", + "smithy.api#documentation": "The status of the associations for the managed node(s).
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -6785,7 +6794,7 @@ "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "The instance IDs for which you want association status information.
", + "smithy.api#documentation": "The managed node IDs for which you want association status information.
", "smithy.api#required": {} } }, @@ -6847,7 +6856,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes one or more of your instances, including information about the operating system\n platform, the version of SSM Agent installed on the instance, instance status, and so on.
\nIf you specify one or more instance IDs, it returns information for those instances. If you\n don't specify instance IDs, it returns information for all your instances. If you specify an\n instance ID that isn't valid or an instance that you don't own, you receive an error.
\nThe IamRole field for this API operation is the Identity and Access Management\n (IAM) role assigned to on-premises instances. This call doesn't return the\n IAM role for EC2 instances.
Describes one or more of your managed nodes, including information about the operating\n system platform, the version of SSM Agent installed on the managed node, node status, and so\n on.
\nIf you specify one or more managed node IDs, it returns information for those managed nodes. If\n you don't specify node IDs, it returns information for all your managed nodes. If you specify\n a node ID that isn't valid or a node that you don't own, you receive an error.
\nThe IamRole field for this API operation is the Identity and Access Management\n (IAM) role assigned to on-premises managed nodes. This call doesn't return the\n IAM role for EC2 instances.
This is a legacy method. We recommend that you don't use this method. Instead, use the\n Filters data type. Filters enables you to return instance information\n by filtering based on tags applied to managed instances.
Attempting to use InstanceInformationFilterList and Filters leads\n to an exception error.
This is a legacy method. We recommend that you don't use this method. Instead, use the\n Filters data type. Filters enables you to return node information\n by filtering based on tags applied to managed nodes.
Attempting to use InstanceInformationFilterList and Filters leads\n to an exception error.
One or more filters. Use a filter to return a more specific list of instances. You can\n filter based on tags applied to EC2 instances. Use this Filters data type instead of\n InstanceInformationFilterList, which is deprecated.
One or more filters. Use a filter to return a more specific list of managed nodes. You can\n filter based on tags applied to EC2 instances. Use this Filters data type instead of\n InstanceInformationFilterList, which is deprecated.
The instance information list.
" + "smithy.api#documentation": "The managed node information list.
" } }, "NextToken": { @@ -6920,7 +6929,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the high-level patch state of one or more instances.
", + "smithy.api#documentation": "Retrieves the high-level patch state of one or more managed nodes.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -6949,7 +6958,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the high-level patch state for the instances in the specified patch group.
", + "smithy.api#documentation": "Retrieves the high-level patch state for the managed nodes in the specified patch group.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -6995,7 +7004,7 @@ "InstancePatchStates": { "target": "com.amazonaws.ssm#InstancePatchStatesList", "traits": { - "smithy.api#documentation": "The high-level patch state for the requested instances.
" + "smithy.api#documentation": "The high-level patch state for the requested managed nodes.
" } }, "NextToken": { @@ -7012,7 +7021,7 @@ "InstanceIds": { "target": "com.amazonaws.ssm#InstanceIdList", "traits": { - "smithy.api#documentation": "The ID of the instance for which patch state information should be retrieved.
", + "smithy.api#documentation": "The ID of the managed node for which patch state information should be retrieved.
", "smithy.api#required": {} } }, @@ -7026,7 +7035,7 @@ "target": "com.amazonaws.ssm#PatchComplianceMaxResults", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "The maximum number of instances to return (per page).
" + "smithy.api#documentation": "The maximum number of managed nodes to return (per page).
" } } } @@ -7037,7 +7046,7 @@ "InstancePatchStates": { "target": "com.amazonaws.ssm#InstancePatchStateList", "traits": { - "smithy.api#documentation": "The high-level patch state for the requested instances.
" + "smithy.api#documentation": "The high-level patch state for the requested managed nodes.
" } }, "NextToken": { @@ -7071,7 +7080,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves information about the patches on the specified instance and their state relative\n to the patch baseline being used for the instance.
", + "smithy.api#documentation": "Retrieves information about the patches on the specified managed node and their state relative\n to the patch baseline being used for the node.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -7086,7 +7095,7 @@ "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "The ID of the instance whose patch state information should be retrieved.
", + "smithy.api#documentation": "The ID of the managed node whose patch state information should be retrieved.
", "smithy.api#required": {} } }, @@ -7462,7 +7471,7 @@ "Targets": { "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "The instance ID or key-value pair to retrieve information about.
" + "smithy.api#documentation": "The managed node ID or key-value pair to retrieve information about.
" } }, "ResourceType": { @@ -7694,7 +7703,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves information about the maintenance window targets or tasks that an instance is\n associated with.
", + "smithy.api#documentation": "Retrieves information about the maintenance window targets or tasks that a managed node is\n associated with.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -7709,7 +7718,7 @@ "Targets": { "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "The instance ID or key-value pair to retrieve information about.
", + "smithy.api#documentation": "The managed node ID or key-value pair to retrieve information about.
", "smithy.api#required": {} } }, @@ -7741,7 +7750,7 @@ "WindowIdentities": { "target": "com.amazonaws.ssm#MaintenanceWindowsForTargetList", "traits": { - "smithy.api#documentation": "Information about the maintenance window targets and tasks an instance is associated\n with.
" + "smithy.api#documentation": "Information about the maintenance window targets and tasks a managed node is associated\n with.
" } }, "NextToken": { @@ -8039,79 +8048,79 @@ "Instances": { "target": "com.amazonaws.ssm#Integer", "traits": { - "smithy.api#documentation": "The number of instances in the patch group.
" + "smithy.api#documentation": "The number of managed nodes in the patch group.
" } }, "InstancesWithInstalledPatches": { "target": "com.amazonaws.ssm#Integer", "traits": { - "smithy.api#documentation": "The number of instances with installed patches.
" + "smithy.api#documentation": "The number of managed nodes with installed patches.
" } }, "InstancesWithInstalledOtherPatches": { "target": "com.amazonaws.ssm#Integer", "traits": { - "smithy.api#documentation": "The number of instances with patches installed that aren't defined in the patch\n baseline.
" + "smithy.api#documentation": "The number of managed nodes with patches installed that aren't defined in the patch\n baseline.
" } }, "InstancesWithInstalledPendingRebootPatches": { "target": "com.amazonaws.ssm#InstancesCount", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "The number of instances with patches installed by Patch Manager that haven't been rebooted\n after the patch installation. The status of these instances is NON_COMPLIANT.
The number of managed nodes with patches installed by Patch Manager that haven't been\n rebooted after the patch installation. The status of these managed nodes is\n NON_COMPLIANT.
The number of instances with patches installed that are specified in a\n RejectedPatches list. Patches with a status of INSTALLED_REJECTED were\n typically installed before they were added to a RejectedPatches list.
If ALLOW_AS_DEPENDENCY is the specified option for\n RejectedPatchesAction, the value of\n InstancesWithInstalledRejectedPatches will always be 0 (zero).
The number of managed nodes with patches installed that are specified in a\n RejectedPatches list. Patches with a status of INSTALLED_REJECTED were\n typically installed before they were added to a RejectedPatches list.
If ALLOW_AS_DEPENDENCY is the specified option for\n RejectedPatchesAction, the value of\n InstancesWithInstalledRejectedPatches will always be 0 (zero).
The number of instances with missing patches from the patch baseline.
" + "smithy.api#documentation": "The number of managed nodes with missing patches from the patch baseline.
" } }, "InstancesWithFailedPatches": { "target": "com.amazonaws.ssm#Integer", "traits": { - "smithy.api#documentation": "The number of instances with patches from the patch baseline that failed to install.
" + "smithy.api#documentation": "The number of managed nodes with patches from the patch baseline that failed to\n install.
" } }, "InstancesWithNotApplicablePatches": { "target": "com.amazonaws.ssm#Integer", "traits": { - "smithy.api#documentation": "The number of instances with patches that aren't applicable.
" + "smithy.api#documentation": "The number of managed nodes with patches that aren't applicable.
" } }, "InstancesWithUnreportedNotApplicablePatches": { "target": "com.amazonaws.ssm#Integer", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "The number of instances with NotApplicable patches beyond the supported limit,\n which aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.
The number of managed nodes with NotApplicable patches beyond the supported\n limit, which aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.
The number of instances where patches that are specified as Critical for\n compliance reporting in the patch baseline aren't installed. These patches might be missing, have\n failed installation, were rejected, or were installed but awaiting a required instance reboot.\n The status of these instances is NON_COMPLIANT.
The number of managed nodes where patches that are specified as Critical for\n compliance reporting in the patch baseline aren't installed. These patches might be missing, have\n failed installation, were rejected, or were installed but awaiting a required managed node reboot.\n The status of these managed nodes is NON_COMPLIANT.
The number of instances where patches that are specified as Security in a patch\n advisory aren't installed. These patches might be missing, have failed installation, were\n rejected, or were installed but awaiting a required instance reboot. The status of these\n instances is NON_COMPLIANT.
The number of managed nodes where patches that are specified as Security in a\n patch advisory aren't installed. These patches might be missing, have failed installation, were\n rejected, or were installed but awaiting a required managed node reboot. The status of these managed\n nodes is NON_COMPLIANT.
The number of instances with patches installed that are specified as other than\n Critical or Security but aren't compliant with the patch baseline. The\n status of these instances is NON_COMPLIANT.
The number of managed nodes with patches installed that are specified as other than\n Critical or Security but aren't compliant with the patch baseline. The\n status of these managed nodes is NON_COMPLIANT.
You can't specify an instance ID in more than one association.
", + "smithy.api#documentation": "You can't specify a managed node ID in more than one association.
", "smithy.api#error": "client" } }, @@ -9798,7 +9807,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns detailed information about command execution for an invocation or plugin.
\n\n GetCommandInvocation only gives the execution status of a plugin in a document.\n To get the command execution status on a specific instance, use ListCommandInvocations. To get the command execution status across instances, use\n ListCommands.
Returns detailed information about command execution for an invocation or plugin.
\n\n GetCommandInvocation only gives the execution status of a plugin in a document.\n To get the command execution status on a specific managed node, use ListCommandInvocations. To get the command execution status across managed nodes,\n use ListCommands.
(Required) The ID of the managed instance targeted by the command. A managed instance can be\n an Amazon Elastic Compute Cloud (Amazon EC2) instance or an instance in your hybrid environment that is configured for\n Amazon Web Services Systems Manager.
", + "smithy.api#documentation": "(Required) The ID of the managed node targeted by the command. A managed node can be an\n Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, and on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.
", "smithy.api#required": {} } }, @@ -9931,7 +9940,7 @@ "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "The ID of the managed instance targeted by the command. A managed instance can be an EC2\n instance or an instance in your hybrid environment that is configured for Systems Manager.
" + "smithy.api#documentation": "The ID of the managed node targeted by the command. A managed node can be an\n Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.
" } }, "Comment": { @@ -9961,7 +9970,7 @@ "ResponseCode": { "target": "com.amazonaws.ssm#ResponseCode", "traits": { - "smithy.api#documentation": "The error level response code for the plugin script. If the response code is\n -1, then the command hasn't started running on the instance, or it wasn't received\n by the instance.
The error level response code for the plugin script. If the response code is\n -1, then the command hasn't started running on the managed node, or it wasn't received\n by the node.
A detailed status of the command execution for an invocation. StatusDetails\n includes more information than Status because it includes states resulting from\n error and concurrency control parameters. StatusDetails can show different results\n than Status. For more information about these statuses, see Understanding\n command statuses in the Amazon Web Services Systems Manager User Guide.\n StatusDetails can be one of the following values:
Pending: The command hasn't been sent to the instance.
\nIn Progress: The command has been sent to the instance but hasn't reached a terminal\n state.
\nDelayed: The system attempted to send the command to the target, but the target wasn't\n available. The instance might not be available because of network issues, because the instance\n was stopped, or for similar reasons. The system will try to send the command again.
\nSuccess: The command or plugin ran successfully. This is a terminal state.
\nDelivery Timed Out: The command wasn't delivered to the instance before the delivery\n timeout expired. Delivery timeouts don't count against the parent command's\n MaxErrors limit, but they do contribute to whether the parent command status is\n Success or Incomplete. This is a terminal state.
Execution Timed Out: The command started to run on the instance, but the execution wasn't\n complete before the timeout expired. Execution timeouts count against the\n MaxErrors limit of the parent command. This is a terminal state.
Failed: The command wasn't run successfully on the instance. For a plugin, this indicates\n that the result code wasn't zero. For a command invocation, this indicates that the result code\n for one or more plugins wasn't zero. Invocation failures count against the\n MaxErrors limit of the parent command. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal\n state.
\nUndeliverable: The command can't be delivered to the instance. The instance might not\n exist or might not be responding. Undeliverable invocations don't count against the parent\n command's MaxErrors limit and don't contribute to whether the parent command\n status is Success or Incomplete. This is a terminal state.
Terminated: The parent command exceeded its MaxErrors limit and subsequent\n command invocations were canceled by the system. This is a terminal state.
A detailed status of the command execution for an invocation. StatusDetails\n includes more information than Status because it includes states resulting from\n error and concurrency control parameters. StatusDetails can show different results\n than Status. For more information about these statuses, see Understanding\n command statuses in the Amazon Web Services Systems Manager User Guide.\n StatusDetails can be one of the following values:
Pending: The command hasn't been sent to the managed node.
\nIn Progress: The command has been sent to the managed node but hasn't reached a terminal\n state.
\nDelayed: The system attempted to send the command to the target, but the target wasn't\n available. The managed node might not be available because of network issues, because the node\n was stopped, or for similar reasons. The system will try to send the command again.
\nSuccess: The command or plugin ran successfully. This is a terminal state.
\nDelivery Timed Out: The command wasn't delivered to the managed node before the delivery\n timeout expired. Delivery timeouts don't count against the parent command's\n MaxErrors limit, but they do contribute to whether the parent command status is\n Success or Incomplete. This is a terminal state.
Execution Timed Out: The command started to run on the managed node, but the execution wasn't\n complete before the timeout expired. Execution timeouts count against the\n MaxErrors limit of the parent command. This is a terminal state.
Failed: The command wasn't run successfully on the managed node. For a plugin, this indicates\n that the result code wasn't zero. For a command invocation, this indicates that the result code\n for one or more plugins wasn't zero. Invocation failures count against the\n MaxErrors limit of the parent command. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal\n state.
\nUndeliverable: The command can't be delivered to the managed node. The node might not\n exist or might not be responding. Undeliverable invocations don't count against the parent\n command's MaxErrors limit and don't contribute to whether the parent command\n status is Success or Incomplete. This is a terminal state.
Terminated: The parent command exceeded its MaxErrors limit and subsequent\n command invocations were canceled by the system. This is a terminal state.
Retrieves the Session Manager connection status for an instance to determine whether it is running and\n ready to receive Session Manager connections.
" + "smithy.api#documentation": "Retrieves the Session Manager connection status for a managed node to determine whether it is running and\n ready to receive Session Manager connections.
" } }, "com.amazonaws.ssm#GetConnectionStatusRequest": { @@ -10049,7 +10058,7 @@ "Target": { "target": "com.amazonaws.ssm#SessionTarget", "traits": { - "smithy.api#documentation": "The instance ID.
", + "smithy.api#documentation": "The managed node ID.
", "smithy.api#required": {} } } @@ -10061,13 +10070,13 @@ "Target": { "target": "com.amazonaws.ssm#SessionTarget", "traits": { - "smithy.api#documentation": "The ID of the instance to check connection status.
" + "smithy.api#documentation": "The ID of the managed node to check connection status.
" } }, "Status": { "target": "com.amazonaws.ssm#ConnectionStatus", "traits": { - "smithy.api#documentation": "The status of the connection to the instance. For example, 'Connected' or 'Not\n Connected'.
" + "smithy.api#documentation": "The status of the connection to the managed node. For example, 'Connected' or 'Not\n Connected'.
" } } } @@ -10137,7 +10146,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the current snapshot for the patch baseline the instance uses. This API is\n primarily used by the AWS-RunPatchBaseline Systems Manager document (SSM document).
If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid\n this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of\n Amazon Web Services Systems Manager, with an SSM document that enables you to target an instance with a script or command.\n For example, run the command using the AWS-RunShellScript document or the\n AWS-RunPowerShellScript document.
Retrieves the current snapshot for the patch baseline the managed node uses. This API is\n primarily used by the AWS-RunPatchBaseline Systems Manager document (SSM document).
If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid\n this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of\n Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or command.\n For example, run the command using the AWS-RunShellScript document or the\n AWS-RunPowerShellScript document.
The ID of the instance for which the appropriate patch snapshot should be retrieved.
", + "smithy.api#documentation": "The ID of the managed node for which the appropriate patch snapshot should be retrieved.
", "smithy.api#required": {} } }, @@ -10171,7 +10180,7 @@ "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "The instance ID.
" + "smithy.api#documentation": "The managed node ID.
" } }, "SnapshotId": { @@ -10189,7 +10198,7 @@ "Product": { "target": "com.amazonaws.ssm#Product", "traits": { - "smithy.api#documentation": "Returns the specific operating system (for example Windows Server 2012 or Amazon Linux\n 2015.09) on the instance for the specified patch snapshot.
" + "smithy.api#documentation": "Returns the specific operating system (for example Windows Server 2012 or Amazon Linux\n 2015.09) on the managed node for the specified patch snapshot.
" } } } @@ -10362,7 +10371,7 @@ } ], "traits": { - "smithy.api#documentation": "Query inventory information. This includes instance status, such as Stopped or\n Terminated.
Query inventory information. This includes managed node status, such as Stopped or\n Terminated.
Returns counts of inventory types based on one or more expressions. For example, if you\n aggregate by using an expression that uses the AWS:InstanceInformation.PlatformType\n type, you can see a count of how many Windows and Linux instances exist in your inventoried\n fleet.
Returns counts of inventory types based on one or more expressions. For example, if you\n aggregate by using an expression that uses the AWS:InstanceInformation.PlatformType\n type, you can see a count of how many Windows and Linux managed nodes exist in your inventoried\n fleet.
Collection of inventory entities such as a collection of instance inventory.
" + "smithy.api#documentation": "Collection of inventory entities such as a collection of managed node inventory.
" } }, "NextToken": { @@ -11758,7 +11767,7 @@ "target": "com.amazonaws.ssm#Boolean", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "Indicates whether the list of approved patches includes non-security updates that should be\n applied to the instances. The default value is false. Applies to Linux instances\n only.
Indicates whether the list of approved patches includes non-security updates that should be\n applied to the managed nodes. The default value is false. Applies to Linux managed\n nodes only.
Information about the patches to use to update the instances, including target operating\n systems and source repositories. Applies to Linux instances only.
" + "smithy.api#documentation": "Information about the patches to use to update the managed nodes, including target operating\n systems and source repositories. Applies to Linux managed nodes only.
" } } } @@ -11977,7 +11986,7 @@ "InstanceAssociationStatusAggregatedCount": { "target": "com.amazonaws.ssm#InstanceAssociationStatusAggregatedCount", "traits": { - "smithy.api#documentation": "The number of associations for the instance(s).
" + "smithy.api#documentation": "The number of associations for the managed node(s).
" } } }, @@ -11997,24 +12006,24 @@ "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "The instance ID.
" + "smithy.api#documentation": "The managed node ID.
" } }, "Content": { "target": "com.amazonaws.ssm#DocumentContent", "traits": { - "smithy.api#documentation": "The content of the association document for the instance(s).
" + "smithy.api#documentation": "The content of the association document for the managed node(s).
" } }, "AssociationVersion": { "target": "com.amazonaws.ssm#AssociationVersion", "traits": { - "smithy.api#documentation": "Version information for the association on the instance.
" + "smithy.api#documentation": "Version information for the association on the managed node.
" } } }, "traits": { - "smithy.api#documentation": "One or more association documents on the instance.
" + "smithy.api#documentation": "One or more association documents on the managed node.
" } }, "com.amazonaws.ssm#InstanceAssociationExecutionSummary": { @@ -12093,31 +12102,31 @@ "AssociationVersion": { "target": "com.amazonaws.ssm#AssociationVersion", "traits": { - "smithy.api#documentation": "The version of the association applied to the instance.
" + "smithy.api#documentation": "The version of the association applied to the managed node.
" } }, "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "The instance ID where the association was created.
" + "smithy.api#documentation": "The managed node ID where the association was created.
" } }, "ExecutionDate": { "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "The date the instance association ran.
" + "smithy.api#documentation": "The date the association ran.
" } }, "Status": { "target": "com.amazonaws.ssm#StatusName", "traits": { - "smithy.api#documentation": "Status information about the instance association.
" + "smithy.api#documentation": "Status information about the association.
" } }, "DetailedStatus": { "target": "com.amazonaws.ssm#StatusName", "traits": { - "smithy.api#documentation": "Detailed status information about the instance association.
" + "smithy.api#documentation": "Detailed status information about the association.
" } }, "ExecutionSummary": { @@ -12141,12 +12150,12 @@ "AssociationName": { "target": "com.amazonaws.ssm#AssociationName", "traits": { - "smithy.api#documentation": "The name of the association applied to the instance.
" + "smithy.api#documentation": "The name of the association applied to the managed node.
" } } }, "traits": { - "smithy.api#documentation": "Status information about the instance association.
" + "smithy.api#documentation": "Status information about the association.
" } }, "com.amazonaws.ssm#InstanceAssociationStatusInfos": { @@ -12182,7 +12191,7 @@ "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "The instance ID.
" + "smithy.api#documentation": "The managed node ID.
" } }, "PingStatus": { @@ -12200,14 +12209,14 @@ "AgentVersion": { "target": "com.amazonaws.ssm#Version", "traits": { - "smithy.api#documentation": "The version of SSM Agent running on your Linux instance.
" + "smithy.api#documentation": "The version of SSM Agent running on your Linux managed node.
" } }, "IsLatestVersion": { "target": "com.amazonaws.ssm#Boolean", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "Indicates whether the latest version of SSM Agent is running on your Linux Managed Instance.\n This field doesn't indicate whether or not the latest version is installed on Windows managed\n instances, because some older versions of Windows Server use the EC2Config service to process\n Systems Manager requests.
" + "smithy.api#documentation": "Indicates whether the latest version of SSM Agent is running on your Linux managed node. This\n field doesn't indicate whether or not the latest version is installed on Windows managed nodes,\n because some older versions of Windows Server use the EC2Config service to process Systems Manager\n requests.
" } }, "PlatformType": { @@ -12219,13 +12228,13 @@ "PlatformName": { "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "The name of the operating system platform running on your instance.
" + "smithy.api#documentation": "The name of the operating system platform running on your managed node.
" } }, "PlatformVersion": { "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "The version of the OS platform running on your instance.
" + "smithy.api#documentation": "The version of the OS platform running on your managed node.
" } }, "ActivationId": { @@ -12237,13 +12246,13 @@ "IamRole": { "target": "com.amazonaws.ssm#IamRole", "traits": { - "smithy.api#documentation": "The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager\n managed instance. This call doesn't return the IAM role for Amazon Elastic Compute Cloud\n (Amazon EC2) instances. To retrieve the IAM role for an EC2 instance, use\n the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in\n the Amazon Web Services CLI Command Reference.
The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager\n managed node. This call doesn't return the IAM role for Amazon Elastic Compute Cloud\n (Amazon EC2) instances. To retrieve the IAM role for an EC2 instance, use\n the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in\n the Amazon Web Services CLI Command Reference.
The date the server or VM was registered with Amazon Web Services as a managed instance.
" + "smithy.api#documentation": "The date the server or VM was registered with Amazon Web Services as a managed node.
" } }, "ResourceType": { @@ -12255,19 +12264,19 @@ "Name": { "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "The name assigned to an on-premises server or virtual machine (VM) when it is activated as a\n Systems Manager managed instance. The name is specified as the DefaultInstanceName property\n using the CreateActivation command. It is applied to the managed instance by\n specifying the Activation Code and Activation ID when you install SSM Agent on the instance, as\n explained in Install SSM Agent for a\n hybrid environment (Linux) and Install SSM Agent for a\n hybrid environment (Windows). To retrieve the Name tag of an EC2 instance, use the Amazon EC2\n DescribeInstances operation. For information, see DescribeInstances in the\n Amazon EC2 API Reference or describe-instances in the\n Amazon Web Services CLI Command Reference.
The name assigned to an on-premises server, edge device, or virtual machine (VM) when it is\n activated as a Systems Manager managed node. The name is specified as the DefaultInstanceName\n property using the CreateActivation command. It is applied to the managed node\n by specifying the Activation Code and Activation ID when you install SSM Agent on the node, as\n explained in Install SSM Agent for a\n hybrid environment (Linux) and Install SSM Agent for a\n hybrid environment (Windows). To retrieve the Name tag of an EC2 instance,\n use the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in\n the Amazon Web Services CLI Command Reference.
The IP address of the managed instance.
" + "smithy.api#documentation": "The IP address of the managed node.
" } }, "ComputerName": { "target": "com.amazonaws.ssm#ComputerName", "traits": { - "smithy.api#documentation": "The fully qualified host name of the managed instance.
" + "smithy.api#documentation": "The fully qualified host name of the managed node.
" } }, "AssociationStatus": { @@ -12293,10 +12302,22 @@ "traits": { "smithy.api#documentation": "Information about the association.
" } + }, + "SourceId": { + "target": "com.amazonaws.ssm#SourceId", + "traits": { + "smithy.api#documentation": "The ID of the source resource. For IoT Greengrass devices, SourceId is\n the Thing name.
The type of the source resource. For IoT Greengrass devices, SourceType\n is AWS::IoT::Thing.
Describes a filter for a specific list of instances.
" + "smithy.api#documentation": "Describes a filter for a specific list of managed nodes.
" } }, "com.amazonaws.ssm#InstanceInformationFilter": { @@ -12318,7 +12339,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes a filter for a specific list of instances. You can filter instances information by\n using tags. You specify tags by using a key-value mapping.
\nUse this operation instead of the DescribeInstanceInformationRequest$InstanceInformationFilterList method. The\n InstanceInformationFilterList method is a legacy method and doesn't support tags.\n
Describes a filter for a specific list of managed nodes. You can filter node information by\n using tags. You specify tags by using a key-value mapping.
\nUse this operation instead of the DescribeInstanceInformationRequest$InstanceInformationFilterList method. The\n InstanceInformationFilterList method is a legacy method and doesn't support tags.\n
The filter key name to describe your instances. For example:
\n\"InstanceIds\"|\"AgentVersion\"|\"PingStatus\"|\"PlatformTypes\"|\"ActivationIds\"|\"IamRole\"|\"ResourceType\"|\"AssociationStatus\"|\"Tag\n Key\"
\n\n Tag key isn't a valid filter. You must specify either tag-key or\n tag:keyname and a string. Here are some valid examples: tag-key, tag:123, tag:al!,\n tag:Windows. Here are some invalid examples: tag-keys, Tag Key, tag:,\n tagKey, abc:keyname.
The filter key name to describe your managed nodes. For example:
\n\"InstanceIds\"|\"AgentVersion\"|\"PingStatus\"|\"PlatformTypes\"|\"ActivationIds\"|\"IamRole\"|\"ResourceType\"|\"AssociationStatus\"|\"Tag\n Key\"
\n\n Tag key isn't a valid filter. You must specify either tag-key or\n tag:keyname and a string. Here are some valid examples: tag-key, tag:123, tag:al!,\n tag:Windows. Here are some invalid examples: tag-keys, Tag Key, tag:,\n tagKey, abc:keyname.
The filters to describe or get information about your managed instances.
" + "smithy.api#documentation": "The filters to describe or get information about your managed nodes.
" } }, "com.amazonaws.ssm#InstanceInformationStringFilterKey": { @@ -12456,21 +12477,21 @@ "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "The ID of the managed instance the high-level patch compliance information was collected\n for.
", + "smithy.api#documentation": "The ID of the managed node the high-level patch compliance information was collected\n for.
", "smithy.api#required": {} } }, "PatchGroup": { "target": "com.amazonaws.ssm#PatchGroup", "traits": { - "smithy.api#documentation": "The name of the patch group the managed instance belongs to.
", + "smithy.api#documentation": "The name of the patch group the managed node belongs to.
", "smithy.api#required": {} } }, "BaselineId": { "target": "com.amazonaws.ssm#BaselineId", "traits": { - "smithy.api#documentation": "The ID of the patch baseline used to patch the instance.
", + "smithy.api#documentation": "The ID of the patch baseline used to patch the managed node.
", "smithy.api#required": {} } }, @@ -12495,33 +12516,33 @@ "InstalledCount": { "target": "com.amazonaws.ssm#PatchInstalledCount", "traits": { - "smithy.api#documentation": "The number of patches from the patch baseline that are installed on the instance.
" + "smithy.api#documentation": "The number of patches from the patch baseline that are installed on the managed node.
" } }, "InstalledOtherCount": { "target": "com.amazonaws.ssm#PatchInstalledOtherCount", "traits": { - "smithy.api#documentation": "The number of patches not specified in the patch baseline that are installed on the\n instance.
" + "smithy.api#documentation": "The number of patches not specified in the patch baseline that are installed on the\n managed node.
" } }, "InstalledPendingRebootCount": { "target": "com.amazonaws.ssm#PatchInstalledPendingRebootCount", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "The number of patches installed by Patch Manager since the last time the instance was\n rebooted.
" + "smithy.api#documentation": "The number of patches installed by Patch Manager since the last time the managed node was\n rebooted.
" } }, "InstalledRejectedCount": { "target": "com.amazonaws.ssm#PatchInstalledRejectedCount", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "The number of patches installed on an instance that are specified in a\n RejectedPatches list. Patches with a status of InstalledRejected were\n typically installed before they were added to a RejectedPatches list.
If ALLOW_AS_DEPENDENCY is the specified option for\n RejectedPatchesAction, the value of InstalledRejectedCount will\n always be 0 (zero).
The number of patches installed on a managed node that are specified in a\n RejectedPatches list. Patches with a status of InstalledRejected were\n typically installed before they were added to a RejectedPatches list.
If ALLOW_AS_DEPENDENCY is the specified option for\n RejectedPatchesAction, the value of InstalledRejectedCount will\n always be 0 (zero).
The number of patches from the patch baseline that are applicable for the instance but\n aren't currently installed.
" + "smithy.api#documentation": "The number of patches from the patch baseline that are applicable for the managed node but\n aren't currently installed.
" } }, "FailedCount": { @@ -12540,20 +12561,20 @@ "NotApplicableCount": { "target": "com.amazonaws.ssm#PatchNotApplicableCount", "traits": { - "smithy.api#documentation": "The number of patches from the patch baseline that aren't applicable for the instance and\n therefore aren't installed on the instance. This number may be truncated if the list of patch\n names is very large. The number of patches beyond this limit are reported in\n UnreportedNotApplicableCount.
The number of patches from the patch baseline that aren't applicable for the managed node and\n therefore aren't installed on the node. This number may be truncated if the list of patch\n names is very large. The number of patches beyond this limit are reported in\n UnreportedNotApplicableCount.
The time the most recent patching operation was started on the instance.
", + "smithy.api#documentation": "The time the most recent patching operation was started on the managed node.
", "smithy.api#required": {} } }, "OperationEndTime": { "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "The time the most recent patching operation completed on the instance.
", + "smithy.api#documentation": "The time the most recent patching operation completed on the managed node.
", "smithy.api#required": {} } }, @@ -12567,39 +12588,39 @@ "LastNoRebootInstallOperationTime": { "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "The time of the last attempt to patch the instance with NoReboot specified as\n the reboot option.
The time of the last attempt to patch the managed node with NoReboot specified as\n the reboot option.
Indicates the reboot option specified in the patch baseline.
\nReboot options apply to Install operations only. Reboots aren't attempted for\n Patch Manager Scan operations.
\n RebootIfNeeded: Patch Manager tries to reboot the instance if it installed\n any patches, or if any patches are detected with a status of\n InstalledPendingReboot.
\n NoReboot: Patch Manager attempts to install missing packages without trying\n to reboot the system. Patches installed with this option are assigned a status of\n InstalledPendingReboot. These patches might not be in effect until a reboot is\n performed.
Indicates the reboot option specified in the patch baseline.
\nReboot options apply to Install operations only. Reboots aren't attempted for\n Patch Manager Scan operations.
\n RebootIfNeeded: Patch Manager tries to reboot the managed node if it installed\n any patches, or if any patches are detected with a status of\n InstalledPendingReboot.
\n NoReboot: Patch Manager attempts to install missing packages without trying\n to reboot the system. Patches installed with this option are assigned a status of\n InstalledPendingReboot. These patches might not be in effect until a reboot is\n performed.
The number of instances where patches that are specified as Critical for\n compliance reporting in the patch baseline aren't installed. These patches might be missing, have\n failed installation, were rejected, or were installed but awaiting a required instance reboot.\n The status of these instances is NON_COMPLIANT.
The number of managed nodes where patches that are specified as Critical for\n compliance reporting in the patch baseline aren't installed. These patches might be missing, have\n failed installation, were rejected, or were installed but awaiting a required managed node reboot.\n The status of these managed nodes is NON_COMPLIANT.
The number of instances where patches that are specified as Security in a patch\n advisory aren't installed. These patches might be missing, have failed installation, were\n rejected, or were installed but awaiting a required instance reboot. The status of these\n instances is NON_COMPLIANT.
The number of managed nodes where patches that are specified as Security in a\n patch advisory aren't installed. These patches might be missing, have failed installation, were\n rejected, or were installed but awaiting a required managed node reboot. The status of these managed\n nodes is NON_COMPLIANT.
The number of instances with patches installed that are specified as other than\n Critical or Security but aren't compliant with the patch baseline. The\n status of these instances is NON_COMPLIANT.
The number of managed nodes with patches installed that are specified as other than\n Critical or Security but aren't compliant with the patch baseline. The\n status of these managed nodes is NON_COMPLIANT.
Defines the high-level patch compliance state for a managed instance, providing information\n about the number of installed, missing, not applicable, and failed patches along with metadata\n about the operation when this information was gathered for the instance.
" + "smithy.api#documentation": "Defines the high-level patch compliance state for a managed node, providing information\n about the number of installed, missing, not applicable, and failed patches along with metadata\n about the operation when this information was gathered for the managed node.
" } }, "com.amazonaws.ssm#InstancePatchStateFilter": { @@ -12628,7 +12649,7 @@ } }, "traits": { - "smithy.api#documentation": "Defines a filter used in DescribeInstancePatchStatesForPatchGroup to scope\n down the information returned by the API.
\n\n Example: To filter for all instances in a patch group\n having more than three patches with a FailedCount status, use the following for the\n filter:
Value for Key: FailedCount\n
Value for Type: GreaterThan\n
Value for Values: 3\n
Defines a filter used in DescribeInstancePatchStatesForPatchGroup to scope\n down the information returned by the API.
\n\n Example: To filter for all managed nodes in a patch group\n having more than three patches with a FailedCount status, use the following for the\n filter:
Value for Key: FailedCount\n
Value for Type: GreaterThan\n
Value for Values: 3\n
The following problems can cause this exception:
\nYou don't have permission to access the instance.
\nAmazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is\n running.
\nSSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
\nThe instance isn't in valid state. Valid states are: Running,\n Pending, Stopped, and Stopping. Invalid states are:\n Shutting-down and Terminated.
The following problems can cause this exception:
\nYou don't have permission to access the managed node.
\nAmazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is\n running.
\nSSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
\nThe managed node isn't in valid state. Valid states are: Running,\n Pending, Stopped, and Stopping. Invalid states are:\n Shutting-down and Terminated.
The resource type isn't valid. For example, if you are attempting to tag an instance, the\n instance must be a registered, managed instance.
", + "smithy.api#documentation": "The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the\n instance must be a registered managed node.
", "smithy.api#error": "client" } }, @@ -13694,7 +13715,7 @@ "Values": { "target": "com.amazonaws.ssm#InventoryFilterValueList", "traits": { - "smithy.api#documentation": "Inventory filter values. Example: inventory filter where instance IDs are specified as\n values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g,\n i-1a2b3c4d5e6,Type=Equal.
Inventory filter values. Example: inventory filter where managed node IDs are specified as\n values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g,\n i-1a2b3c4d5e6,Type=Equal.
Information collected from managed instances based on your inventory policy document
" + "smithy.api#documentation": "Information collected from managed nodes based on your inventory policy document
" } }, "com.amazonaws.ssm#InventoryItemAttribute": { @@ -14058,7 +14079,7 @@ "Id": { "target": "com.amazonaws.ssm#InventoryResultEntityId", "traits": { - "smithy.api#documentation": "ID of the inventory result entity. For example, for managed instance inventory the result\n will be the managed instance ID. For EC2 instance inventory, the result will be the instance ID.\n
" + "smithy.api#documentation": "ID of the inventory result entity. For example, for managed node inventory the result\n will be the managed node ID. For EC2 instance inventory, the result will be the instance ID.\n
" } }, "Data": { @@ -14163,7 +14184,7 @@ "code": "InvocationDoesNotExist", "httpResponseCode": 400 }, - "smithy.api#documentation": "The command ID and instance ID you specified didn't match any invocations. Verify the\n command ID and the instance ID and try again.
", + "smithy.api#documentation": "The command ID and managed node ID you specified didn't match any invocations. Verify the\n command ID and the managed node ID and try again.
", "smithy.api#error": "client" } }, @@ -14411,7 +14432,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You\n can limit the results to a specific State Manager association document or instance by specifying\n a filter. State Manager is a capability of Amazon Web Services Systems Manager.
", + "smithy.api#documentation": "Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You\n can limit the results to a specific State Manager association document or managed node by specifying\n a filter. State Manager is a capability of Amazon Web Services Systems Manager.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -14426,7 +14447,7 @@ "AssociationFilterList": { "target": "com.amazonaws.ssm#AssociationFilterList", "traits": { - "smithy.api#documentation": "One or more filters. Use a filter to return a more specific list of results.
\nFiltering associations using the InstanceID attribute only returns legacy\n associations created using the InstanceID attribute. Associations targeting the\n instance that are part of the Target Attributes ResourceGroup or Tags\n aren't returned.
One or more filters. Use a filter to return a more specific list of results.
\nFiltering associations using the InstanceID attribute only returns legacy\n associations created using the InstanceID attribute. Associations targeting the\n managed node that are part of the Target Attributes ResourceGroup or Tags\n aren't returned.
An invocation is copy of a command sent to a specific instance. A command can apply to one\n or more instances. A command invocation applies to one instance. For example, if a user runs\n SendCommand against three instances, then a command invocation is created for each\n requested instance ID. ListCommandInvocations provide status about command\n execution.
An invocation is copy of a command sent to a specific managed node. A command can apply to one\n or more managed nodes. A command invocation applies to one managed node. For example, if a user runs\n SendCommand against three managed nodes, then a command invocation is created for\n each requested managed node ID. ListCommandInvocations provide status about command\n execution.
(Optional) The command execution details for a specific instance ID.
" + "smithy.api#documentation": "(Optional) The command execution details for a specific managed node ID.
" } }, "MaxResults": { @@ -14602,7 +14623,7 @@ "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "(Optional) Lists commands issued against this instance ID.
\nYou can't specify an instance ID in the same command that you specify Status =\n Pending. This is because the command hasn't reached the instance yet.
(Optional) Lists commands issued against this managed node ID.
\nYou can't specify a managed node ID in the same command that you specify Status =\n Pending. This is because the command hasn't reached the managed node yet.
The instance ID for which you want inventory information.
", + "smithy.api#documentation": "The managed node ID for which you want inventory information.
", "smithy.api#required": {} } }, @@ -15126,25 +15147,25 @@ "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "The instance ID targeted by the request to query inventory information.
" + "smithy.api#documentation": "The managed node ID targeted by the request to query inventory information.
" } }, "SchemaVersion": { "target": "com.amazonaws.ssm#InventoryItemSchemaVersion", "traits": { - "smithy.api#documentation": "The inventory schema version used by the instance(s).
" + "smithy.api#documentation": "The inventory schema version used by the managed node(s).
" } }, "CaptureTime": { "target": "com.amazonaws.ssm#InventoryItemCaptureTime", "traits": { - "smithy.api#documentation": "The time that inventory information was collected for the instance(s).
" + "smithy.api#documentation": "The time that inventory information was collected for the managed node(s).
" } }, "Entries": { "target": "com.amazonaws.ssm#InventoryItemEntryList", "traits": { - "smithy.api#documentation": "A list of inventory items on the instance(s).
" + "smithy.api#documentation": "A list of inventory items on the managed node(s).
" } }, "NextToken": { @@ -15434,7 +15455,7 @@ "ResourceComplianceSummaryItems": { "target": "com.amazonaws.ssm#ResourceComplianceSummaryItemList", "traits": { - "smithy.api#documentation": "A summary count for specified or targeted managed instances. Summary count includes\n information about compliant and non-compliant State Manager associations, patch status, or custom\n items according to the filter criteria that you specify.
" + "smithy.api#documentation": "A summary count for specified or targeted managed nodes. Summary count includes information\n about compliant and non-compliant State Manager associations, patch status, or custom items\n according to the filter criteria that you specify.
" } }, "NextToken": { @@ -15593,7 +15614,7 @@ } }, "traits": { - "smithy.api#documentation": "Information about an Amazon Simple Storage Service (Amazon S3) bucket to write\n instance-level logs to.
\n\n LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the\n OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure.\n For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance\n window task types, see MaintenanceWindowTaskInvocationParameters.
Information about an Amazon Simple Storage Service (Amazon S3) bucket to write\n managed node-level logs to.
\n\n LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the\n OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure.\n For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance\n window task types, see MaintenanceWindowTaskInvocationParameters.
Configurations for sending notifications about command status changes on a per-instance\n basis.
" + "smithy.api#documentation": "Configurations for sending notifications about command status changes on a per-managed node\n basis.
" } }, "OutputS3BucketName": { @@ -16369,7 +16390,7 @@ "Targets": { "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "The targets, either instances or tags.
\nSpecify instances using the following format:
\n\n Key=instanceids,Values=\n
Tags are specified using the following format:
\n\n Key=.
The targets, either managed nodes or tags.
\nSpecify managed nodes using the following format:
\n\n Key=instanceids,Values=\n
Tags are specified using the following format:
\n\n Key=.
The targets (either instances or tags). Instances are specified using\n Key=instanceids,Values=. Tags are specified\n using Key=.
The targets (either managed nodes or tags). Managed nodes are specified using\n Key=instanceids,Values=. Tags are specified\n using Key=.
The type of notification.
\n\n Command: Receive notification when the status of a command changes.
\n Invocation: For commands sent to multiple instances, receive notification on\n a per-instance basis when the status of a command changes.
The type of notification.
\n\n Command: Receive notification when the status of a command changes.
\n Invocation: For commands sent to multiple managed nodes, receive notification\n on a per-node basis when the status of a command changes.
The Advisory ID of the patch. For example, RHSA-2020:3779. Applies to\n Linux-based instances only.
The Advisory ID of the patch. For example, RHSA-2020:3779. Applies to\n Linux-based managed nodes only.
The Bugzilla ID of the patch. For example, 1600646. Applies to Linux-based\n instances only.
The Bugzilla ID of the patch. For example, 1600646. Applies to Linux-based\n managed nodes only.
The Common Vulnerabilities and Exposures (CVE) ID of the patch. For example,\n CVE-2011-3192. Applies to Linux-based instances only.
The Common Vulnerabilities and Exposures (CVE) ID of the patch. For example,\n CVE-2011-3192. Applies to Linux-based managed nodes only.
The name of the patch. Applies to Linux-based instances only.
" + "smithy.api#documentation": "The name of the patch. Applies to Linux-based managed nodes only.
" } }, "Epoch": { "target": "com.amazonaws.ssm#PatchEpoch", "traits": { - "smithy.api#documentation": "The epoch of the patch. For example in\n pkg-example-EE-20180914-2.2.amzn1.noarch, the epoch value is\n 20180914-2. Applies to Linux-based instances only.
The epoch of the patch. For example in\n pkg-example-EE-20180914-2.2.amzn1.noarch, the epoch value is\n 20180914-2. Applies to Linux-based managed nodes only.
The version number of the patch. For example, in\n example-pkg-1.710.10-2.7.abcd.x86_64, the version number is indicated by\n -1. Applies to Linux-based instances only.
The version number of the patch. For example, in\n example-pkg-1.710.10-2.7.abcd.x86_64, the version number is indicated by\n -1. Applies to Linux-based managed nodes only.
The particular release of a patch. For example, in\n pkg-example-EE-20180914-2.2.amzn1.noarch, the release is 2.amaz1.\n Applies to Linux-based instances only.
The particular release of a patch. For example, in\n pkg-example-EE-20180914-2.2.amzn1.noarch, the release is 2.amaz1.\n Applies to Linux-based managed nodes only.
The architecture of the patch. For example, in\n example-pkg-0.710.10-2.7.abcd.x86_64, the architecture is indicated by\n x86_64. Applies to Linux-based instances only.
The architecture of the patch. For example, in\n example-pkg-0.710.10-2.7.abcd.x86_64, the architecture is indicated by\n x86_64. Applies to Linux-based managed nodes only.
The source patch repository for the operating system and version, such as\n trusty-security for Ubuntu Server 14.04 LTE and focal-security for\n Ubuntu Server 20.04 LTE. Applies to Linux-based instances only.
The source patch repository for the operating system and version, such as\n trusty-security for Ubuntu Server 14.04 LTE and focal-security for\n Ubuntu Server 20.04 LTE. Applies to Linux-based managed nodes only.
The state of the patch on the instance, such as INSTALLED or FAILED.
\nFor descriptions of each patch state, see About patch compliance in the Amazon Web Services Systems Manager User Guide.
", + "smithy.api#documentation": "The state of the patch on the managed node, such as INSTALLED or FAILED.
\nFor descriptions of each patch state, see About patch compliance in the Amazon Web Services Systems Manager User Guide.
", "smithy.api#required": {} } }, "InstalledTime": { "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "The date/time the patch was installed on the instance. Not all operating systems provide\n this level of information.
", + "smithy.api#documentation": "The date/time the patch was installed on the managed node. Not all operating systems provide\n this level of information.
", "smithy.api#required": {} } }, @@ -19780,7 +19808,7 @@ } }, "traits": { - "smithy.api#documentation": "Information about the state of a patch on a particular instance as it relates to the patch\n baseline used to patch the instance.
" + "smithy.api#documentation": "Information about the state of a patch on a particular managed node as it relates to the patch\n baseline used to patch the node.
" } }, "com.amazonaws.ssm#PatchComplianceDataList": { @@ -20322,7 +20350,7 @@ "target": "com.amazonaws.ssm#Boolean", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "For instances identified by the approval rule filters, enables a patch baseline to apply\n non-security updates available in the specified repository. The default value is\n false. Applies to Linux instances only.
For managed nodes identified by the approval rule filters, enables a patch baseline to apply\n non-security updates available in the specified repository. The default value is\n false. Applies to Linux managed nodes only.
Information about the patches to use to update the instances, including target operating\n systems and source repository. Applies to Linux instances only.
" + "smithy.api#documentation": "Information about the patches to use to update the managed nodes, including target operating\n systems and source repository. Applies to Linux managed nodes only.
" } }, "com.amazonaws.ssm#PatchSourceConfiguration": { @@ -20533,6 +20561,10 @@ { "value": "Linux", "name": "LINUX" + }, + { + "value": "MacOS", + "name": "MACOS" } ] } @@ -20635,7 +20667,7 @@ } ], "traits": { - "smithy.api#documentation": "Registers a compliance type and other compliance details on a designated resource. This\n operation lets you register custom compliance details with a resource. This call overwrites\n existing compliance information on the resource, so you must provide a full list of compliance\n items each time that you send the request.
\nComplianceType can be one of the following:
\nExecutionId: The execution ID when the patch, association, or custom compliance item was\n applied.
\nExecutionType: Specify patch, association, or Custom:string.
ExecutionTime. The time the patch, association, or custom compliance item was applied to\n the instance.
\nId: The patch, association, or custom compliance ID.
\nTitle: A title.
\nStatus: The status of the compliance item. For example, approved for patches,\n or Failed for associations.
Severity: A patch severity. For example, critical.
DocumentName: An SSM document name. For example, AWS-RunPatchBaseline.
DocumentVersion: An SSM document version number. For example, 4.
\nClassification: A patch classification. For example, security updates.
PatchBaselineId: A patch baseline ID.
\nPatchSeverity: A patch severity. For example, Critical.
PatchState: A patch state. For example, InstancesWithFailedPatches.
PatchGroup: The name of a patch group.
\nInstalledTime: The time the association, patch, or custom compliance item was applied to\n the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
\nRegisters a compliance type and other compliance details on a designated resource. This\n operation lets you register custom compliance details with a resource. This call overwrites\n existing compliance information on the resource, so you must provide a full list of compliance\n items each time that you send the request.
\nComplianceType can be one of the following:
\nExecutionId: The execution ID when the patch, association, or custom compliance item was\n applied.
\nExecutionType: Specify patch, association, or Custom:string.
ExecutionTime. The time the patch, association, or custom compliance item was applied to\n the managed node.
\nId: The patch, association, or custom compliance ID.
\nTitle: A title.
\nStatus: The status of the compliance item. For example, approved for patches,\n or Failed for associations.
Severity: A patch severity. For example, critical.
DocumentName: An SSM document name. For example, AWS-RunPatchBaseline.
DocumentVersion: An SSM document version number. For example, 4.
\nClassification: A patch classification. For example, security updates.
PatchBaselineId: A patch baseline ID.
\nPatchSeverity: A patch severity. For example, Critical.
PatchState: A patch state. For example, InstancesWithFailedPatches.
PatchGroup: The name of a patch group.
\nInstalledTime: The time the association, patch, or custom compliance item was applied to\n the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
\nSpecify an ID for this resource. For a managed instance, this is the instance ID.
", + "smithy.api#documentation": "Specify an ID for this resource. For a managed node, this is the node ID.
", "smithy.api#required": {} } }, @@ -20741,7 +20773,7 @@ } ], "traits": { - "smithy.api#documentation": "Bulk update custom inventory items on one more instance. The request adds an inventory item,\n if it doesn't already exist, or updates an inventory item, if it does exist.
" + "smithy.api#documentation": "Bulk update custom inventory items on one or more managed nodes. The request adds an inventory item,\n if it doesn't already exist, or updates an inventory item, if it does exist.
" } }, "com.amazonaws.ssm#PutInventoryMessage": { @@ -20753,14 +20785,14 @@ "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "An instance ID where you want to add or update inventory items.
", + "smithy.api#documentation": "An managed node ID where you want to add or update inventory items.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.ssm#InventoryItemList", "traits": { - "smithy.api#documentation": "The inventory items that you want to add or update on instances.
", + "smithy.api#documentation": "The inventory items that you want to add or update on managed nodes.
", "smithy.api#required": {} } } @@ -20899,7 +20931,7 @@ "Policies": { "target": "com.amazonaws.ssm#ParameterPolicies", "traits": { - "smithy.api#documentation": "One or more policies to apply to a parameter. This operation takes a JSON array. Parameter\n Store, a capability of Amazon Web Services Systems Manager supports the following policy types:
\nExpiration: This policy deletes the parameter after it expires. When you create the policy,\n you specify the expiration date. You can update the expiration date and time by updating the\n policy. Updating the parameter doesn't affect the expiration date and time.\n When the expiration time is reached, Parameter Store deletes the parameter.
\nExpirationNotification: This policy triggers an event in Amazon CloudWatch Events that\n notifies you about the expiration. By using this policy, you can receive notification before or\n after the expiration time is reached, in units of days or hours.
\nNoChangeNotification: This policy triggers a CloudWatch Events event if a parameter hasn't\n been modified for a specified period of time. This policy type is useful when, for example, a\n secret needs to be changed within a period of time, but it hasn't been changed.
\nAll existing policies are preserved until you send new policies or an empty policy. For more\n information about parameter policies, see Assigning parameter\n policies.
" + "smithy.api#documentation": "One or more policies to apply to a parameter. This operation takes a JSON array. Parameter\n Store, a capability of Amazon Web Services Systems Manager supports the following policy types:
\nExpiration: This policy deletes the parameter after it expires. When you create the policy,\n you specify the expiration date. You can update the expiration date and time by updating the\n policy. Updating the parameter doesn't affect the expiration date and time.\n When the expiration time is reached, Parameter Store deletes the parameter.
\nExpirationNotification: This policy initiates an event in Amazon CloudWatch Events that\n notifies you about the expiration. By using this policy, you can receive notification before or\n after the expiration time is reached, in units of days or hours.
\nNoChangeNotification: This policy initiates a CloudWatch Events event if a parameter hasn't\n been modified for a specified period of time. This policy type is useful when, for example, a\n secret needs to be changed within a period of time, but it hasn't been changed.
\nAll existing policies are preserved until you send new policies or an empty policy. For more\n information about parameter policies, see Assigning parameter\n policies.
" } }, "DataType": { @@ -21114,7 +21146,7 @@ "Targets": { "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "The targets to register with the maintenance window. In other words, the instances to run\n commands on when the maintenance window runs.
\nIf a single maintenance window task is registered with multiple targets, its task\n invocations occur sequentially and not in parallel. If your task must run on multiple targets at\n the same time, register a task for each target individually and assign each task the same\n priority level.
\nYou can specify targets using instance IDs, resource group names, or tags that have been\n applied to instances.
\n\n Example 1: Specify instance IDs
\n\n Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3\n \n
\n Example 2: Use tag key-pairs applied to instances
\n\n Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2\n \n
\n Example 3: Use tag-keys applied to instances
\n\n Key=tag-key,Values=my-tag-key-1,my-tag-key-2\n \n
\n Example 4: Use resource group names
\n\n Key=resource-groups:Name,Values=resource-group-name\n \n
\n Example 5: Use filters for resource group types
\n\n Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2\n \n
For Key=resource-groups:ResourceTypeFilters, specify resource types in the\n following format
\n Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC\n \n
For more information about these examples formats, including the best use case for each one,\n see Examples: Register\n targets with a maintenance window in the Amazon Web Services Systems Manager User Guide.
", + "smithy.api#documentation": "The targets to register with the maintenance window. In other words, the managed nodes to\n run commands on when the maintenance window runs.
\nIf a single maintenance window task is registered with multiple targets, its task\n invocations occur sequentially and not in parallel. If your task must run on multiple targets at\n the same time, register a task for each target individually and assign each task the same\n priority level.
\nYou can specify targets using managed node IDs, resource group names, or tags that have been\n applied to managed nodes.
\n\n Example 1: Specify managed node IDs
\n\n Key=InstanceIds,Values=\n
\n Example 2: Use tag key-pairs applied to managed\n nodes
\n\n Key=tag:\n
\n Example 3: Use tag-keys applied to managed nodes
\n\n Key=tag-key,Values=\n
\n Example 4: Use resource group names
\n\n Key=resource-groups:Name,Values=\n
\n Example 5: Use filters for resource group types
\n\n Key=resource-groups:ResourceTypeFilters,Values=\n
For Key=resource-groups:ResourceTypeFilters, specify resource types in the\n following format
\n Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC\n
For more information about these examples formats, including the best use case for each one,\n see Examples: Register\n targets with a maintenance window in the Amazon Web Services Systems Manager User Guide.
", "smithy.api#required": {} } }, @@ -21198,7 +21230,7 @@ "Targets": { "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "The targets (either instances or maintenance window targets).
\nOne or more targets must be specified for maintenance window Run Command-type tasks.\n Depending on the task, targets are optional for other maintenance window task types (Automation,\n Lambda, and Step Functions). For more information about running tasks\n that don't specify targets, see Registering\n maintenance window tasks without targets in the\n Amazon Web Services Systems Manager User Guide.
\nSpecify instances using the following format:
\n\n Key=InstanceIds,Values=\n
Specify maintenance window targets using the following format:
\n\n Key=WindowTargetIds,Values=\n
The targets (either managed nodes or maintenance window targets).
\nOne or more targets must be specified for maintenance window Run Command-type tasks.\n Depending on the task, targets are optional for other maintenance window task types (Automation,\n Lambda, and Step Functions). For more information about running tasks\n that don't specify targets, see Registering\n maintenance window tasks without targets in the\n Amazon Web Services Systems Manager User Guide.
\nSpecify managed nodes using the following format:
\n\n Key=InstanceIds,Values=\n
Specify maintenance window targets using the following format:
\n\n Key=WindowTargetIds,Values=\n
A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket\n to write instance-level logs to.
\n\n LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the\n OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure.\n For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance\n window task types, see MaintenanceWindowTaskInvocationParameters.
A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket\n to write managed node-level logs to.
\n\n LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the\n OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure.\n For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance\n window task types, see MaintenanceWindowTaskInvocationParameters.
Reserved for internal use.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.ssm#RegistrationMetadataValue", + "traits": { + "smithy.api#documentation": "Reserved for internal use.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Reserved for internal use.
" + } + }, + "com.amazonaws.ssm#RegistrationMetadataKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!\\s*$).+$" + } + }, + "com.amazonaws.ssm#RegistrationMetadataList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssm#RegistrationMetadataItem" + } + }, + "com.amazonaws.ssm#RegistrationMetadataValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(?!\\s*$).+$" + } + }, "com.amazonaws.ssm#RegistrationsCount": { "type": "integer", "traits": { @@ -21370,14 +21450,14 @@ "ResourceType": { "target": "com.amazonaws.ssm#ResourceTypeForTagging", "traits": { - "smithy.api#documentation": "The type of resource from which you want to remove a tag.
\nThe ManagedInstance type for this API operation is only for on-premises\n managed instances. Specify the name of the managed instance in the following format:\n mi-ID_number\n . For example,\n mi-1a2b3c4d5e6f.
The type of resource from which you want to remove a tag.
\nThe ManagedInstance type for this API operation is only for on-premises\n managed nodes. Specify the name of the managed node in the following format:\n mi-ID_number\n . For example,\n mi-1a2b3c4d5e6f.
The ID of the resource from which you want to remove tags. For example:
\nManagedInstance: mi-012345abcde
\nMaintenanceWindow: mw-012345abcde
\nPatchBaseline: pb-012345abcde
\nOpsMetadata object: ResourceID for tagging is created from the Amazon Resource\n Name (ARN) for the object. Specifically, ResourceID is created from the strings that\n come after the word opsmetadata in the ARN. For example, an OpsMetadata object with\n an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager\n has a ResourceID of either aws/ssm/MyGroup/appmanager or\n /aws/ssm/MyGroup/appmanager.
For the Document and Parameter values, use the name of the resource.
\nThe ManagedInstance type for this API operation is only for on-premises managed instances.\n Specify the name of the managed instance in the following format: mi-ID_number. For example,\n mi-1a2b3c4d5e6f.
\nThe ID of the resource from which you want to remove tags. For example:
\nManagedInstance: mi-012345abcde
\nMaintenanceWindow: mw-012345abcde
\nPatchBaseline: pb-012345abcde
\nOpsMetadata object: ResourceID for tagging is created from the Amazon Resource\n Name (ARN) for the object. Specifically, ResourceID is created from the strings that\n come after the word opsmetadata in the ARN. For example, an OpsMetadata object with\n an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager\n has a ResourceID of either aws/ssm/MyGroup/appmanager or\n /aws/ssm/MyGroup/appmanager.
For the Document and Parameter values, use the name of the resource.
\nThe ManagedInstance type for this API operation is only for on-premises\n managed nodes. Specify the name of the managed node in the following format: mi-ID_number. For\n example, mi-1a2b3c4d5e6f.
Reconnects a session to an instance after it has been disconnected. Connections can be\n resumed for disconnected sessions, but not terminated sessions.
\nThis command is primarily for use by client machines to automatically reconnect during\n intermittent network issues. It isn't intended for any other use.
\nReconnects a session to a managed node after it has been disconnected. Connections can be\n resumed for disconnected sessions, but not terminated sessions.
\nThis command is primarily for use by client machines to automatically reconnect during\n intermittent network issues. It isn't intended for any other use.
\nAn encrypted token value containing session and caller information. Used to authenticate the\n connection to the instance.
" + "smithy.api#documentation": "An encrypted token value containing session and caller information. Used to authenticate the\n connection to the managed node.
" } }, "StreamUrl": { "target": "com.amazonaws.ssm#StreamUrl", "traits": { - "smithy.api#documentation": "A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and\n receive output from the instance. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output).
\n region represents the Region identifier for an\n\t\t\t\t\t\tAmazon Web Services Region supported by Amazon Web Services Systems Manager, such as us-east-2 for the US East (Ohio) Region.\n\t\t\t\t\t\tFor a list of supported region values, see the Region column in Systems Manager service endpoints in the\n Amazon Web Services General Reference.
\n session-id represents the ID of a Session Manager session, such as\n 1a2b3c4dEXAMPLE.
A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and\n receive output from the managed node. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output).
\n region represents the Region identifier for an\n\t\t\t\t\t\tAmazon Web Services Region supported by Amazon Web Services Systems Manager, such as us-east-2 for the US East (Ohio) Region.\n\t\t\t\t\t\tFor a list of supported region values, see the Region column in Systems Manager service endpoints in the\n Amazon Web Services General Reference.
\n session-id represents the ID of a Session Manager session, such as\n 1a2b3c4dEXAMPLE.
Runs commands on one or more managed instances.
" + "smithy.api#documentation": "Runs commands on one or more managed nodes.
" } }, "com.amazonaws.ssm#SendCommandRequest": { @@ -22563,13 +22643,13 @@ "InstanceIds": { "target": "com.amazonaws.ssm#InstanceIdList", "traits": { - "smithy.api#documentation": "The IDs of the instances where the command should run. Specifying instance IDs is most\n useful when you are targeting a limited number of instances, though you can specify up to 50\n IDs.
\nTo target a larger number of instances, or if you prefer not to list individual instance\n IDs, we recommend using the Targets option instead. Using Targets,\n which accepts tag key-value pairs to identify the instances to send commands to, you can a send\n command to tens, hundreds, or thousands of instances at once.
For more information about how to use targets, see Using targets and rate\n controls to send commands to a fleet in the\n Amazon Web Services Systems Manager User Guide.
" + "smithy.api#documentation": "The IDs of the managed nodes where the command should run. Specifying managed node IDs is most\n useful when you are targeting a limited number of managed nodes, though you can specify up to 50\n IDs.
\nTo target a larger number of managed nodes, or if you prefer not to list individual node\n IDs, we recommend using the Targets option instead. Using Targets,\n which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a\n send command to tens, hundreds, or thousands of nodes at once.
For more information about how to use targets, see Using targets and rate\n controls to send commands to a fleet in the\n Amazon Web Services Systems Manager User Guide.
" } }, "Targets": { "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "An array of search criteria that targets instances using a Key,Value\n combination that you specify. Specifying targets is most useful when you want to send a command\n to a large number of instances at once. Using Targets, which accepts tag key-value\n pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances\n at once.
To send a command to a smaller number of instances, you can use the InstanceIds\n option instead.
For more information about how to use targets, see Sending commands to a\n fleet in the Amazon Web Services Systems Manager User Guide.
" + "smithy.api#documentation": "An array of search criteria that targets managed nodes using a Key,Value\n combination that you specify. Specifying targets is most useful when you want to send a command\n to a large number of managed nodes at once. Using Targets, which accepts tag\n key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands\n of nodes at once.
To send a command to a smaller number of managed nodes, you can use the\n InstanceIds option instead.
For more information about how to use targets, see Sending commands to a\n fleet in the Amazon Web Services Systems Manager User Guide.
" } }, "DocumentName": { @@ -22637,7 +22717,7 @@ "MaxConcurrency": { "target": "com.amazonaws.ssm#MaxConcurrency", "traits": { - "smithy.api#documentation": "(Optional) The maximum number of instances that are allowed to run the command at the same\n time. You can specify a number such as 10 or a percentage such as 10%. The default value is\n 50. For more information about how to use MaxConcurrency, see Using\n concurrency controls in the Amazon Web Services Systems Manager User Guide.
(Optional) The maximum number of managed nodes that are allowed to run the command at the\n same time. You can specify a number such as 10 or a percentage such as 10%. The default value is\n 50. For more information about how to use MaxConcurrency, see Using\n concurrency controls in the Amazon Web Services Systems Manager User Guide.
The instance that the Session Manager session connected to.
" + "smithy.api#documentation": "The managed node that the Session Manager session connected to.
" } }, "Status": { @@ -22829,7 +22909,7 @@ } }, "traits": { - "smithy.api#documentation": "Information about a Session Manager connection to an instance.
" + "smithy.api#documentation": "Information about a Session Manager connection to a managed node.
" } }, "com.amazonaws.ssm#SessionDetails": { @@ -22854,7 +22934,7 @@ "value": { "target": "com.amazonaws.ssm#SessionFilterValue", "traits": { - "smithy.api#documentation": "The filter value. Valid values for each filter key are as follows:
\nInvokedAfter: Specify a timestamp to limit your results. For example, specify\n 2018-08-29T00:00:00Z to see sessions that started August 29, 2018, and later.
\nInvokedBefore: Specify a timestamp to limit your results. For example, specify\n 2018-08-29T00:00:00Z to see sessions that started before August 29, 2018.
\nTarget: Specify an instance to which session connections have been made.
\nOwner: Specify an Amazon Web Services user account to see a list of sessions started by that\n user.
\nStatus: Specify a valid session status to see a list of all sessions with that status.\n Status values you can specify include:
\nConnected
\nConnecting
\nDisconnected
\nTerminated
\nTerminating
\nFailed
\nSessionId: Specify a session ID to return details about the session.
\nThe filter value. Valid values for each filter key are as follows:
\nInvokedAfter: Specify a timestamp to limit your results. For example, specify\n 2018-08-29T00:00:00Z to see sessions that started August 29, 2018, and later.
\nInvokedBefore: Specify a timestamp to limit your results. For example, specify\n 2018-08-29T00:00:00Z to see sessions that started before August 29, 2018.
\nTarget: Specify a managed node to which session connections have been made.
\nOwner: Specify an Amazon Web Services user account to see a list of sessions started by that\n user.
\nStatus: Specify a valid session status to see a list of all sessions with that status.\n Status values you can specify include:
\nConnected
\nConnecting
\nDisconnected
\nTerminated
\nTerminating
\nFailed
\nSessionId: Specify a session ID to return details about the session.
\nThe number of managed instances found for each patch severity level defined in the request\n filter.
" + "smithy.api#documentation": "The number of managed nodes found for each patch severity level defined in the request\n filter.
" } }, "com.amazonaws.ssm#SharedDocumentVersion": { @@ -23179,6 +23259,35 @@ "smithy.api#pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } }, + "com.amazonaws.ssm#SourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9:_-]*$" + } + }, + "com.amazonaws.ssm#SourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWS::EC2::Instance", + "name": "AWS_EC2_INSTANCE" + }, + { + "value": "AWS::IoT::Thing", + "name": "AWS_IOT_THING" + }, + { + "value": "AWS::SSM::ManagedInstance", + "name": "AWS_SSM_MANAGEDINSTANCE" + } + ] + } + }, "com.amazonaws.ssm#StandardErrorContent": { "type": "string", "traits": { @@ -23496,7 +23605,7 @@ } ], "traits": { - "smithy.api#documentation": "Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a\n URL and token that can be used to open a WebSocket connection for sending input and receiving\n outputs.
\nAmazon Web Services CLI usage: start-session is an interactive command that requires the Session Manager\n plugin to be installed on the client machine making the call. For information, see Install\n the Session Manager plugin for the Amazon Web Services CLI in the Amazon Web Services Systems Manager User Guide.
Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools\n for PowerShell on Windows local machines.
\nInitiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a\n URL and token that can be used to open a WebSocket connection for sending input and receiving\n outputs.
\nAmazon Web Services CLI usage: start-session is an interactive command that requires the Session Manager\n plugin to be installed on the client machine making the call. For information, see Install\n the Session Manager plugin for the Amazon Web Services CLI in the Amazon Web Services Systems Manager User Guide.
Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools\n for PowerShell on Windows local machines.
\nThe instance to connect to for the session.
", + "smithy.api#documentation": "The managed node to connect to for the session.
", "smithy.api#required": {} } }, "DocumentName": { "target": "com.amazonaws.ssm#DocumentARN", "traits": { - "smithy.api#documentation": "The name of the SSM document to define the parameters and plugin settings for the session.\n For example, SSM-SessionManagerRunShell. You can call the GetDocument API to verify the document exists before attempting to start a session.\n If no document name is provided, a shell to the instance is launched by default.
The name of the SSM document to define the parameters and plugin settings for the session.\n For example, SSM-SessionManagerRunShell. You can call the GetDocument API to verify the document exists before attempting to start a session.\n If no document name is provided, a shell to the managed node is launched by default.
The reason for connecting to the instance. This value is included in the details for the Amazon CloudWatch Events event created when you start the session.
" + "smithy.api#documentation": "The reason for connecting to the instance. This value is included in the details for the\n Amazon CloudWatch Events event created when you start the session.
" } }, "Parameters": { @@ -23541,13 +23650,13 @@ "TokenValue": { "target": "com.amazonaws.ssm#TokenValue", "traits": { - "smithy.api#documentation": "An encrypted token value containing session and caller information. Used to authenticate the\n connection to the instance.
" + "smithy.api#documentation": "An encrypted token value containing session and caller information. Used to authenticate the\n connection to the managed node.
" } }, "StreamUrl": { "target": "com.amazonaws.ssm#StreamUrl", "traits": { - "smithy.api#documentation": "A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and\n receive output from the instance. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)\n
\n region represents the Region identifier for an\n\t\t\t\t\t\tAmazon Web Services Region supported by Amazon Web Services Systems Manager, such as us-east-2 for the US East (Ohio) Region.\n\t\t\t\t\t\tFor a list of supported region values, see the Region column in Systems Manager service endpoints in the\n Amazon Web Services General Reference.
\n session-id represents the ID of a Session Manager session, such as\n 1a2b3c4dEXAMPLE.
A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and\n receive output from the node. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)\n
\n region represents the Region identifier for an\n\t\t\t\t\t\tAmazon Web Services Region supported by Amazon Web Services Systems Manager, such as us-east-2 for the US East (Ohio) Region.\n\t\t\t\t\t\tFor a list of supported region values, see the Region column in Systems Manager service endpoints in the\n Amazon Web Services General Reference.
\n session-id represents the ID of a Session Manager session, such as\n 1a2b3c4dEXAMPLE.
Metadata that you assign to your Amazon Web Services resources. Tags enable you to categorize your\n resources in different ways, for example, by purpose, owner, or environment. In Amazon Web Services Systems Manager, you\n can apply tags to Systems Manager documents (SSM documents), managed instances, maintenance windows,\n parameters, patch baselines, OpsItems, and OpsMetadata.
" + "smithy.api#documentation": "Metadata that you assign to your Amazon Web Services resources. Tags enable you to categorize your\n resources in different ways, for example, by purpose, owner, or environment. In Amazon Web Services Systems Manager, you\n can apply tags to Systems Manager documents (SSM documents), managed nodes, maintenance windows,\n parameters, patch baselines, OpsItems, and OpsMetadata.
" } }, "com.amazonaws.ssm#TagKey": { @@ -23984,7 +24093,7 @@ "Key": { "target": "com.amazonaws.ssm#TargetKey", "traits": { - "smithy.api#documentation": "User-defined criteria for sending commands that target instances that meet the\n criteria.
" + "smithy.api#documentation": "User-defined criteria for sending commands that target managed nodes that meet the\n criteria.
" } }, "Values": { @@ -23995,7 +24104,7 @@ } }, "traits": { - "smithy.api#documentation": "An array of search criteria that targets instances using a key-value pair that you\n specify.
\nOne or more targets must be specified for maintenance window Run Command-type tasks.\n Depending on the task, targets are optional for other maintenance window task types (Automation,\n Lambda, and Step Functions). For more information about running tasks\n that don't specify targets, see Registering\n maintenance window tasks without targets in the\n Amazon Web Services Systems Manager User Guide.
\nSupported formats include the following.
\n\n Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3\n \n
\n Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2\n \n
\n Key=tag-key,Values=my-tag-key-1,my-tag-key-2\n \n
\n Run Command and Maintenance window targets only:\n Key=resource-groups:Name,Values=resource-group-name\n \n
\n Maintenance window targets only:\n Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2\n \n
\n Automation targets only:\n Key=ResourceGroup;Values=resource-group-name\n \n
For example:
\n\n Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE\n
\n Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3\n
\n Key=tag-key,Values=Name,Instance-Type,CostCenter\n
\n Run Command and Maintenance window targets only:\n Key=resource-groups:Name,Values=ProductionResourceGroup\n
This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.
\n\n Maintenance window targets only:\n Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC\n \n
This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2)\n instances and VPCs in your maintenance window.
\n\n Automation targets only:\n Key=ResourceGroup,Values=MyResourceGroup\n
\n State Manager association targets only:\n Key=InstanceIds,Values=*\n \n
This example demonstrates how to target all managed instances in the Amazon Web Services Region where\n the association was created.
\nFor more information about how to send commands that target instances using\n Key,Value parameters, see Targeting multiple instances in the Amazon Web Services Systems Manager User Guide.
An array of search criteria that targets managed nodes using a key-value pair that you\n specify.
\nOne or more targets must be specified for maintenance window Run Command-type tasks.\n Depending on the task, targets are optional for other maintenance window task types (Automation,\n Lambda, and Step Functions). For more information about running tasks\n that don't specify targets, see Registering\n maintenance window tasks without targets in the\n Amazon Web Services Systems Manager User Guide.
\nSupported formats include the following.
\n\n Key=InstanceIds,Values=\n
\n Key=tag:\n
\n Key=tag-key,Values=\n
\n Run Command and Maintenance window targets only:\n Key=resource-groups:Name,Values=\n
\n Maintenance window targets only:\n Key=resource-groups:ResourceTypeFilters,Values=\n
\n Automation targets only:\n Key=ResourceGroup;Values=\n
For example:
\n\n Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE\n
\n Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3\n
\n Key=tag-key,Values=Name,Instance-Type,CostCenter\n
\n Run Command and Maintenance window targets only:\n Key=resource-groups:Name,Values=ProductionResourceGroup\n
This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.
\n\n Maintenance window targets only:\n Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC\n
This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2)\n instances and VPCs in your maintenance window.
\n\n Automation targets only:\n Key=ResourceGroup,Values=MyResourceGroup\n
\n State Manager association targets only:\n Key=InstanceIds,Values=*\n
This example demonstrates how to target all managed instances in the Amazon Web Services Region where\n the association was created.
\nFor more information about how to send commands that target managed nodes using\n Key,Value parameters, see Targeting multiple instances in the Amazon Web Services Systems Manager User Guide.
The specified target instance for the session isn't fully configured for use with Session Manager. For\n more information, see Getting started with\n Session Manager in the Amazon Web Services Systems Manager User Guide. This error is also returned if you\n attempt to start a session on an instance that is located in a different account or Region
", + "smithy.api#documentation": "The specified target managed node for the session isn't fully configured for use with Session Manager. For\n more information, see Getting started with\n Session Manager in the Amazon Web Services Systems Manager User Guide. This error is also returned if you\n attempt to start a session on a managed node that is located in a different account or Region
", "smithy.api#error": "client" } }, @@ -24210,7 +24319,7 @@ } ], "traits": { - "smithy.api#documentation": "Permanently ends a session and closes the data connection between the Session Manager client and\n SSM Agent on the instance. A terminated session isn't be resumed.
" + "smithy.api#documentation": "Permanently ends a session and closes the data connection between the Session Manager client and\n SSM Agent on the managed node. A terminated session isn't be resumed.
" } }, "com.amazonaws.ssm#TerminateSessionRequest": { @@ -24488,7 +24597,7 @@ "code": "UnsupportedPlatformType", "httpResponseCode": 400 }, - "smithy.api#documentation": "The document doesn't support the platform type of the given instance ID(s). For example, you\n sent an document for a Windows instance to a Linux instance.
", + "smithy.api#documentation": "The document doesn't support the platform type of the given managed node ID(s). For example, you\n sent an document for a Windows managed node to a Linux node.
", "smithy.api#error": "client" } }, @@ -24579,7 +24688,7 @@ "Name": { "target": "com.amazonaws.ssm#DocumentARN", "traits": { - "smithy.api#documentation": "The name of the SSM Command document or Automation runbook that contains the configuration\n information for the instance.
\nYou can specify Amazon Web Services-predefined documents, documents you created, or a document that is\n shared with you from another account.
\nFor Systems Manager document (SSM document) that are shared with you from other Amazon Web Services accounts, you\n must specify the complete SSM document ARN, in the following format:
\n\n arn:aws:ssm:region:account-id:document/document-name\n \n
For example:
\n\n arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document\n
For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need\n to specify the document name. For example, AWS-ApplyPatchBaseline or\n My-Document.
The name of the SSM Command document or Automation runbook that contains the configuration\n information for the managed node.
\nYou can specify Amazon Web Services-predefined documents, documents you created, or a document that is\n shared with you from another account.
\nFor Systems Manager document (SSM document) that are shared with you from other Amazon Web Services accounts, you\n must specify the complete SSM document ARN, in the following format:
\n\n arn:aws:ssm:region:account-id:document/document-name\n \n
For example:
\n\n arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document\n
For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need\n to specify the document name. For example, AWS-ApplyPatchBaseline or\n My-Document.
The number of errors that are allowed before the system stops sending requests to run the\n association on additional targets. You can specify either an absolute number of errors, for\n example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,\n the system stops sending requests when the fourth error is received. If you specify 0, then the\n system stops sending requests after the first error is returned. If you run an association on 50\n instances and set MaxError to 10%, then the system stops sending the request when\n the sixth error is received.
Executions that are already running an association when MaxErrors is reached\n are allowed to complete, but some of these executions may fail as well. If you need to ensure\n that there won't be more than max-errors failed executions, set MaxConcurrency to 1\n so that executions proceed one at a time.
The number of errors that are allowed before the system stops sending requests to run the\n association on additional targets. You can specify either an absolute number of errors, for\n example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,\n the system stops sending requests when the fourth error is received. If you specify 0, then the\n system stops sending requests after the first error is returned. If you run an association on 50\n managed nodes and set MaxError to 10%, then the system stops sending the request\n when the sixth error is received.
Executions that are already running an association when MaxErrors is reached\n are allowed to complete, but some of these executions may fail as well. If you need to ensure\n that there won't be more than max-errors failed executions, set MaxConcurrency to 1\n so that executions proceed one at a time.
The maximum number of targets allowed to run the association at the same time. You can\n specify a number, for example 10, or a percentage of the target set, for example 10%. The default\n value is 100%, which means all targets run the association at the same time.
\nIf a new instance starts and attempts to run an association while Systems Manager is running\n MaxConcurrency associations, the association is allowed to run. During the next\n association interval, the new instance will process its association within the limit specified\n for MaxConcurrency.
The maximum number of targets allowed to run the association at the same time. You can\n specify a number, for example 10, or a percentage of the target set, for example 10%. The default\n value is 100%, which means all targets run the association at the same time.
\nIf a new managed node starts and attempts to run an association while Systems Manager is running\n MaxConcurrency associations, the association is allowed to run. During the next\n association interval, the new managed node will process its association within the limit specified\n for MaxConcurrency.
Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified\n instance.
\n\n UpdateAssociationStatus is primarily used by the Amazon Web Services Systems Manager Agent (SSM Agent) to\n report status updates about your associations and is only used for associations created with the\n InstanceId legacy parameter.
Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified\n managed node.
\n\n UpdateAssociationStatus is primarily used by the Amazon Web Services Systems Manager Agent (SSM Agent) to\n report status updates about your associations and is only used for associations created with the\n InstanceId legacy parameter.
The instance ID.
", + "smithy.api#documentation": "The managed node ID.
", "smithy.api#required": {} } }, @@ -25290,7 +25399,7 @@ "Targets": { "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "The targets (either instances or tags) to modify. Instances are specified using the format\n Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using the\n format Key=tag_name,Values=tag_value.
One or more targets must be specified for maintenance window Run Command-type tasks.\n Depending on the task, targets are optional for other maintenance window task types (Automation,\n Lambda, and Step Functions). For more information about running tasks\n that don't specify targets, see Registering\n maintenance window tasks without targets in the\n Amazon Web Services Systems Manager User Guide.
\nThe targets (either managed nodes or tags) to modify. Managed nodes are specified using the\n format Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using\n the format Key=tag_name,Values=tag_value.
One or more targets must be specified for maintenance window Run Command-type tasks.\n Depending on the task, targets are optional for other maintenance window task types (Automation,\n Lambda, and Step Functions). For more information about running tasks\n that don't specify targets, see Registering\n maintenance window tasks without targets in the\n Amazon Web Services Systems Manager User Guide.
\nChanges the Identity and Access Management (IAM) role that is assigned to the\n on-premises instance or virtual machines (VM). IAM roles are first assigned to\n these hybrid instances during the activation process. For more information, see CreateActivation.
" + "smithy.api#documentation": "Changes the Identity and Access Management (IAM) role that is assigned to the\n on-premises server, edge device, or virtual machines (VM). IAM roles are first\n assigned to these hybrid nodes during the activation process. For more information, see CreateActivation.
" } }, "com.amazonaws.ssm#UpdateManagedInstanceRoleRequest": { @@ -25484,7 +25593,7 @@ "InstanceId": { "target": "com.amazonaws.ssm#ManagedInstanceId", "traits": { - "smithy.api#documentation": "The ID of the managed instance where you want to update the role.
", + "smithy.api#documentation": "The ID of the managed node where you want to update the role.
", "smithy.api#required": {} } }, @@ -25758,7 +25867,7 @@ "target": "com.amazonaws.ssm#Boolean", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "Indicates whether the list of approved patches includes non-security updates that should be\n applied to the instances. The default value is false. Applies to Linux instances\n only.
Indicates whether the list of approved patches includes non-security updates that should be\n applied to the managed nodes. The default value is false. Applies to Linux managed\n nodes only.
Information about the patches to use to update the instances, including target operating\n systems and source repositories. Applies to Linux instances only.
" + "smithy.api#documentation": "Information about the patches to use to update the managed nodes, including target operating\n systems and source repositories. Applies to Linux managed nodes only.
" } }, "Replace": { @@ -25843,7 +25952,7 @@ "target": "com.amazonaws.ssm#Boolean", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "Indicates whether the list of approved patches includes non-security updates that should be\n applied to the instances. The default value is false. Applies to Linux instances\n only.
Indicates whether the list of approved patches includes non-security updates that should be\n applied to the managed nodes. The default value is false. Applies to Linux managed\n nodes only.
Information about the patches to use to update the instances, including target operating\n systems and source repositories. Applies to Linux instances only.
" + "smithy.api#documentation": "Information about the patches to use to update the managed nodes, including target operating\n systems and source repositories. Applies to Linux managed nodes only.
" } } } diff --git a/aws/sdk/aws-models/storagegateway.json b/aws/sdk/aws-models/storagegateway.json index 5905d401d1895ac7570b6f07145577da7eea6bbb..3b198e6a0f8f1fec990635ad824313229c7c8558 100644 --- a/aws/sdk/aws-models/storagegateway.json +++ b/aws/sdk/aws-models/storagegateway.json @@ -83,7 +83,7 @@ "GatewayType": { "target": "com.amazonaws.storagegateway#GatewayType", "traits": { - "smithy.api#documentation": "A value that defines the type of gateway to activate. The type specified is critical to\n all later functions of the gateway and cannot be changed after activation. The default\n value is CACHED.
Valid Values: STORED | CACHED | VTL |\n FILE_S3 | FILE_FSX_SMB|\n
A value that defines the type of gateway to activate. The type specified is critical to\n all later functions of the gateway and cannot be changed after activation. The default\n value is CACHED.
Valid Values: STORED | CACHED | VTL |\n VTL_SNOW | FILE_S3 | FILE_FSX_SMB\n
The type of hypervisor environment used by the host.
" + "smithy.api#documentation": "The type of hardware or software platform on which the gateway is running.
" } }, "EndpointType": { @@ -3190,6 +3190,12 @@ "traits": { "smithy.api#documentation": "A list of the metadata cache sizes that the gateway can support based on its current\n hardware specifications.
" } + }, + "HostEnvironmentId": { + "target": "com.amazonaws.storagegateway#HostEnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the specific instance of the host platform running the gateway.\n This value is only available for certain host environments, and its format depends on the\n host environment type.
" + } } }, "traits": { @@ -4998,6 +5004,18 @@ "traits": { "smithy.api#documentation": "The Amazon Web Services Region where the Amazon EC2 instance is located.
" } + }, + "HostEnvironment": { + "target": "com.amazonaws.storagegateway#HostEnvironment", + "traits": { + "smithy.api#documentation": "The type of hardware or software platform on which the gateway is running.
" + } + }, + "HostEnvironmentId": { + "target": "com.amazonaws.storagegateway#HostEnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the specific instance of the host platform running the gateway.\n This value is only available for certain host environments, and its format depends on the\n host environment type.
" + } } }, "traits": { @@ -5096,10 +5114,23 @@ { "value": "OTHER", "name": "OTHER" + }, + { + "value": "SNOWBALL", + "name": "SNOWBALL" } ] } }, + "com.amazonaws.storagegateway#HostEnvironmentId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, "com.amazonaws.storagegateway#Hosts": { "type": "list", "member": { @@ -7362,6 +7393,24 @@ }, "com.amazonaws.storagegateway#StorageGateway_20130630": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Storage Gateway", + "arnNamespace": "storagegateway", + "cloudFormationName": "StorageGateway", + "cloudTrailEventSource": "storagegateway.amazonaws.com", + "endpointPrefix": "storagegateway" + }, + "aws.auth#sigv4": { + "name": "storagegateway" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Storage Gateway is the service that connects an on-premises software appliance\n with cloud-based storage to provide seamless and secure integration between an\n organization's on-premises IT environment and the Amazon Web Services storage\n infrastructure. The service enables you to securely upload data to the Amazon Web Services Cloud for cost effective backup and rapid disaster recovery.
\n\nUse the following links to get started using the Storage Gateway\n Service API Reference:
\n\n\n Storage Gateway required request headers: Describes the required\n headers that you must send with every POST request to Storage Gateway.
\n\n Signing requests: Storage Gateway requires that you authenticate\n every request you send; this topic describes how sign such a request.
\n\n Error responses: Provides reference information about Storage Gateway errors.
\n\n Operations in Storage Gateway: Contains detailed descriptions of all Storage Gateway operations, their request parameters, response elements, possible errors, and\n examples of requests and responses.
\n\n Storage Gateway\n endpoints and quotas: Provides a list of each Amazon Web Services Region\n and the endpoints available for use with Storage Gateway.
\nStorage Gateway resource IDs are in uppercase. When you use these resource IDs\n with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change\n your resource ID to lowercase to use it with the EC2 API. For example, in Storage\n Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use\n this ID with the EC2 API, you must change it to vol-aa22bb012345daf670.\n Otherwise, the EC2 API might not behave as expected.
IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway\n volumes are changing to a longer format. Starting in December 2016, all new volumes and\n snapshots will be created with a 17-character string. Starting in April 2016, you will\n be able to use these longer IDs so you can test your systems with the new format. For\n more information, see Longer EC2 and\n EBS resource IDs.
\n\nFor example, a volume Amazon Resource Name (ARN) with the longer volume ID format\n looks like the following:
\n\n\n arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.
A snapshot ID with the longer ID format looks like the following:\n snap-78e226633445566ee.
For more information, see Announcement:\n Heads-up – Longer Storage Gateway volume and snapshot IDs coming in\n 2016.
\nStorage Gateway is the service that connects an on-premises software appliance\n with cloud-based storage to provide seamless and secure integration between an\n organization's on-premises IT environment and the Amazon Web Services storage\n infrastructure. The service enables you to securely upload data to the Amazon Web Services Cloud for cost effective backup and rapid disaster recovery.
\n\nUse the following links to get started using the Storage Gateway\n Service API Reference:
\n\n\n Storage Gateway required request headers: Describes the required\n headers that you must send with every POST request to Storage Gateway.
\n\n Signing requests: Storage Gateway requires that you authenticate\n every request you send; this topic describes how sign such a request.
\n\n Error responses: Provides reference information about Storage Gateway errors.
\n\n Operations in Storage Gateway: Contains detailed descriptions of all Storage Gateway operations, their request parameters, response elements, possible errors, and\n examples of requests and responses.
\n\n Storage Gateway\n endpoints and quotas: Provides a list of each Amazon Web Services Region\n and the endpoints available for use with Storage Gateway.
\nStorage Gateway resource IDs are in uppercase. When you use these resource IDs\n with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change\n your resource ID to lowercase to use it with the EC2 API. For example, in Storage\n Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use\n this ID with the EC2 API, you must change it to vol-aa22bb012345daf670.\n Otherwise, the EC2 API might not behave as expected.
IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway\n volumes are changing to a longer format. Starting in December 2016, all new volumes and\n snapshots will be created with a 17-character string. Starting in April 2016, you will\n be able to use these longer IDs so you can test your systems with the new format. For\n more information, see Longer EC2 and\n EBS resource IDs.
\n\nFor example, a volume Amazon Resource Name (ARN) with the longer volume ID format\n looks like the following:
\n\n\n arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.
A snapshot ID with the longer ID format looks like the following:\n snap-78e226633445566ee.
For more information, see Announcement:\n Heads-up – Longer Storage Gateway volume and snapshot IDs coming in\n 2016.
\nSecurity Token Service (STS) enables you to request temporary, limited-privilege \n credentials for Identity and Access Management (IAM) users or for users that you \n authenticate (federated users). This guide provides descriptions of the STS API. For \n more information about using this service, see Temporary Security Credentials.
", + "smithy.api#title": "AWS Security Token Service", + "smithy.api#xmlNamespace": { + "uri": "https://sts.amazonaws.com/doc/2011-06-15/" + } + }, "version": "2011-06-15", "operations": [ { @@ -57,25 +75,7 @@ { "target": "com.amazonaws.sts#GetSessionToken" } - ], - "traits": { - "aws.api#service": { - "sdkId": "STS", - "arnNamespace": "sts", - "cloudFormationName": "STS", - "cloudTrailEventSource": "sts.amazonaws.com", - "endpointPrefix": "sts" - }, - "aws.auth#sigv4": { - "name": "sts" - }, - "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "Security Token Service (STS) enables you to request temporary, limited-privilege \n credentials for Identity and Access Management (IAM) users or for users that you \n authenticate (federated users). This guide provides descriptions of the STS API. For \n more information about using this service, see Temporary Security Credentials.
", - "smithy.api#title": "AWS Security Token Service", - "smithy.api#xmlNamespace": { - "uri": "https://sts.amazonaws.com/doc/2011-06-15/" - } - } + ] }, "com.amazonaws.sts#AssumeRole": { "type": "operation", @@ -100,7 +100,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a set of temporary security credentials that you can use to access Amazon Web Services\n resources that you might not normally have access to. These temporary credentials\n consist of an access key ID, a secret access key, and a security token. Typically, you\n use AssumeRole within your account or for cross-account access. For a\n comparison of AssumeRole with other API operations that produce temporary\n credentials, see Requesting Temporary Security\n Credentials and Comparing\n the STS API operations in the\n IAM User Guide.
\n Permissions\n
\nThe temporary security credentials created by AssumeRole can be used to\n make API calls to any Amazon Web Services service with the following exception: You cannot call the\n STS GetFederationToken or GetSessionToken API\n operations.
(Optional) You can pass inline or managed session policies to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policies to use as managed session policies.\n The plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
\nTo assume a role from a different account, your account must be trusted by the\n role. The trust relationship is defined in the role's trust policy when the role is\n created. That trust policy states which accounts are allowed to delegate that access to\n users in the account.
\nA user who wants to access a role in a different account must also have permissions that\n are delegated from the user account administrator. The administrator must attach a policy\n that allows the user to call AssumeRole for the ARN of the role in the other\n account. If the user is in the same account as the role, then you can do either of the\n following:
Attach a policy to the user (identical to the previous user in a different\n account).
\nAdd the user as a principal directly in the role's trust policy.
\nIn this case, the trust policy acts as an IAM resource-based policy. Users in the same\n account as the role do not need explicit permission to assume the role. For more\n information about trust policies and resource-based policies, see IAM Policies in\n the IAM User Guide.
\n\n Tags\n
\n(Optional) You can pass tag key-value pairs to your session. These tags are called\n session tags. For more information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.
\nAn administrator must grant you the permissions necessary to pass session tags. The\n administrator can also create granular permissions to allow you to pass only specific\n session tags. For more information, see Tutorial: Using Tags\n for Attribute-Based Access Control in the\n IAM User Guide.
\nYou can set the session tags as transitive. Transitive tags persist during role\n chaining. For more information, see Chaining Roles\n with Session Tags in the IAM User Guide.
\n\n Using MFA with AssumeRole\n
\n(Optional) You can include multi-factor authentication (MFA) information when you call\n AssumeRole. This is useful for cross-account scenarios to ensure that the\n user that assumes the role has been authenticated with an Amazon Web Services MFA device. In that\n scenario, the trust policy of the role being assumed includes a condition that tests for\n MFA authentication. If the caller does not include valid MFA information, the request to\n assume the role is denied. The condition in a trust policy that tests for MFA\n authentication might look like the following example.
\n \"Condition\": {\"Bool\": {\"aws:MultiFactorAuthPresent\": true}}\n
For more information, see Configuring MFA-Protected API Access\n in the IAM User Guide guide.
\nTo use MFA with AssumeRole, you pass values for the\n SerialNumber and TokenCode parameters. The\n SerialNumber value identifies the user's hardware or virtual MFA device.\n The TokenCode is the time-based one-time password (TOTP) that the MFA device\n produces.
Returns a set of temporary security credentials that you can use to access Amazon Web Services\n resources that you might not normally have access to. These temporary credentials consist\n of an access key ID, a secret access key, and a security token. Typically, you use\n AssumeRole within your account or for cross-account access. For a\n comparison of AssumeRole with other API operations that produce temporary\n credentials, see Requesting Temporary Security\n Credentials and Comparing the\n Amazon Web Services STS API operations in the IAM User Guide.
\n Permissions\n
\nThe temporary security credentials created by AssumeRole can be used to\n make API calls to any Amazon Web Services service with the following exception: You cannot call the\n Amazon Web Services STS GetFederationToken or GetSessionToken API\n operations.
(Optional) You can pass inline or managed session policies to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policies to use as managed session policies.\n The plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
\nWhen you create a role, you create two policies: A role trust policy that specifies\n who can assume the role and a permissions policy that specifies\n what can be done with the role. You specify the trusted principal\n who is allowed to assume the role in the role trust policy.
\nTo assume a role from a different account, your Amazon Web Services account must be trusted by the\n role. The trust relationship is defined in the role's trust policy when the role is\n created. That trust policy states which accounts are allowed to delegate that access to\n users in the account.
\nA user who wants to access a role in a different account must also have permissions that\n are delegated from the user account administrator. The administrator must attach a policy\n that allows the user to call AssumeRole for the ARN of the role in the other\n account.
To allow a user to assume a role in the same account, you can do either of the\n following:
\nAttach a policy to the user that allows the user to call\n AssumeRole (as long as the role's trust policy trusts the account).
Add the user as a principal directly in the role's trust policy.
\nYou can do either because the role’s trust policy acts as an IAM resource-based\n policy. When a resource-based policy grants access to a principal in the same account, no\n additional identity-based policy is required. For more information about trust policies and\n resource-based policies, see IAM Policies in the\n IAM User Guide.
\n\n\n Tags\n
\n(Optional) You can pass tag key-value pairs to your session. These tags are called\n session tags. For more information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.
\nAn administrator must grant you the permissions necessary to pass session tags. The\n administrator can also create granular permissions to allow you to pass only specific\n session tags. For more information, see Tutorial: Using Tags\n for Attribute-Based Access Control in the\n IAM User Guide.
\nYou can set the session tags as transitive. Transitive tags persist during role\n chaining. For more information, see Chaining Roles\n with Session Tags in the IAM User Guide.
\n\n Using MFA with AssumeRole\n
\n(Optional) You can include multi-factor authentication (MFA) information when you call\n AssumeRole. This is useful for cross-account scenarios to ensure that the\n user that assumes the role has been authenticated with an Amazon Web Services MFA device. In that\n scenario, the trust policy of the role being assumed includes a condition that tests for\n MFA authentication. If the caller does not include valid MFA information, the request to\n assume the role is denied. The condition in a trust policy that tests for MFA\n authentication might look like the following example.
\n \"Condition\": {\"Bool\": {\"aws:MultiFactorAuthPresent\": true}}\n
For more information, see Configuring MFA-Protected API Access\n in the IAM User Guide guide.
\nTo use MFA with AssumeRole, you pass values for the\n SerialNumber and TokenCode parameters. The\n SerialNumber value identifies the user's hardware or virtual MFA device.\n The TokenCode is the time-based one-time password (TOTP) that the MFA device\n produces.
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as\n managed session policies. The policies must exist in the same account as the role.
\nThis parameter is optional. You can provide up to 10 managed policy ARNs. However, the\n plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services\n Service Namespaces in the Amazon Web Services General Reference.
\nAn Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n
Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
" + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as\n managed session policies. The policies must exist in the same account as the role.
\nThis parameter is optional. You can provide up to 10 managed policy ARNs. However, the\n plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services\n Service Namespaces in the Amazon Web Services General Reference.
\n \nAn Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n
Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
" } }, "Policy": { "target": "com.amazonaws.sts#sessionPolicyDocumentType", "traits": { - "smithy.api#documentation": "An IAM policy in JSON format that you want to use as an inline session policy.
\nThis parameter is optional. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
\nThe plaintext that you use for both inline and managed session policies can't exceed\n 2,048 characters. The JSON policy characters can be any ASCII character from the space\n character to the end of the valid character list (\\u0020 through \\u00FF). It can also\n include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)\n characters.
\nAn Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n
An IAM policy in JSON format that you want to use as an inline session policy.
\nThis parameter is optional. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
\nThe plaintext that you use for both inline and managed session policies can't exceed\n 2,048 characters. The JSON policy characters can be any ASCII character from the space\n character to the end of the valid character list (\\u0020 through \\u00FF). It can also\n include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)\n characters.
\n \nAn Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n
The duration, in seconds, of the role session. The value specified can can range from\n 900 seconds (15 minutes) up to the maximum session duration that is set for the role. The\n maximum session duration setting can have a value from 1 hour to 12 hours. If you specify a\n value higher than this setting or the administrator setting (whichever is lower), the\n operation fails. For example, if you specify a session duration of 12 hours, but your\n administrator set the maximum session duration to 6 hours, your operation fails. To learn\n how to view the maximum value for your role, see View the\n Maximum Session Duration Setting for a Role in the\n IAM User Guide.
\nBy default, the value is set to 3600 seconds.
The DurationSeconds parameter is separate from the duration of a console\n session that you might request using the returned credentials. The request to the\n federation endpoint for a console sign-in token takes a SessionDuration\n parameter that specifies the maximum length of the console session. For more\n information, see Creating a URL\n that Enables Federated Users to Access the Management Console in the\n IAM User Guide.
The duration, in seconds, of the role session. The value specified can range from 900\n seconds (15 minutes) up to the maximum session duration set for the role. The maximum\n session duration setting can have a value from 1 hour to 12 hours. If you specify a value\n higher than this setting or the administrator setting (whichever is lower), the operation\n fails. For example, if you specify a session duration of 12 hours, but your administrator\n set the maximum session duration to 6 hours, your operation fails.
\nRole chaining limits your Amazon Web Services CLI or Amazon Web Services API role session to a maximum of one hour.\n When you use the AssumeRole API operation to assume a role, you can specify\n the duration of your role session with the DurationSeconds parameter. You can\n specify a parameter value of up to 43200 seconds (12 hours), depending on the maximum\n session duration setting for your role. However, if you assume a role using role chaining\n and provide a DurationSeconds parameter value greater than one hour, the\n operation fails. To learn how to view the maximum value for your role, see View the\n Maximum Session Duration Setting for a Role in the\n IAM User Guide.
By default, the value is set to 3600 seconds.
The DurationSeconds parameter is separate from the duration of a console\n session that you might request using the returned credentials. The request to the\n federation endpoint for a console sign-in token takes a SessionDuration\n parameter that specifies the maximum length of the console session. For more\n information, see Creating a URL\n that Enables Federated Users to Access the Amazon Web Services Management Console in the\n IAM User Guide.
A list of session tags that you want to pass. Each session tag consists of a key name\n and an associated value. For more information about session tags, see Tagging STS\n Sessions in the IAM User Guide.
\nThis parameter is optional. You can pass up to 50 session tags. The plaintext session\n tag keys can’t exceed 128 characters, and the values can’t exceed 256 characters. For these\n and additional limits, see IAM\n and STS Character Limits in the IAM User Guide.
\n \nAn Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n
You can pass a session tag with the same key as a tag that is already\n attached to the role. When you do, session tags override a role tag with the same key.
\nTag key–value pairs are not case sensitive, but case is preserved. This means that you\n cannot have separate Department and department tag keys. Assume\n that the role has the Department=Marketing tag and you pass the\n department=engineering session tag. Department\n and department are not saved as separate tags, and the session tag passed in\n the request takes precedence over the role tag.
Additionally, if you used temporary credentials to perform this operation, the new\n session inherits any transitive session tags from the calling session. If you pass a\n session tag with the same key as an inherited tag, the operation fails. To view the\n inherited tags for a session, see the CloudTrail logs. For more information, see Viewing Session Tags in CloudTrail in the\n IAM User Guide.
" + "smithy.api#documentation": "A list of session tags that you want to pass. Each session tag consists of a key name\n and an associated value. For more information about session tags, see Tagging Amazon Web Services STS\n Sessions in the IAM User Guide.
\nThis parameter is optional. You can pass up to 50 session tags. The plaintext session\n tag keys can’t exceed 128 characters, and the values can’t exceed 256 characters. For these\n and additional limits, see IAM\n and STS Character Limits in the IAM User Guide.
\n \nAn Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n
You can pass a session tag with the same key as a tag that is already attached to the\n role. When you do, session tags override a role tag with the same key.
\nTag key–value pairs are not case sensitive, but case is preserved. This means that you\n cannot have separate Department and department tag keys. Assume\n that the role has the Department=Marketing tag and you pass the\n department=engineering session tag. Department\n and department are not saved as separate tags, and the session tag passed in\n the request takes precedence over the role tag.
Additionally, if you used temporary credentials to perform this operation, the new\n session inherits any transitive session tags from the calling session. If you pass a\n session tag with the same key as an inherited tag, the operation fails. To view the\n inherited tags for a session, see the CloudTrail logs. For more information, see Viewing Session Tags in CloudTrail in the\n IAM User Guide.
" } }, "TransitiveTagKeys": { @@ -171,7 +171,7 @@ "SourceIdentity": { "target": "com.amazonaws.sts#sourceIdentityType", "traits": { - "smithy.api#documentation": "The source identity specified by the principal that is calling the\n AssumeRole operation.
You can require users to specify a source identity when they assume a role. You do this\n by using the sts:SourceIdentity condition key in a role trust policy. You can\n use source identity information in CloudTrail logs to determine who took actions with a role.\n You can use the aws:SourceIdentity condition key to further control access to\n Amazon Web Services resources based on the value of source identity. For more information about using\n source identity, see Monitor and control\n actions taken with assumed roles in the\n IAM User Guide.
The regex used to validate this parameter is a string of characters consisting of upper-\n and lower-case alphanumeric characters with no spaces. You can also include underscores or\n any of the following characters: =,.@-. You cannot use a value that begins with the text\n aws:. This prefix is reserved for Amazon Web Services internal\n use.
The source identity specified by the principal that is calling the\n AssumeRole operation.
You can require users to specify a source identity when they assume a role. You do this\n by using the sts:SourceIdentity condition key in a role trust policy. You can\n use source identity information in CloudTrail logs to determine who took actions with a role.\n You can use the aws:SourceIdentity condition key to further control access to\n Amazon Web Services resources based on the value of source identity. For more information about using\n source identity, see Monitor and control\n actions taken with assumed roles in the\n IAM User Guide.
The regex used to validate this parameter is a string of characters consisting of upper-\n and lower-case alphanumeric characters with no spaces. You can also include underscores or\n any of the following characters: =,.@-. You cannot use a value that begins with the text\n aws:. This prefix is reserved for Amazon Web Services internal use.
The temporary security credentials, which include an access key ID, a secret access key,\n and a security (or session) token.
\nThe size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.
\nThe temporary security credentials, which include an access key ID, a secret access key,\n and a security (or session) token.
\n \nThe size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.
\nReturns a set of temporary security credentials for users who have been authenticated\n via a SAML authentication response. This operation provides a mechanism for tying an\n enterprise identity store or directory to role-based Amazon Web Services access without user-specific\n credentials or configuration. For a comparison of AssumeRoleWithSAML with the\n other API operations that produce temporary credentials, see Requesting Temporary Security\n Credentials and Comparing the\n STS API operations in the IAM User Guide.
The temporary security credentials returned by this operation consist of an access key\n ID, a secret access key, and a security token. Applications can use these temporary\n security credentials to sign calls to Amazon Web Services services.
\n\n Session Duration\n
\nBy default, the temporary security credentials created by\n AssumeRoleWithSAML last for one hour. However, you can use the optional\n DurationSeconds parameter to specify the duration of your session. Your\n role session lasts for the duration that you specify, or until the time specified in the\n SAML authentication response's SessionNotOnOrAfter value, whichever is\n shorter. You can provide a DurationSeconds value from 900 seconds (15 minutes)\n up to the maximum session duration setting for the role. This setting can have a value from\n 1 hour to 12 hours. To learn how to view the maximum value for your role, see View the\n Maximum Session Duration Setting for a Role in the\n IAM User Guide. The maximum session duration limit applies when\n you use the AssumeRole* API operations or the assume-role* CLI\n commands. However the limit does not apply when you use those operations to create a\n console URL. For more information, see Using IAM Roles in the\n IAM User Guide.
\n Role chaining limits your CLI or Amazon Web Services API\n role session to a maximum of one hour. When you use the AssumeRole API\n operation to assume a role, you can specify the duration of your role session with\n the DurationSeconds parameter. You can specify a parameter value of up\n to 43200 seconds (12 hours), depending on the maximum session duration setting for\n your role. However, if you assume a role using role chaining and provide a\n DurationSeconds parameter value greater than one hour, the\n operation fails.
\n Permissions\n
\nThe temporary security credentials created by AssumeRoleWithSAML can be\n used to make API calls to any Amazon Web Services service with the following exception: you cannot call\n the STS GetFederationToken or GetSessionToken API\n operations.
(Optional) You can pass inline or managed session policies to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policies to use as managed session policies.\n The plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
\nCalling AssumeRoleWithSAML does not require the use of Amazon Web Services security\n credentials. The identity of the caller is validated by using keys in the metadata document\n that is uploaded for the SAML provider entity for your identity provider.
Calling AssumeRoleWithSAML can result in an entry in your CloudTrail logs.\n The entry includes the value in the NameID element of the SAML assertion.\n We recommend that you use a NameIDType that is not associated with any\n personally identifiable information (PII). For example, you could instead use the\n persistent identifier\n (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent).
\n Tags\n
\n(Optional) You can configure your IdP to pass attributes into your SAML assertion as\n session tags. Each session tag consists of a key name and an associated value. For more\n information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.
\nYou can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128\n characters and the values can’t exceed 256 characters. For these and additional limits, see\n IAM\n and STS Character Limits in the IAM User Guide.
\n \nAn Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n
You can pass a session tag with the same key as a tag that is\n attached to the role. When you do, session tags override the role's tags with the same\n key.
\nAn administrator must grant you the permissions necessary to pass session tags. The\n administrator can also create granular permissions to allow you to pass only specific\n session tags. For more information, see Tutorial: Using Tags\n for Attribute-Based Access Control in the\n IAM User Guide.
\nYou can set the session tags as transitive. Transitive tags persist during role\n chaining. For more information, see Chaining Roles\n with Session Tags in the IAM User Guide.
\n\n SAML Configuration\n
\nBefore your application can call AssumeRoleWithSAML, you must configure\n your SAML identity provider (IdP) to issue the claims required by Amazon Web Services. Additionally, you\n must use Identity and Access Management (IAM) to create a SAML provider entity in your Amazon Web Services account that\n represents your identity provider. You must also create an IAM role that specifies this\n SAML provider in its trust policy.
For more information, see the following resources:
\n\n About\n SAML 2.0-based Federation in the IAM User Guide.\n
\n\n Creating SAML Identity Providers in the\n IAM User Guide.
\n\n Configuring\n a Relying Party and Claims in the IAM User Guide.\n
\n\n Creating a Role for SAML 2.0 Federation in the\n IAM User Guide.
\nReturns a set of temporary security credentials for users who have been authenticated\n via a SAML authentication response. This operation provides a mechanism for tying an\n enterprise identity store or directory to role-based Amazon Web Services access without user-specific\n credentials or configuration. For a comparison of AssumeRoleWithSAML with the\n other API operations that produce temporary credentials, see Requesting Temporary Security\n Credentials and Comparing the\n Amazon Web Services STS API operations in the IAM User Guide.
The temporary security credentials returned by this operation consist of an access key\n ID, a secret access key, and a security token. Applications can use these temporary\n security credentials to sign calls to Amazon Web Services services.
\n\n Session Duration\n
\nBy default, the temporary security credentials created by\n AssumeRoleWithSAML last for one hour. However, you can use the optional\n DurationSeconds parameter to specify the duration of your session. Your\n role session lasts for the duration that you specify, or until the time specified in the\n SAML authentication response's SessionNotOnOrAfter value, whichever is\n shorter. You can provide a DurationSeconds value from 900 seconds (15 minutes)\n up to the maximum session duration setting for the role. This setting can have a value from\n 1 hour to 12 hours. To learn how to view the maximum value for your role, see View the\n Maximum Session Duration Setting for a Role in the\n IAM User Guide. The maximum session duration limit applies when\n you use the AssumeRole* API operations or the assume-role* CLI\n commands. However the limit does not apply when you use those operations to create a\n console URL. For more information, see Using IAM Roles in the\n IAM User Guide.
\n Role chaining limits your CLI or Amazon Web Services API role\n session to a maximum of one hour. When you use the AssumeRole API operation\n to assume a role, you can specify the duration of your role session with the\n DurationSeconds parameter. You can specify a parameter value of up to\n 43200 seconds (12 hours), depending on the maximum session duration setting for your\n role. However, if you assume a role using role chaining and provide a\n DurationSeconds parameter value greater than one hour, the operation\n fails.
\n Permissions\n
\nThe temporary security credentials created by AssumeRoleWithSAML can be\n used to make API calls to any Amazon Web Services service with the following exception: you cannot call\n the STS GetFederationToken or GetSessionToken API\n operations.
(Optional) You can pass inline or managed session policies to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policies to use as managed session policies.\n The plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
\nCalling AssumeRoleWithSAML does not require the use of Amazon Web Services security\n credentials. The identity of the caller is validated by using keys in the metadata document\n that is uploaded for the SAML provider entity for your identity provider.
Calling AssumeRoleWithSAML can result in an entry in your CloudTrail logs.\n The entry includes the value in the NameID element of the SAML assertion.\n We recommend that you use a NameIDType that is not associated with any\n personally identifiable information (PII). For example, you could instead use the\n persistent identifier\n (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent).
\n Tags\n
\n(Optional) You can configure your IdP to pass attributes into your SAML assertion as\n session tags. Each session tag consists of a key name and an associated value. For more\n information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.
\nYou can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128\n characters and the values can’t exceed 256 characters. For these and additional limits, see\n IAM\n and STS Character Limits in the IAM User Guide.
\n \nAn Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n
You can pass a session tag with the same key as a tag that is attached to the role. When\n you do, session tags override the role's tags with the same key.
\nAn administrator must grant you the permissions necessary to pass session tags. The\n administrator can also create granular permissions to allow you to pass only specific\n session tags. For more information, see Tutorial: Using Tags\n for Attribute-Based Access Control in the\n IAM User Guide.
\nYou can set the session tags as transitive. Transitive tags persist during role\n chaining. For more information, see Chaining Roles\n with Session Tags in the IAM User Guide.
\n\n SAML Configuration\n
\nBefore your application can call AssumeRoleWithSAML, you must configure\n your SAML identity provider (IdP) to issue the claims required by Amazon Web Services. Additionally, you\n must use Identity and Access Management (IAM) to create a SAML provider entity in your Amazon Web Services account that\n represents your identity provider. You must also create an IAM role that specifies this\n SAML provider in its trust policy.
For more information, see the following resources:
\n\n About\n SAML 2.0-based Federation in the IAM User Guide.\n
\n\n Creating SAML Identity Providers in the\n IAM User Guide.
\n\n Configuring\n a Relying Party and Claims in the IAM User Guide.\n
\n\n Creating a Role for SAML 2.0 Federation in the\n IAM User Guide.
\nThe Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as\n managed session policies. The policies must exist in the same account as the role.
\nThis parameter is optional. You can provide up to 10 managed policy ARNs. However, the\n plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services\n Service Namespaces in the Amazon Web Services General Reference.
\nAn Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n
Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
" + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as\n managed session policies. The policies must exist in the same account as the role.
\nThis parameter is optional. You can provide up to 10 managed policy ARNs. However, the\n plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services\n Service Namespaces in the Amazon Web Services General Reference.
\n \nAn Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n
Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
" } }, "Policy": { "target": "com.amazonaws.sts#sessionPolicyDocumentType", "traits": { - "smithy.api#documentation": "An IAM policy in JSON format that you want to use as an inline session policy.
\nThis parameter is optional. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
\nThe plaintext that you use for both inline and managed session policies can't exceed\n 2,048 characters. The JSON policy characters can be any ASCII character from the space\n character to the end of the valid character list (\\u0020 through \\u00FF). It can also\n include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)\n characters.
\nAn Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n
An IAM policy in JSON format that you want to use as an inline session policy.
\nThis parameter is optional. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
\nThe plaintext that you use for both inline and managed session policies can't exceed\n 2,048 characters. The JSON policy characters can be any ASCII character from the space\n character to the end of the valid character list (\\u0020 through \\u00FF). It can also\n include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)\n characters.
\n \nAn Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n
The duration, in seconds, of the role session. Your role session lasts for the duration\n that you specify for the DurationSeconds parameter, or until the time\n specified in the SAML authentication response's SessionNotOnOrAfter value,\n whichever is shorter. You can provide a DurationSeconds value from 900 seconds\n (15 minutes) up to the maximum session duration setting for the role. This setting can have\n a value from 1 hour to 12 hours. If you specify a value higher than this setting, the\n operation fails. For example, if you specify a session duration of 12 hours, but your\n administrator set the maximum session duration to 6 hours, your operation fails. To learn\n how to view the maximum value for your role, see View the\n Maximum Session Duration Setting for a Role in the\n IAM User Guide.
By default, the value is set to 3600 seconds.
The DurationSeconds parameter is separate from the duration of a console\n session that you might request using the returned credentials. The request to the\n federation endpoint for a console sign-in token takes a SessionDuration\n parameter that specifies the maximum length of the console session. For more\n information, see Creating a URL\n that Enables Federated Users to Access the Management Console in the\n IAM User Guide.
The duration, in seconds, of the role session. Your role session lasts for the duration\n that you specify for the DurationSeconds parameter, or until the time\n specified in the SAML authentication response's SessionNotOnOrAfter value,\n whichever is shorter. You can provide a DurationSeconds value from 900 seconds\n (15 minutes) up to the maximum session duration setting for the role. This setting can have\n a value from 1 hour to 12 hours. If you specify a value higher than this setting, the\n operation fails. For example, if you specify a session duration of 12 hours, but your\n administrator set the maximum session duration to 6 hours, your operation fails. To learn\n how to view the maximum value for your role, see View the\n Maximum Session Duration Setting for a Role in the\n IAM User Guide.
By default, the value is set to 3600 seconds.
The DurationSeconds parameter is separate from the duration of a console\n session that you might request using the returned credentials. The request to the\n federation endpoint for a console sign-in token takes a SessionDuration\n parameter that specifies the maximum length of the console session. For more\n information, see Creating a URL\n that Enables Federated Users to Access the Amazon Web Services Management Console in the\n IAM User Guide.
The temporary security credentials, which include an access key ID, a secret access key,\n and a security (or session) token.
\nThe size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.
\nThe temporary security credentials, which include an access key ID, a secret access key,\n and a security (or session) token.
\n \nThe size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.
\nReturns a set of temporary security credentials for users who have been authenticated in\n a mobile or web application with a web identity provider. Example providers include Amazon Cognito,\n Login with Amazon, Facebook, Google, or any OpenID Connect-compatible identity\n provider.
\nFor mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the\n Amazon Web Services SDK for iOS Developer Guide and the Amazon Web Services SDK for Android Developer Guide to uniquely\n identify a user. You can also supply the user with a consistent identity throughout the\n lifetime of an application.
\nTo learn more about Amazon Cognito, see Amazon Cognito Overview in\n Amazon Web Services SDK for Android Developer Guide and Amazon Cognito Overview in the\n Amazon Web Services SDK for iOS Developer Guide.
\nCalling AssumeRoleWithWebIdentity does not require the use of Amazon Web Services\n security credentials. Therefore, you can distribute an application (for example, on mobile\n devices) that requests temporary security credentials without including long-term Amazon Web Services\n credentials in the application. You also don't need to deploy server-based proxy services\n that use long-term Amazon Web Services credentials. Instead, the identity of the caller is validated by\n using a token from the web identity provider. For a comparison of\n AssumeRoleWithWebIdentity with the other API operations that produce\n temporary credentials, see Requesting Temporary Security\n Credentials and Comparing the\n STS API operations in the IAM User Guide.
The temporary security credentials returned by this API consist of an access key ID, a\n secret access key, and a security token. Applications can use these temporary security\n credentials to sign calls to Amazon Web Services service API operations.
\n\n Session Duration\n
\nBy default, the temporary security credentials created by\n AssumeRoleWithWebIdentity last for one hour. However, you can use the\n optional DurationSeconds parameter to specify the duration of your session.\n You can provide a value from 900 seconds (15 minutes) up to the maximum session duration\n setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how\n to view the maximum value for your role, see View the\n Maximum Session Duration Setting for a Role in the\n IAM User Guide. The maximum session duration limit applies when\n you use the AssumeRole* API operations or the assume-role* CLI\n commands. However the limit does not apply when you use those operations to create a\n console URL. For more information, see Using IAM Roles in the\n IAM User Guide.
\n Permissions\n
\nThe temporary security credentials created by AssumeRoleWithWebIdentity can\n be used to make API calls to any Amazon Web Services service with the following exception: you cannot\n call the STS GetFederationToken or GetSessionToken API\n operations.
(Optional) You can pass inline or managed session policies to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policies to use as managed session policies.\n The plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
\n\n Tags\n
\n(Optional) You can configure your IdP to pass attributes into your web identity token as\n session tags. Each session tag consists of a key name and an associated value. For more\n information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.
\nYou can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128\n characters and the values can’t exceed 256 characters. For these and additional limits, see\n IAM\n and STS Character Limits in the IAM User Guide.
\n \nAn Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n
You can pass a session tag with the same key as a tag that is\n attached to the role. When you do, the session tag overrides the role tag with the same\n key.
\nAn administrator must grant you the permissions necessary to pass session tags. The\n administrator can also create granular permissions to allow you to pass only specific\n session tags. For more information, see Tutorial: Using Tags\n for Attribute-Based Access Control in the\n IAM User Guide.
\nYou can set the session tags as transitive. Transitive tags persist during role\n chaining. For more information, see Chaining Roles\n with Session Tags in the IAM User Guide.
\n\n Identities\n
\nBefore your application can call AssumeRoleWithWebIdentity, you must have\n an identity token from a supported identity provider and create a role that the application\n can assume. The role that your application assumes must trust the identity provider that is\n associated with the identity token. In other words, the identity provider must be specified\n in the role's trust policy.
Calling AssumeRoleWithWebIdentity can result in an entry in your\n CloudTrail logs. The entry includes the Subject of\n the provided web identity token. We recommend that you avoid using any personally\n identifiable information (PII) in this field. For example, you could instead use a GUID\n or a pairwise identifier, as suggested\n in the OIDC specification.
For more information about how to use web identity federation and the\n AssumeRoleWithWebIdentity API, see the following resources:
\n Using Web Identity Federation API Operations for Mobile Apps and Federation Through a Web-based Identity Provider.
\n\n Web Identity Federation Playground. Walk through the process of\n authenticating through Login with Amazon, Facebook, or Google, getting temporary\n security credentials, and then using those credentials to make a request to Amazon Web Services.\n
\n\n Amazon Web Services SDK for iOS Developer Guide and Amazon Web Services SDK for Android Developer Guide. These toolkits\n contain sample apps that show how to invoke the identity providers. The toolkits then\n show how to use the information from these providers to get and use temporary\n security credentials.
\n\n Web Identity\n Federation with Mobile Applications. This article discusses web identity\n federation and shows an example of how to use web identity federation to get access\n to content in Amazon S3.
\nReturns a set of temporary security credentials for users who have been authenticated in\n a mobile or web application with a web identity provider. Example providers include Amazon Cognito,\n Login with Amazon, Facebook, Google, or any OpenID Connect-compatible identity\n provider.
\nFor mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the\n Amazon Web Services SDK for iOS Developer Guide and the Amazon Web Services SDK for Android Developer Guide to uniquely\n identify a user. You can also supply the user with a consistent identity throughout the\n lifetime of an application.
\nTo learn more about Amazon Cognito, see Amazon Cognito Overview in\n Amazon Web Services SDK for Android Developer Guide and Amazon Cognito Overview in the\n Amazon Web Services SDK for iOS Developer Guide.
\nCalling AssumeRoleWithWebIdentity does not require the use of Amazon Web Services\n security credentials. Therefore, you can distribute an application (for example, on mobile\n devices) that requests temporary security credentials without including long-term Amazon Web Services\n credentials in the application. You also don't need to deploy server-based proxy services\n that use long-term Amazon Web Services credentials. Instead, the identity of the caller is validated by\n using a token from the web identity provider. For a comparison of\n AssumeRoleWithWebIdentity with the other API operations that produce\n temporary credentials, see Requesting Temporary Security\n Credentials and Comparing the\n Amazon Web Services STS API operations in the IAM User Guide.
The temporary security credentials returned by this API consist of an access key ID, a\n secret access key, and a security token. Applications can use these temporary security\n credentials to sign calls to Amazon Web Services service API operations.
\n\n Session Duration\n
\nBy default, the temporary security credentials created by\n AssumeRoleWithWebIdentity last for one hour. However, you can use the\n optional DurationSeconds parameter to specify the duration of your session.\n You can provide a value from 900 seconds (15 minutes) up to the maximum session duration\n setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how\n to view the maximum value for your role, see View the\n Maximum Session Duration Setting for a Role in the\n IAM User Guide. The maximum session duration limit applies when\n you use the AssumeRole* API operations or the assume-role* CLI\n commands. However the limit does not apply when you use those operations to create a\n console URL. For more information, see Using IAM Roles in the\n IAM User Guide.
\n Permissions\n
\nThe temporary security credentials created by AssumeRoleWithWebIdentity can\n be used to make API calls to any Amazon Web Services service with the following exception: you cannot\n call the STS GetFederationToken or GetSessionToken API\n operations.
(Optional) You can pass inline or managed session policies to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policies to use as managed session policies.\n The plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
\n\n Tags\n
\n(Optional) You can configure your IdP to pass attributes into your web identity token as\n session tags. Each session tag consists of a key name and an associated value. For more\n information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.
\nYou can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128\n characters and the values can’t exceed 256 characters. For these and additional limits, see\n IAM\n and STS Character Limits in the IAM User Guide.
\n \nAn Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n
You can pass a session tag with the same key as a tag that is attached to the role. When\n you do, the session tag overrides the role tag with the same key.
\nAn administrator must grant you the permissions necessary to pass session tags. The\n administrator can also create granular permissions to allow you to pass only specific\n session tags. For more information, see Tutorial: Using Tags\n for Attribute-Based Access Control in the\n IAM User Guide.
\nYou can set the session tags as transitive. Transitive tags persist during role\n chaining. For more information, see Chaining Roles\n with Session Tags in the IAM User Guide.
\n\n Identities\n
\nBefore your application can call AssumeRoleWithWebIdentity, you must have\n an identity token from a supported identity provider and create a role that the application\n can assume. The role that your application assumes must trust the identity provider that is\n associated with the identity token. In other words, the identity provider must be specified\n in the role's trust policy.
Calling AssumeRoleWithWebIdentity can result in an entry in your\n CloudTrail logs. The entry includes the Subject of\n the provided web identity token. We recommend that you avoid using any personally\n identifiable information (PII) in this field. For example, you could instead use a GUID\n or a pairwise identifier, as suggested\n in the OIDC specification.
For more information about how to use web identity federation and the\n AssumeRoleWithWebIdentity API, see the following resources:
\n Using Web Identity Federation API Operations for Mobile Apps and Federation Through a Web-based Identity Provider.
\n\n Web Identity Federation Playground. Walk through the process of\n authenticating through Login with Amazon, Facebook, or Google, getting temporary\n security credentials, and then using those credentials to make a request to Amazon Web Services.\n
\n\n Amazon Web Services SDK for iOS Developer Guide and Amazon Web Services SDK for Android Developer Guide. These toolkits\n contain sample apps that show how to invoke the identity providers. The toolkits then\n show how to use the information from these providers to get and use temporary\n security credentials.
\n\n Web Identity\n Federation with Mobile Applications. This article discusses web identity\n federation and shows an example of how to use web identity federation to get access\n to content in Amazon S3.
\nThe Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as\n managed session policies. The policies must exist in the same account as the role.
\nThis parameter is optional. You can provide up to 10 managed policy ARNs. However, the\n plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services\n Service Namespaces in the Amazon Web Services General Reference.
\nAn Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n
Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
" + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as\n managed session policies. The policies must exist in the same account as the role.
\nThis parameter is optional. You can provide up to 10 managed policy ARNs. However, the\n plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services\n Service Namespaces in the Amazon Web Services General Reference.
\n \nAn Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n
Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
" } }, "Policy": { "target": "com.amazonaws.sts#sessionPolicyDocumentType", "traits": { - "smithy.api#documentation": "An IAM policy in JSON format that you want to use as an inline session policy.
\nThis parameter is optional. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
\nThe plaintext that you use for both inline and managed session policies can't exceed\n 2,048 characters. The JSON policy characters can be any ASCII character from the space\n character to the end of the valid character list (\\u0020 through \\u00FF). It can also\n include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)\n characters.
\nAn Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n
An IAM policy in JSON format that you want to use as an inline session policy.
\nThis parameter is optional. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.
\nThe plaintext that you use for both inline and managed session policies can't exceed\n 2,048 characters. The JSON policy characters can be any ASCII character from the space\n character to the end of the valid character list (\\u0020 through \\u00FF). It can also\n include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)\n characters.
\n \nAn Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n
The duration, in seconds, of the role session. The value can range from 900 seconds (15\n minutes) up to the maximum session duration setting for the role. This setting can have a\n value from 1 hour to 12 hours. If you specify a value higher than this setting, the\n operation fails. For example, if you specify a session duration of 12 hours, but your\n administrator set the maximum session duration to 6 hours, your operation fails. To learn\n how to view the maximum value for your role, see View the\n Maximum Session Duration Setting for a Role in the\n IAM User Guide.
\nBy default, the value is set to 3600 seconds.
The DurationSeconds parameter is separate from the duration of a console\n session that you might request using the returned credentials. The request to the\n federation endpoint for a console sign-in token takes a SessionDuration\n parameter that specifies the maximum length of the console session. For more\n information, see Creating a URL\n that Enables Federated Users to Access the Management Console in the\n IAM User Guide.
The duration, in seconds, of the role session. The value can range from 900 seconds (15\n minutes) up to the maximum session duration setting for the role. This setting can have a\n value from 1 hour to 12 hours. If you specify a value higher than this setting, the\n operation fails. For example, if you specify a session duration of 12 hours, but your\n administrator set the maximum session duration to 6 hours, your operation fails. To learn\n how to view the maximum value for your role, see View the\n Maximum Session Duration Setting for a Role in the\n IAM User Guide.
\nBy default, the value is set to 3600 seconds.
The DurationSeconds parameter is separate from the duration of a console\n session that you might request using the returned credentials. The request to the\n federation endpoint for a console sign-in token takes a SessionDuration\n parameter that specifies the maximum length of the console session. For more\n information, see Creating a URL\n that Enables Federated Users to Access the Amazon Web Services Management Console in the\n IAM User Guide.
The temporary security credentials, which include an access key ID, a secret access key,\n and a security token.
\nThe size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.
\nThe temporary security credentials, which include an access key ID, a secret access key,\n and a security token.
\n \nThe size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.
\nDecodes additional information about the authorization status of a request from an\n encoded message returned in response to an Amazon Web Services request.
\nFor example, if a user is not authorized to perform an operation that he or she has\n requested, the request returns a Client.UnauthorizedOperation response (an\n HTTP 403 response). Some Amazon Web Services operations additionally return an encoded message that can\n provide details about this authorization failure.
Only certain Amazon Web Services operations return an encoded authorization message. The\n documentation for an individual operation indicates whether that operation returns an\n encoded message in addition to returning an HTTP code.
\nThe message is encoded because the details of the authorization status can constitute\n privileged information that the user who requested the operation should not see. To decode\n an authorization status message, a user must be granted permissions via an IAM policy to\n request the DecodeAuthorizationMessage\n (sts:DecodeAuthorizationMessage) action.
The decoded message includes the following type of information:
\nWhether the request was denied due to an explicit deny or due to the absence of an\n explicit allow. For more information, see Determining Whether a Request is Allowed or Denied in the\n IAM User Guide.
\nThe principal who made the request.
\nThe requested action.
\nThe requested resource.
\nThe values of condition keys in the context of the user's request.
\nDecodes additional information about the authorization status of a request from an\n encoded message returned in response to an Amazon Web Services request.
\nFor example, if a user is not authorized to perform an operation that he or she has\n requested, the request returns a Client.UnauthorizedOperation response (an\n HTTP 403 response). Some Amazon Web Services operations additionally return an encoded message that can\n provide details about this authorization failure.
Only certain Amazon Web Services operations return an encoded authorization message. The\n documentation for an individual operation indicates whether that operation returns an\n encoded message in addition to returning an HTTP code.
\nThe message is encoded because the details of the authorization status can contain\n privileged information that the user who requested the operation should not see. To decode\n an authorization status message, a user must be granted permissions through an IAM policy to\n request the DecodeAuthorizationMessage\n (sts:DecodeAuthorizationMessage) action.
The decoded message includes the following type of information:
\nWhether the request was denied due to an explicit deny or due to the absence of an\n explicit allow. For more information, see Determining Whether a Request is Allowed or Denied in the\n IAM User Guide.
\nThe principal who made the request.
\nThe requested action.
\nThe requested resource.
\nThe values of condition keys in the context of the user's request.
\nAn XML document that contains the decoded message.
" + "smithy.api#documentation": "The API returns a response with the decoded message.
" } } }, @@ -633,7 +633,7 @@ "target": "com.amazonaws.sts#GetAccessKeyInfoResponse" }, "traits": { - "smithy.api#documentation": "Returns the account identifier for the specified access key ID.
\nAccess keys consist of two parts: an access key ID (for example,\n AKIAIOSFODNN7EXAMPLE) and a secret access key (for example,\n wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). For more information about\n access keys, see Managing Access Keys for IAM\n Users in the IAM User Guide.
When you pass an access key ID to this operation, it returns the ID of the Amazon Web Services\n account to which the keys belong. Access key IDs beginning with AKIA are\n long-term credentials for an IAM user or the Amazon Web Services account root user. Access key IDs\n beginning with ASIA are temporary credentials that are created using STS\n operations. If the account in the response belongs to you, you can sign in as the root\n user and review your root user access keys. Then, you can pull a credentials report to learn which IAM user owns the keys. To learn who\n requested the temporary credentials for an ASIA access key, view the STS\n events in your CloudTrail logs in the\n IAM User Guide.
This operation does not indicate the state of the access key. The key might be active,\n inactive, or deleted. Active keys might not have permissions to perform an operation.\n Providing a deleted access key might return an error that the key doesn't exist.
" + "smithy.api#documentation": "Returns the account identifier for the specified access key ID.
\nAccess keys consist of two parts: an access key ID (for example,\n AKIAIOSFODNN7EXAMPLE) and a secret access key (for example,\n wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). For more information about\n access keys, see Managing Access Keys for IAM\n Users in the IAM User Guide.
When you pass an access key ID to this operation, it returns the ID of the Amazon Web Services account\n to which the keys belong. Access key IDs beginning with AKIA are long-term\n credentials for an IAM user or the Amazon Web Services account root user. Access key IDs beginning with\n ASIA are temporary credentials that are created using STS operations. If\n the account in the response belongs to you, you can sign in as the root user and review\n your root user access keys. Then, you can pull a credentials report to\n learn which IAM user owns the keys. To learn who requested the temporary credentials for\n an ASIA access key, view the STS events in your CloudTrail logs in the\n IAM User Guide.
This operation does not indicate the state of the access key. The key might be active,\n inactive, or deleted. Active keys might not have permissions to perform an operation.\n Providing a deleted access key might return an error that the key doesn't exist.
" } }, "com.amazonaws.sts#GetAccessKeyInfoRequest": { @@ -642,7 +642,7 @@ "AccessKeyId": { "target": "com.amazonaws.sts#accessKeyIdType", "traits": { - "smithy.api#documentation": "The identifier of an access key.
\nThis parameter allows (through its regex pattern) a string of characters that can\n consist of any upper- or lowercase letter or digit.
", + "smithy.api#documentation": "The identifier of an access key.
\nThis parameter allows (through its regex pattern) a string of characters that can\n consist of any upper- or lowercase letter or digit.
", "smithy.api#required": {} } } @@ -668,7 +668,7 @@ "target": "com.amazonaws.sts#GetCallerIdentityResponse" }, "traits": { - "smithy.api#documentation": "Returns details about the IAM user or role whose credentials are used to call the\n operation.
\nNo permissions are required to perform this operation. If an administrator adds a\n policy to your IAM user or role that explicitly denies access to the\n sts:GetCallerIdentity action, you can still perform this operation.\n Permissions are not required because the same information is returned when an IAM\n user or role is denied access. To view an example response, see I Am Not Authorized to Perform: iam:DeleteVirtualMFADevice in the\n IAM User Guide.
Returns details about the IAM user or role whose credentials are used to call the\n operation.
\nNo permissions are required to perform this operation. If an administrator adds a\n policy to your IAM user or role that explicitly denies access to the\n sts:GetCallerIdentity action, you can still perform this operation.\n Permissions are not required because the same information is returned when an IAM user\n or role is denied access. To view an example response, see I Am Not Authorized to Perform: iam:DeleteVirtualMFADevice in the\n IAM User Guide.
Returns a set of temporary security credentials (consisting of an access key ID, a\n secret access key, and a security token) for a federated user. A typical use is in a proxy\n application that gets temporary security credentials on behalf of distributed applications\n inside a corporate network. You must call the GetFederationToken operation\n using the long-term security credentials of an IAM user. As a result, this call is\n appropriate in contexts where those credentials can be safely stored, usually in a\n server-based application. For a comparison of GetFederationToken with the\n other API operations that produce temporary credentials, see Requesting Temporary Security\n Credentials and Comparing the\n STS API operations in the IAM User Guide.
You can create a mobile-based or browser-based app that can authenticate users using\n a web identity provider like Login with Amazon, Facebook, Google, or an OpenID\n Connect-compatible identity provider. In this case, we recommend that you use Amazon Cognito or\n AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider in the\n IAM User Guide.
You can also call GetFederationToken using the security credentials of an\n Amazon Web Services account root user, but we do not recommend it. Instead, we recommend that you create\n an IAM user for the purpose of the proxy application. Then attach a policy to the IAM\n user that limits federated users to only the actions and resources that they need to\n access. For more information, see IAM Best Practices in the\n IAM User Guide.
\n Session duration\n
\nThe temporary credentials are valid for the specified duration, from 900 seconds (15\n minutes) up to a maximum of 129,600 seconds (36 hours). The default session duration is\n 43,200 seconds (12 hours). Temporary credentials that are obtained by using Amazon Web Services account\n root user credentials have a maximum duration of 3,600 seconds (1 hour).
\n\n Permissions\n
\nYou can use the temporary credentials created by GetFederationToken in any\n Amazon Web Services service except the following:
You cannot call any IAM operations using the CLI or the Amazon Web Services API.
\nYou cannot call any STS operations except GetCallerIdentity.
You must pass an inline or managed session policy to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policies to use as managed session policies.\n The plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters.
\nThough the session policy parameters are optional, if you do not pass a policy, then the\n resulting federated user session has no permissions. When you pass session policies, the\n session permissions are the intersection of the IAM user policies and the session\n policies that you pass. This gives you a way to further restrict the permissions for a\n federated user. You cannot use session policies to grant more permissions than those that\n are defined in the permissions policy of the IAM user. For more information, see Session\n Policies in the IAM User Guide. For information about\n using GetFederationToken to create temporary security credentials, see GetFederationToken—Federation Through a Custom Identity Broker.
You can use the credentials to access a resource that has a resource-based policy. If\n that policy specifically references the federated user session in the\n Principal element of the policy, the session has the permissions allowed by\n the policy. These permissions are granted in addition to the permissions granted by the\n session policies.
\n Tags\n
\n(Optional) You can pass tag key-value pairs to your session. These are called session\n tags. For more information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.
\nYou can create a mobile-based or browser-based app that can authenticate users\n using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID\n Connect-compatible identity provider. In this case, we recommend that you use Amazon Cognito or\n AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider in the\n IAM User Guide.
You can also call GetFederationToken using the security credentials of an\n Amazon Web Services account root user, but we do not recommend it. Instead, we recommend that you\n create an IAM user for the purpose of the proxy application. Then attach a policy to\n the IAM user that limits federated users to only the actions and resources that they\n need to access. For more information, see IAM Best Practices in the\n IAM User Guide.
\n Session duration\n
\nThe temporary credentials are valid for the specified duration, from 900 seconds (15\n minutes) up to a maximum of 129,600 seconds (36 hours). The default session duration is\n 43,200 seconds (12 hours). Temporary credentials that are obtained by using Amazon Web Services\n account root user credentials have a maximum duration of 3,600 seconds (1 hour).
\n\n Permissions\n
\nYou can use the temporary credentials created by GetFederationToken in\n any Amazon Web Services service except the following:
You cannot call any IAM operations using the CLI or the Amazon Web Services API.\n
\nYou cannot call any STS operations except\n GetCallerIdentity.
You must pass an inline or managed session policy to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policies to use as managed session\n policies. The plain text that you use for both inline and managed session policies can't\n exceed 2,048 characters.
\nThough the session policy parameters are optional, if you do not pass a policy, then\n the resulting federated user session has no permissions. When you pass session policies,\n the session permissions are the intersection of the IAM user policies and the session\n policies that you pass. This gives you a way to further restrict the permissions for a\n federated user. You cannot use session policies to grant more permissions than those\n that are defined in the permissions policy of the IAM user. For more information, see\n Session Policies\n in the IAM User Guide. For information about using\n GetFederationToken to create temporary security credentials, see GetFederationToken—Federation Through a Custom Identity Broker.
You can use the credentials to access a resource that has a resource-based policy. If\n that policy specifically references the federated user session in the\n Principal element of the policy, the session has the permissions\n allowed by the policy. These permissions are granted in addition to the permissions\n granted by the session policies.
\n Tags\n
\n(Optional) You can pass tag key-value pairs to your session. These are called session\n tags. For more information about session tags, see Passing Session Tags in STS in\n the IAM User Guide.
\nAn administrator must grant you the permissions necessary to pass session tags. The\n administrator can also create granular permissions to allow you to pass only specific\n session tags. For more information, see Tutorial: Using\n Tags for Attribute-Based Access Control in the\n IAM User Guide.
\nTag key–value pairs are not case sensitive, but case is preserved. This means that you\n cannot have separate Department and department tag keys.\n Assume that the user that you are federating has the\n Department=Marketing tag and you pass the\n department=engineering session tag.\n Department and department are not saved as separate tags,\n and the session tag passed in the request takes precedence over the user tag.
Returns a set of temporary security credentials (consisting of an access key ID, a\n secret access key, and a security token) for a federated user. A typical use is in a proxy\n application that gets temporary security credentials on behalf of distributed applications\n inside a corporate network. You must call the GetFederationToken operation\n using the long-term security credentials of an IAM user. As a result, this call is\n appropriate in contexts where those credentials can be safely stored, usually in a\n server-based application. For a comparison of GetFederationToken with the\n other API operations that produce temporary credentials, see Requesting Temporary Security\n Credentials and Comparing the\n Amazon Web Services STS API operations in the IAM User Guide.
You can create a mobile-based or browser-based app that can authenticate users using\n a web identity provider like Login with Amazon, Facebook, Google, or an OpenID\n Connect-compatible identity provider. In this case, we recommend that you use Amazon Cognito or\n AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider in the\n IAM User Guide.
You can also call GetFederationToken using the security credentials of an\n Amazon Web Services account root user, but we do not recommend it. Instead, we recommend that you create\n an IAM user for the purpose of the proxy application. Then attach a policy to the IAM\n user that limits federated users to only the actions and resources that they need to\n access. For more information, see IAM Best Practices in the\n IAM User Guide.
\n Session duration\n
\nThe temporary credentials are valid for the specified duration, from 900 seconds (15\n minutes) up to a maximum of 129,600 seconds (36 hours). The default session duration is\n 43,200 seconds (12 hours). Temporary credentials obtained by using the Amazon Web Services account root\n user credentials have a maximum duration of 3,600 seconds (1 hour).
\n\n Permissions\n
\nYou can use the temporary credentials created by GetFederationToken in any\n Amazon Web Services service except the following:
You cannot call any IAM operations using the CLI or the Amazon Web Services API.
\nYou cannot call any STS operations except GetCallerIdentity.
You must pass an inline or managed session policy to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policies to use as managed session policies.\n The plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters.
\nThough the session policy parameters are optional, if you do not pass a policy, then the\n resulting federated user session has no permissions. When you pass session policies, the\n session permissions are the intersection of the IAM user policies and the session\n policies that you pass. This gives you a way to further restrict the permissions for a\n federated user. You cannot use session policies to grant more permissions than those that\n are defined in the permissions policy of the IAM user. For more information, see Session\n Policies in the IAM User Guide. For information about\n using GetFederationToken to create temporary security credentials, see GetFederationToken—Federation Through a Custom Identity Broker.
You can use the credentials to access a resource that has a resource-based policy. If\n that policy specifically references the federated user session in the\n Principal element of the policy, the session has the permissions allowed by\n the policy. These permissions are granted in addition to the permissions granted by the\n session policies.
\n Tags\n
\n(Optional) You can pass tag key-value pairs to your session. These are called session\n tags. For more information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.
\nYou can create a mobile-based or browser-based app that can authenticate users using\n a web identity provider like Login with Amazon, Facebook, Google, or an OpenID\n Connect-compatible identity provider. In this case, we recommend that you use Amazon Cognito or\n AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider in the\n IAM User Guide.
An administrator must grant you the permissions necessary to pass session tags. The\n administrator can also create granular permissions to allow you to pass only specific\n session tags. For more information, see Tutorial: Using Tags\n for Attribute-Based Access Control in the\n IAM User Guide.
\nTag key–value pairs are not case sensitive, but case is preserved. This means that you\n cannot have separate Department and department tag keys. Assume\n that the user that you are federating has the\n Department=Marketing tag and you pass the\n department=engineering session tag. Department\n and department are not saved as separate tags, and the session tag passed in\n the request takes precedence over the user tag.
An IAM policy in JSON format that you want to use as an inline session policy.
\nYou must pass an inline or managed session policy to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policies to use as managed session\n policies.
\nThis parameter is optional. However, if you do not pass any session policies, then the\n resulting federated user session has no permissions.
\nWhen you pass session policies, the session permissions are the intersection of the\n IAM user policies and the session policies that you pass. This gives you a way to further\n restrict the permissions for a federated user. You cannot use session policies to grant\n more permissions than those that are defined in the permissions policy of the IAM user.\n For more information, see Session Policies in\n the IAM User Guide.
\nThe resulting credentials can be used to access a resource that has a resource-based\n policy. If that policy specifically references the federated user session in the\n Principal element of the policy, the session has the permissions allowed by\n the policy. These permissions are granted in addition to the permissions that are granted\n by the session policies.
The plaintext that you use for both inline and managed session policies can't exceed\n 2,048 characters. The JSON policy characters can be any ASCII character from the space\n character to the end of the valid character list (\\u0020 through \\u00FF). It can also\n include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)\n characters.
\nAn Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n
An IAM policy in JSON format that you want to use as an inline session policy.
\nYou must pass an inline or managed session policy to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policies to use as managed session\n policies.
\nThis parameter is optional. However, if you do not pass any session policies, then the\n resulting federated user session has no permissions.
\nWhen you pass session policies, the session permissions are the intersection of the\n IAM user policies and the session policies that you pass. This gives you a way to further\n restrict the permissions for a federated user. You cannot use session policies to grant\n more permissions than those that are defined in the permissions policy of the IAM user.\n For more information, see Session Policies in\n the IAM User Guide.
\nThe resulting credentials can be used to access a resource that has a resource-based\n policy. If that policy specifically references the federated user session in the\n Principal element of the policy, the session has the permissions allowed by\n the policy. These permissions are granted in addition to the permissions that are granted\n by the session policies.
The plaintext that you use for both inline and managed session policies can't exceed\n 2,048 characters. The JSON policy characters can be any ASCII character from the space\n character to the end of the valid character list (\\u0020 through \\u00FF). It can also\n include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)\n characters.
\n \nAn Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a\n managed session policy. The policies must exist in the same account as the IAM user that\n is requesting federated access.
\nYou must pass an inline or managed session policy to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policies to use as managed session policies.\n The plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. You can provide up to 10 managed policy ARNs. For more information about ARNs,\n see Amazon\n Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
\nThis parameter is optional. However, if you do not pass any session policies, then the\n resulting federated user session has no permissions.
\nWhen you pass session policies, the session permissions are the intersection of the\n IAM user policies and the session policies that you pass. This gives you a way to further\n restrict the permissions for a federated user. You cannot use session policies to grant\n more permissions than those that are defined in the permissions policy of the IAM user.\n For more information, see Session Policies in\n the IAM User Guide.
\nThe resulting credentials can be used to access a resource that has a resource-based\n policy. If that policy specifically references the federated user session in the\n Principal element of the policy, the session has the permissions allowed by\n the policy. These permissions are granted in addition to the permissions that are granted\n by the session policies.
An Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a\n managed session policy. The policies must exist in the same account as the IAM user that\n is requesting federated access.
\nYou must pass an inline or managed session policy to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policies to use as managed session policies.\n The plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. You can provide up to 10 managed policy ARNs. For more information about ARNs,\n see Amazon\n Resource Names (ARNs) and Amazon Web Services Service Namespaces in the\n Amazon Web Services General Reference.
\nThis parameter is optional. However, if you do not pass any session policies, then the\n resulting federated user session has no permissions.
\nWhen you pass session policies, the session permissions are the intersection of the\n IAM user policies and the session policies that you pass. This gives you a way to further\n restrict the permissions for a federated user. You cannot use session policies to grant\n more permissions than those that are defined in the permissions policy of the IAM user.\n For more information, see Session Policies in\n the IAM User Guide.
\nThe resulting credentials can be used to access a resource that has a resource-based\n policy. If that policy specifically references the federated user session in the\n Principal element of the policy, the session has the permissions allowed by\n the policy. These permissions are granted in addition to the permissions that are granted\n by the session policies.
An Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n
A list of session tags. Each session tag consists of a key name and an associated value.\n For more information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.
\nThis parameter is optional. You can pass up to 50 session tags. The plaintext session\n tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these\n and additional limits, see IAM\n and STS Character Limits in the IAM User Guide.
\n \nAn Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n
You can pass a session tag with the same key as a tag that is already\n attached to the user you are federating. When you do, session tags override a user tag with\n the same key.
\nTag key–value pairs are not case sensitive, but case is preserved. This means that you\n cannot have separate Department and department tag keys. Assume\n that the role has the Department=Marketing tag and you pass the\n department=engineering session tag. Department\n and department are not saved as separate tags, and the session tag passed in\n the request takes precedence over the role tag.
A list of session tags. Each session tag consists of a key name and an associated value.\n For more information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.
\nThis parameter is optional. You can pass up to 50 session tags. The plaintext session\n tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these\n and additional limits, see IAM\n and STS Character Limits in the IAM User Guide.
\n \nAn Amazon Web Services conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plaintext meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n
You can pass a session tag with the same key as a tag that is already attached to the\n user you are federating. When you do, session tags override a user tag with the same key.
\nTag key–value pairs are not case sensitive, but case is preserved. This means that you\n cannot have separate Department and department tag keys. Assume\n that the role has the Department=Marketing tag and you pass the\n department=engineering session tag. Department\n and department are not saved as separate tags, and the session tag passed in\n the request takes precedence over the role tag.
The temporary security credentials, which include an access key ID, a secret access key,\n and a security (or session) token.
\nThe size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.
\nThe temporary security credentials, which include an access key ID, a secret access key,\n and a security (or session) token.
\n \nThe size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.
\nReturns a set of temporary credentials for an Amazon Web Services account or IAM user. The\n credentials consist of an access key ID, a secret access key, and a security token.\n Typically, you use GetSessionToken if you want to use MFA to protect\n programmatic calls to specific Amazon Web Services API operations like Amazon EC2 StopInstances.\n MFA-enabled IAM users would need to call GetSessionToken and submit an MFA\n code that is associated with their MFA device. Using the temporary security credentials\n that are returned from the call, IAM users can then make programmatic calls to API\n operations that require MFA authentication. If you do not supply a correct MFA code, then\n the API returns an access denied error. For a comparison of GetSessionToken\n with the other API operations that produce temporary credentials, see Requesting\n Temporary Security Credentials and Comparing the\n STS API operations in the IAM User Guide.
\n Session Duration\n
\nThe GetSessionToken operation must be called by using the long-term Amazon Web Services\n security credentials of the Amazon Web Services account root user or an IAM user. Credentials that are\n created by IAM users are valid for the duration that you specify. This duration can range\n from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), with a default\n of 43,200 seconds (12 hours). Credentials based on account credentials can range from 900\n seconds (15 minutes) up to 3,600 seconds (1 hour), with a default of 1 hour.
\n Permissions\n
\nThe temporary security credentials created by GetSessionToken can be used\n to make API calls to any Amazon Web Services service with the following exceptions:
You cannot call any IAM API operations unless MFA authentication information is\n included in the request.
\nYou cannot call any STS API except\n AssumeRole or GetCallerIdentity.
We recommend that you do not call GetSessionToken with Amazon Web Services account\n root user credentials. Instead, follow our best practices by\n creating one or more IAM users, giving them the necessary permissions, and using IAM\n users for everyday interaction with Amazon Web Services.
The credentials that are returned by GetSessionToken are based on\n permissions associated with the user whose credentials were used to call the operation. If\n GetSessionToken is called using Amazon Web Services account root user credentials, the\n temporary credentials have root user permissions. Similarly, if\n GetSessionToken is called using the credentials of an IAM user, the\n temporary credentials have the same permissions as the IAM user.
For more information about using GetSessionToken to create temporary\n credentials, go to Temporary\n Credentials for Users in Untrusted Environments in the\n IAM User Guide.
Returns a set of temporary credentials for an Amazon Web Services account or IAM user. The\n credentials consist of an access key ID, a secret access key, and a security token.\n Typically, you use GetSessionToken if you want to use MFA to protect\n programmatic calls to specific Amazon Web Services API operations like Amazon EC2 StopInstances.\n MFA-enabled IAM users would need to call GetSessionToken and submit an MFA\n code that is associated with their MFA device. Using the temporary security credentials\n that are returned from the call, IAM users can then make programmatic calls to API\n operations that require MFA authentication. If you do not supply a correct MFA code, then\n the API returns an access denied error. For a comparison of GetSessionToken\n with the other API operations that produce temporary credentials, see Requesting\n Temporary Security Credentials and Comparing the\n Amazon Web Services STS API operations in the IAM User Guide.
\n Session Duration\n
\nThe GetSessionToken operation must be called by using the long-term Amazon Web Services\n security credentials of the Amazon Web Services account root user or an IAM user. Credentials that are\n created by IAM users are valid for the duration that you specify. This duration can range\n from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), with a default\n of 43,200 seconds (12 hours). Credentials based on account credentials can range from 900\n seconds (15 minutes) up to 3,600 seconds (1 hour), with a default of 1 hour.
\n Permissions\n
\nThe temporary security credentials created by GetSessionToken can be used\n to make API calls to any Amazon Web Services service with the following exceptions:
You cannot call any IAM API operations unless MFA authentication information is\n included in the request.
\nYou cannot call any STS API except\n AssumeRole or GetCallerIdentity.
We recommend that you do not call GetSessionToken with Amazon Web Services account\n root user credentials. Instead, follow our best practices by\n creating one or more IAM users, giving them the necessary permissions, and using IAM\n users for everyday interaction with Amazon Web Services.
The credentials that are returned by GetSessionToken are based on\n permissions associated with the user whose credentials were used to call the operation. If\n GetSessionToken is called using Amazon Web Services account root user credentials, the\n temporary credentials have root user permissions. Similarly, if\n GetSessionToken is called using the credentials of an IAM user, the\n temporary credentials have the same permissions as the IAM user.
For more information about using GetSessionToken to create temporary\n credentials, go to Temporary\n Credentials for Users in Untrusted Environments in the\n IAM User Guide.
The duration, in seconds, that the credentials should remain valid. Acceptable\n durations for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds\n (36 hours), with 43,200 seconds (12 hours) as the default. Sessions for Amazon Web Services account\n owners are restricted to a maximum of 3,600 seconds (one hour). If the duration is\n longer than one hour, the session for Amazon Web Services account owners defaults to one hour.
" + "smithy.api#documentation": "The duration, in seconds, that the credentials should remain valid. Acceptable durations\n for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours),\n with 43,200 seconds (12 hours) as the default. Sessions for Amazon Web Services account owners are\n restricted to a maximum of 3,600 seconds (one hour). If the duration is longer than one\n hour, the session for Amazon Web Services account owners defaults to one hour.
" } }, "SerialNumber": { "target": "com.amazonaws.sts#serialNumberType", "traits": { - "smithy.api#documentation": "The identification number of the MFA device that is associated with the IAM user who\n is making the GetSessionToken call. Specify this value if the IAM user\n has a policy that requires MFA authentication. The value is either the serial number for\n a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN)\n for a virtual device (such as arn:aws:iam::123456789012:mfa/user). You can\n find the device for an IAM user by going to the Management Console and viewing the user's\n security credentials.
The regex used to validate this parameter is a string of \n characters consisting of upper- and lower-case alphanumeric characters with no spaces. \n You can also include underscores or any of the following characters: =,.@:/-
" + "smithy.api#documentation": "The identification number of the MFA device that is associated with the IAM user who\n is making the GetSessionToken call. Specify this value if the IAM user has a\n policy that requires MFA authentication. The value is either the serial number for a\n hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a\n virtual device (such as arn:aws:iam::123456789012:mfa/user). You can find the\n device for an IAM user by going to the Amazon Web Services Management Console and viewing the user's security\n credentials.
The regex used to validate this parameter is a string of \n characters consisting of upper- and lower-case alphanumeric characters with no spaces. \n You can also include underscores or any of the following characters: =,.@:/-
" } }, "TokenCode": { "target": "com.amazonaws.sts#tokenCodeType", "traits": { - "smithy.api#documentation": "The value provided by the MFA device, if MFA is required. If any policy requires the\n IAM user to submit an MFA code, specify this value. If MFA authentication is required,\n the user must provide a code when requesting a set of temporary security credentials. A\n user who fails to provide the code receives an \"access denied\" response when requesting\n resources that require MFA authentication.
\nThe format for this parameter, as described by its regex pattern, is a sequence of six\n numeric digits.
" + "smithy.api#documentation": "The value provided by the MFA device, if MFA is required. If any policy requires the\n IAM user to submit an MFA code, specify this value. If MFA authentication is required,\n the user must provide a code when requesting a set of temporary security credentials. A\n user who fails to provide the code receives an \"access denied\" response when requesting\n resources that require MFA authentication.
\nThe format for this parameter, as described by its regex pattern, is a sequence of six\n numeric digits.
" } } } @@ -832,7 +832,7 @@ "Credentials": { "target": "com.amazonaws.sts#Credentials", "traits": { - "smithy.api#documentation": "The temporary security credentials, which include an access key ID, a secret access\n key, and a security (or session) token.
\n \nThe size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.
\nThe temporary security credentials, which include an access key ID, a secret access key,\n and a security (or session) token.
\n \nThe size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.
\nThe request was rejected because the total packed size of the session policies and\n session tags combined was too large. An Amazon Web Services conversion compresses the session policy\n document, session policy ARNs, and session tags into a packed binary format that has a\n separate limit. The error message indicates by percentage how close the policies and\n tags are to the upper size limit. For more information, see Passing Session Tags in STS in\n the IAM User Guide.
\nYou could receive this error even though you meet other defined session policy and\n session tag limits. For more information, see IAM and STS Entity\n Character Limits in the IAM User Guide.
", + "smithy.api#documentation": "The request was rejected because the total packed size of the session policies and\n session tags combined was too large. An Amazon Web Services conversion compresses the session policy\n document, session policy ARNs, and session tags into a packed binary format that has a\n separate limit. The error message indicates by percentage how close the policies and\n tags are to the upper size limit. For more information, see Passing Session Tags in STS in\n the IAM User Guide.
\nYou could receive this error even though you meet other defined session policy and\n session tag limits. For more information, see IAM and STS Entity\n Character Limits in the IAM User Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1013,7 +1013,7 @@ } }, "traits": { - "smithy.api#documentation": "You can pass custom key-value pair attributes when you assume a role or federate a user.\n These are called session tags. You can then use the session tags to control access to\n resources. For more information, see Tagging STS Sessions in the\n IAM User Guide.
" + "smithy.api#documentation": "You can pass custom key-value pair attributes when you assume a role or federate a user.\n These are called session tags. You can then use the session tags to control access to\n resources. For more information, see Tagging Amazon Web Services STS Sessions in the\n IAM User Guide.
" } }, "com.amazonaws.sts#accessKeyIdType": { diff --git a/aws/sdk/aws-models/textract.json b/aws/sdk/aws-models/textract.json index bf00e011431d2485d9f4cc8b71a40316cfb0053d..52657983e39b6bef90b024cd3a8dcdc344c7274a 100644 --- a/aws/sdk/aws-models/textract.json +++ b/aws/sdk/aws-models/textract.json @@ -180,7 +180,7 @@ } ], "traits": { - "smithy.api#documentation": "Analyzes an input document for financially related relationships between text.
\nInformation is returned as ExpenseDocuments and seperated as follows.
\n LineItemGroups- A data set containing LineItems which\n store information about the lines of text, such as an item purchased and its price on a receipt.
\n SummaryFields- Contains all other information a receipt, such as header information\n or the vendors name.
\n AnalyzeExpense synchronously analyzes an input document for financially related relationships between text.
Information is returned as ExpenseDocuments and seperated as follows.
\n LineItemGroups- A data set containing LineItems which\n store information about the lines of text, such as an item purchased and its price on a receipt.
\n SummaryFields- Contains all other information a receipt, such as header information\n or the vendors name.
Analyzes identity documents for relevant information. This information is extracted\n and returned as IdentityDocumentFields, which records both the normalized\n field and value of the extracted text.
Text of either the normalized field or value associated with it.
", + "smithy.api#required": {} + } + }, + "NormalizedValue": { + "target": "com.amazonaws.textract#NormalizedValue", + "traits": { + "smithy.api#documentation": "Only returned for dates, returns the type of value detected and the date\n written in a more machine readable way.
" + } + }, + "Confidence": { + "target": "com.amazonaws.textract#Percent", + "traits": { + "smithy.api#documentation": "The confidence score of the detected text.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Used to contain the information detected by an AnalyzeID operation.
" + } + }, + "com.amazonaws.textract#AnalyzeIDRequest": { + "type": "structure", + "members": { + "DocumentPages": { + "target": "com.amazonaws.textract#DocumentPages", + "traits": { + "smithy.api#documentation": "The document being passed to AnalyzeID.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.textract#AnalyzeIDResponse": { + "type": "structure", + "members": { + "IdentityDocuments": { + "target": "com.amazonaws.textract#IdentityDocumentList", + "traits": { + "smithy.api#documentation": "The list of documents processed by AnalyzeID. Includes a number denoting their\n place in the list and the response structure for the document.
" + } + }, + "DocumentMetadata": { + "target": "com.amazonaws.textract#DocumentMetadata" + }, + "AnalyzeIDModelVersion": { + "target": "com.amazonaws.textract#String", + "traits": { + "smithy.api#documentation": "The version of the AnalyzeIdentity API being used to process documents.
" + } + } + } + }, "com.amazonaws.textract#BadDocumentException": { "type": "structure", "members": { @@ -549,6 +649,18 @@ "smithy.api#documentation": "Information about the input document.
" } }, + "com.amazonaws.textract#DocumentPages": { + "type": "list", + "member": { + "target": "com.amazonaws.textract#Document" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, "com.amazonaws.textract#DocumentTooLargeException": { "type": "structure", "members": { @@ -672,7 +784,7 @@ } }, "traits": { - "smithy.api#documentation": "Breakdown of detected information, seperated into \n the catagories Type, LableDetection, and ValueDetection
" + "smithy.api#documentation": "Breakdown of detected information, seperated into \n the catagories Type, LabelDetection, and ValueDetection
" } }, "com.amazonaws.textract#ExpenseFieldList": { @@ -1237,6 +1349,52 @@ "smithy.api#error": "client" } }, + "com.amazonaws.textract#IdentityDocument": { + "type": "structure", + "members": { + "DocumentIndex": { + "target": "com.amazonaws.textract#UInteger", + "traits": { + "smithy.api#documentation": "Denotes the placement of a document in the IdentityDocument list. The first document\n is marked 1, the second 2 and so on.
" + } + }, + "IdentityDocumentFields": { + "target": "com.amazonaws.textract#IdentityDocumentFieldList", + "traits": { + "smithy.api#documentation": "The structure used to record information extracted from identity documents.\n Contains both normalized field and value of the extracted text.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The structure that lists each document processed in an AnalyzeID operation.
" + } + }, + "com.amazonaws.textract#IdentityDocumentField": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.textract#AnalyzeIDDetections" + }, + "ValueDetection": { + "target": "com.amazonaws.textract#AnalyzeIDDetections" + } + }, + "traits": { + "smithy.api#documentation": "Structure containing both the normalized type of the extracted information\n and the text associated with it. These are extracted as Type and Value respectively.
" + } + }, + "com.amazonaws.textract#IdentityDocumentFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.textract#IdentityDocumentField" + } + }, + "com.amazonaws.textract#IdentityDocumentList": { + "type": "list", + "member": { + "target": "com.amazonaws.textract#IdentityDocument" + } + }, "com.amazonaws.textract#ImageBlob": { "type": "blob", "traits": { @@ -1450,6 +1608,26 @@ "smithy.api#pattern": "\\S" } }, + "com.amazonaws.textract#NormalizedValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.textract#String", + "traits": { + "smithy.api#documentation": "The value of the date, written as Year-Month-DayTHour:Minute:Second.
" + } + }, + "ValueType": { + "target": "com.amazonaws.textract#ValueType", + "traits": { + "smithy.api#documentation": "The normalized type of the value detected. In this case, DATE.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information relating to dates in a document, including the type\n of value, and the value.
" + } + }, "com.amazonaws.textract#NotificationChannel": { "type": "structure", "members": { @@ -2068,6 +2246,9 @@ { "target": "com.amazonaws.textract#AnalyzeExpense" }, + { + "target": "com.amazonaws.textract#AnalyzeID" + }, { "target": "com.amazonaws.textract#DetectDocumentText" }, @@ -2126,10 +2307,21 @@ } }, "traits": { - "smithy.api#documentation": "The format of the input document isn't supported. Documents for synchronous operations can be in\n PNG or JPEG format. Documents for asynchronous operations can also be in PDF format.
", + "smithy.api#documentation": "The format of the input document isn't supported. Documents for synchronous operations can be in\n PNG or JPEG format only. Documents for asynchronous operations can be in PDF format.
", "smithy.api#error": "client" } }, + "com.amazonaws.textract#ValueType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DATE", + "name": "DATE" + } + ] + } + }, "com.amazonaws.textract#Warning": { "type": "structure", "members": { diff --git a/aws/sdk/aws-models/timestream-query.json b/aws/sdk/aws-models/timestream-query.json index 88bd7e8ac2aef0360eedc50f992cda065c0adf8a..d63d85b13937a309d86ed84d29124ef273e44349 100644 --- a/aws/sdk/aws-models/timestream-query.json +++ b/aws/sdk/aws-models/timestream-query.json @@ -37,11 +37,24 @@ } }, "traits": { - "smithy.api#documentation": "\n You are not authorized to perform this action.\n
", + "aws.protocols#awsQueryError": { + "code": "AccessDenied", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "You are not authorized to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, + "com.amazonaws.timestreamquery#AmazonResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, "com.amazonaws.timestreamquery#CancelQuery": { "type": "operation", "input": { @@ -71,7 +84,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": true }, - "smithy.api#documentation": "\n Cancels a query that has been issued. Cancellation is guaranteed only if the query has not \n completed execution before the cancellation request was issued. Because cancellation is an idempotent operation, \n subsequent cancellation requests will return a CancellationMessage, indicating that the query has already been canceled.\n
Cancels a query that has been issued. Cancellation is provided only if the query has\n not completed running before the cancellation request was issued. Because cancellation\n is an idempotent operation, subsequent cancellation requests will return a\n CancellationMessage, indicating that the query has already been\n canceled. See code\n sample for details.
\n The id of the query that needs to be cancelled. QueryID is returned as part of QueryResult.\n
The ID of the query that needs to be cancelled. QueryID is returned as\n part of the query result.
\n A CancellationMessage is returned when a CancelQuery request for the query specified by QueryId has already been issued. \n
A CancellationMessage is returned when a CancelQuery\n request for the query specified by QueryId has already been issued.
\n The name of the result set column. The name of the result set is available for columns of all data types except for arrays.\n
" + "smithy.api#documentation": "The name of the result set column. The name of the result set is available for\n columns of all data types except for arrays.
" } }, "Type": { "target": "com.amazonaws.timestreamquery#Type", "traits": { - "smithy.api#documentation": "\n The data type of the result set column. The data type can be a scalar or complex. Scalar data types are integers, strings, doubles, booleans, and others. Complex data types are types such as arrays, rows, and others.\n
", + "smithy.api#documentation": "The data type of the result set column. The data type can be a scalar or complex.\n Scalar data types are integers, strings, doubles, Booleans, and others. Complex data\n types are types such as arrays, rows, and others.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "\n Contains the meta data for query results such as the column names, data types, and other attributes.\n
" + "smithy.api#documentation": "Contains the metadata for query results such as the column names, data types, and\n other attributes.
" } }, "com.amazonaws.timestreamquery#ColumnInfoList": { @@ -143,47 +166,170 @@ } }, "traits": { - "smithy.api#documentation": "\n Unable to poll results for a cancelled query.\n
", + "smithy.api#documentation": "Unable to poll results for a cancelled query.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, + "com.amazonaws.timestreamquery#CreateScheduledQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamquery#CreateScheduledQueryRequest" + }, + "output": { + "target": "com.amazonaws.timestreamquery#CreateScheduledQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamquery#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreamquery#ConflictException" + }, + { + "target": "com.amazonaws.timestreamquery#InternalServerException" + }, + { + "target": "com.amazonaws.timestreamquery#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamquery#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.timestreamquery#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamquery#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": " Create a scheduled query that will be run on your behalf at the configured schedule.\n Timestream assumes the execution role provided as part of the\n ScheduledQueryExecutionRoleArn parameter to run the query. You can use\n the NotificationConfiguration parameter to configure notification for your\n scheduled query operations.
Name of the scheduled query.
", + "smithy.api#required": {} + } + }, + "QueryString": { + "target": "com.amazonaws.timestreamquery#QueryString", + "traits": { + "smithy.api#documentation": "The query string to run. Parameter\n names can be specified in the query string @ character followed by an\n identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run.
The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. \n For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is \n initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.
The schedule configuration for the query.
", + "smithy.api#required": {} + } + }, + "NotificationConfiguration": { + "target": "com.amazonaws.timestreamquery#NotificationConfiguration", + "traits": { + "smithy.api#documentation": "Notification configuration for the scheduled query. A notification is sent by\n Timestream when a query run finishes, when the state is updated or when you delete it.
", + "smithy.api#required": {} + } + }, + "TargetConfiguration": { + "target": "com.amazonaws.timestreamquery#TargetConfiguration", + "traits": { + "smithy.api#documentation": "Configuration used for writing the result of a query.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.timestreamquery#ClientToken", + "traits": { + "smithy.api#documentation": "Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making \n multiple identical CreateScheduledQuery requests has the same effect as making a single request.\n\n
\n If CreateScheduledQuery is called without a ClientToken, the\n Query SDK generates a ClientToken on your behalf.
After 8 hours, any request with the same ClientToken is treated\n as a new request.
The ARN for the IAM role that Timestream will assume when running the scheduled query.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.timestreamquery#TagList", + "traits": { + "smithy.api#documentation": "A list of key-value pairs to label the scheduled query.
" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.timestreamquery#StringValue2048", + "traits": { + "smithy.api#documentation": "The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS\n key is not specified, the scheduled query resource will be encrypted with a Timestream\n owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias\n ARN. When using an alias name, prefix the name with alias/\n
\nIf ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.
Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.timestreamquery#CreateScheduledQueryResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.timestreamquery#AmazonResourceName", + "traits": { + "smithy.api#documentation": "ARN for the created scheduled query.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.timestreamquery#Datum": { "type": "structure", "members": { "ScalarValue": { "target": "com.amazonaws.timestreamquery#ScalarValue", "traits": { - "smithy.api#documentation": "\n Indicates if the data point is a scalar value such as integer, string, double, or boolean.\n
" + "smithy.api#documentation": "Indicates if the data point is a scalar value such as integer, string, double, or\n Boolean.
" } }, "TimeSeriesValue": { "target": "com.amazonaws.timestreamquery#TimeSeriesDataPointList", "traits": { - "smithy.api#documentation": "\n Indicates if the data point is of timeseries data type.\n
" + "smithy.api#documentation": "Indicates if the data point is a timeseries data type.
" } }, "ArrayValue": { "target": "com.amazonaws.timestreamquery#DatumList", "traits": { - "smithy.api#documentation": "\n Indicates if the data point is an array.\n
" + "smithy.api#documentation": "Indicates if the data point is an array.
" } }, "RowValue": { "target": "com.amazonaws.timestreamquery#Row", "traits": { - "smithy.api#documentation": "\n Indicates if the data point is a row.\n
" + "smithy.api#documentation": "Indicates if the data point is a row.
" } }, "NullValue": { "target": "com.amazonaws.timestreamquery#NullableBoolean", "traits": { - "smithy.api#documentation": "\n Indicates if the data point is null.\n
" + "smithy.api#documentation": "Indicates if the data point is null.
" } } }, "traits": { - "smithy.api#documentation": "\n Datum represents a single data point in a query result.\n
" + "smithy.api#documentation": "Datum represents a single data point in a query result.
" } }, "com.amazonaws.timestreamquery#DatumList": { @@ -192,6 +338,51 @@ "target": "com.amazonaws.timestreamquery#Datum" } }, + "com.amazonaws.timestreamquery#DeleteScheduledQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamquery#DeleteScheduledQueryRequest" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamquery#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreamquery#InternalServerException" + }, + { + "target": "com.amazonaws.timestreamquery#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamquery#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreamquery#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamquery#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "Deletes a given scheduled query. This is an irreversible operation.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.timestreamquery#DeleteScheduledQueryRequest": { + "type": "structure", + "members": { + "ScheduledQueryArn": { + "target": "com.amazonaws.timestreamquery#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The ARN of the scheduled query.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.timestreamquery#DescribeEndpoints": { "type": "operation", "input": { @@ -212,7 +403,7 @@ } ], "traits": { - "smithy.api#documentation": "DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.\n This API is available through both Write and Query.
\nBecause Timestream’s SDKs are designed to transparently work with the service’s architecture, \n including the management and mapping of the service endpoints,\n it is not recommended that you use this API unless:
\nYour application uses a programming language that does not yet have SDK support
\nYou require better control over the client-side implementation
\nFor detailed information on how to use DescribeEndpoints, \n see The Endpoint Discovery Pattern and REST APIs.
" + "smithy.api#documentation": "DescribeEndpoints returns a list of available endpoints to make Timestream\n API calls against. This API is available through both Write and Query.
\nBecause the Timestream SDKs are designed to transparently work with the\n service’s architecture, including the management and mapping of the service endpoints,\n it is not recommended that you use this API unless:
\nYou are using VPC endpoints (Amazon Web Services PrivateLink) with Timestream\n \n
\nYour application uses a programming language that does not yet have SDK\n support
\nYou require better control over the client-side implementation
\nFor detailed information on how and when to use and implement DescribeEndpoints, see\n The Endpoint Discovery Pattern.
" } }, "com.amazonaws.timestreamquery#DescribeEndpointsRequest": { @@ -225,10 +416,108 @@ "Endpoints": { "target": "com.amazonaws.timestreamquery#Endpoints", "traits": { - "smithy.api#documentation": "An Endpoints object is returned when a DescribeEndpoints request is made.
An Endpoints object is returned when a DescribeEndpoints\n request is made.
Provides detailed information about a scheduled query.
" + } + }, + "com.amazonaws.timestreamquery#DescribeScheduledQueryRequest": { + "type": "structure", + "members": { + "ScheduledQueryArn": { + "target": "com.amazonaws.timestreamquery#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The ARN of the scheduled query.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.timestreamquery#DescribeScheduledQueryResponse": { + "type": "structure", + "members": { + "ScheduledQuery": { + "target": "com.amazonaws.timestreamquery#ScheduledQueryDescription", + "traits": { + "smithy.api#documentation": "The scheduled query.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.timestreamquery#DimensionMapping": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.timestreamquery#SchemaName", + "traits": { + "smithy.api#documentation": "Column name from query result.
", + "smithy.api#required": {} + } + }, + "DimensionValueType": { + "target": "com.amazonaws.timestreamquery#DimensionValueType", + "traits": { + "smithy.api#documentation": "Type for the dimension.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "This type is used to map column(s) from the query result to a dimension in the\n destination table.
" + } + }, + "com.amazonaws.timestreamquery#DimensionMappingList": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreamquery#DimensionMapping" + } + }, + "com.amazonaws.timestreamquery#DimensionValueType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "VARCHAR", + "name": "VARCHAR" + } + ] } }, "com.amazonaws.timestreamquery#Double": { @@ -253,7 +542,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents an available endpoint against which to make API calls agaisnt, as well as the TTL for that endpoint.
" + "smithy.api#documentation": "Represents an available endpoint against which to make API calls against, as well as\n the TTL for that endpoint.
" } }, "com.amazonaws.timestreamquery#Endpoints": { @@ -265,66 +554,44 @@ "com.amazonaws.timestreamquery#ErrorMessage": { "type": "string" }, - "com.amazonaws.timestreamquery#InternalServerException": { + "com.amazonaws.timestreamquery#ErrorReportConfiguration": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.timestreamquery#ErrorMessage" + "S3Configuration": { + "target": "com.amazonaws.timestreamquery#S3Configuration", + "traits": { + "smithy.api#documentation": "The S3 configuration for the error reports.
", + "smithy.api#required": {} + } } }, "traits": { - "smithy.api#documentation": "\n Timestream was unable to fully process this request because of an internal server error.\n
", - "smithy.api#error": "server", - "smithy.api#httpError": 500 + "smithy.api#documentation": "Configuration required for error reporting.
" } }, - "com.amazonaws.timestreamquery#InvalidEndpointException": { + "com.amazonaws.timestreamquery#ErrorReportLocation": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.timestreamquery#ErrorMessage" + "S3ReportLocation": { + "target": "com.amazonaws.timestreamquery#S3ReportLocation", + "traits": { + "smithy.api#documentation": "The S3 location where error reports are written.
" + } } }, "traits": { - "smithy.api#documentation": "The requested endpoint was invalid.
", - "smithy.api#error": "client", - "smithy.api#httpError": 421 - } - }, - "com.amazonaws.timestreamquery#Long": { - "type": "long" - }, - "com.amazonaws.timestreamquery#MaxQueryResults": { - "type": "integer", - "traits": { - "smithy.api#box": {}, - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.timestreamquery#NullableBoolean": { - "type": "boolean", - "traits": { - "smithy.api#box": {} + "smithy.api#documentation": "This contains the location of the error report for a single scheduled query call.\n
" } }, - "com.amazonaws.timestreamquery#Query": { + "com.amazonaws.timestreamquery#ExecuteScheduledQuery": { "type": "operation", "input": { - "target": "com.amazonaws.timestreamquery#QueryRequest" - }, - "output": { - "target": "com.amazonaws.timestreamquery#QueryResponse" + "target": "com.amazonaws.timestreamquery#ExecuteScheduledQueryRequest" }, "errors": [ { "target": "com.amazonaws.timestreamquery#AccessDeniedException" }, - { - "target": "com.amazonaws.timestreamquery#ConflictException" - }, { "target": "com.amazonaws.timestreamquery#InternalServerException" }, @@ -332,7 +599,7 @@ "target": "com.amazonaws.timestreamquery#InvalidEndpointException" }, { - "target": "com.amazonaws.timestreamquery#QueryExecutionException" + "target": "com.amazonaws.timestreamquery#ResourceNotFoundException" }, { "target": "com.amazonaws.timestreamquery#ThrottlingException" @@ -345,17 +612,88 @@ "aws.api#clientDiscoveredEndpoint": { "required": true }, - "smithy.api#documentation": "\n Query is a synchronous operation that enables you to execute a query. Query will timeout after 60 seconds. You must update the default timeout in the SDK to support a timeout of 60 seconds. The result set will be truncated to 1MB. Service quotas apply. For more information, see Quotas in the Timestream Developer Guide.\n
", - "smithy.api#idempotent": {}, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Rows", - "pageSize": "MaxRows" + "smithy.api#documentation": "You can use this API to run a scheduled query manually.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.timestreamquery#ExecuteScheduledQueryRequest": { + "type": "structure", + "members": { + "ScheduledQueryArn": { + "target": "com.amazonaws.timestreamquery#AmazonResourceName", + "traits": { + "smithy.api#documentation": "ARN of the scheduled query.
", + "smithy.api#required": {} + } + }, + "InvocationTime": { + "target": "com.amazonaws.timestreamquery#Time", + "traits": { + "smithy.api#documentation": "The timestamp in UTC. Query will be run as if it was invoked at this timestamp.
", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.timestreamquery#ClientToken", + "traits": { + "smithy.api#documentation": "Not used.
", + "smithy.api#idempotencyToken": {} + } } } }, - "com.amazonaws.timestreamquery#QueryExecutionException": { + "com.amazonaws.timestreamquery#ExecutionStats": { + "type": "structure", + "members": { + "ExecutionTimeInMillis": { + "target": "com.amazonaws.timestreamquery#Long", + "traits": { + "smithy.api#documentation": "Total time, measured in milliseconds, that was needed for the scheduled query run to complete.
" + } + }, + "DataWrites": { + "target": "com.amazonaws.timestreamquery#Long", + "traits": { + "smithy.api#documentation": "Data writes metered for records ingested in a single scheduled query run.
" + } + }, + "BytesMetered": { + "target": "com.amazonaws.timestreamquery#Long", + "traits": { + "smithy.api#documentation": "Bytes metered for a single scheduled query run.
" + } + }, + "RecordsIngested": { + "target": "com.amazonaws.timestreamquery#Long", + "traits": { + "smithy.api#documentation": "The number of records ingested for a single scheduled query run.
" + } + }, + "QueryResultRows": { + "target": "com.amazonaws.timestreamquery#Long", + "traits": { + "smithy.api#documentation": "Number of rows present in the output from running a query before ingestion to\n destination data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Statistics for a single scheduled query run.
" + } + }, + "com.amazonaws.timestreamquery#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.timestreamquery#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "\n Timestream was unable to fully process this request because of an internal\n server error.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.timestreamquery#InvalidEndpointException": { "type": "structure", "members": { "Message": { @@ -363,203 +701,1379 @@ } }, "traits": { - "smithy.api#documentation": "\n Timestream was unable to run the query successfully.\n
", + "smithy.api#documentation": "The requested endpoint was not valid.
", "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#httpError": 421 } }, - "com.amazonaws.timestreamquery#QueryId": { - "type": "string", + "com.amazonaws.timestreamquery#ListScheduledQueries": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamquery#ListScheduledQueriesRequest" + }, + "output": { + "target": "com.amazonaws.timestreamquery#ListScheduledQueriesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamquery#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreamquery#InternalServerException" + }, + { + "target": "com.amazonaws.timestreamquery#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamquery#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamquery#ValidationException" + } + ], "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 + "aws.api#clientDiscoveredEndpoint": { + "required": true }, - "smithy.api#pattern": "[a-zA-Z0-9]+" + "smithy.api#documentation": "Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries is eventually consistent.
\n The query to be executed by Timestream.\n
", - "smithy.api#required": {} + "smithy.api#documentation": "The maximum number of items to return in the output. If the total number of items\n available is more than the value specified, a NextToken is provided in the\n output. To resume pagination, provide the NextToken value as the argument\n to the subsequent call to ListScheduledQueriesRequest.
\n Unique, case-sensitive string of up to 64 ASCII characters that you specify when you make a Query request.\n Providing a ClientToken makes the call to Query idempotent, meaning that multiple identical calls \n have the same effect as one single call.\n
Your query request will fail in the following cases:
\n\n If you submit a request with the same client token outside the 5-minute idepotency window.\n
\n\n If you submit a request with the same client token but a change in other parameters within the 5-minute idempotency window. \n
\n\n After 4 hours, any request with the same client token is treated as a new request.\n
", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "A pagination token to resume pagination.
" + } + } + } + }, + "com.amazonaws.timestreamquery#ListScheduledQueriesResponse": { + "type": "structure", + "members": { + "ScheduledQueries": { + "target": "com.amazonaws.timestreamquery#ScheduledQueryList", + "traits": { + "smithy.api#documentation": "A list of scheduled queries.
", + "smithy.api#required": {} } }, "NextToken": { - "target": "com.amazonaws.timestreamquery#String", + "target": "com.amazonaws.timestreamquery#NextScheduledQueriesResultsToken", + "traits": { + "smithy.api#documentation": "A token to specify where to start paginating. This is the NextToken from a previously\n truncated response.
" + } + } + } + }, + "com.amazonaws.timestreamquery#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamquery#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.timestreamquery#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamquery#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamquery#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreamquery#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamquery#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "List all tags on a Timestream query resource.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.timestreamquery#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.timestreamquery#AmazonResourceName", "traits": { - "smithy.api#documentation": "\n A pagination token passed to get a set of results.\n
" + "smithy.api#documentation": "The Timestream resource with tags to be listed. This value is an Amazon Resource Name\n (ARN).
", + "smithy.api#required": {} } }, - "MaxRows": { - "target": "com.amazonaws.timestreamquery#MaxQueryResults", + "MaxResults": { + "target": "com.amazonaws.timestreamquery#MaxTagsForResourceResult", + "traits": { + "smithy.api#documentation": "The maximum number of tags to return.
" + } + }, + "NextToken": { + "target": "com.amazonaws.timestreamquery#NextTagsForResourceResultsToken", "traits": { - "smithy.api#documentation": "\n The total number of rows to return in the output. If the total number of rows available\n is more than the value specified, a NextToken is provided in the command's output.\n To resume pagination, provide the NextToken value in the starting-token argument of a \n subsequent command.\n
" + "smithy.api#documentation": "A pagination token to resume pagination.
" } } } }, - "com.amazonaws.timestreamquery#QueryResponse": { + "com.amazonaws.timestreamquery#ListTagsForResourceResponse": { "type": "structure", "members": { - "QueryId": { - "target": "com.amazonaws.timestreamquery#QueryId", + "Tags": { + "target": "com.amazonaws.timestreamquery#TagList", "traits": { - "smithy.api#documentation": "\n A unique ID for the given query.\n
", + "smithy.api#documentation": "The tags currently associated with the Timestream resource.
", "smithy.api#required": {} } }, "NextToken": { - "target": "com.amazonaws.timestreamquery#String", + "target": "com.amazonaws.timestreamquery#NextTagsForResourceResultsToken", + "traits": { + "smithy.api#documentation": "A pagination token to resume pagination with a subsequent call to\n ListTagsForResourceResponse.
\n A pagination token that can be used again on a Query call to get the next set of results. \n
Refers to the value of measure_name in a result row. This field is required if\n MeasureNameColumn is provided.
" } }, - "Rows": { - "target": "com.amazonaws.timestreamquery#RowList", + "SourceColumn": { + "target": "com.amazonaws.timestreamquery#SchemaName", "traits": { - "smithy.api#documentation": "\n The result set rows returned by the query.\n
", - "smithy.api#required": {} + "smithy.api#documentation": "This field refers to the source column from which measure-value is to be read for\n result materialization.
" } }, - "ColumnInfo": { - "target": "com.amazonaws.timestreamquery#ColumnInfoList", + "TargetMeasureName": { + "target": "com.amazonaws.timestreamquery#SchemaName", + "traits": { + "smithy.api#documentation": "Target measure name to be used. If not provided, the target measure name by default\n would be measure-name if provided, or sourceColumn otherwise.
" + } + }, + "MeasureValueType": { + "target": "com.amazonaws.timestreamquery#MeasureValueType", "traits": { - "smithy.api#documentation": "\n The column data types of the returned result set.\n
", + "smithy.api#documentation": "Type of the value that is to be read from sourceColumn. If the mapping is for MULTI,\n use MeasureValueType.MULTI.
", "smithy.api#required": {} } }, - "QueryStatus": { - "target": "com.amazonaws.timestreamquery#QueryStatus", + "MultiMeasureAttributeMappings": { + "target": "com.amazonaws.timestreamquery#MultiMeasureAttributeMappingList", "traits": { - "smithy.api#documentation": "Information about the status of the query, including progress and bytes scannned.
" + "smithy.api#documentation": "Required when measureValueType is MULTI. Attribute mappings for MULTI value\n measures.
" } } + }, + "traits": { + "smithy.api#documentation": "MixedMeasureMappings are mappings that can be used to ingest data into a mixture of\n narrow and multi measures in the derived table.
" } }, - "com.amazonaws.timestreamquery#QueryStatus": { + "com.amazonaws.timestreamquery#MixedMeasureMappingList": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreamquery#MixedMeasureMapping" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.timestreamquery#MultiMeasureAttributeMapping": { "type": "structure", "members": { - "ProgressPercentage": { - "target": "com.amazonaws.timestreamquery#Double", + "SourceColumn": { + "target": "com.amazonaws.timestreamquery#SchemaName", "traits": { - "smithy.api#documentation": "The progress of the query, expressed as a percentage.
" + "smithy.api#documentation": "Source column from where the attribute value is to be read.
", + "smithy.api#required": {} } }, - "CumulativeBytesScanned": { - "target": "com.amazonaws.timestreamquery#Long", + "TargetMultiMeasureAttributeName": { + "target": "com.amazonaws.timestreamquery#SchemaName", + "traits": { + "smithy.api#documentation": "Custom name to be used for attribute name in derived table. If not provided, source\n column name would be used.
" + } + }, + "MeasureValueType": { + "target": "com.amazonaws.timestreamquery#ScalarMeasureValueType", + "traits": { + "smithy.api#documentation": "Type of the attribute to be read from the source column.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Attribute mapping for MULTI value measures.
" + } + }, + "com.amazonaws.timestreamquery#MultiMeasureAttributeMappingList": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreamquery#MultiMeasureAttributeMapping" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.timestreamquery#MultiMeasureMappings": { + "type": "structure", + "members": { + "TargetMultiMeasureName": { + "target": "com.amazonaws.timestreamquery#SchemaName", + "traits": { + "smithy.api#documentation": "The name of the target multi-measure name in the derived table. This input is required\n when measureNameColumn is not provided. If MeasureNameColumn is provided, then value\n from that column will be used as multi-measure name.
" + } + }, + "MultiMeasureAttributeMappings": { + "target": "com.amazonaws.timestreamquery#MultiMeasureAttributeMappingList", + "traits": { + "smithy.api#documentation": "Required. Attribute mappings to be used for mapping query results to ingest data for\n multi-measure attributes.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Only one of MixedMeasureMappings or MultiMeasureMappings is to be provided.\n MultiMeasureMappings can be used to ingest data as multi measures in the derived\n table.
" + } + }, + "com.amazonaws.timestreamquery#NextScheduledQueriesResultsToken": { + "type": "string" + }, + "com.amazonaws.timestreamquery#NextTagsForResourceResultsToken": { + "type": "string" + }, + "com.amazonaws.timestreamquery#NotificationConfiguration": { + "type": "structure", + "members": { + "SnsConfiguration": { + "target": "com.amazonaws.timestreamquery#SnsConfiguration", + "traits": { + "smithy.api#documentation": "Details on SNS configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Notification configuration for a scheduled query. A notification is sent by\n Timestream when a scheduled query is created, its state is updated or when it is deleted.
" + } + }, + "com.amazonaws.timestreamquery#NullableBoolean": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.timestreamquery#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.timestreamquery#ParameterMapping": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.timestreamquery#String", + "traits": { + "smithy.api#documentation": "Parameter name.
", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.timestreamquery#Type", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Mapping for named parameters.
" + } + }, + "com.amazonaws.timestreamquery#ParameterMappingList": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreamquery#ParameterMapping" + } + }, + "com.amazonaws.timestreamquery#PrepareQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamquery#PrepareQueryRequest" + }, + "output": { + "target": "com.amazonaws.timestreamquery#PrepareQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamquery#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreamquery#InternalServerException" + }, + { + "target": "com.amazonaws.timestreamquery#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamquery#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamquery#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "A synchronous operation that allows you to submit a query with parameters to be stored\n by Timestream for later running. Timestream only supports using this operation with the\n PrepareQueryRequest$ValidateOnly set to true.
The Timestream query string that you want to use as a prepared statement. Parameter\n names can be specified in the query string @ character followed by an\n identifier.
By setting this value to true, Timestream will only validate that the\n query string is a valid Timestream query, and not store the prepared query for later\n use.
The query string that you want prepare.
", + "smithy.api#required": {} + } + }, + "Columns": { + "target": "com.amazonaws.timestreamquery#SelectColumnList", + "traits": { + "smithy.api#documentation": "A list of SELECT clause columns of the submitted query string.
", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.timestreamquery#ParameterMappingList", + "traits": { + "smithy.api#documentation": "A list of parameters used in the submitted query string.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.timestreamquery#Query": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamquery#QueryRequest" + }, + "output": { + "target": "com.amazonaws.timestreamquery#QueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamquery#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreamquery#ConflictException" + }, + { + "target": "com.amazonaws.timestreamquery#InternalServerException" + }, + { + "target": "com.amazonaws.timestreamquery#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamquery#QueryExecutionException" + }, + { + "target": "com.amazonaws.timestreamquery#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamquery#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "\n Query is a synchronous operation that enables you to run a query against\n your Amazon Timestream data. Query will time out after 60 seconds.\n You must update the default timeout in the SDK to support a timeout of 60 seconds. See\n the code\n sample for details.
Your query request will fail in the following cases:
\n If you submit a Query request with the same client token outside\n of the 5-minute idempotency window.
If you submit a Query request with the same client token, but\n change other parameters, within the 5-minute idempotency window.
If the size of the row (including the query metadata) exceeds 1 MB, then the\n query will fail with the following error message:
\n\n Query aborted as max page response size has been exceeded by the output\n result row\n
If the IAM principal of the query initiator and the result reader are not the\n same and/or the query initiator and the result reader do not have the same query\n string in the query requests, the query will fail with an Invalid\n pagination token error.
\n Timestream was unable to run the query successfully.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.timestreamquery#QueryId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.timestreamquery#QueryRequest": { + "type": "structure", + "members": { + "QueryString": { + "target": "com.amazonaws.timestreamquery#QueryString", + "traits": { + "smithy.api#documentation": "The query to be run by Timestream.
", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.timestreamquery#ClientRequestToken", + "traits": { + "smithy.api#documentation": " Unique, case-sensitive string of up to 64 ASCII characters specified when a\n Query request is made. Providing a ClientToken makes the\n call to Query\n idempotent. This means that running the same query repeatedly will\n produce the same result. In other words, making multiple identical Query\n requests has the same effect as making a single request. When using\n ClientToken in a query, note the following:
If the Query API is instantiated without a ClientToken, the\n Query SDK generates a ClientToken on your behalf.
If the Query invocation only contains the\n ClientToken but does not include a NextToken, that\n invocation of Query is assumed to be a new query run.
If the invocation contains NextToken, that particular invocation\n is assumed to be a subsequent invocation of a prior call to the Query API, and a\n result set is returned.
After 4 hours, any request with the same ClientToken is treated\n as a new request.
A pagination token used to return a set of results. When the Query API\n is invoked using NextToken, that particular invocation is assumed to be a\n subsequent invocation of a prior call to Query, and a result set is\n returned. However, if the Query invocation only contains the\n ClientToken, that invocation of Query is assumed to be a\n new query run.
Note the following when using NextToken in a query:
\nA pagination token can be used for up to five Query invocations,\n OR for a duration of up to 1 hour – whichever comes first.
Using the same NextToken will return the same set of records. To\n keep paginating through the result set, you must to use the most recent\n nextToken.
Suppose a Query invocation returns two NextToken\n values, TokenA and TokenB. If TokenB is\n used in a subsequent Query invocation, then TokenA is\n invalidated and cannot be reused.
To request a previous result set from a query after pagination has begun, you\n must re-invoke the Query API.
\nThe latest NextToken should be used to paginate until\n null is returned, at which point a new NextToken\n should be used.
If the IAM principal of the query initiator and the result reader are not the\n same and/or the query initiator and the result reader do not have the same query\n string in the query requests, the query will fail with an Invalid\n pagination token error.
The total number of rows to be returned in the Query output. The initial\n run of Query with a MaxRows value specified will return the\n result set of the query in two cases:
The size of the result is less than 1MB.
The number of rows in the result set is less than the value of\n maxRows.
Otherwise, the initial invocation of Query only returns a\n NextToken, which can then be used in subsequent calls to fetch the\n result set. To resume pagination, provide the NextToken value in the\n subsequent command.
If the row size is large (e.g. a row has many columns), Timestream may return\n fewer rows to keep the response size from exceeding the 1 MB limit. If\n MaxRows is not provided, Timestream will send the necessary\n number of rows to meet the 1 MB limit.
A unique ID for the given query.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.timestreamquery#PaginationToken", + "traits": { + "smithy.api#documentation": " A pagination token that can be used again on a Query call to get the\n next set of results.
The result set rows returned by the query.
", + "smithy.api#required": {} + } + }, + "ColumnInfo": { + "target": "com.amazonaws.timestreamquery#ColumnInfoList", + "traits": { + "smithy.api#documentation": "The column data types of the returned result set.
", + "smithy.api#required": {} + } + }, + "QueryStatus": { + "target": "com.amazonaws.timestreamquery#QueryStatus", + "traits": { + "smithy.api#documentation": "Information about the status of the query, including progress and bytes\n scanned.
" + } + } + } + }, + "com.amazonaws.timestreamquery#QueryStatus": { + "type": "structure", + "members": { + "ProgressPercentage": { + "target": "com.amazonaws.timestreamquery#Double", + "traits": { + "smithy.api#documentation": "The progress of the query, expressed as a percentage.
" + } + }, + "CumulativeBytesScanned": { + "target": "com.amazonaws.timestreamquery#Long", + "traits": { + "smithy.api#documentation": "The amount of data scanned by the query in bytes. This is a cumulative sum and\n represents the total amount of bytes scanned since the query was started.
" + } + }, + "CumulativeBytesMetered": { + "target": "com.amazonaws.timestreamquery#Long", + "traits": { + "smithy.api#documentation": "The amount of data scanned by the query in bytes that you will be charged for. This is\n a cumulative sum and represents the total amount of data that you will be charged for\n since the query was started. The charge is applied only once and is either applied when\n the query completes running or when the query is cancelled.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the status of the query, including progress and bytes\n scanned.
" + } + }, + "com.amazonaws.timestreamquery#QueryString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 262144 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.timestreamquery#ResourceName": { + "type": "string" + }, + "com.amazonaws.timestreamquery#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.timestreamquery#ErrorMessage" + }, + "ScheduledQueryArn": { + "target": "com.amazonaws.timestreamquery#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The ARN of the scheduled query.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The requested resource could not be found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.timestreamquery#Row": { + "type": "structure", + "members": { + "Data": { + "target": "com.amazonaws.timestreamquery#DatumList", + "traits": { + "smithy.api#documentation": "List of data points in a single row of the result set.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a single row in the query results.
" + } + }, + "com.amazonaws.timestreamquery#RowList": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreamquery#Row" + } + }, + "com.amazonaws.timestreamquery#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.timestreamquery#S3Configuration": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.timestreamquery#S3BucketName", + "traits": { + "smithy.api#documentation": "Name of the S3 bucket under which error reports will be created.
", + "smithy.api#required": {} + } + }, + "ObjectKeyPrefix": { + "target": "com.amazonaws.timestreamquery#S3ObjectKeyPrefix", + "traits": { + "smithy.api#documentation": "Prefix for the error report key. Timestream by default adds the following prefix to\n the error report path.
" + } + }, + "EncryptionOption": { + "target": "com.amazonaws.timestreamquery#S3EncryptionOption", + "traits": { + "smithy.api#documentation": "Encryption at rest options for the error reports. If no encryption option is\n specified, Timestream will choose SSE_S3 as default.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details on S3 location for error reports that result from running a query.
" + } + }, + "com.amazonaws.timestreamquery#S3EncryptionOption": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SSE_S3", + "name": "SSE_S3" + }, + { + "value": "SSE_KMS", + "name": "SSE_KMS" + } + ] + } + }, + "com.amazonaws.timestreamquery#S3ObjectKey": { + "type": "string" + }, + "com.amazonaws.timestreamquery#S3ObjectKeyPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 896 + }, + "smithy.api#pattern": "^[a-zA-Z0-9|!\\-_*'\\(\\)]([a-zA-Z0-9]|[!\\-_*'\\(\\)\\/.])+$" + } + }, + "com.amazonaws.timestreamquery#S3ReportLocation": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.timestreamquery#S3BucketName", + "traits": { + "smithy.api#documentation": "S3 bucket name.
" + } + }, + "ObjectKey": { + "target": "com.amazonaws.timestreamquery#S3ObjectKey", + "traits": { + "smithy.api#documentation": "S3 key.
" + } + } + }, + "traits": { + "smithy.api#documentation": "S3 report location for the scheduled query run.
" + } + }, + "com.amazonaws.timestreamquery#ScalarMeasureValueType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "BIGINT", + "name": "BIGINT" + }, + { + "value": "BOOLEAN", + "name": "BOOLEAN" + }, + { + "value": "DOUBLE", + "name": "DOUBLE" + }, + { + "value": "VARCHAR", + "name": "VARCHAR" + } + ] + } + }, + "com.amazonaws.timestreamquery#ScalarType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "VARCHAR", + "name": "VARCHAR" + }, + { + "value": "BOOLEAN", + "name": "BOOLEAN" + }, + { + "value": "BIGINT", + "name": "BIGINT" + }, + { + "value": "DOUBLE", + "name": "DOUBLE" + }, + { + "value": "TIMESTAMP", + "name": "TIMESTAMP" + }, + { + "value": "DATE", + "name": "DATE" + }, + { + "value": "TIME", + "name": "TIME" + }, + { + "value": "INTERVAL_DAY_TO_SECOND", + "name": "INTERVAL_DAY_TO_SECOND" + }, + { + "value": "INTERVAL_YEAR_TO_MONTH", + "name": "INTERVAL_YEAR_TO_MONTH" + }, + { + "value": "UNKNOWN", + "name": "UNKNOWN" + }, + { + "value": "INTEGER", + "name": "INTEGER" + } + ] + } + }, + "com.amazonaws.timestreamquery#ScalarValue": { + "type": "string" + }, + "com.amazonaws.timestreamquery#ScheduleConfiguration": { + "type": "structure", + "members": { + "ScheduleExpression": { + "target": "com.amazonaws.timestreamquery#ScheduleExpression", + "traits": { + "smithy.api#documentation": "An expression that denotes when to trigger the scheduled query run. This can be a cron\n expression or a rate expression.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration of the schedule of the query.
" + } + }, + "com.amazonaws.timestreamquery#ScheduleExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.timestreamquery#ScheduledQuery": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.timestreamquery#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.timestreamquery#ScheduledQueryName", + "traits": { + "smithy.api#documentation": "The name of the scheduled query.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.timestreamquery#Time", + "traits": { + "smithy.api#documentation": "The creation time of the scheduled query.
" + } + }, + "State": { + "target": "com.amazonaws.timestreamquery#ScheduledQueryState", + "traits": { + "smithy.api#documentation": "State of scheduled query.
", + "smithy.api#required": {} + } + }, + "PreviousInvocationTime": { + "target": "com.amazonaws.timestreamquery#Time", + "traits": { + "smithy.api#documentation": "The last time the scheduled query was run.
" + } + }, + "NextInvocationTime": { + "target": "com.amazonaws.timestreamquery#Time", + "traits": { + "smithy.api#documentation": "The next time the scheduled query is to be run.
" + } + }, + "ErrorReportConfiguration": { + "target": "com.amazonaws.timestreamquery#ErrorReportConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for scheduled query error reporting.
" + } + }, + "TargetDestination": { + "target": "com.amazonaws.timestreamquery#TargetDestination", + "traits": { + "smithy.api#documentation": "Target data source where final scheduled query result will be written.
" + } + }, + "LastRunStatus": { + "target": "com.amazonaws.timestreamquery#ScheduledQueryRunStatus", + "traits": { + "smithy.api#documentation": "Status of the last scheduled query run.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Scheduled Query
" + } + }, + "com.amazonaws.timestreamquery#ScheduledQueryDescription": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.timestreamquery#AmazonResourceName", + "traits": { + "smithy.api#documentation": "Scheduled query ARN.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.timestreamquery#ScheduledQueryName", + "traits": { + "smithy.api#documentation": "Name of the scheduled query.
", + "smithy.api#required": {} + } + }, + "QueryString": { + "target": "com.amazonaws.timestreamquery#QueryString", + "traits": { + "smithy.api#documentation": "The query to be run.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.timestreamquery#Time", + "traits": { + "smithy.api#documentation": "Creation time of the scheduled query.
" + } + }, + "State": { + "target": "com.amazonaws.timestreamquery#ScheduledQueryState", + "traits": { + "smithy.api#documentation": "State of the scheduled query.
", + "smithy.api#required": {} + } + }, + "PreviousInvocationTime": { + "target": "com.amazonaws.timestreamquery#Time", + "traits": { + "smithy.api#documentation": "Last time the query was run.
" + } + }, + "NextInvocationTime": { + "target": "com.amazonaws.timestreamquery#Time", + "traits": { + "smithy.api#documentation": "The next time the scheduled query is scheduled to run.
" + } + }, + "ScheduleConfiguration": { + "target": "com.amazonaws.timestreamquery#ScheduleConfiguration", + "traits": { + "smithy.api#documentation": "Schedule configuration.
", + "smithy.api#required": {} + } + }, + "NotificationConfiguration": { + "target": "com.amazonaws.timestreamquery#NotificationConfiguration", + "traits": { + "smithy.api#documentation": "Notification configuration.
", + "smithy.api#required": {} + } + }, + "TargetConfiguration": { + "target": "com.amazonaws.timestreamquery#TargetConfiguration", + "traits": { + "smithy.api#documentation": "Scheduled query target store configuration.
" + } + }, + "ScheduledQueryExecutionRoleArn": { + "target": "com.amazonaws.timestreamquery#AmazonResourceName", + "traits": { + "smithy.api#documentation": "IAM role that Timestream uses to run the schedule query.
" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.timestreamquery#StringValue2048", + "traits": { + "smithy.api#documentation": "A customer provided KMS key used to encrypt the scheduled query resource.
" + } + }, + "ErrorReportConfiguration": { + "target": "com.amazonaws.timestreamquery#ErrorReportConfiguration", + "traits": { + "smithy.api#documentation": "Error-reporting configuration for the scheduled query.
" + } + }, + "LastRunSummary": { + "target": "com.amazonaws.timestreamquery#ScheduledQueryRunSummary", + "traits": { + "smithy.api#documentation": "Runtime summary for the last scheduled query run.
" + } + }, + "RecentlyFailedRuns": { + "target": "com.amazonaws.timestreamquery#ScheduledQueryRunSummaryList", + "traits": { + "smithy.api#documentation": "Runtime summary for the last five failed scheduled query runs.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Structure that describes scheduled query.
" + } + }, + "com.amazonaws.timestreamquery#ScheduledQueryList": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreamquery#ScheduledQuery" + } + }, + "com.amazonaws.timestreamquery#ScheduledQueryName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" + } + }, + "com.amazonaws.timestreamquery#ScheduledQueryRunStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AUTO_TRIGGER_SUCCESS", + "name": "AUTO_TRIGGER_SUCCESS" + }, + { + "value": "AUTO_TRIGGER_FAILURE", + "name": "AUTO_TRIGGER_FAILURE" + }, + { + "value": "MANUAL_TRIGGER_SUCCESS", + "name": "MANUAL_TRIGGER_SUCCESS" + }, + { + "value": "MANUAL_TRIGGER_FAILURE", + "name": "MANUAL_TRIGGER_FAILURE" + } + ] + } + }, + "com.amazonaws.timestreamquery#ScheduledQueryRunSummary": { + "type": "structure", + "members": { + "InvocationTime": { + "target": "com.amazonaws.timestreamquery#Time", + "traits": { + "smithy.api#documentation": "InvocationTime for this run. This is the time at which the query is scheduled to run.\n Parameter @scheduled_runtime can be used in the query to get the value.
The actual time when the query was run.
" + } + }, + "RunStatus": { + "target": "com.amazonaws.timestreamquery#ScheduledQueryRunStatus", + "traits": { + "smithy.api#documentation": "The status of a scheduled query run.
" + } + }, + "ExecutionStats": { + "target": "com.amazonaws.timestreamquery#ExecutionStats", + "traits": { + "smithy.api#documentation": "Runtime statistics for a scheduled run.
" + } + }, + "ErrorReportLocation": { + "target": "com.amazonaws.timestreamquery#ErrorReportLocation", + "traits": { + "smithy.api#documentation": "S3 location for error report.
" + } + }, + "FailureReason": { + "target": "com.amazonaws.timestreamquery#ErrorMessage", + "traits": { + "smithy.api#documentation": "Error message for the scheduled query in case of failure. You might have to look at\n the error report to get more detailed error reasons.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Run summary for the scheduled query
" + } + }, + "com.amazonaws.timestreamquery#ScheduledQueryRunSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreamquery#ScheduledQueryRunSummary" + } + }, + "com.amazonaws.timestreamquery#ScheduledQueryState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "DISABLED", + "name": "DISABLED" + } + ] + } + }, + "com.amazonaws.timestreamquery#SchemaName": { + "type": "string" + }, + "com.amazonaws.timestreamquery#SelectColumn": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.timestreamquery#String", + "traits": { + "smithy.api#documentation": "Name of the column.
" + } + }, + "Type": { + "target": "com.amazonaws.timestreamquery#Type" + }, + "DatabaseName": { + "target": "com.amazonaws.timestreamquery#ResourceName", + "traits": { + "smithy.api#documentation": "Database that has this column.
" + } + }, + "TableName": { + "target": "com.amazonaws.timestreamquery#ResourceName", + "traits": { + "smithy.api#documentation": "Table within the database that has this column.
" + } + }, + "Aliased": { + "target": "com.amazonaws.timestreamquery#NullableBoolean", + "traits": { + "smithy.api#documentation": "True, if the column name was aliased by the query. False otherwise.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of the column that is returned by the query.
" + } + }, + "com.amazonaws.timestreamquery#SelectColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreamquery#SelectColumn" + } + }, + "com.amazonaws.timestreamquery#ServiceErrorMessage": { + "type": "string" + }, + "com.amazonaws.timestreamquery#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.timestreamquery#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "You have exceeded the service quota.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.timestreamquery#SnsConfiguration": { + "type": "structure", + "members": { + "TopicArn": { + "target": "com.amazonaws.timestreamquery#AmazonResourceName", + "traits": { + "smithy.api#documentation": "SNS topic ARN that the scheduled query status notifications will be sent to.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details on SNS that are required to send the notification.
" + } + }, + "com.amazonaws.timestreamquery#String": { + "type": "string" + }, + "com.amazonaws.timestreamquery#StringValue2048": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.timestreamquery#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.timestreamquery#TagKey", + "traits": { + "smithy.api#documentation": "The key of the tag. Tag keys are case sensitive.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.timestreamquery#TagValue", + "traits": { + "smithy.api#documentation": "The value of the tag. Tag values are case sensitive and can be null.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A tag is a label that you assign to a Timestream database and/or table. Each tag\n consists of a key and an optional value, both of which you define. Tags enable you to\n categorize databases and/or tables, for example, by purpose, owner, or environment.\n
" + } + }, + "com.amazonaws.timestreamquery#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.timestreamquery#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreamquery#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.timestreamquery#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreamquery#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.timestreamquery#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamquery#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.timestreamquery#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamquery#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamquery#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreamquery#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.timestreamquery#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamquery#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "Associate a set of tags with a Timestream resource. You can then activate these\n user-defined tags so that they appear on the Billing and Cost Management console for\n cost allocation tracking.
" + } + }, + "com.amazonaws.timestreamquery#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.timestreamquery#AmazonResourceName", "traits": { - "smithy.api#documentation": "The amount of data scanned by the query in bytes. \n This is a cumulative sum and represents the total amount of bytes scanned since the query was started.\n
" + "smithy.api#documentation": "Identifies the Timestream resource to which tags should be added. This value is an\n Amazon Resource Name (ARN).
", + "smithy.api#required": {} } }, - "CumulativeBytesMetered": { - "target": "com.amazonaws.timestreamquery#Long", + "Tags": { + "target": "com.amazonaws.timestreamquery#TagList", "traits": { - "smithy.api#documentation": "The amount of data scanned by the query in bytes that you will be charged for. \n This is a cumulative sum and represents the total amount of data that you will be charged \n for since the query was started. \n The charge is applied only once and is either applied when \n the query completes execution or when the query is cancelled.\n
" + "smithy.api#documentation": "The tags to be assigned to the Timestream resource.
", + "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "Information about the status of the query, including progress and bytes scannned.
" } }, - "com.amazonaws.timestreamquery#QueryString": { + "com.amazonaws.timestreamquery#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.timestreamquery#TagValue": { "type": "string", "traits": { - "smithy.api#sensitive": {} + "smithy.api#length": { + "min": 0, + "max": 256 + } } }, - "com.amazonaws.timestreamquery#Row": { + "com.amazonaws.timestreamquery#TargetConfiguration": { "type": "structure", "members": { - "Data": { - "target": "com.amazonaws.timestreamquery#DatumList", + "TimestreamConfiguration": { + "target": "com.amazonaws.timestreamquery#TimestreamConfiguration", "traits": { - "smithy.api#documentation": "List of data points in a single row of the result set.
", + "smithy.api#documentation": "Configuration needed to write data into the Timestream database and table.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents a single row in the query results.
" - } - }, - "com.amazonaws.timestreamquery#RowList": { - "type": "list", - "member": { - "target": "com.amazonaws.timestreamquery#Row" + "smithy.api#documentation": "Configuration used for writing the output of a query.
" } }, - "com.amazonaws.timestreamquery#ScalarType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "VARCHAR", - "name": "VARCHAR" - }, - { - "value": "BOOLEAN", - "name": "BOOLEAN" - }, - { - "value": "BIGINT", - "name": "BIGINT" - }, - { - "value": "DOUBLE", - "name": "DOUBLE" - }, - { - "value": "TIMESTAMP", - "name": "TIMESTAMP" - }, - { - "value": "DATE", - "name": "DATE" - }, - { - "value": "TIME", - "name": "TIME" - }, - { - "value": "INTERVAL_DAY_TO_SECOND", - "name": "INTERVAL_DAY_TO_SECOND" - }, - { - "value": "INTERVAL_YEAR_TO_MONTH", - "name": "INTERVAL_YEAR_TO_MONTH" - }, - { - "value": "UNKNOWN", - "name": "UNKNOWN" - }, - { - "value": "INTEGER", - "name": "INTEGER" + "com.amazonaws.timestreamquery#TargetDestination": { + "type": "structure", + "members": { + "TimestreamDestination": { + "target": "com.amazonaws.timestreamquery#TimestreamDestination", + "traits": { + "smithy.api#documentation": "Query result destination details for Timestream data source.
" } - ] + } + }, + "traits": { + "smithy.api#documentation": "Destination details to write data for a target data source. Current supported data\n source is Timestream.
" } }, - "com.amazonaws.timestreamquery#ScalarValue": { - "type": "string" - }, - "com.amazonaws.timestreamquery#ServiceErrorMessage": { - "type": "string" - }, - "com.amazonaws.timestreamquery#String": { - "type": "string" - }, "com.amazonaws.timestreamquery#ThrottlingException": { "type": "structure", "members": { @@ -573,6 +2087,9 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.timestreamquery#Time": { + "type": "timestamp" + }, "com.amazonaws.timestreamquery#TimeSeriesDataPoint": { "type": "structure", "members": { @@ -586,13 +2103,13 @@ "Value": { "target": "com.amazonaws.timestreamquery#Datum", "traits": { - "smithy.api#documentation": "The measure value for the data point.
", + "smithy.api#documentation": "The measure value for the data point.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The timeseries datatype represents the values of a measure over time. A time series is an array of rows of timestamps and measure values, with rows sorted in ascending order of time. A TimeSeriesDataPoint is a single data point in the timeseries. It represents a tuple of (time, measure value) in a timeseries.
" + "smithy.api#documentation": "The timeseries data type represents the values of a measure over time. A time series\n is an array of rows of timestamps and measure values, with rows sorted in ascending\n order of time. A TimeSeriesDataPoint is a single data point in the time series. It\n represents a tuple of (time, measure value) in a time series.
" } }, "com.amazonaws.timestreamquery#TimeSeriesDataPointList": { @@ -604,20 +2121,82 @@ "com.amazonaws.timestreamquery#Timestamp": { "type": "string" }, - "com.amazonaws.timestreamquery#Timestream_20181101": { - "type": "service", - "version": "2018-11-01", - "operations": [ - { - "target": "com.amazonaws.timestreamquery#CancelQuery" + "com.amazonaws.timestreamquery#TimestreamConfiguration": { + "type": "structure", + "members": { + "DatabaseName": { + "target": "com.amazonaws.timestreamquery#ResourceName", + "traits": { + "smithy.api#documentation": "Name of Timestream database to which the query result will be written.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.timestreamquery#DescribeEndpoints" + "TableName": { + "target": "com.amazonaws.timestreamquery#ResourceName", + "traits": { + "smithy.api#documentation": "Name of Timestream table that the query result will be written to. The table should\n be within the same database that is provided in Timestream configuration.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.timestreamquery#Query" + "TimeColumn": { + "target": "com.amazonaws.timestreamquery#SchemaName", + "traits": { + "smithy.api#documentation": "Column from query result that should be used as the time column in destination table.\n Column type for this should be TIMESTAMP.
", + "smithy.api#required": {} + } + }, + "DimensionMappings": { + "target": "com.amazonaws.timestreamquery#DimensionMappingList", + "traits": { + "smithy.api#documentation": "This is to allow mapping column(s) from the query result to the dimension in the\n destination table.
", + "smithy.api#required": {} + } + }, + "MultiMeasureMappings": { + "target": "com.amazonaws.timestreamquery#MultiMeasureMappings", + "traits": { + "smithy.api#documentation": "Multi-measure mappings.
" + } + }, + "MixedMeasureMappings": { + "target": "com.amazonaws.timestreamquery#MixedMeasureMappingList", + "traits": { + "smithy.api#documentation": "Specifies how to map measures to multi-measure records.
" + } + }, + "MeasureNameColumn": { + "target": "com.amazonaws.timestreamquery#SchemaName", + "traits": { + "smithy.api#documentation": "Name of the measure column.
" + } } - ], + }, + "traits": { + "smithy.api#documentation": "Configuration to write data into Timestream database and table. This configuration\n allows the user to map the query result select columns into the destination table\n columns.
" + } + }, + "com.amazonaws.timestreamquery#TimestreamDestination": { + "type": "structure", + "members": { + "DatabaseName": { + "target": "com.amazonaws.timestreamquery#ResourceName", + "traits": { + "smithy.api#documentation": "Timestream database name.
" + } + }, + "TableName": { + "target": "com.amazonaws.timestreamquery#ResourceName", + "traits": { + "smithy.api#documentation": "Timestream table name.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Destination for scheduled query.
" + } + }, + "com.amazonaws.timestreamquery#Timestream_20181101": { + "type": "service", "traits": { "aws.api#clientEndpointDiscovery": { "operation": "com.amazonaws.timestreamquery#DescribeEndpoints", @@ -634,9 +2213,51 @@ "name": "timestream" }, "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "\n \n
", + "smithy.api#documentation": "Indicates if the column is of type string, integer, boolean, double, timestamp, date, time.
" + "smithy.api#documentation": "Indicates if the column is of type string, integer, Boolean, double, timestamp, date,\n time.
" } }, "ArrayColumnInfo": { @@ -667,7 +2288,110 @@ } }, "traits": { - "smithy.api#documentation": "Contains the data type of a column in a query result set. The data type can be scalar or complex. The supported scalar data types are integers, boolean, string, double, timestamp, date, time, and intervals. The supported complex data types are arrays, rows, and timeseries.
" + "smithy.api#documentation": "Contains the data type of a column in a query result set. The data type can be scalar\n or complex. The supported scalar data types are integers, Boolean, string, double,\n timestamp, date, time, and intervals. The supported complex data types are arrays, rows,\n and timeseries.
" + } + }, + "com.amazonaws.timestreamquery#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamquery#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.timestreamquery#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamquery#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamquery#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreamquery#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamquery#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "Removes the association of tags from a Timestream query resource.
" + } + }, + "com.amazonaws.timestreamquery#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.timestreamquery#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The Timestream resource that the tags will be removed from. This value is an Amazon\n Resource Name (ARN).
", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.timestreamquery#TagKeyList", + "traits": { + "smithy.api#documentation": "A list of tags keys. Existing tags of the resource whose keys are members of this list\n will be removed from the Timestream resource.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.timestreamquery#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.timestreamquery#UpdateScheduledQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamquery#UpdateScheduledQueryRequest" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamquery#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreamquery#InternalServerException" + }, + { + "target": "com.amazonaws.timestreamquery#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamquery#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreamquery#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamquery#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "Update a scheduled query.
" + } + }, + "com.amazonaws.timestreamquery#UpdateScheduledQueryRequest": { + "type": "structure", + "members": { + "ScheduledQueryArn": { + "target": "com.amazonaws.timestreamquery#AmazonResourceName", + "traits": { + "smithy.api#documentation": "ARN of the scheuled query.
", + "smithy.api#required": {} + } + }, + "State": { + "target": "com.amazonaws.timestreamquery#ScheduledQueryState", + "traits": { + "smithy.api#documentation": "State of the scheduled query.
", + "smithy.api#required": {} + } + } } }, "com.amazonaws.timestreamquery#ValidationException": { @@ -678,7 +2402,7 @@ } }, "traits": { - "smithy.api#documentation": "\n Invalid or malformed request.\n
", + "smithy.api#documentation": "Invalid or malformed request.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } diff --git a/aws/sdk/aws-models/timestream-write.json b/aws/sdk/aws-models/timestream-write.json index c5b894e7173d4531078036af20d9dc3e98d7739f..6495a50d73808aed3e84aa9cce84569feca953af 100644 --- a/aws/sdk/aws-models/timestream-write.json +++ b/aws/sdk/aws-models/timestream-write.json @@ -54,6 +54,12 @@ } } }, + "com.amazonaws.timestreamwrite#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.timestreamwrite#ConflictException": { "type": "structure", "members": { @@ -105,14 +111,14 @@ "aws.api#clientDiscoveredEndpoint": { "required": true }, - "smithy.api#documentation": "Creates a new Timestream database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account.\n Refer to AWS managed KMS keys for more info. \n Service quotas apply. For more information, see Access Management in the Timestream Developer Guide.\n
" + "smithy.api#documentation": "Creates a new Timestream database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS \n key located in your account.\n Refer to Amazon Web Services managed KMS keys for more info. \n Service quotas apply.\n See \n code sample for details.\n
" } }, "com.amazonaws.timestreamwrite#CreateDatabaseRequest": { "type": "structure", "members": { "DatabaseName": { - "target": "com.amazonaws.timestreamwrite#ResourceName", + "target": "com.amazonaws.timestreamwrite#ResourceCreateAPIName", "traits": { "smithy.api#documentation": "The name of the Timestream database.
", "smithy.api#required": {} @@ -121,7 +127,7 @@ "KmsKeyId": { "target": "com.amazonaws.timestreamwrite#StringValue2048", "traits": { - "smithy.api#documentation": "The KMS key for the database. If the KMS key is not specified, the database will be encrypted with a Timestream\n managed KMS key located in your account. Refer to AWS managed KMS keys for more info.
" + "smithy.api#documentation": "The KMS key for the database. \n If the KMS key is not specified, the database will be encrypted with a Timestream\n managed KMS key located in your account. \n Refer to Amazon Web Services managed KMS keys for more info.
" } }, "Tags": { @@ -181,21 +187,21 @@ "aws.api#clientDiscoveredEndpoint": { "required": true }, - "smithy.api#documentation": "The CreateTable operation adds a new table to an existing database in your account. In an AWS account,\n table names must be at least unique within each Region if they are in the same database. \n You may have identical table names in the same Region if the tables are in seperate databases.\n While creating the table, you must specify the table name, database name,\n and the retention properties.\n Service quotas apply. For more information, see Access Management\n in the Timestream Developer Guide.\n
" + "smithy.api#documentation": "The CreateTable operation adds a new table to an existing database in your account. In an Amazon Web Services account,\n table names must be at least unique within each Region if they are in the same database. \n You may have identical table names in the same Region if the tables are in separate databases.\n While creating the table, you must specify the table name, database name,\n and the retention properties.\n Service quotas apply.\n See \n code sample for details.\n
" } }, "com.amazonaws.timestreamwrite#CreateTableRequest": { "type": "structure", "members": { "DatabaseName": { - "target": "com.amazonaws.timestreamwrite#ResourceName", + "target": "com.amazonaws.timestreamwrite#ResourceCreateAPIName", "traits": { "smithy.api#documentation": "The name of the Timestream database.
", "smithy.api#required": {} } }, "TableName": { - "target": "com.amazonaws.timestreamwrite#ResourceName", + "target": "com.amazonaws.timestreamwrite#ResourceCreateAPIName", "traits": { "smithy.api#documentation": "The name of the Timestream table.
", "smithy.api#required": {} @@ -212,6 +218,12 @@ "traits": { "smithy.api#documentation": "\n A list of key-value pairs to label the table. \n
" } + }, + "MagneticStoreWriteProperties": { + "target": "com.amazonaws.timestreamwrite#MagneticStoreWriteProperties", + "traits": { + "smithy.api#documentation": "Contains properties to set on the table when enabling magnetic store writes.
" + } } } }, @@ -308,7 +320,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": true }, - "smithy.api#documentation": "Deletes a given Timestream database. This is an irreversible operation.\n After a database is deleted, the time series data from its tables cannot be recovered.\n
\n \nAll tables in the database must be deleted first, or a ValidationException error will be thrown.\n
\n \nDue to the nature of distributed retries, \n the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.
" + "smithy.api#documentation": "Deletes a given Timestream database. This is an irreversible operation.\n After a database is deleted, the time series data from its tables cannot be recovered.\n
\n \nAll tables in the database must be deleted first, or a ValidationException error will be thrown.\n
\n \nDue to the nature of distributed retries, \n the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.
\nSee \n code sample for details.
" } }, "com.amazonaws.timestreamwrite#DeleteDatabaseRequest": { @@ -352,7 +364,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": true }, - "smithy.api#documentation": "Deletes a given Timestream table. This is an irreversible operation.\n After a Timestream database table is deleted, the time series data stored in \n the table cannot be recovered.\n
\nDue to the nature of distributed retries, \n the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.
" + "smithy.api#documentation": "Deletes a given Timestream table. This is an irreversible operation.\n After a Timestream database table is deleted, the time series data stored in \n the table cannot be recovered.\n
\nDue to the nature of distributed retries, \n the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.
\nSee \n code sample for details.
" } }, "com.amazonaws.timestreamwrite#DeleteTableRequest": { @@ -406,7 +418,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": true }, - "smithy.api#documentation": "Returns information about the database, including the database name, time that the database was created, \n and the total number of tables found within the database.\n Service quotas apply. For more information, see Access Management in the Timestream Developer Guide.
" + "smithy.api#documentation": "Returns information about the database, including the database name, time that the database was created, \n and the total number of tables found within the database.\n Service quotas apply. See \n code sample for details.
" } }, "com.amazonaws.timestreamwrite#DescribeDatabaseRequest": { @@ -452,7 +464,7 @@ } ], "traits": { - "smithy.api#documentation": "DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.
\nBecause Timestream’s SDKs are designed to transparently work with the service’s architecture, \n including the management and mapping of the service endpoints,\n it is not recommended that you use this API unless:
\nYour application uses a programming language that does not yet have SDK support
\nYou require better control over the client-side implementation
\nFor detailed information on how to use DescribeEndpoints, \n see The Endpoint Discovery Pattern and REST APIs.
" + "smithy.api#documentation": "DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.\n This API is available through both Write and Query.
\nBecause the Timestream SDKs are designed to transparently work with the service’s architecture, \n including the management and mapping of the service endpoints,\n it is not recommended that you use this API unless:
\nYou are using VPC endpoints (Amazon Web Services PrivateLink) with Timestream\n
\nYour application uses a programming language that does not yet have SDK support
\nYou require better control over the client-side implementation
\nFor detailed information on how and when to use and implement DescribeEndpoints, \n see The Endpoint Discovery Pattern.
" } }, "com.amazonaws.timestreamwrite#DescribeEndpointsRequest": { @@ -503,7 +515,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": true }, - "smithy.api#documentation": "Returns information about the table, including the table name, database name, \n retention duration of the memory store and the magnetic store.\n Service quotas apply. For more information, see Access Management in the Timestream Developer Guide.\n
" + "smithy.api#documentation": "Returns information about the table, including the table name, database name, \n retention duration of the memory store and the magnetic store.\n Service quotas apply. See \n code sample for details.\n
" } }, "com.amazonaws.timestreamwrite#DescribeTableRequest": { @@ -540,14 +552,14 @@ "type": "structure", "members": { "Name": { - "target": "com.amazonaws.timestreamwrite#StringValue256", + "target": "com.amazonaws.timestreamwrite#SchemaName", "traits": { "smithy.api#documentation": "\n Dimension represents the meta data attributes of the time series. \n For example, the name and availability zone of an EC2 instance or \n the name of the manufacturer of a wind turbine are dimensions.\n \n
\nFor constraints on Dimension names, \n see Naming Constraints.
", "smithy.api#required": {} } }, "Value": { - "target": "com.amazonaws.timestreamwrite#StringValue2048", + "target": "com.amazonaws.timestreamwrite#SchemaValue", "traits": { "smithy.api#documentation": "The value of the dimension.
", "smithy.api#required": {} @@ -618,6 +630,9 @@ "com.amazonaws.timestreamwrite#ErrorMessage": { "type": "string" }, + "com.amazonaws.timestreamwrite#Integer": { + "type": "integer" + }, "com.amazonaws.timestreamwrite#InternalServerException": { "type": "structure", "members": { @@ -676,7 +691,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": true }, - "smithy.api#documentation": "Returns a list of your Timestream databases. \n Service quotas apply. For more information, see Access Management in the Timestream Developer Guide.\n
", + "smithy.api#documentation": "Returns a list of your Timestream databases. \n Service quotas apply. See \n code sample for details.\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -750,7 +765,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": true }, - "smithy.api#documentation": "A list of tables, along with the name, status and retention properties of each table.\n
", + "smithy.api#documentation": "A list of tables, along with the name, status and retention properties of each table.\n See \n code sample for details.\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -853,6 +868,20 @@ "com.amazonaws.timestreamwrite#Long": { "type": "long" }, + "com.amazonaws.timestreamwrite#MagneticStoreRejectedDataLocation": { + "type": "structure", + "members": { + "S3Configuration": { + "target": "com.amazonaws.timestreamwrite#S3Configuration", + "traits": { + "smithy.api#documentation": "Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The location to write error reports for records rejected, asynchronously, during magnetic store writes.
" + } + }, "com.amazonaws.timestreamwrite#MagneticStoreRetentionPeriodInDays": { "type": "long", "traits": { @@ -862,6 +891,56 @@ } } }, + "com.amazonaws.timestreamwrite#MagneticStoreWriteProperties": { + "type": "structure", + "members": { + "EnableMagneticStoreWrites": { + "target": "com.amazonaws.timestreamwrite#Boolean", + "traits": { + "smithy.api#documentation": "A flag to enable magnetic store writes.
", + "smithy.api#required": {} + } + }, + "MagneticStoreRejectedDataLocation": { + "target": "com.amazonaws.timestreamwrite#MagneticStoreRejectedDataLocation", + "traits": { + "smithy.api#documentation": "The location to write error reports for records rejected asynchronously during magnetic store writes.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The set of properties on a table for configuring magnetic store writes.
" + } + }, + "com.amazonaws.timestreamwrite#MeasureValue": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.timestreamwrite#SchemaName", + "traits": { + "smithy.api#documentation": "Name of the MeasureValue.
\nFor constraints on MeasureValue names, refer to \n Naming Constraints in the Timestream developer guide.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.timestreamwrite#StringValue2048", + "traits": { + "smithy.api#documentation": "Value for the MeasureValue.
", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.timestreamwrite#MeasureValueType", + "traits": { + "smithy.api#documentation": "Contains the data type of the MeasureValue for the time series data point.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "MeasureValue represents the data attribute of the time series. For example, the CPU utilization of an EC2 instance or the RPM of a wind turbine are measures. MeasureValue has both name and value.
\n MeasureValue is only allowed for type MULTI. Using MULTI type, you can pass multiple data attributes associated with the same time series in a single record
Measure represents the data attribute of the time series. For example, the CPU utilization of an EC2 instance or the RPM of a wind turbine are measures.
" } @@ -928,7 +1021,7 @@ "MeasureValueType": { "target": "com.amazonaws.timestreamwrite#MeasureValueType", "traits": { - "smithy.api#documentation": "\nContains the data type of the measure value for the time series data point.\n
" + "smithy.api#documentation": "\nContains the data type of the measure value for the time series data point. Default type is DOUBLE.\n
\nThe granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds or other supported values.\n
" + "smithy.api#documentation": "\nThe granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds or other supported values. \nDefault is MILLISECONDS.\n
64-bit attribute used for record updates. \n Write requests for duplicate data with a higher version number will update the existing measure value and version. \n In cases where the measure value is the same, Version will still be updated . Default value is to 1.
64-bit attribute used for record updates. \n Write requests for duplicate data with a higher version number will update the existing measure value and version. \n In cases where the measure value is the same, Version will still be updated . Default value is 1.
\n Version must be 1 or greater, or you will receive a ValidationException error.
Contains the list of MeasureValue for time series data points.
\n This is only allowed for type MULTI. For scalar values, use MeasureValue attribute of the Record directly.
Record represents a time series data point being written into \n Timestream. Each record contains an array of dimensions. Dimensions \n represent the meta data attributes of a time series data point such as\n the instance name or availability zone of an EC2 instance. A record also \n contains the measure name which is the name of the measure being collected \n for example the CPU utilization of an EC2 instance. A record also contains \n the measure value and the value type which is the data type of the measure value.\n In addition, the record contains the timestamp when the measure was collected that \n the timestamp unit which represents the granularity of the timestamp.\n
" + "smithy.api#documentation": "Record represents a time series data point being written into \n Timestream. Each record contains an array of dimensions. Dimensions \n represent the meta data attributes of a time series data point such as\n the instance name or availability zone of an EC2 instance. A record also \n contains the measure name which is the name of the measure being collected \n for example the CPU utilization of an EC2 instance. A record also contains \n the measure value and the value type which is the data type of the measure value.\n In addition, the record contains the timestamp when the measure was collected that \n the timestamp unit which represents the granularity of the timestamp.\n
\n\n Records have a Version field, which is a 64-bit long that you can use for updating data points. \n Writes of a duplicate record with the same dimension, \n timestamp, and measure name \n but different measure value will only succeed if the Version attribute of the record in the write request \n is higher than that of the existing record. \n Timestream defaults to a Version of 1 for records without the Version field.\n
Total count of successfully ingested records.
" + } + }, + "MemoryStore": { + "target": "com.amazonaws.timestreamwrite#Integer", + "traits": { + "smithy.api#documentation": "Count of records ingested into the memory store.
" + } + }, + "MagneticStore": { + "target": "com.amazonaws.timestreamwrite#Integer", + "traits": { + "smithy.api#documentation": "Count of records ingested into the magnetic store.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information on the records ingested by this request.
" + } + }, "com.amazonaws.timestreamwrite#RejectedRecord": { "type": "structure", "members": { @@ -985,7 +1110,7 @@ "Reason": { "target": "com.amazonaws.timestreamwrite#ErrorMessage", "traits": { - "smithy.api#documentation": "\n The reason why a record was not successfully inserted into Timestream. Possible causes of failure include:\n
\n\n Records with duplicate data where there are multiple records with the same dimensions,\n timestamps, and measure names but different measure values.\n
\n\n Records with timestamps that lie outside the retention duration of the memory store\n
\nWhen the retention window is updated, you will receive a RejectedRecords exception \n if you immediately try to ingest data within the new window. \n To avoid a RejectedRecords exception, \n wait until the duration of the new window to ingest new data.\n For further information, \n see \n \n Best Practices for Configuring Timestream\n and \n the explanation of how storage works in Timestream.
\n Records with dimensions or measures that exceed the Timestream defined limits.\n
\n\n For more information, see Access Management in the Timestream Developer Guide.\n
" + "smithy.api#documentation": "\n The reason why a record was not successfully inserted into Timestream. Possible causes of failure include:\n
\nRecords with duplicate data where there are multiple records with the same dimensions,\n timestamps, and measure names but:\n
\nMeasure values are different
\nVersion is not present in the request or\n the value of version in the new record is equal to or lower than the existing value
\n\n If Timestream rejects data for this case, the ExistingVersion field in the RejectedRecords \n response will indicate the current record’s version. \n To force an update, you can resend the request with a version for the record set to a value greater than the ExistingVersion.
\n Records with timestamps that lie outside the retention duration of the memory store\n
\nWhen the retention window is updated, you will receive a RejectedRecords exception \n if you immediately try to ingest data within the new window. \n To avoid a RejectedRecords exception, \n wait until the duration of the new window to ingest new data.\n For further information, \n see \n \n Best Practices for Configuring Timestream\n and \n the explanation of how storage works in Timestream.
\n Records with dimensions or measures that exceed the Timestream defined limits.\n
\n\n For more information, see Access Management in the Timestream Developer Guide.\n
" } }, "ExistingVersion": { @@ -1017,21 +1142,20 @@ } }, "traits": { - "smithy.api#documentation": "\n WriteRecords would throw this exception in the following cases:\n
\n\n Records with duplicate data where there are multiple records with the same dimensions,\n timestamps, and measure names but different measure values.\n
\n\n Records with timestamps that lie outside the retention duration of the memory store\n
\n\n Records with dimensions or measures that exceed the Timestream defined limits.\n
\n\n For more information, see Access Management in the Timestream Developer Guide.\n
", + "smithy.api#documentation": "\n WriteRecords would throw this exception in the following cases:\n
\nRecords with duplicate data where there are multiple records with the same dimensions,\n timestamps, and measure names but:\n
\nMeasure values are different
\nVersion is not present in the request or\n the value of version in the new record is equal to or lower than the existing value
\n\n In this case, if Timestream rejects data, the ExistingVersion field in the RejectedRecords \n response will indicate the current record’s version. \n To force an update, you can resend the request with a version for the record set to a value greater than the ExistingVersion.
\n Records with timestamps that lie outside the retention duration of the memory store\n
\n\n Records with dimensions or measures that exceed the Timestream defined limits.\n
\n\n For more information, see Quotas in the Timestream Developer Guide.\n
", "smithy.api#error": "client", "smithy.api#httpError": 419 } }, - "com.amazonaws.timestreamwrite#ResourceName": { + "com.amazonaws.timestreamwrite#ResourceCreateAPIName": { "type": "string", "traits": { - "smithy.api#length": { - "min": 3, - "max": 64 - }, - "smithy.api#pattern": "[a-zA-Z0-9_.-]+" + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" } }, + "com.amazonaws.timestreamwrite#ResourceName": { + "type": "string" + }, "com.amazonaws.timestreamwrite#ResourceNotFoundException": { "type": "structure", "members": { @@ -1067,6 +1191,84 @@ "smithy.api#documentation": "Retention properties contain the duration for which your time series data must be stored in the magnetic store and the memory store.\n
" } }, + "com.amazonaws.timestreamwrite#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.timestreamwrite#S3Configuration": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.timestreamwrite#S3BucketName", + "traits": { + "smithy.api#documentation": ">Bucket name of the customer S3 bucket.
" + } + }, + "ObjectKeyPrefix": { + "target": "com.amazonaws.timestreamwrite#S3ObjectKeyPrefix", + "traits": { + "smithy.api#documentation": "Object key preview for the customer S3 location.
" + } + }, + "EncryptionOption": { + "target": "com.amazonaws.timestreamwrite#S3EncryptionOption", + "traits": { + "smithy.api#documentation": "Encryption option for the customer s3 location. Options are S3 server side encryption with an S3-managed key or KMS managed key.
" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.timestreamwrite#StringValue2048", + "traits": { + "smithy.api#documentation": "KMS key id for the customer s3 location when encrypting with a KMS managed key.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration specifing an S3 location.
" + } + }, + "com.amazonaws.timestreamwrite#S3EncryptionOption": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SSE_S3", + "name": "SSE_S3" + }, + { + "value": "SSE_KMS", + "name": "SSE_KMS" + } + ] + } + }, + "com.amazonaws.timestreamwrite#S3ObjectKeyPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 928 + }, + "smithy.api#pattern": "^[a-zA-Z0-9|!\\-_*'\\(\\)]([a-zA-Z0-9]|[!\\-_*'\\(\\)\\/.])+$" + } + }, + "com.amazonaws.timestreamwrite#SchemaName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.timestreamwrite#SchemaValue": { + "type": "string" + }, "com.amazonaws.timestreamwrite#ServiceQuotaExceededException": { "type": "structure", "members": { @@ -1145,6 +1347,12 @@ "traits": { "smithy.api#documentation": "The time when the Timestream table was last updated.
" } + }, + "MagneticStoreWriteProperties": { + "target": "com.amazonaws.timestreamwrite#MagneticStoreWriteProperties", + "traits": { + "smithy.api#documentation": "Contains properties to set on the table when enabling magnetic store writes.
" + } } }, "traits": { @@ -1332,6 +1540,25 @@ }, "com.amazonaws.timestreamwrite#Timestream_20181101": { "type": "service", + "traits": { + "aws.api#clientEndpointDiscovery": { + "operation": "com.amazonaws.timestreamwrite#DescribeEndpoints", + "error": "com.amazonaws.timestreamwrite#InvalidEndpointException" + }, + "aws.api#service": { + "sdkId": "Timestream Write", + "arnNamespace": "timestream", + "cloudFormationName": "TimestreamWrite", + "cloudTrailEventSource": "timestreamwrite.amazonaws.com", + "endpointPrefix": "ingest.timestream" + }, + "aws.auth#sigv4": { + "name": "timestream" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "Amazon Timestream is a fast, scalable, fully managed time series database service that makes it easy to store and analyze trillions of time series data points per day. \n With Timestream, you can easily store and analyze IoT sensor data to derive insights from your IoT applications. \n You can analyze industrial telemetry to streamline equipment management and maintenance. \n You can also store and analyze log data and metrics to improve the performance and availability of your applications. \n Timestream is built from the ground up to effectively ingest, process, \n and store time series data. It organizes data to optimize query processing. It automatically scales based on the volume of data ingested and on the query volume to ensure you receive optimal performance while inserting and querying data. As your data grows over time, Timestream’s adaptive query processing engine spans across storage tiers to provide fast analysis while reducing costs.
", + "smithy.api#title": "Amazon Timestream Write" + }, "version": "2018-11-01", "operations": [ { @@ -1379,26 +1606,7 @@ { "target": "com.amazonaws.timestreamwrite#WriteRecords" } - ], - "traits": { - "aws.api#clientEndpointDiscovery": { - "operation": "com.amazonaws.timestreamwrite#DescribeEndpoints", - "error": "com.amazonaws.timestreamwrite#InvalidEndpointException" - }, - "aws.api#service": { - "sdkId": "Timestream Write", - "arnNamespace": "timestream", - "cloudFormationName": "TimestreamWrite", - "cloudTrailEventSource": "timestreamwrite.amazonaws.com", - "endpointPrefix": "ingest.timestream" - }, - "aws.auth#sigv4": { - "name": "timestream" - }, - "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "Amazon Timestream is a fast, scalable, fully managed time series database service that makes it easy to store and analyze trillions of time series data points per day. With Timestream, you can easily store and analyze IoT sensor data to derive insights from your IoT applications. You can analyze industrial telemetry to streamline equipment management and maintenance. You can also store and analyze log data and metrics to improve the performance and availability of your applications. Timestream is built from the ground up to effectively ingest, process, and store time series data. It organizes data to optimize query processing. It automatically scales based on the volume of data ingested and on the query volume to ensure you receive optimal performance while inserting and querying data. As your data grows over time, Timestream’s adaptive query processing engine spans across storage tiers to provide fast analysis while reducing costs.
", - "smithy.api#title": "Amazon Timestream Write" - } + ] }, "com.amazonaws.timestreamwrite#UntagResource": { "type": "operation", @@ -1490,7 +1698,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": true }, - "smithy.api#documentation": "\n Modifies the KMS key for an existing database. While updating the database, \n you must specify the database name and the identifier of the new KMS key to be used (KmsKeyId).\n If there are any concurrent UpdateDatabase requests, first writer wins.\n
\n Modifies the KMS key for an existing database. While updating the database, \n you must specify the database name and the identifier of the new KMS key to be used (KmsKeyId).\n If there are any concurrent UpdateDatabase requests, first writer wins.\n
See \n code sample for details.
" } }, "com.amazonaws.timestreamwrite#UpdateDatabaseRequest": { @@ -1552,7 +1760,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": true }, - "smithy.api#documentation": "Modifies the retention duration of the memory store and magnetic store for your Timestream table. \n Note that the change in retention duration takes effect immediately. \n For example, if the retention period of the memory store was initially set to 2 hours and then changed to 24 hours, \n the memory store will be capable of holding 24 hours of data, but will\n be populated with 24 hours of data 22 hours after this change was made.\n Timestream does not retrieve data from the magnetic store to populate the memory store.
\nService quotas apply. For more information, see Access Management in the Timestream Developer Guide.
" + "smithy.api#documentation": "Modifies the retention duration of the memory store and magnetic store for your Timestream table. \n Note that the change in retention duration takes effect immediately. \n For example, if the retention period of the memory store was initially set to 2 hours and then changed to 24 hours, \n the memory store will be capable of holding 24 hours of data, but will\n be populated with 24 hours of data 22 hours after this change was made.\n Timestream does not retrieve data from the magnetic store to populate the memory store.
\nSee \n code sample for details.
" } }, "com.amazonaws.timestreamwrite#UpdateTableRequest": { @@ -1568,15 +1776,20 @@ "TableName": { "target": "com.amazonaws.timestreamwrite#ResourceName", "traits": { - "smithy.api#documentation": "The name of the Timesream table.
", + "smithy.api#documentation": "The name of the Timestream table.
", "smithy.api#required": {} } }, "RetentionProperties": { "target": "com.amazonaws.timestreamwrite#RetentionProperties", "traits": { - "smithy.api#documentation": "The retention duration of the memory store and the magnetic store.
", - "smithy.api#required": {} + "smithy.api#documentation": "The retention duration of the memory store and the magnetic store.
" + } + }, + "MagneticStoreWriteProperties": { + "target": "com.amazonaws.timestreamwrite#MagneticStoreWriteProperties", + "traits": { + "smithy.api#documentation": "Contains properties to set on the table when enabling magnetic store writes.
" } } } @@ -1613,6 +1826,9 @@ "input": { "target": "com.amazonaws.timestreamwrite#WriteRecordsRequest" }, + "output": { + "target": "com.amazonaws.timestreamwrite#WriteRecordsResponse" + }, "errors": [ { "target": "com.amazonaws.timestreamwrite#AccessDeniedException" @@ -1640,7 +1856,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": true }, - "smithy.api#documentation": "The WriteRecords operation enables you to write your time series \n data into Timestream. You can specify a single data point or a batch \n of data points to be inserted into the system. Timestream offers you \n with a flexible schema that auto detects the column names and data types \n for your Timestream tables based on the dimension names and data types of\n the data points you specify when invoking writes into the database. \n Timestream support eventual consistency read semantics. This means that \n when you query data immediately after writing a batch of data into Timestream, \n the query results might not reflect the results of a recently completed write \n operation. The results may also include some stale data. If you repeat the \n query request after a short time, the results should return the latest data.\n Service quotas apply. For more information, \n see Access Management in the Timestream Developer Guide.\n
" + "smithy.api#documentation": "The WriteRecords operation enables you to write your time series \n data into Timestream. You can specify a single data point or a batch \n of data points to be inserted into the system. Timestream offers you \n with a flexible schema that auto detects the column names and data types \n for your Timestream tables based on the dimension names and data types of\n the data points you specify when invoking writes into the database. \n Timestream support eventual consistency read semantics. This means that \n when you query data immediately after writing a batch of data into Timestream, \n the query results might not reflect the results of a recently completed write \n operation. The results may also include some stale data. If you repeat the \n query request after a short time, the results should return the latest data.\n Service quotas apply.\n
\n \nSee \n code sample for details.
\n \n\n Upserts\n
\n \nYou can use the Version parameter in a WriteRecords request to update data points. \n Timestream tracks a version number with each record. Version defaults to 1 when not specified for the record in the request. \n Timestream will update an existing record’s measure value along with its Version upon receiving a write request with a higher \n Version number for that record. \n Upon receiving an update request where the measure value is the same as that of the existing record, \n Timestream still updates Version, if it is greater than the existing value of Version. \n You can update a data point as many times as desired, as long as the value of Version continuously increases. \n
\n For example, suppose you write a new record without indicating Version in the request. \n Timestream will store this record, and set Version to 1. \n Now, suppose you try to update this record with a WriteRecords request of the same record with a different measure value but, \n like before, do not provide Version. \n In this case, Timestream will reject this update with a RejectedRecordsException since the updated record’s version is not greater than the existing value of Version. \n However, if you were to resend the update request with Version set to 2, \n Timestream would then succeed in updating the record’s value, \n and the Version would be set to 2. \n Next, suppose you sent a WriteRecords request with this same record and an identical measure value, \n but with Version set to 3. \n In this case, Timestream would only update Version to 3. \n Any further updates would need to send a version number greater than 3, \n or the update requests would receive a RejectedRecordsException.\n
The name of the Timesream table.
", + "smithy.api#documentation": "The name of the Timestream table.
", "smithy.api#required": {} } }, "CommonAttributes": { "target": "com.amazonaws.timestreamwrite#Record", "traits": { - "smithy.api#documentation": "A record containing the common measure and dimension attributes \n shared across all the records in the request. The measure and dimension \n attributes specified in here will be merged with the measure and dimension\n attributes in the records object when the data is written into Timestream.\n
" + "smithy.api#documentation": "A record containing the common measure, dimension, time, \n and version attributes \n shared across all the records in the request. The measure and dimension \n attributes specified will be merged with the measure and dimension\n attributes in the records object when the data is written into Timestream.\n Dimensions may not overlap,\n or a ValidationException will be thrown.\n In other words, a record must contain dimensions with unique names.\n
An array of records containing the unique dimension and measure \n attributes for each time series data point.\n
", + "smithy.api#documentation": "An array of records containing the unique measure, dimension, time, and version \n attributes for each time series data point.\n
", "smithy.api#required": {} } } } + }, + "com.amazonaws.timestreamwrite#WriteRecordsResponse": { + "type": "structure", + "members": { + "RecordsIngested": { + "target": "com.amazonaws.timestreamwrite#RecordsIngested", + "traits": { + "smithy.api#documentation": "Information on the records ingested by this request.
" + } + } + } } } } diff --git a/aws/sdk/aws-models/transcribe-streaming.json b/aws/sdk/aws-models/transcribe-streaming.json index 15e13dbc6f688aabdffe93102b138ef0c5eda76e..c3bc9f9eed2609b82bb0ebc83467b2027e90496f 100644 --- a/aws/sdk/aws-models/transcribe-streaming.json +++ b/aws/sdk/aws-models/transcribe-streaming.json @@ -172,7 +172,7 @@ "Category": { "target": "com.amazonaws.transcribestreaming#String", "traits": { - "smithy.api#documentation": "The category of of information identified in this entity; for example, PII.
" + "smithy.api#documentation": "The category of information identified in this entity; for example, PII.
" } }, "Type": { @@ -235,7 +235,7 @@ "Type": { "target": "com.amazonaws.transcribestreaming#ItemType", "traits": { - "smithy.api#documentation": "The type of the item. PRONUNCIATION indicates that the item is a word that\n was recognized in the input audio. PUNCTUATION indicates that the item was\n interpreted as a pause in the input audio.
The type of the item. PRONUNCIATION indicates that the item is a word\n that was recognized in the input audio. PUNCTUATION indicates that the item\n was interpreted as a pause in the input audio.
Indicates whether a word in the item matches a word in the vocabulary filter you've chosen\n for your real-time stream. If true then a word in the item matches your\n vocabulary filter.
Indicates whether a word in the item matches a word in the vocabulary filter you've chosen\n for your media stream. If true then a word in the item matches your\n vocabulary filter.
If speaker identification is enabled, shows the speakers identified in the real-time\n stream.
" + "smithy.api#documentation": "If speaker identification is enabled, shows the speakers identified in the media\n stream.
" } }, "Confidence": { "target": "com.amazonaws.transcribestreaming#Confidence", "traits": { - "smithy.api#documentation": "A value between 0 and 1 for an item that is a confidence score that Amazon Transcribe assigns to each\n word or phrase that it transcribes.
" + "smithy.api#documentation": "A value between zero and one for an item that is a confidence score that Amazon Transcribe assigns to each\n word or phrase that it transcribes.
" } }, "Stable": { @@ -349,6 +349,42 @@ ] } }, + "com.amazonaws.transcribestreaming#LanguageIdentification": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribestreaming#LanguageWithScore" + } + }, + "com.amazonaws.transcribestreaming#LanguageOptions": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[a-zA-Z-,]+$" + } + }, + "com.amazonaws.transcribestreaming#LanguageWithScore": { + "type": "structure", + "members": { + "LanguageCode": { + "target": "com.amazonaws.transcribestreaming#LanguageCode", + "traits": { + "smithy.api#documentation": "The language code of the language identified by Amazon Transcribe.
" + } + }, + "Score": { + "target": "com.amazonaws.transcribestreaming#Double", + "traits": { + "smithy.api#documentation": "The confidence score for the associated language code. Confidence scores are values\n between zero and one; larger values indicate a higher confidence in the identified language.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "The language codes of the identified languages and their associated confidence scores. \n The confidence score is a value between zero and one; a larger value indicates a higher \n confidence in the identified language.
" + } + }, "com.amazonaws.transcribestreaming#LimitExceededException": { "type": "structure", "members": { @@ -717,7 +753,7 @@ "Alternatives": { "target": "com.amazonaws.transcribestreaming#AlternativeList", "traits": { - "smithy.api#documentation": "A list of possible transcriptions for the audio. Each alternative typically contains one\n item that contains the result of the transcription.
A list of possible transcriptions for the audio. Each alternative typically contains one\n item that contains the result of the transcription.
When channel identification is enabled, Amazon Transcribe transcribes the speech from each audio\n channel separately.
\nYou can use ChannelId to retrieve the transcription results for a single\n channel in your audio stream.
The language code of the identified language in your media stream.
" + } + }, + "LanguageIdentification": { + "target": "com.amazonaws.transcribestreaming#LanguageIdentification", + "traits": { + "smithy.api#documentation": "The language code of the dominant language identified in your media.
" + } } }, "traits": { @@ -1061,15 +1109,14 @@ "LanguageCode": { "target": "com.amazonaws.transcribestreaming#LanguageCode", "traits": { - "smithy.api#documentation": "Indicates the source language used in the input audio stream.
", - "smithy.api#httpHeader": "x-amzn-transcribe-language-code", - "smithy.api#required": {} + "smithy.api#documentation": "The language code of the input audio stream.
", + "smithy.api#httpHeader": "x-amzn-transcribe-language-code" } }, "MediaSampleRateHertz": { "target": "com.amazonaws.transcribestreaming#MediaSampleRateHertz", "traits": { - "smithy.api#documentation": "The sample rate, in Hertz, of the input audio. We suggest that you use 8,000 Hz for low\n quality audio and 16,000 Hz for high quality audio.
", + "smithy.api#documentation": "The sample rate, in Hertz (Hz), of the input audio. We suggest that you use 8,000 Hz \n for low quality audio and 16,000 Hz or higher for high quality audio.
", "smithy.api#httpHeader": "x-amzn-transcribe-sample-rate", "smithy.api#required": {} } @@ -1114,21 +1161,21 @@ "VocabularyFilterMethod": { "target": "com.amazonaws.transcribestreaming#VocabularyFilterMethod", "traits": { - "smithy.api#documentation": "The manner in which you use your vocabulary filter to filter words in your transcript.\n Remove removes filtered words from your transcription results.\n Mask masks filtered words with a *** in your transcription results.\n Tag keeps the filtered words in your transcription results and tags them. The\n tag appears as VocabularyFilterMatch equal to True\n
The manner in which you use your vocabulary filter to filter words in your transcript.\n Remove removes filtered words from your transcription results.\n Mask masks filtered words with a *** in your transcription\n results. Tag keeps the filtered words in your transcription results and tags \n them. The tag appears as VocabularyFilterMatch equal to \n True.
When true, enables speaker identification in your real-time stream.
When true, enables speaker identification in your media stream.
When true, instructs Amazon Transcribe to process each audio channel separately and then\n merge the transcription output of each channel into a single transcription.
Amazon Transcribe also produces a transcription of each item. An item includes the start time, end\n time, and any alternative transcriptions.
\nYou can't set both ShowSpeakerLabel and\n EnableChannelIdentification in the same request. If you set both, your request\n returns a BadRequestException.
When true, instructs Amazon Transcribe to process each audio channel separately,\n then merges the transcription output of each channel into a single transcription.
Amazon Transcribe also produces a transcription of each item. An item includes the start time, end\n time, and any alternative transcriptions.
\nYou can't set both ShowSpeakerLabel and\n EnableChannelIdentification in the same request. If you set both, your request\n returns a BadRequestException.
Set this field to PII to identify personally identifiable information (PII) in the transcription output. Content identification is performed only upon complete transcription of the audio segments.
\nYou can’t set both ContentIdentificationType and ContentRedactionType in the same request. If you set both, your request returns a BadRequestException.
Set this field to PII to identify personally identifiable information (PII) in the transcription\n output. Content identification is performed only upon complete transcription of the audio\n segments.
\nYou can’t set both ContentIdentificationType and\n ContentRedactionType in the same request. If you set both, your request \n returns a BadRequestException.
Set this field to PII to redact personally identifiable information (PII) in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.
\nYou can’t set both ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException.
Set this field to PII to redact personally identifiable information (PII) in the transcription\n output. Content redaction is performed only upon complete transcription of the audio\n segments.
\nYou can’t set both ContentRedactionType and\n ContentIdentificationType in the same request. If you set both, your request\n returns a BadRequestException.
List the PII entity types you want to identify or redact. In order to specify entity types, you must have \n either ContentIdentificationType or ContentRedactionType enabled.
\n PiiEntityTypes is an optional parameter with a default value of ALL.
List the PII entity types you want to identify or redact. In order to specify entity types,\n you must have either ContentIdentificationType or\n ContentRedactionType enabled.
\n PIIEntityTypes must be comma-separated; the available values are:\n BANK_ACCOUNT_NUMBER, BANK_ROUTING,\n CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, \n CREDIT_DEBIT_EXPIRY, PIN, EMAIL, \n ADDRESS, NAME, PHONE, \n SSN, and ALL.
\n PiiEntityTypes is an optional parameter with a default value of\n ALL.
The name of the language model you want to use.
", "smithy.api#httpHeader": "x-amzn-transcribe-language-model-name" } + }, + "IdentifyLanguage": { + "target": "com.amazonaws.transcribestreaming#Boolean", + "traits": { + "smithy.api#documentation": "Optional. Set this value to true to enable language identification for \n your media stream.
An object containing a list of languages that might be present in your audio.
\nYou must provide two or more language codes to help Amazon Transcribe identify the correct \n language of your media stream with the highest possible accuracy. You can only select one\n variant per language; for example, you can't include both en-US and\n en-UK in the same request.
You can only use this parameter if you've set IdentifyLanguage to\n truein your request.
Optional. From the subset of languages codes you provided for \n LanguageOptions, you can select one preferred language for your \n transcription.
You can only use this parameter if you've set IdentifyLanguage to\n truein your request.
The language code for the input audio stream.
", + "smithy.api#documentation": "The language code of the input audio stream.
", "smithy.api#httpHeader": "x-amzn-transcribe-language-code" } }, "MediaSampleRateHertz": { "target": "com.amazonaws.transcribestreaming#MediaSampleRateHertz", "traits": { - "smithy.api#documentation": "The sample rate for the input audio stream. Use 8,000 Hz for low quality audio and 16,000 Hz\n for high quality audio.
", + "smithy.api#documentation": "The sample rate, in Hertz (Hz), for the input audio stream. Use 8,000 Hz for low quality \n audio and 16,000 Hz or higher for high quality audio.
", "smithy.api#httpHeader": "x-amzn-transcribe-sample-rate" } }, @@ -1238,14 +1306,14 @@ "VocabularyFilterName": { "target": "com.amazonaws.transcribestreaming#VocabularyFilterName", "traits": { - "smithy.api#documentation": "The name of the vocabulary filter used in your real-time stream.
", + "smithy.api#documentation": "The name of the vocabulary filter used in your media stream.
", "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-filter-name" } }, "VocabularyFilterMethod": { "target": "com.amazonaws.transcribestreaming#VocabularyFilterMethod", "traits": { - "smithy.api#documentation": "The vocabulary filtering method used in the real-time stream.
", + "smithy.api#documentation": "The vocabulary filtering method used in the media stream.
", "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-filter-method" } }, @@ -1308,8 +1376,30 @@ "LanguageModelName": { "target": "com.amazonaws.transcribestreaming#ModelName", "traits": { + "smithy.api#documentation": "The name of the language model used in your media stream.
", "smithy.api#httpHeader": "x-amzn-transcribe-language-model-name" } + }, + "IdentifyLanguage": { + "target": "com.amazonaws.transcribestreaming#Boolean", + "traits": { + "smithy.api#documentation": "The language code of the language identified in your media stream.
", + "smithy.api#httpHeader": "x-amzn-transcribe-identify-language" + } + }, + "LanguageOptions": { + "target": "com.amazonaws.transcribestreaming#LanguageOptions", + "traits": { + "smithy.api#documentation": "The language codes used in the identification of your media stream's predominant \n language.
", + "smithy.api#httpHeader": "x-amzn-transcribe-language-options" + } + }, + "PreferredLanguage": { + "target": "com.amazonaws.transcribestreaming#LanguageCode", + "traits": { + "smithy.api#documentation": "The preferred language you specified in your request.
", + "smithy.api#httpHeader": "x-amzn-transcribe-preferred-language" + } } } }, @@ -1318,15 +1408,6 @@ }, "com.amazonaws.transcribestreaming#Transcribe": { "type": "service", - "version": "2017-10-26", - "operations": [ - { - "target": "com.amazonaws.transcribestreaming#StartMedicalStreamTranscription" - }, - { - "target": "com.amazonaws.transcribestreaming#StartStreamTranscription" - } - ], "traits": { "aws.api#service": { "sdkId": "Transcribe Streaming", @@ -1341,7 +1422,16 @@ "aws.protocols#restJson1": {}, "smithy.api#documentation": "Operations and objects for transcribing streaming speech to text.
", "smithy.api#title": "Amazon Transcribe Streaming Service" - } + }, + "version": "2017-10-26", + "operations": [ + { + "target": "com.amazonaws.transcribestreaming#StartMedicalStreamTranscription" + }, + { + "target": "com.amazonaws.transcribestreaming#StartStreamTranscription" + } + ] }, "com.amazonaws.transcribestreaming#Transcript": { "type": "structure", @@ -1377,7 +1467,7 @@ "TranscriptEvent": { "target": "com.amazonaws.transcribestreaming#TranscriptEvent", "traits": { - "smithy.api#documentation": "A portion of the transcription of the audio stream. Events are sent periodically from\n Amazon Transcribe to your application. The event can be a partial transcription of a section of the audio\n stream, or it can be the entire transcription of that portion of the audio stream.\n
" + "smithy.api#documentation": "A portion of the transcription of the audio stream. Events are sent periodically from\n Amazon Transcribe to your application. The event can be a partial transcription of a section of the audio\n stream, or it can be the entire transcription of that portion of the audio stream.
" } }, "BadRequestException": { diff --git a/aws/sdk/aws-models/translate.json b/aws/sdk/aws-models/translate.json index 157a7697d03caad6d36595a842458952caa228b5..8ed011407a4fbc10d6872c20e11ff9d710078f5c 100644 --- a/aws/sdk/aws-models/translate.json +++ b/aws/sdk/aws-models/translate.json @@ -445,14 +445,14 @@ "Type": { "target": "com.amazonaws.translate#EncryptionKeyType", "traits": { - "smithy.api#documentation": "The type of encryption key used by Amazon Translate to encrypt custom terminologies.
", + "smithy.api#documentation": "The type of encryption key used by Amazon Translate to encrypt this object.
", "smithy.api#required": {} } }, "Id": { "target": "com.amazonaws.translate#EncryptionKeyID", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the encryption key being used to encrypt the custom\n terminology.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.
", "smithy.api#required": {} } } @@ -532,7 +532,7 @@ "DataLocation": { "target": "com.amazonaws.translate#ParallelDataDataLocation", "traits": { - "smithy.api#documentation": "The Amazon S3 location of the most recent parallel data input file that was successfully\n imported into Amazon Translate. The location is returned as a presigned URL that has a 30\n minute expiration.
\n \nAmazon Translate doesn't scan parallel data input files for the risk of CSV injection\n attacks.
\nCSV injection occurs when a .csv or .tsv file is altered so that a record contains\n malicious code. The record begins with a special character, such as =, +, -, or @. When the\n file is opened in a spreadsheet program, the program might interpret the record as a formula\n and run the code within it.
\nBefore you download a parallel data input file from Amazon S3, ensure that you recognize the file and trust its creator.
\nThe Amazon S3 location of the most recent parallel data input file that was successfully\n imported into Amazon Translate. The location is returned as a presigned URL that has a 30\n minute expiration.
\n \nAmazon Translate doesn't scan all input files for the risk of CSV injection\n attacks.
\nCSV injection occurs when a .csv or .tsv file is altered so that a record contains\n malicious code. The record begins with a special character, such as =, +, -, or @. When the\n file is opened in a spreadsheet program, the program might interpret the record as a formula\n and run the code within it.
\nBefore you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.
\nThe data location of the custom terminology being retrieved. The custom terminology file\n is returned in a presigned url that has a 30 minute expiration.
" + "smithy.api#documentation": "The Amazon S3 location of the most recent custom terminology input file that was\n successfully imported into Amazon Translate. The location is returned as a presigned URL that\n has a 30 minute expiration.
\n \nAmazon Translate doesn't scan all input files for the risk of CSV injection\n attacks.
\nCSV injection occurs when a .csv or .tsv file is altered so that a record contains\n malicious code. The record begins with a special character, such as =, +, -, or @. When the\n file is opened in a spreadsheet program, the program might interpret the record as a formula\n and run the code within it.
\nBefore you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.
\nThe Amazon S3 location of the parallel data input file. The location is returned as a\n presigned URL to that has a 30 minute expiration.
\n \nAmazon Translate doesn't scan parallel data input files for the risk of CSV injection\n attacks.
\nCSV injection occurs when a .csv or .tsv file is altered so that a record contains\n malicious code. The record begins with a special character, such as =, +, -, or @. When the\n file is opened in a spreadsheet program, the program might interpret the record as a formula\n and run the code within it.
\nBefore you download a parallel data input file from Amazon S3, ensure that you recognize the file and trust its creator.
\nThe Amazon S3 location of the parallel data input file. The location is returned as a\n presigned URL to that has a 30 minute expiration.
\n \nAmazon Translate doesn't scan all input files for the risk of CSV injection\n attacks.
\nCSV injection occurs when a .csv or .tsv file is altered so that a record contains\n malicious code. The record begins with a special character, such as =, +, -, or @. When the\n file is opened in a spreadsheet program, the program might interpret the record as a formula\n and run the code within it.
\nBefore you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.
\nSettings to configure your translation output, including the option to mask profane words\n and phrases.
" + } } } }, @@ -1694,7 +1711,7 @@ "Location": { "target": "com.amazonaws.translate#String", "traits": { - "smithy.api#documentation": "The location of the custom terminology data.
", + "smithy.api#documentation": "The Amazon S3 location of the most recent custom terminology input file that was\n successfully imported into Amazon Translate. The location is returned as a presigned URL that\n has a 30 minute expiration.
\n \nAmazon Translate doesn't scan all input files for the risk of CSV injection\n attacks.
\nCSV injection occurs when a .csv or .tsv file is altered so that a record contains\n malicious code. The record begins with a special character, such as =, +, -, or @. When the\n file is opened in a spreadsheet program, the program might interpret the record as a formula\n and run the code within it.
\nBefore you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.
\nThe Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role\n that granted Amazon Translate read access to the job's input data.
" } + }, + "Settings": { + "target": "com.amazonaws.translate#TranslationSettings", + "traits": { + "smithy.api#documentation": "Settings that configure the translation output.
" + } } }, "traits": { @@ -2037,6 +2060,12 @@ "smithy.api#documentation": "The language code requested for the language of the target text. The language must be a\n language supported by Amazon Translate.
", "smithy.api#required": {} } + }, + "Settings": { + "target": "com.amazonaws.translate#TranslationSettings", + "traits": { + "smithy.api#documentation": "Settings to configure your translation output, including the option to mask profane words\n and phrases.
" + } } } }, @@ -2069,7 +2098,27 @@ "traits": { "smithy.api#documentation": "The names of the custom terminologies applied to the input text by Amazon Translate for the\n translated text response.
" } + }, + "AppliedSettings": { + "target": "com.amazonaws.translate#TranslationSettings", + "traits": { + "smithy.api#documentation": "Settings that configure the translation output.
" + } + } + } + }, + "com.amazonaws.translate#TranslationSettings": { + "type": "structure", + "members": { + "Profanity": { + "target": "com.amazonaws.translate#Profanity", + "traits": { + "smithy.api#documentation": "Enable the profanity setting if you want Amazon Translate to mask profane words and\n phrases in your translation output.
\nTo mask profane words and phrases, Amazon Translate replaces them with the grawlix string\n “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the\n length or number of words.
\nAmazon Translate does not detect profanity in all of its supported languages. For\n languages that support profanity detection, see Supported\n Languages and Language Codes in the Amazon Translate Developer Guide.
" + } } + }, + "traits": { + "smithy.api#documentation": "Settings that configure the translation output.
" } }, "com.amazonaws.translate#UnboundedLengthString": { diff --git a/aws/sdk/aws-models/wellarchitected.json b/aws/sdk/aws-models/wellarchitected.json index 785733f6165847d03b3b54c22a3cc7e65c3ee892..588e29f5f71e2d2c0dff846fdcb2220c601d8892 100644 --- a/aws/sdk/aws-models/wellarchitected.json +++ b/aws/sdk/aws-models/wellarchitected.json @@ -66,6 +66,12 @@ "HelpfulResourceUrl": { "target": "com.amazonaws.wellarchitected#HelpfulResourceUrl" }, + "HelpfulResourceDisplayText": { + "target": "com.amazonaws.wellarchitected#DisplayText", + "traits": { + "smithy.api#documentation": "The helpful resource text to be displayed.
" + } + }, "Choices": { "target": "com.amazonaws.wellarchitected#Choices" }, @@ -201,7 +207,7 @@ } ], "traits": { - "smithy.api#documentation": "Associate a lens to a workload.
", + "smithy.api#documentation": "Associate a lens to a workload.
\nUp to 10 lenses can be associated with a workload in a single API operation. A \n maximum of 20 lenses can be associated with a workload.
\n\n Disclaimer\n
\nBy accessing and/or applying custom lenses created by another Amazon Web Services user or account, \n you acknowledge that custom lenses created by other users and shared with you are \n Third Party Content as defined in the Amazon Web Services Customer Agreement.
\nAn AWS account ID.
", + "smithy.api#documentation": "An Amazon Web Services account ID.
", "smithy.api#pattern": "^[0-9]{12}$" } }, "com.amazonaws.wellarchitected#AwsRegion": { "type": "string", "traits": { - "smithy.api#documentation": "An AWS Region, for example, us-west-2 or\n ap-northeast-1.
An Amazon Web Services Region, for example, us-west-2 or\n ap-northeast-1.
The choice level helpful resource.
" + } + }, + "ImprovementPlan": { + "target": "com.amazonaws.wellarchitected#ChoiceContent", + "traits": { + "smithy.api#documentation": "The choice level improvement plan.
" + } } }, "traits": { @@ -334,6 +352,44 @@ "target": "com.amazonaws.wellarchitected#ChoiceAnswer" } }, + "com.amazonaws.wellarchitected#ChoiceContent": { + "type": "structure", + "members": { + "DisplayText": { + "target": "com.amazonaws.wellarchitected#ChoiceContentDisplayText", + "traits": { + "smithy.api#documentation": "The display text for the choice content.
" + } + }, + "Url": { + "target": "com.amazonaws.wellarchitected#ChoiceContentUrl", + "traits": { + "smithy.api#documentation": "The URL for the choice content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The choice content.
" + } + }, + "com.amazonaws.wellarchitected#ChoiceContentDisplayText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.wellarchitected#ChoiceContentUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, "com.amazonaws.wellarchitected#ChoiceDescription": { "type": "string", "traits": { @@ -354,6 +410,32 @@ } } }, + "com.amazonaws.wellarchitected#ChoiceImprovementPlan": { + "type": "structure", + "members": { + "ChoiceId": { + "target": "com.amazonaws.wellarchitected#ChoiceId" + }, + "DisplayText": { + "target": "com.amazonaws.wellarchitected#DisplayText", + "traits": { + "smithy.api#documentation": "The display text for the improvement plan.
" + } + }, + "ImprovementPlanUrl": { + "target": "com.amazonaws.wellarchitected#ImprovementPlanUrl" + } + }, + "traits": { + "smithy.api#documentation": "The choice level improvement plan.
" + } + }, + "com.amazonaws.wellarchitected#ChoiceImprovementPlans": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ChoiceImprovementPlan" + } + }, "com.amazonaws.wellarchitected#ChoiceNotes": { "type": "string", "traits": { @@ -467,7 +549,7 @@ "com.amazonaws.wellarchitected#ClientRequestToken": { "type": "string", "traits": { - "smithy.api#documentation": "A unique case-sensitive string used to ensure that this request is idempotent\n (executes only once).
\nYou should not reuse the same token for other requests. If you retry a request with\n the same client request token and the same parameters after it has completed\n successfully, the result of the original request is returned.
\nThis token is listed as required, however, if you do not specify it, the AWS SDKs\n automatically generate one for you. If you are not using the AWS SDK or the AWS CLI,\n you must provide this token or the request will fail.
\nA unique case-sensitive string used to ensure that this request is idempotent\n (executes only once).
\nYou should not reuse the same token for other requests. If you retry a request with\n the same client request token and the same parameters after it has completed\n successfully, the result of the original request is returned.
\nThis token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs\n automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI,\n you must provide this token or the request will fail.
\nCreate a lens share.
\nThe owner of a lens can share it with other Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. \n Shared access to a lens is not removed until the lens invitation is deleted.
\n\n Disclaimer\n
\nBy sharing your custom lenses with other Amazon Web Services accounts, \n you acknowledge that Amazon Web Services will make your custom lenses available to those \n other accounts. Those other accounts may continue to access and use your \n shared custom lenses even if you delete the custom lenses \n from your own Amazon Web Services account or terminate \n your Amazon Web Services account.
\nCreate a new lens version.
\nA lens can have up to 100 versions.
\nAfter a lens has been imported, create a new lens version to publish it. The owner of a lens can share the lens with other \n Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Only the owner of a lens can delete it.\n
", + "smithy.api#http": { + "method": "POST", + "uri": "/lenses/{LensAlias}/versions", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#CreateLensVersionInput": { + "type": "structure", + "members": { + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "The version of the lens being created.
", + "smithy.api#required": {} + } + }, + "IsMajorVersion": { + "target": "com.amazonaws.wellarchitected#IsMajorVersion", + "traits": { + "smithy.api#documentation": "Set to true if this new major lens version.
" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.wellarchitected#CreateLensVersionOutput": { + "type": "structure", + "members": { + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "The ARN for the lens.
" + } + }, + "LensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "The version of the lens.
" + } + } + } + }, "com.amazonaws.wellarchitected#CreateMilestone": { "type": "operation", "input": { @@ -618,7 +862,7 @@ } ], "traits": { - "smithy.api#documentation": "Create a new workload.
\nThe owner of a workload can share the workload with other AWS accounts and IAM users\n in the same AWS Region. Only the owner of a workload can delete it.
\nFor more information, see Defining a Workload in the\n AWS Well-Architected Tool User Guide.
", + "smithy.api#documentation": "Create a new workload.
\nThe owner of a workload can share the workload with other Amazon Web Services accounts and IAM users\n in the same Amazon Web Services Region. Only the owner of a workload can delete it.
\nFor more information, see Defining a Workload in the\n Well-Architected Tool User Guide.
", "smithy.api#http": { "method": "POST", "uri": "/workloads", @@ -747,7 +991,7 @@ } ], "traits": { - "smithy.api#documentation": "Create a workload share.
\nThe owner of a workload can share it with other AWS accounts and IAM users in the same\n AWS Region. Shared access to a workload is not removed until the workload invitation is\n deleted.
\nFor more information, see Sharing a Workload in the\n AWS Well-Architected Tool User Guide.
", + "smithy.api#documentation": "Create a workload share.
\nThe owner of a workload can share it with other Amazon Web Services accounts and IAM users in the same\n Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is\n deleted.
\nFor more information, see Sharing a Workload in the\n Well-Architected Tool User Guide.
", "smithy.api#http": { "method": "POST", "uri": "/workloads/{WorkloadId}/shares", @@ -803,10 +1047,10 @@ "smithy.api#documentation": "Input for Create Workload Share
" } }, - "com.amazonaws.wellarchitected#DeleteWorkload": { + "com.amazonaws.wellarchitected#DeleteLens": { "type": "operation", "input": { - "target": "com.amazonaws.wellarchitected#DeleteWorkloadInput" + "target": "com.amazonaws.wellarchitected#DeleteLensInput" }, "errors": [ { @@ -829,19 +1073,19 @@ } ], "traits": { - "smithy.api#documentation": "Delete an existing workload.
", + "smithy.api#documentation": "Delete an existing lens.
\nOnly the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and IAM users \n that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.\n
\n\n Disclaimer\n
\nBy sharing your custom lenses with other Amazon Web Services accounts, \n you acknowledge that Amazon Web Services will make your custom lenses available to those \n other accounts. Those other accounts may continue to access and use your \n shared custom lenses even if you delete the custom lenses \n from your own Amazon Web Services account or terminate \n your Amazon Web Services account.
\nThe status of the lens to be deleted.
", + "smithy.api#httpQuery": "LensStatus", + "smithy.api#required": {} + } } - }, - "traits": { - "smithy.api#documentation": "Input for workload deletion.
" } }, - "com.amazonaws.wellarchitected#DeleteWorkloadShare": { + "com.amazonaws.wellarchitected#DeleteLensShare": { "type": "operation", "input": { - "target": "com.amazonaws.wellarchitected#DeleteWorkloadShareInput" + "target": "com.amazonaws.wellarchitected#DeleteLensShareInput" }, "errors": [ { @@ -886,15 +1135,15 @@ } ], "traits": { - "smithy.api#documentation": "Delete a workload share.
", + "smithy.api#documentation": "Delete a lens share.
\nAfter the lens share is deleted, Amazon Web Services accounts and IAM users \n that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.
\n\n Disclaimer\n
\nBy sharing your custom lenses with other Amazon Web Services accounts, \n you acknowledge that Amazon Web Services will make your custom lenses available to those \n other accounts. Those other accounts may continue to access and use your \n shared custom lenses even if you delete the custom lenses \n from your own Amazon Web Services account or terminate \n your Amazon Web Services account.
\nInput for Delete Workload Share
" - } - }, - "com.amazonaws.wellarchitected#DifferenceStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UPDATED", - "name": "UPDATED" - }, - { - "value": "NEW", - "name": "NEW" - }, - { - "value": "DELETED", - "name": "DELETED" - } - ] } }, - "com.amazonaws.wellarchitected#DisassociateLenses": { + "com.amazonaws.wellarchitected#DeleteWorkload": { "type": "operation", "input": { - "target": "com.amazonaws.wellarchitected#DisassociateLensesInput" + "target": "com.amazonaws.wellarchitected#DeleteWorkloadInput" }, "errors": [ { @@ -969,15 +1196,155 @@ } ], "traits": { - "smithy.api#documentation": "Disassociate a lens from a workload.
\nThe AWS Well-Architected Framework lens (wellarchitected) cannot be\n removed from a workload.
Delete an existing workload.
", "smithy.api#http": { - "method": "PATCH", - "uri": "/workloads/{WorkloadId}/disassociateLenses", + "method": "DELETE", + "uri": "/workloads/{WorkloadId}", "code": 200 } } }, - "com.amazonaws.wellarchitected#DisassociateLensesInput": { + "com.amazonaws.wellarchitected#DeleteWorkloadInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#httpQuery": "ClientRequestToken", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Input for workload deletion.
" + } + }, + "com.amazonaws.wellarchitected#DeleteWorkloadShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#DeleteWorkloadShareInput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Delete a workload share.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/workloads/{WorkloadId}/shares/{ShareId}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#DeleteWorkloadShareInput": { + "type": "structure", + "members": { + "ShareId": { + "target": "com.amazonaws.wellarchitected#ShareId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#httpQuery": "ClientRequestToken", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Input for Delete Workload Share
" + } + }, + "com.amazonaws.wellarchitected#DifferenceStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UPDATED", + "name": "UPDATED" + }, + { + "value": "NEW", + "name": "NEW" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] + } + }, + "com.amazonaws.wellarchitected#DisassociateLenses": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#DisassociateLensesInput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociate a lens from a workload.
\nUp to 10 lenses can be disassociated from a workload in a single API operation.
\nThe Amazon Web Services Well-Architected Framework lens (wellarchitected) cannot be\n removed from a workload.
Input to disassociate lens reviews.
" } }, + "com.amazonaws.wellarchitected#DisplayText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, "com.amazonaws.wellarchitected#ExceptionMessage": { "type": "string", "traits": { @@ -1016,6 +1392,70 @@ "smithy.api#documentation": "Type of the resource affected.
" } }, + "com.amazonaws.wellarchitected#ExportLens": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ExportLensInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ExportLensOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Export an existing lens.
\nLenses are defined in JSON. For more information, see JSON format specification \n in the Well-Architected Tool User Guide. Only the owner of a lens can export it. \n
\n\n Disclaimer\n
\nDo not include or gather personal identifiable information (PII) of end users or \n other identifiable individuals in or via your custom lenses. If your custom \n lens or those shared with you and used in your account do include or collect \n PII you are responsible for: ensuring that the included PII is processed in accordance \n with applicable law, providing adequate privacy notices, and obtaining necessary \n consents for processing such data.
\nThe lens version to be exported.
", + "smithy.api#httpQuery": "LensVersion" + } + } + } + }, + "com.amazonaws.wellarchitected#ExportLensOutput": { + "type": "structure", + "members": { + "LensJSON": { + "target": "com.amazonaws.wellarchitected#LensJSON", + "traits": { + "smithy.api#documentation": "The JSON for the lens.
" + } + } + } + }, "com.amazonaws.wellarchitected#GetAnswer": { "type": "operation", "input": { @@ -1097,6 +1537,12 @@ "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "The ARN for the lens.
" + } + }, "Answer": { "target": "com.amazonaws.wellarchitected#Answer" } @@ -1105,6 +1551,70 @@ "smithy.api#documentation": "Output of a get answer call.
" } }, + "com.amazonaws.wellarchitected#GetLens": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#GetLensInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#GetLensOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get an existing lens.
", + "smithy.api#http": { + "method": "GET", + "uri": "/lenses/{LensAlias}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#GetLensInput": { + "type": "structure", + "members": { + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "The lens version to be retrieved.
", + "smithy.api#httpQuery": "LensVersion" + } + } + } + }, + "com.amazonaws.wellarchitected#GetLensOutput": { + "type": "structure", + "members": { + "Lens": { + "target": "com.amazonaws.wellarchitected#Lens", + "traits": { + "smithy.api#documentation": "A lens return object.
" + } + } + } + }, "com.amazonaws.wellarchitected#GetLensReview": { "type": "operation", "input": { @@ -1311,8 +1821,14 @@ "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "The base version of the lens.
", - "smithy.api#httpQuery": "BaseLensVersion", - "smithy.api#required": {} + "smithy.api#httpQuery": "BaseLensVersion" + } + }, + "TargetLensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "The lens version to target a difference for.
", + "smithy.api#httpQuery": "TargetLensVersion" } } } @@ -1323,12 +1839,24 @@ "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "The ARN for the lens.
" + } + }, "BaseLensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "The base version of the lens.
" } }, + "TargetLensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "The target lens version for the lens.
" + } + }, "LatestLensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { @@ -1480,6 +2008,110 @@ } } }, + "com.amazonaws.wellarchitected#ImportLens": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ImportLensInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ImportLensOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Import a new lens.
\nThe lens cannot be applied to workloads or shared with other Amazon Web Services accounts\n until it's published with CreateLensVersion\n
\nLenses are defined in JSON. For more information, see JSON format specification \n in the Well-Architected Tool User Guide.
\nA custom lens cannot exceed 500 KB in size.
\n \n\n Disclaimer\n
\nDo not include or gather personal identifiable information (PII) of end users or \n other identifiable individuals in or via your custom lenses. If your custom \n lens or those shared with you and used in your account do include or collect \n PII you are responsible for: ensuring that the included PII is processed in accordance \n with applicable law, providing adequate privacy notices, and obtaining necessary \n consents for processing such data.
\nThe JSON representation of a lens.
", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.wellarchitected#TagMap", + "traits": { + "smithy.api#documentation": "Tags to associate to a lens.
" + } + } + } + }, + "com.amazonaws.wellarchitected#ImportLensOutput": { + "type": "structure", + "members": { + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "The ARN for the lens.
" + } + }, + "Status": { + "target": "com.amazonaws.wellarchitected#ImportLensStatus", + "traits": { + "smithy.api#documentation": "The status of the imported lens.
" + } + } + } + }, + "com.amazonaws.wellarchitected#ImportLensStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "COMPLETE", + "name": "COMPLETE" + }, + { + "value": "ERROR", + "name": "ERROR" + } + ] + } + }, "com.amazonaws.wellarchitected#ImprovementPlanUrl": { "type": "string", "traits": { @@ -1516,6 +2148,12 @@ }, "ImprovementPlanUrl": { "target": "com.amazonaws.wellarchitected#ImprovementPlanUrl" + }, + "ImprovementPlans": { + "target": "com.amazonaws.wellarchitected#ChoiceImprovementPlans", + "traits": { + "smithy.api#documentation": "The improvement plan details.
" + } } }, "traits": { @@ -1533,7 +2171,7 @@ } }, "traits": { - "smithy.api#documentation": "There is a problem with the AWS Well-Architected Tool API service.
", + "smithy.api#documentation": "There is a problem with the Well-Architected Tool API service.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1544,16 +2182,57 @@ "smithy.api#documentation": "Defines whether this question is applicable to a lens review.
" } }, + "com.amazonaws.wellarchitected#IsMajorVersion": { + "type": "boolean" + }, "com.amazonaws.wellarchitected#IsReviewOwnerUpdateAcknowledged": { "type": "boolean" }, + "com.amazonaws.wellarchitected#Lens": { + "type": "structure", + "members": { + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "The ARN of a lens.
" + } + }, + "LensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "The version of a lens.
" + } + }, + "Name": { + "target": "com.amazonaws.wellarchitected#LensName" + }, + "Description": { + "target": "com.amazonaws.wellarchitected#LensDescription" + }, + "Owner": { + "target": "com.amazonaws.wellarchitected#LensOwner", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID that owns the lens.
" + } + }, + "ShareInvitationId": { + "target": "com.amazonaws.wellarchitected#ShareInvitationId", + "traits": { + "smithy.api#documentation": "The ID assigned to the share invitation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A lens return object.
" + } + }, "com.amazonaws.wellarchitected#LensAlias": { "type": "string", "traits": { "smithy.api#documentation": "The alias of the lens, for example, serverless.
Each lens is identified by its LensSummary$LensAlias.
", "smithy.api#length": { "min": 1, - "max": 64 + "max": 128 } } }, @@ -1563,12 +2242,15 @@ "target": "com.amazonaws.wellarchitected#LensAlias" }, "traits": { - "smithy.api#documentation": "List of lens aliases to associate or disassociate with a workload.
\nIdentify a lens using its LensSummary$LensAlias.
", + "smithy.api#documentation": "List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified.
\nIdentify a lens using its LensSummary$LensAlias.
", "smithy.api#length": { "min": 1 } } }, + "com.amazonaws.wellarchitected#LensArn": { + "type": "string" + }, "com.amazonaws.wellarchitected#LensDescription": { "type": "string", "traits": { @@ -1579,6 +2261,15 @@ } } }, + "com.amazonaws.wellarchitected#LensJSON": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 500000 + } + } + }, "com.amazonaws.wellarchitected#LensName": { "type": "string", "traits": { @@ -1589,12 +2280,30 @@ } } }, + "com.amazonaws.wellarchitected#LensNamePrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.wellarchitected#LensOwner": { + "type": "string" + }, "com.amazonaws.wellarchitected#LensReview": { "type": "structure", "members": { "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "The ARN for the lens.
" + } + }, "LensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { @@ -1636,6 +2345,12 @@ "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "The ARN for the lens.
" + } + }, "Base64String": { "target": "com.amazonaws.wellarchitected#Base64String" } @@ -1659,6 +2374,12 @@ "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "The ARN for the lens.
" + } + }, "LensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { @@ -1674,15 +2395,38 @@ "smithy.api#documentation": "The status of the lens.
" } }, - "UpdatedAt": { - "target": "com.amazonaws.wellarchitected#Timestamp" + "UpdatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "RiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" + } + }, + "traits": { + "smithy.api#documentation": "A lens review summary of a workload.
" + } + }, + "com.amazonaws.wellarchitected#LensShareSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#LensShareSummary" + } + }, + "com.amazonaws.wellarchitected#LensShareSummary": { + "type": "structure", + "members": { + "ShareId": { + "target": "com.amazonaws.wellarchitected#ShareId" + }, + "SharedWith": { + "target": "com.amazonaws.wellarchitected#SharedWith" }, - "RiskCounts": { - "target": "com.amazonaws.wellarchitected#RiskCounts" + "Status": { + "target": "com.amazonaws.wellarchitected#ShareStatus" } }, "traits": { - "smithy.api#documentation": "A lens review summary of a workload.
" + "smithy.api#documentation": "A lens share summary return object.
" } }, "com.amazonaws.wellarchitected#LensStatus": { @@ -1700,6 +2444,33 @@ { "value": "DEPRECATED", "name": "DEPRECATED" + }, + { + "value": "DELETED", + "name": "DELETED" + }, + { + "value": "UNSHARED", + "name": "UNSHARED" + } + ] + } + }, + "com.amazonaws.wellarchitected#LensStatusType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALL", + "name": "ALL" + }, + { + "value": "DRAFT", + "name": "DRAFT" + }, + { + "value": "PUBLISHED", + "name": "PUBLISHED" } ] } @@ -1716,26 +2487,72 @@ "com.amazonaws.wellarchitected#LensSummary": { "type": "structure", "members": { + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "The ARN of the lens.
" + } + }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, + "LensName": { + "target": "com.amazonaws.wellarchitected#LensName" + }, + "LensType": { + "target": "com.amazonaws.wellarchitected#LensType", + "traits": { + "smithy.api#documentation": "The type of the lens.
" + } + }, + "Description": { + "target": "com.amazonaws.wellarchitected#LensDescription" + }, + "CreatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "UpdatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, "LensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "The version of the lens.
" } }, - "LensName": { - "target": "com.amazonaws.wellarchitected#LensName" + "Owner": { + "target": "com.amazonaws.wellarchitected#AwsAccountId" }, - "Description": { - "target": "com.amazonaws.wellarchitected#LensDescription" + "LensStatus": { + "target": "com.amazonaws.wellarchitected#LensStatus", + "traits": { + "smithy.api#documentation": "The status of the lens.
" + } } }, "traits": { "smithy.api#documentation": "A lens summary of a lens.
" } }, + "com.amazonaws.wellarchitected#LensType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWS_OFFICIAL", + "name": "AWS_OFFICIAL" + }, + { + "value": "CUSTOM_SHARED", + "name": "CUSTOM_SHARED" + }, + { + "value": "CUSTOM_SELF", + "name": "CUSTOM_SELF" + } + ] + } + }, "com.amazonaws.wellarchitected#LensUpgradeSummary": { "type": "structure", "members": { @@ -1748,6 +2565,12 @@ "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "The ARN for the lens.
" + } + }, "CurrentLensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { @@ -1770,7 +2593,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 128 + "max": 32 } } }, @@ -1881,6 +2704,12 @@ "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "The ARN for the lens.
" + } + }, "AnswerSummaries": { "target": "com.amazonaws.wellarchitected#AnswerSummaries" }, @@ -1999,6 +2828,12 @@ "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "The ARN for the lens.
" + } + }, "ImprovementSummaries": { "target": "com.amazonaws.wellarchitected#ImprovementSummaries" }, @@ -2102,6 +2937,91 @@ "smithy.api#documentation": "Output of a list lens reviews call.
" } }, + "com.amazonaws.wellarchitected#ListLensShares": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListLensSharesInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListLensSharesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List the lens shares associated with the lens.
", + "smithy.api#http": { + "method": "GET", + "uri": "/lenses/{LensAlias}/shares", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListLensSharesInput": { + "type": "structure", + "members": { + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SharedWithPrefix": { + "target": "com.amazonaws.wellarchitected#SharedWithPrefix", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID or IAM role with which the lens is shared.
", + "smithy.api#httpQuery": "SharedWithPrefix" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#ListWorkloadSharesMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return for this request.
", + "smithy.api#httpQuery": "MaxResults" + } + } + } + }, + "com.amazonaws.wellarchitected#ListLensSharesOutput": { + "type": "structure", + "members": { + "LensShareSummaries": { + "target": "com.amazonaws.wellarchitected#LensShareSummaries", + "traits": { + "smithy.api#documentation": "A list of lens share summaries.
" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + } + }, "com.amazonaws.wellarchitected#ListLenses": { "type": "operation", "input": { @@ -2152,6 +3072,26 @@ "traits": { "smithy.api#httpQuery": "MaxResults" } + }, + "LensType": { + "target": "com.amazonaws.wellarchitected#LensType", + "traits": { + "smithy.api#documentation": "The type of lenses to be returned.
", + "smithy.api#httpQuery": "LensType" + } + }, + "LensStatus": { + "target": "com.amazonaws.wellarchitected#LensStatusType", + "traits": { + "smithy.api#documentation": "The status of lenses to be returned.
", + "smithy.api#httpQuery": "LensStatus" + } + }, + "LensName": { + "target": "com.amazonaws.wellarchitected#LensName", + "traits": { + "smithy.api#httpQuery": "LensName" + } } }, "traits": { @@ -2370,6 +3310,20 @@ "smithy.api#httpQuery": "WorkloadNamePrefix" } }, + "LensNamePrefix": { + "target": "com.amazonaws.wellarchitected#LensNamePrefix", + "traits": { + "smithy.api#documentation": "An optional string added to the beginning of each lens name returned in the results.
", + "smithy.api#httpQuery": "LensNamePrefix" + } + }, + "ShareResourceType": { + "target": "com.amazonaws.wellarchitected#ShareResourceType", + "traits": { + "smithy.api#documentation": "The type of share invitations to be returned.
", + "smithy.api#httpQuery": "ShareResourceType" + } + }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { @@ -2514,7 +3468,7 @@ "SharedWithPrefix": { "target": "com.amazonaws.wellarchitected#SharedWithPrefix", "traits": { - "smithy.api#documentation": "The AWS account ID or IAM role with which the workload is shared.
", + "smithy.api#documentation": "The Amazon Web Services account ID or IAM role with which the workload is shared.
", "smithy.api#httpQuery": "SharedWithPrefix" } }, @@ -2799,6 +3753,9 @@ "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId" }, + "PillarName": { + "target": "com.amazonaws.wellarchitected#PillarName" + }, "DifferenceStatus": { "target": "com.amazonaws.wellarchitected#DifferenceStatus", "traits": { @@ -3078,8 +4035,23 @@ "smithy.api#documentation": "The ID assigned to the share invitation.
" } }, + "ShareResourceType": { + "target": "com.amazonaws.wellarchitected#ShareResourceType", + "traits": { + "smithy.api#documentation": "The resource type of the share invitation.
" + } + }, "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "The ARN for the lens.
" + } } }, "traits": { @@ -3132,17 +4104,47 @@ "PermissionType": { "target": "com.amazonaws.wellarchitected#PermissionType" }, + "ShareResourceType": { + "target": "com.amazonaws.wellarchitected#ShareResourceType", + "traits": { + "smithy.api#documentation": "The resource type of the share invitation.
" + } + }, "WorkloadName": { "target": "com.amazonaws.wellarchitected#WorkloadName" }, "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "LensName": { + "target": "com.amazonaws.wellarchitected#LensName" + }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "The ARN for the lens.
" + } } }, "traits": { "smithy.api#documentation": "A share invitation summary return object.
" } }, + "com.amazonaws.wellarchitected#ShareResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "WORKLOAD", + "name": "WORKLOAD" + }, + { + "value": "LENS", + "name": "LENS" + } + ] + } + }, "com.amazonaws.wellarchitected#ShareStatus": { "type": "string", "traits": { @@ -3174,7 +4176,7 @@ "com.amazonaws.wellarchitected#SharedWith": { "type": "string", "traits": { - "smithy.api#documentation": "The AWS account ID or IAM role with which the workload is shared.
", + "smithy.api#documentation": "The Amazon Web Services account ID or IAM role with which the workload is shared.
", "smithy.api#length": { "min": 12, "max": 2048 @@ -3456,6 +4458,12 @@ "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "The ARN for the lens.
" + } + }, "Answer": { "target": "com.amazonaws.wellarchitected#Answer" } @@ -3959,11 +4967,32 @@ }, "com.amazonaws.wellarchitected#WellArchitectedApiServiceLambda": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "WellArchitected", + "arnNamespace": "wellarchitected", + "cloudFormationName": "WellArchitected", + "cloudTrailEventSource": "wellarchitected.amazonaws.com", + "endpointPrefix": "wellarchitected" + }, + "aws.auth#sigv4": { + "name": "wellarchitected" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "This is the Well-Architected Tool API Reference. The WA Tool API provides programmatic access to the \n Well-Architected Tool in the \n Amazon Web Services Management Console. For information \n about the Well-Architected Tool, see the \n Well-Architected Tool User Guide.
", + "smithy.api#title": "AWS Well-Architected Tool" + }, "version": "2020-03-31", "operations": [ { "target": "com.amazonaws.wellarchitected#AssociateLenses" }, + { + "target": "com.amazonaws.wellarchitected#CreateLensShare" + }, + { + "target": "com.amazonaws.wellarchitected#CreateLensVersion" + }, { "target": "com.amazonaws.wellarchitected#CreateMilestone" }, @@ -3973,6 +5002,12 @@ { "target": "com.amazonaws.wellarchitected#CreateWorkloadShare" }, + { + "target": "com.amazonaws.wellarchitected#DeleteLens" + }, + { + "target": "com.amazonaws.wellarchitected#DeleteLensShare" + }, { "target": "com.amazonaws.wellarchitected#DeleteWorkload" }, @@ -3982,9 +5017,15 @@ { "target": "com.amazonaws.wellarchitected#DisassociateLenses" }, + { + "target": "com.amazonaws.wellarchitected#ExportLens" + }, { "target": "com.amazonaws.wellarchitected#GetAnswer" }, + { + "target": "com.amazonaws.wellarchitected#GetLens" + }, { "target": "com.amazonaws.wellarchitected#GetLensReview" }, @@ -4000,6 +5041,9 @@ { "target": "com.amazonaws.wellarchitected#GetWorkload" }, + { + "target": "com.amazonaws.wellarchitected#ImportLens" + }, { "target": "com.amazonaws.wellarchitected#ListAnswers" }, @@ -4012,6 +5056,9 @@ { "target": "com.amazonaws.wellarchitected#ListLensReviews" }, + { + "target": "com.amazonaws.wellarchitected#ListLensShares" + }, { "target": "com.amazonaws.wellarchitected#ListMilestones" }, @@ -4054,22 +5101,7 @@ { "target": "com.amazonaws.wellarchitected#UpgradeLensReview" } - ], - "traits": { - "aws.api#service": { - "sdkId": "WellArchitected", - "arnNamespace": "wellarchitected", - "cloudFormationName": "WellArchitected", - "cloudTrailEventSource": "wellarchitected.amazonaws.com", - "endpointPrefix": "wellarchitected" - }, - "aws.auth#sigv4": { - "name": "wellarchitected" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "This is the AWS Well-Architected Tool API Reference. The AWS Well-Architected Tool API provides programmatic access to the \n AWS Well-Architected Tool in the \n AWS Management Console. For information \n about the AWS Well-Architected Tool, see the \n AWS Well-Architected Tool User Guide.
", - "smithy.api#title": "AWS Well-Architected Tool" - } + ] }, "com.amazonaws.wellarchitected#Workload": { "type": "structure", @@ -4163,7 +5195,7 @@ "target": "com.amazonaws.wellarchitected#AwsAccountId" }, "traits": { - "smithy.api#documentation": "The list of AWS account IDs associated with the workload.
", + "smithy.api#documentation": "The list of Amazon Web Services account IDs associated with the workload.
", "smithy.api#length": { "min": 0, "max": 100 @@ -4192,7 +5224,7 @@ "target": "com.amazonaws.wellarchitected#AwsRegion" }, "traits": { - "smithy.api#documentation": "The list of AWS Regions associated with the workload, for example,\n us-east-2, or ca-central-1.
The list of Amazon Web Services Regions associated with the workload, for example,\n us-east-2, or ca-central-1.
The ID assigned to the workload. This ID is unique within an AWS Region.
", + "smithy.api#documentation": "The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
", "smithy.api#pattern": "^[0-9a-f]{32}$" } }, @@ -4292,7 +5324,7 @@ "com.amazonaws.wellarchitected#WorkloadName": { "type": "string", "traits": { - "smithy.api#documentation": "The name of the workload.
\nThe name must be unique within an account within a Region. Spaces and capitalization\n are ignored when checking for uniqueness.
", + "smithy.api#documentation": "The name of the workload.
\nThe name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization\n are ignored when checking for uniqueness.
", "smithy.api#length": { "min": 3, "max": 100 @@ -4324,7 +5356,7 @@ "target": "com.amazonaws.wellarchitected#WorkloadNonAwsRegion" }, "traits": { - "smithy.api#documentation": "The list of non-AWS Regions associated with the workload.
", + "smithy.api#documentation": "The list of non-Amazon Web Services Regions associated with the workload.
", "smithy.api#length": { "min": 0, "max": 5 diff --git a/aws/sdk/aws-models/workspaces-web.json b/aws/sdk/aws-models/workspaces-web.json new file mode 100644 index 0000000000000000000000000000000000000000..6c48f08d58bfe7b52f6297d7cb772f07d5625b35 --- /dev/null +++ b/aws/sdk/aws-models/workspaces-web.json @@ -0,0 +1,4446 @@ +{ + "smithy": "1.0", + "shapes": { + "com.amazonaws.workspacesweb#ARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$" + } + }, + "com.amazonaws.workspacesweb#AWSErmineControlPlaneService": { + "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "WorkSpaces Web", + "arnNamespace": "workspaces-web", + "cloudFormationName": "WorkSpacesWeb", + "cloudTrailEventSource": "workspaces-web.amazonaws.com", + "endpointPrefix": "workspaces-web" + }, + "aws.auth#sigv4": { + "name": "workspaces-web" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "WorkSpaces Web is a low cost, fully managed WorkSpace built specifically to facilitate\n secure, web-based workloads. WorkSpaces Web makes it easy for customers to safely provide\n their employees with access to internal websites and SaaS web applications without the\n administrative burden of appliances or specialized client software. WorkSpaces Web provides\n simple policy tools tailored for user interactions, while offloading common tasks like\n capacity management, scaling, and maintaining browser images.
", + "smithy.api#title": "Amazon WorkSpaces Web" + }, + "version": "2020-07-08", + "operations": [ + { + "target": "com.amazonaws.workspacesweb#AssociateBrowserSettings" + }, + { + "target": "com.amazonaws.workspacesweb#AssociateNetworkSettings" + }, + { + "target": "com.amazonaws.workspacesweb#AssociateTrustStore" + }, + { + "target": "com.amazonaws.workspacesweb#AssociateUserSettings" + }, + { + "target": "com.amazonaws.workspacesweb#CreateBrowserSettings" + }, + { + "target": "com.amazonaws.workspacesweb#CreateIdentityProvider" + }, + { + "target": "com.amazonaws.workspacesweb#CreateNetworkSettings" + }, + { + "target": "com.amazonaws.workspacesweb#CreatePortal" + }, + { + "target": "com.amazonaws.workspacesweb#CreateTrustStore" + }, + { + "target": "com.amazonaws.workspacesweb#CreateUserSettings" + }, + { + "target": "com.amazonaws.workspacesweb#DeleteBrowserSettings" + }, + { + "target": "com.amazonaws.workspacesweb#DeleteIdentityProvider" + }, + { + "target": "com.amazonaws.workspacesweb#DeleteNetworkSettings" + }, + { + "target": "com.amazonaws.workspacesweb#DeletePortal" + }, + { + "target": "com.amazonaws.workspacesweb#DeleteTrustStore" + }, + { + "target": "com.amazonaws.workspacesweb#DeleteUserSettings" + }, + { + "target": "com.amazonaws.workspacesweb#DisassociateBrowserSettings" + }, + { + "target": "com.amazonaws.workspacesweb#DisassociateNetworkSettings" + }, + { + "target": "com.amazonaws.workspacesweb#DisassociateTrustStore" + }, + { + "target": "com.amazonaws.workspacesweb#DisassociateUserSettings" + }, + { + "target": "com.amazonaws.workspacesweb#GetBrowserSettings" + }, + { + "target": "com.amazonaws.workspacesweb#GetIdentityProvider" + }, + { + "target": "com.amazonaws.workspacesweb#GetNetworkSettings" + }, + { + "target": "com.amazonaws.workspacesweb#GetPortal" + }, + { + "target": "com.amazonaws.workspacesweb#GetPortalServiceProviderMetadata" + }, + { + "target": "com.amazonaws.workspacesweb#GetTrustStore" + }, + { + "target": "com.amazonaws.workspacesweb#GetTrustStoreCertificate" + }, + { + "target": "com.amazonaws.workspacesweb#GetUserSettings" + }, + { + "target": "com.amazonaws.workspacesweb#ListBrowserSettings" + }, + { + "target": "com.amazonaws.workspacesweb#ListIdentityProviders" + }, + { + "target": "com.amazonaws.workspacesweb#ListNetworkSettings" + }, + { + "target": "com.amazonaws.workspacesweb#ListPortals" + }, + { + "target": "com.amazonaws.workspacesweb#ListTagsForResource" + }, + { + "target": "com.amazonaws.workspacesweb#ListTrustStoreCertificates" + }, + { + "target": "com.amazonaws.workspacesweb#ListTrustStores" + }, + { + "target": "com.amazonaws.workspacesweb#ListUserSettings" + }, + { + "target": "com.amazonaws.workspacesweb#TagResource" + }, + { + "target": "com.amazonaws.workspacesweb#UntagResource" + }, + { + "target": "com.amazonaws.workspacesweb#UpdateBrowserSettings" + }, + { + "target": "com.amazonaws.workspacesweb#UpdateIdentityProvider" + }, + { + "target": "com.amazonaws.workspacesweb#UpdateNetworkSettings" + }, + { + "target": "com.amazonaws.workspacesweb#UpdatePortal" + }, + { + "target": "com.amazonaws.workspacesweb#UpdateTrustStore" + }, + { + "target": "com.amazonaws.workspacesweb#UpdateUserSettings" + } + ] + }, + "com.amazonaws.workspacesweb#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspacesweb#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "Access is denied.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.workspacesweb#ArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspacesweb#ARN" + } + }, + "com.amazonaws.workspacesweb#AssociateBrowserSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#AssociateBrowserSettingsRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#AssociateBrowserSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#ConflictException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Associates a browser settings resource with a web portal.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/portals/{portalArn+}/browserSettings", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workspacesweb#AssociateBrowserSettingsRequest": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the web portal.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "browserSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the browser settings.
", + "smithy.api#httpQuery": "browserSettingsArn", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#AssociateBrowserSettingsResponse": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the web portal.
", + "smithy.api#required": {} + } + }, + "browserSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the browser settings.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#AssociateNetworkSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#AssociateNetworkSettingsRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#AssociateNetworkSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#ConflictException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Associates a network settings resource with a web portal.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/portals/{portalArn+}/networkSettings", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workspacesweb#AssociateNetworkSettingsRequest": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the web portal.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "networkSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the network settings.
", + "smithy.api#httpQuery": "networkSettingsArn", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#AssociateNetworkSettingsResponse": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the web portal.
", + "smithy.api#required": {} + } + }, + "networkSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the network settings.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#AssociateTrustStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#AssociateTrustStoreRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#AssociateTrustStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Associates a trust store with a web portal.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/portals/{portalArn+}/trustStores", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workspacesweb#AssociateTrustStoreRequest": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the web portal.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "trustStoreArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the trust store.
", + "smithy.api#httpQuery": "trustStoreArn", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#AssociateTrustStoreResponse": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the web portal.
", + "smithy.api#required": {} + } + }, + "trustStoreArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the trust store.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#AssociateUserSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#AssociateUserSettingsRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#AssociateUserSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#ConflictException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Associates a user settings resource with a web portal.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/portals/{portalArn+}/userSettings", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workspacesweb#AssociateUserSettingsRequest": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the web portal.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the user settings.
", + "smithy.api#httpQuery": "userSettingsArn", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#AssociateUserSettingsResponse": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the web portal.
", + "smithy.api#required": {} + } + }, + "userSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the user settings.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#BrowserPolicy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 131072 + }, + "smithy.api#pattern": "\\{[\\S\\s]*\\}\\s*" + } + }, + "com.amazonaws.workspacesweb#BrowserSettings": { + "type": "structure", + "members": { + "browserSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the browser settings.
", + "smithy.api#required": {} + } + }, + "associatedPortalArns": { + "target": "com.amazonaws.workspacesweb#ArnList", + "traits": { + "smithy.api#documentation": "A list of web portal ARNs that this browser settings is associated with.
" + } + }, + "browserPolicy": { + "target": "com.amazonaws.workspacesweb#BrowserPolicy", + "traits": { + "smithy.api#documentation": "A JSON string containing Chrome Enterprise policies that will be applied to all\n streaming sessions.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The browser settings resource that can be associated with a web portal. Once associated\n with a web portal, browser settings control how the browser will behave once a user starts\n a streaming session for the web portal.
" + } + }, + "com.amazonaws.workspacesweb#BrowserSettingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspacesweb#BrowserSettingsSummary" + } + }, + "com.amazonaws.workspacesweb#BrowserSettingsSummary": { + "type": "structure", + "members": { + "browserSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the browser settings.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary for browser settings.
" + } + }, + "com.amazonaws.workspacesweb#BrowserType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Chrome", + "name": "CHROME" + } + ] + } + }, + "com.amazonaws.workspacesweb#Certificate": { + "type": "structure", + "members": { + "thumbprint": { + "target": "com.amazonaws.workspacesweb#CertificateThumbprint", + "traits": { + "smithy.api#documentation": "A hexadecimal identifier for the certificate.
" + } + }, + "subject": { + "target": "com.amazonaws.workspacesweb#CertificatePrincipal", + "traits": { + "smithy.api#documentation": "The entity the certificate belongs to.
" + } + }, + "issuer": { + "target": "com.amazonaws.workspacesweb#CertificatePrincipal", + "traits": { + "smithy.api#documentation": "The entity that issued the certificate.
" + } + }, + "notValidBefore": { + "target": "com.amazonaws.workspacesweb#Timestamp", + "traits": { + "smithy.api#documentation": "The certificate is not valid before this date.
" + } + }, + "notValidAfter": { + "target": "com.amazonaws.workspacesweb#Timestamp", + "traits": { + "smithy.api#documentation": "The certificate is not valid after this date.
" + } + }, + "body": { + "target": "com.amazonaws.workspacesweb#CertificateAuthorityBody", + "traits": { + "smithy.api#documentation": "The body of the certificate.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The certificate.
" + } + }, + "com.amazonaws.workspacesweb#CertificateAuthorityBody": { + "type": "blob" + }, + "com.amazonaws.workspacesweb#CertificateList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspacesweb#CertificateAuthorityBody" + } + }, + "com.amazonaws.workspacesweb#CertificatePrincipal": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^\\S+$" + } + }, + "com.amazonaws.workspacesweb#CertificateSummary": { + "type": "structure", + "members": { + "thumbprint": { + "target": "com.amazonaws.workspacesweb#CertificateThumbprint", + "traits": { + "smithy.api#documentation": "A hexadecimal identifier for the certificate.
" + } + }, + "subject": { + "target": "com.amazonaws.workspacesweb#CertificatePrincipal", + "traits": { + "smithy.api#documentation": "The entity the certificate belongs to.
" + } + }, + "issuer": { + "target": "com.amazonaws.workspacesweb#CertificatePrincipal", + "traits": { + "smithy.api#documentation": "The entity that issued the certificate.
" + } + }, + "notValidBefore": { + "target": "com.amazonaws.workspacesweb#Timestamp", + "traits": { + "smithy.api#documentation": "The certificate is not valid before this date.
" + } + }, + "notValidAfter": { + "target": "com.amazonaws.workspacesweb#Timestamp", + "traits": { + "smithy.api#documentation": "The certificate is not valid after this date.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary of the certificate.
" + } + }, + "com.amazonaws.workspacesweb#CertificateSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspacesweb#CertificateSummary" + } + }, + "com.amazonaws.workspacesweb#CertificateThumbprint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 64, + "max": 64 + }, + "smithy.api#pattern": "^[A-Fa-f0-9]{64}$" + } + }, + "com.amazonaws.workspacesweb#CertificateThumbprintList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspacesweb#CertificateThumbprint" + } + }, + "com.amazonaws.workspacesweb#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.workspacesweb#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspacesweb#ExceptionMessage" + }, + "resourceId": { + "target": "com.amazonaws.workspacesweb#ResourceId", + "traits": { + "smithy.api#documentation": "Identifier of the resource affected.
" + } + }, + "resourceType": { + "target": "com.amazonaws.workspacesweb#ResourceType", + "traits": { + "smithy.api#documentation": "Type of the resource affected.
" + } + } + }, + "traits": { + "smithy.api#documentation": "There is a conflict.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.workspacesweb#CreateBrowserSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#CreateBrowserSettingsRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#CreateBrowserSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#ConflictException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a browser settings resource that can be associated with a web portal. Once\n associated with a web portal, browser settings control how the browser will behave once a\n user starts a streaming session for the web portal.
", + "smithy.api#http": { + "method": "POST", + "uri": "/browserSettings", + "code": 200 + } + } + }, + "com.amazonaws.workspacesweb#CreateBrowserSettingsRequest": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.workspacesweb#TagList", + "traits": { + "smithy.api#documentation": "The tags to add to the browser settings resource. A tag is a key-value pair.
" + } + }, + "customerManagedKey": { + "target": "com.amazonaws.workspacesweb#keyArn", + "traits": { + "smithy.api#documentation": "The custom managed key of the browser settings.
" + } + }, + "additionalEncryptionContext": { + "target": "com.amazonaws.workspacesweb#EncryptionContextMap", + "traits": { + "smithy.api#documentation": "Additional encryption context of the browser settings.
" + } + }, + "browserPolicy": { + "target": "com.amazonaws.workspacesweb#BrowserPolicy", + "traits": { + "smithy.api#documentation": "A JSON string containing Chrome Enterprise policies that will be applied to all\n streaming sessions.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.workspacesweb#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS SDK.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.workspacesweb#CreateBrowserSettingsResponse": { + "type": "structure", + "members": { + "browserSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the browser settings.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#CreateIdentityProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#CreateIdentityProviderRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#CreateIdentityProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#ConflictException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an identity provider resource that is then associated with a web portal.
", + "smithy.api#http": { + "method": "POST", + "uri": "/identityProviders", + "code": 200 + } + } + }, + "com.amazonaws.workspacesweb#CreateIdentityProviderRequest": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the web portal.
", + "smithy.api#required": {} + } + }, + "identityProviderName": { + "target": "com.amazonaws.workspacesweb#IdentityProviderName", + "traits": { + "smithy.api#documentation": "The identity provider name.
", + "smithy.api#required": {} + } + }, + "identityProviderType": { + "target": "com.amazonaws.workspacesweb#IdentityProviderType", + "traits": { + "smithy.api#documentation": "The identity provider type.
", + "smithy.api#required": {} + } + }, + "identityProviderDetails": { + "target": "com.amazonaws.workspacesweb#IdentityProviderDetails", + "traits": { + "smithy.api#documentation": "The identity provider details. The following list describes the provider detail keys for\n each identity provider type.
\nFor Google and Login with Amazon:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
For Facebook:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
\n api_version\n
For Sign in with Apple:
\n\n client_id\n
\n team_id\n
\n key_id\n
\n private_key\n
\n authorize_scopes\n
For OIDC providers:
\n\n client_id\n
\n client_secret\n
\n attributes_request_method\n
\n oidc_issuer\n
\n authorize_scopes\n
\n authorize_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n token_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n attributes_url\n if not available from discovery URL specified by\n oidc_issuer key\n
\n jwks_uri\n if not available from discovery URL specified by\n oidc_issuer key\n
For SAML providers:
\n\n MetadataFile OR MetadataURL\n
\n IDPSignout\n optional\n
A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.workspacesweb#CreateIdentityProviderResponse": { + "type": "structure", + "members": { + "identityProviderArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the identity provider.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#CreateNetworkSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#CreateNetworkSettingsRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#CreateNetworkSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#ConflictException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a network settings resource that can be associated with a web portal. Once\n associated with a web portal, network settings define how streaming instances will connect\n with your specified VPC.
", + "smithy.api#http": { + "method": "POST", + "uri": "/networkSettings", + "code": 200 + } + } + }, + "com.amazonaws.workspacesweb#CreateNetworkSettingsRequest": { + "type": "structure", + "members": { + "vpcId": { + "target": "com.amazonaws.workspacesweb#VpcId", + "traits": { + "smithy.api#documentation": "The VPC that streaming instances will connect to.
", + "smithy.api#required": {} + } + }, + "subnetIds": { + "target": "com.amazonaws.workspacesweb#SubnetIdList", + "traits": { + "smithy.api#documentation": "The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.
", + "smithy.api#required": {} + } + }, + "securityGroupIds": { + "target": "com.amazonaws.workspacesweb#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "One or more security groups used to control access from streaming instances to your VPC.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.workspacesweb#TagList", + "traits": { + "smithy.api#documentation": "The tags to add to the network settings resource. A tag is a key-value pair.
" + } + }, + "clientToken": { + "target": "com.amazonaws.workspacesweb#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.workspacesweb#CreateNetworkSettingsResponse": { + "type": "structure", + "members": { + "networkSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the network settings.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#CreatePortal": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#CreatePortalRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#CreatePortalResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#ConflictException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a web portal.
", + "smithy.api#http": { + "method": "POST", + "uri": "/portals", + "code": 200 + } + } + }, + "com.amazonaws.workspacesweb#CreatePortalRequest": { + "type": "structure", + "members": { + "displayName": { + "target": "com.amazonaws.workspacesweb#DisplayName", + "traits": { + "smithy.api#documentation": "The name of the web portal. This is not visible to users who log into the web portal.
" + } + }, + "tags": { + "target": "com.amazonaws.workspacesweb#TagList", + "traits": { + "smithy.api#documentation": "The tags to add to the web portal. A tag is a key-value pair.
" + } + }, + "customerManagedKey": { + "target": "com.amazonaws.workspacesweb#keyArn", + "traits": { + "smithy.api#documentation": "The customer managed key of the web portal.
" + } + }, + "additionalEncryptionContext": { + "target": "com.amazonaws.workspacesweb#EncryptionContextMap", + "traits": { + "smithy.api#documentation": "The additional encryption context of the portal.
" + } + }, + "clientToken": { + "target": "com.amazonaws.workspacesweb#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.workspacesweb#CreatePortalResponse": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the web portal.
", + "smithy.api#required": {} + } + }, + "portalEndpoint": { + "target": "com.amazonaws.workspacesweb#PortalEndpoint", + "traits": { + "smithy.api#documentation": "The endpoint URL of the web portal that users access in order to start streaming sessions.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#CreateTrustStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#CreateTrustStoreRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#CreateTrustStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#ConflictException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a trust store that can be associated with a web portal. A trust store contains\n certificate authority (CA) certificates. Once associated with a web portal, the browser in\n a streaming session will recognize certificates that have been issued using any of the CAs\n in the trust store. If your organization has internal websites that use certificates issued\n by private CAs, you should add the private CA certificate to the trust store.
", + "smithy.api#http": { + "method": "POST", + "uri": "/trustStores", + "code": 200 + } + } + }, + "com.amazonaws.workspacesweb#CreateTrustStoreRequest": { + "type": "structure", + "members": { + "certificateList": { + "target": "com.amazonaws.workspacesweb#CertificateList", + "traits": { + "smithy.api#documentation": "A list of CA certificates to be added to the trust store.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.workspacesweb#TagList", + "traits": { + "smithy.api#documentation": "The tags to add to the trust store. A tag is a key-value pair.
" + } + }, + "clientToken": { + "target": "com.amazonaws.workspacesweb#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.workspacesweb#CreateTrustStoreResponse": { + "type": "structure", + "members": { + "trustStoreArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the trust store.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#CreateUserSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#CreateUserSettingsRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#CreateUserSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#ConflictException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a user settings resource that can be associated with a web portal. Once\n associated with a web portal, user settings control how users can transfer data between a\n streaming session and the their local devices.
", + "smithy.api#http": { + "method": "POST", + "uri": "/userSettings", + "code": 200 + } + } + }, + "com.amazonaws.workspacesweb#CreateUserSettingsRequest": { + "type": "structure", + "members": { + "copyAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType", + "traits": { + "smithy.api#documentation": "Specifies whether the user can copy text from the streaming session to the local\n device.
", + "smithy.api#required": {} + } + }, + "pasteAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType", + "traits": { + "smithy.api#documentation": "Specifies whether the user can paste text from the local device to the streaming\n session.
", + "smithy.api#required": {} + } + }, + "downloadAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType", + "traits": { + "smithy.api#documentation": "Specifies whether the user can download files from the streaming session to the local\n device.
", + "smithy.api#required": {} + } + }, + "uploadAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType", + "traits": { + "smithy.api#documentation": "Specifies whether the user can upload files from the local device to the streaming\n session.
", + "smithy.api#required": {} + } + }, + "printAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType", + "traits": { + "smithy.api#documentation": "Specifies whether the user can print to the local device.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.workspacesweb#TagList", + "traits": { + "smithy.api#documentation": "The tags to add to the user settings resource. A tag is a key-value pair.
" + } + }, + "clientToken": { + "target": "com.amazonaws.workspacesweb#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.workspacesweb#CreateUserSettingsResponse": { + "type": "structure", + "members": { + "userSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the user settings.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#DeleteBrowserSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#DeleteBrowserSettingsRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#DeleteBrowserSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#ConflictException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes browser settings.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/browserSettings/{browserSettingsArn+}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workspacesweb#DeleteBrowserSettingsRequest": { + "type": "structure", + "members": { + "browserSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the browser settings.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#DeleteBrowserSettingsResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspacesweb#DeleteIdentityProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#DeleteIdentityProviderRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#DeleteIdentityProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#ConflictException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the identity provider.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/identityProviders/{identityProviderArn+}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workspacesweb#DeleteIdentityProviderRequest": { + "type": "structure", + "members": { + "identityProviderArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the identity provider.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#DeleteIdentityProviderResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspacesweb#DeleteNetworkSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#DeleteNetworkSettingsRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#DeleteNetworkSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#ConflictException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes network settings.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/networkSettings/{networkSettingsArn+}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workspacesweb#DeleteNetworkSettingsRequest": { + "type": "structure", + "members": { + "networkSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the network settings.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#DeleteNetworkSettingsResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspacesweb#DeletePortal": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#DeletePortalRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#DeletePortalResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#ConflictException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a web portal.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/portals/{portalArn+}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workspacesweb#DeletePortalRequest": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the web portal.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#DeletePortalResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspacesweb#DeleteTrustStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#DeleteTrustStoreRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#DeleteTrustStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#ConflictException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the trust store.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/trustStores/{trustStoreArn+}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workspacesweb#DeleteTrustStoreRequest": { + "type": "structure", + "members": { + "trustStoreArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the trust store.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#DeleteTrustStoreResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspacesweb#DeleteUserSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#DeleteUserSettingsRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#DeleteUserSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#ConflictException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes user settings.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/userSettings/{userSettingsArn+}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workspacesweb#DeleteUserSettingsRequest": { + "type": "structure", + "members": { + "userSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the user settings.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#DeleteUserSettingsResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspacesweb#DisassociateBrowserSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#DisassociateBrowserSettingsRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#DisassociateBrowserSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates browser settings from a web portal.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/portals/{portalArn+}/browserSettings", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workspacesweb#DisassociateBrowserSettingsRequest": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the web portal.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#DisassociateBrowserSettingsResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspacesweb#DisassociateNetworkSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#DisassociateNetworkSettingsRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#DisassociateNetworkSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates network settings from a web portal.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/portals/{portalArn+}/networkSettings", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workspacesweb#DisassociateNetworkSettingsRequest": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the web portal.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#DisassociateNetworkSettingsResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspacesweb#DisassociateTrustStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#DisassociateTrustStoreRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#DisassociateTrustStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates a trust store from a web portal.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/portals/{portalArn+}/trustStores", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workspacesweb#DisassociateTrustStoreRequest": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the web portal.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#DisassociateTrustStoreResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspacesweb#DisassociateUserSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#DisassociateUserSettingsRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#DisassociateUserSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates user settings from a web portal.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/portals/{portalArn+}/userSettings", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workspacesweb#DisassociateUserSettingsRequest": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the web portal.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#DisassociateUserSettingsResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspacesweb#DisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.workspacesweb#EnabledType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Disabled", + "name": "DISABLED" + }, + { + "value": "Enabled", + "name": "ENABLED" + } + ] + } + }, + "com.amazonaws.workspacesweb#EncryptionContextMap": { + "type": "map", + "key": { + "target": "com.amazonaws.workspacesweb#StringType" + }, + "value": { + "target": "com.amazonaws.workspacesweb#StringType" + } + }, + "com.amazonaws.workspacesweb#ExceptionMessage": { + "type": "string" + }, + "com.amazonaws.workspacesweb#FieldName": { + "type": "string" + }, + "com.amazonaws.workspacesweb#GetBrowserSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#GetBrowserSettingsRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#GetBrowserSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets browser settings.
", + "smithy.api#http": { + "method": "GET", + "uri": "/browserSettings/{browserSettingsArn+}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.workspacesweb#GetBrowserSettingsRequest": { + "type": "structure", + "members": { + "browserSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the browser settings.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#GetBrowserSettingsResponse": { + "type": "structure", + "members": { + "browserSettings": { + "target": "com.amazonaws.workspacesweb#BrowserSettings", + "traits": { + "smithy.api#documentation": "The browser settings.
" + } + } + } + }, + "com.amazonaws.workspacesweb#GetIdentityProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#GetIdentityProviderRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#GetIdentityProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the identity provider.
", + "smithy.api#http": { + "method": "GET", + "uri": "/identityProviders/{identityProviderArn+}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.workspacesweb#GetIdentityProviderRequest": { + "type": "structure", + "members": { + "identityProviderArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the identity provider.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#GetIdentityProviderResponse": { + "type": "structure", + "members": { + "identityProvider": { + "target": "com.amazonaws.workspacesweb#IdentityProvider", + "traits": { + "smithy.api#documentation": "The identity provider.
" + } + } + } + }, + "com.amazonaws.workspacesweb#GetNetworkSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#GetNetworkSettingsRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#GetNetworkSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the network settings.
", + "smithy.api#http": { + "method": "GET", + "uri": "/networkSettings/{networkSettingsArn+}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.workspacesweb#GetNetworkSettingsRequest": { + "type": "structure", + "members": { + "networkSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the network settings.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#GetNetworkSettingsResponse": { + "type": "structure", + "members": { + "networkSettings": { + "target": "com.amazonaws.workspacesweb#NetworkSettings", + "traits": { + "smithy.api#documentation": "The network settings.
" + } + } + } + }, + "com.amazonaws.workspacesweb#GetPortal": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#GetPortalRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#GetPortalResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the web portal.
", + "smithy.api#http": { + "method": "GET", + "uri": "/portals/{portalArn+}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.workspacesweb#GetPortalRequest": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the web portal.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#GetPortalResponse": { + "type": "structure", + "members": { + "portal": { + "target": "com.amazonaws.workspacesweb#Portal", + "traits": { + "smithy.api#documentation": "The web portal.
" + } + } + } + }, + "com.amazonaws.workspacesweb#GetPortalServiceProviderMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#GetPortalServiceProviderMetadataRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#GetPortalServiceProviderMetadataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the service provider metadata.
", + "smithy.api#http": { + "method": "GET", + "uri": "/portalIdp/{portalArn+}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.workspacesweb#GetPortalServiceProviderMetadataRequest": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the web portal.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#GetPortalServiceProviderMetadataResponse": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the web portal.
", + "smithy.api#required": {} + } + }, + "serviceProviderSamlMetadata": { + "target": "com.amazonaws.workspacesweb#SamlMetadata", + "traits": { + "smithy.api#documentation": "The service provider SAML metadata.
" + } + } + } + }, + "com.amazonaws.workspacesweb#GetTrustStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#GetTrustStoreRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#GetTrustStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the trust store.
", + "smithy.api#http": { + "method": "GET", + "uri": "/trustStores/{trustStoreArn+}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.workspacesweb#GetTrustStoreCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#GetTrustStoreCertificateRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#GetTrustStoreCertificateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the trust store certificate.
", + "smithy.api#http": { + "method": "GET", + "uri": "/trustStores/{trustStoreArn+}/certificate", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.workspacesweb#GetTrustStoreCertificateRequest": { + "type": "structure", + "members": { + "trustStoreArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the trust store certificate.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "thumbprint": { + "target": "com.amazonaws.workspacesweb#CertificateThumbprint", + "traits": { + "smithy.api#documentation": "The thumbprint of the trust store certificate.
", + "smithy.api#httpQuery": "thumbprint", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#GetTrustStoreCertificateResponse": { + "type": "structure", + "members": { + "trustStoreArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the trust store certificate.
" + } + }, + "certificate": { + "target": "com.amazonaws.workspacesweb#Certificate", + "traits": { + "smithy.api#documentation": "The certificate of the trust store certificate.
" + } + } + } + }, + "com.amazonaws.workspacesweb#GetTrustStoreRequest": { + "type": "structure", + "members": { + "trustStoreArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the trust store.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#GetTrustStoreResponse": { + "type": "structure", + "members": { + "trustStore": { + "target": "com.amazonaws.workspacesweb#TrustStore", + "traits": { + "smithy.api#documentation": "The trust store.
" + } + } + } + }, + "com.amazonaws.workspacesweb#GetUserSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#GetUserSettingsRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#GetUserSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets user settings.
", + "smithy.api#http": { + "method": "GET", + "uri": "/userSettings/{userSettingsArn+}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.workspacesweb#GetUserSettingsRequest": { + "type": "structure", + "members": { + "userSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the user settings.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#GetUserSettingsResponse": { + "type": "structure", + "members": { + "userSettings": { + "target": "com.amazonaws.workspacesweb#UserSettings", + "traits": { + "smithy.api#documentation": "The user settings.
" + } + } + } + }, + "com.amazonaws.workspacesweb#IdentityProvider": { + "type": "structure", + "members": { + "identityProviderArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the identity provider.
", + "smithy.api#required": {} + } + }, + "identityProviderName": { + "target": "com.amazonaws.workspacesweb#IdentityProviderName", + "traits": { + "smithy.api#documentation": "The identity provider name.
" + } + }, + "identityProviderType": { + "target": "com.amazonaws.workspacesweb#IdentityProviderType", + "traits": { + "smithy.api#documentation": "The identity provider type.
" + } + }, + "identityProviderDetails": { + "target": "com.amazonaws.workspacesweb#IdentityProviderDetails", + "traits": { + "smithy.api#documentation": "The identity provider details. The following list describes the provider detail keys for\n each identity provider type.
\nFor Google and Login with Amazon:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
For Facebook:
\n\n client_id\n
\n client_secret\n
\n authorize_scopes\n
\n api_version\n
For Sign in with Apple:
\n\n client_id\n
\n team_id\n
\n key_id\n
\n private_key\n
\n authorize_scopes\n
For OIDC providers:
\n\n client_id\n
\n client_secret\n
\n attributes_request_method\n
\n oidc_issuer\n
\n authorize_scopes\n
\n authorize_url\n if not available from discovery URL specified by oidc_issuer\n key\n
\n token_url\n if not available from discovery URL specified by oidc_issuer\n key\n
\n attributes_url\n if not available from discovery URL specified by oidc_issuer\n key\n
\n jwks_uri\n if not available from discovery URL specified by oidc_issuer\n key\n
For SAML providers:
\n\n MetadataFile OR MetadataURL\n
\n IDPSignout\n optional\n
The identity provider.
" + } + }, + "com.amazonaws.workspacesweb#IdentityProviderDetails": { + "type": "map", + "key": { + "target": "com.amazonaws.workspacesweb#StringType" + }, + "value": { + "target": "com.amazonaws.workspacesweb#StringType" + } + }, + "com.amazonaws.workspacesweb#IdentityProviderList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspacesweb#IdentityProviderSummary" + } + }, + "com.amazonaws.workspacesweb#IdentityProviderName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[^_][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_]+$" + } + }, + "com.amazonaws.workspacesweb#IdentityProviderSummary": { + "type": "structure", + "members": { + "identityProviderArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the identity provider.
" + } + }, + "identityProviderName": { + "target": "com.amazonaws.workspacesweb#IdentityProviderName", + "traits": { + "smithy.api#documentation": "The identity provider name.
" + } + }, + "identityProviderType": { + "target": "com.amazonaws.workspacesweb#IdentityProviderType", + "traits": { + "smithy.api#documentation": "The identity provider type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary of the identity provider.
" + } + }, + "com.amazonaws.workspacesweb#IdentityProviderType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SAML", + "name": "SAML" + }, + { + "value": "Facebook", + "name": "Facebook" + }, + { + "value": "Google", + "name": "Google" + }, + { + "value": "LoginWithAmazon", + "name": "LoginWithAmazon" + }, + { + "value": "SignInWithApple", + "name": "SignInWithApple" + }, + { + "value": "OIDC", + "name": "OIDC" + } + ] + } + }, + "com.amazonaws.workspacesweb#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspacesweb#ExceptionMessage" + }, + "retryAfterSeconds": { + "target": "com.amazonaws.workspacesweb#RetryAfterSeconds", + "traits": { + "smithy.api#documentation": "Advice to clients on when the call can be safely retried.
", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "There is an internal server error.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.workspacesweb#ListBrowserSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#ListBrowserSettingsRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#ListBrowserSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of browser settings.
", + "smithy.api#http": { + "method": "GET", + "uri": "/browserSettings", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.workspacesweb#ListBrowserSettingsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.workspacesweb#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.workspacesweb#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to be included in the next page.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.workspacesweb#ListBrowserSettingsResponse": { + "type": "structure", + "members": { + "browserSettings": { + "target": "com.amazonaws.workspacesweb#BrowserSettingsList", + "traits": { + "smithy.api#documentation": "The browser settings.
" + } + }, + "nextToken": { + "target": "com.amazonaws.workspacesweb#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" + } + } + } + }, + "com.amazonaws.workspacesweb#ListIdentityProviders": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#ListIdentityProvidersRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#ListIdentityProvidersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of identity providers for a specific web portal.
", + "smithy.api#http": { + "method": "GET", + "uri": "/portals/{portalArn+}/identityProviders", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.workspacesweb#ListIdentityProvidersRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.workspacesweb#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.workspacesweb#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to be included in the next page.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the web portal.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#ListIdentityProvidersResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.workspacesweb#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" + } + }, + "identityProviders": { + "target": "com.amazonaws.workspacesweb#IdentityProviderList", + "traits": { + "smithy.api#documentation": "The identity providers.
" + } + } + } + }, + "com.amazonaws.workspacesweb#ListNetworkSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#ListNetworkSettingsRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#ListNetworkSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of network settings.
", + "smithy.api#http": { + "method": "GET", + "uri": "/networkSettings", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.workspacesweb#ListNetworkSettingsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.workspacesweb#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.workspacesweb#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to be included in the next page.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.workspacesweb#ListNetworkSettingsResponse": { + "type": "structure", + "members": { + "networkSettings": { + "target": "com.amazonaws.workspacesweb#NetworkSettingsList", + "traits": { + "smithy.api#documentation": "The network settings.
" + } + }, + "nextToken": { + "target": "com.amazonaws.workspacesweb#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" + } + } + } + }, + "com.amazonaws.workspacesweb#ListPortals": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#ListPortalsRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#ListPortalsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list or web portals.
", + "smithy.api#http": { + "method": "GET", + "uri": "/portals", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.workspacesweb#ListPortalsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.workspacesweb#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.workspacesweb#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to be included in the next page.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.workspacesweb#ListPortalsResponse": { + "type": "structure", + "members": { + "portals": { + "target": "com.amazonaws.workspacesweb#PortalList", + "traits": { + "smithy.api#documentation": "The portals in the list.
" + } + }, + "nextToken": { + "target": "com.amazonaws.workspacesweb#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" + } + } + } + }, + "com.amazonaws.workspacesweb#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of tags for a resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn+}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.workspacesweb#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.workspacesweb#TagList", + "traits": { + "smithy.api#documentation": "The tags of the resource.
" + } + } + } + }, + "com.amazonaws.workspacesweb#ListTrustStoreCertificates": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#ListTrustStoreCertificatesRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#ListTrustStoreCertificatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of trust store certificates.
", + "smithy.api#http": { + "method": "GET", + "uri": "/trustStores/{trustStoreArn+}/certificates", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.workspacesweb#ListTrustStoreCertificatesRequest": { + "type": "structure", + "members": { + "trustStoreArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the trust store
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.workspacesweb#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.workspacesweb#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to be included in the next page.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.workspacesweb#ListTrustStoreCertificatesResponse": { + "type": "structure", + "members": { + "certificateList": { + "target": "com.amazonaws.workspacesweb#CertificateSummaryList", + "traits": { + "smithy.api#documentation": "The certificate list.
" + } + }, + "trustStoreArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the trust store.
" + } + }, + "nextToken": { + "target": "com.amazonaws.workspacesweb#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.>
" + } + } + } + }, + "com.amazonaws.workspacesweb#ListTrustStores": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#ListTrustStoresRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#ListTrustStoresResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of trust stores.
", + "smithy.api#http": { + "method": "GET", + "uri": "/trustStores", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.workspacesweb#ListTrustStoresRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.workspacesweb#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.workspacesweb#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to be included in the next page.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.workspacesweb#ListTrustStoresResponse": { + "type": "structure", + "members": { + "trustStores": { + "target": "com.amazonaws.workspacesweb#TrustStoreSummaryList", + "traits": { + "smithy.api#documentation": "The trust stores.
" + } + }, + "nextToken": { + "target": "com.amazonaws.workspacesweb#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" + } + } + } + }, + "com.amazonaws.workspacesweb#ListUserSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#ListUserSettingsRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#ListUserSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of user settings.
", + "smithy.api#http": { + "method": "GET", + "uri": "/userSettings", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.workspacesweb#ListUserSettingsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.workspacesweb#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.workspacesweb#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to be included in the next page.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.workspacesweb#ListUserSettingsResponse": { + "type": "structure", + "members": { + "userSettings": { + "target": "com.amazonaws.workspacesweb#UserSettingsList", + "traits": { + "smithy.api#documentation": "The user settings.
" + } + }, + "nextToken": { + "target": "com.amazonaws.workspacesweb#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" + } + } + } + }, + "com.amazonaws.workspacesweb#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.workspacesweb#NetworkSettings": { + "type": "structure", + "members": { + "networkSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the network settings.
", + "smithy.api#required": {} + } + }, + "associatedPortalArns": { + "target": "com.amazonaws.workspacesweb#ArnList", + "traits": { + "smithy.api#documentation": "A list of web portal ARNs that this network settings is associated with.
" + } + }, + "vpcId": { + "target": "com.amazonaws.workspacesweb#VpcId", + "traits": { + "smithy.api#documentation": "The VPC that streaming instances will connect to.
" + } + }, + "subnetIds": { + "target": "com.amazonaws.workspacesweb#SubnetIdList", + "traits": { + "smithy.api#documentation": "The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.
" + } + }, + "securityGroupIds": { + "target": "com.amazonaws.workspacesweb#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "One or more security groups used to control access from streaming instances to your VPC.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A network settings resource that can be associated with a web portal. Once associated\n with a web portal, network settings define how streaming instances will connect with your\n specified VPC.
" + } + }, + "com.amazonaws.workspacesweb#NetworkSettingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspacesweb#NetworkSettingsSummary" + } + }, + "com.amazonaws.workspacesweb#NetworkSettingsSummary": { + "type": "structure", + "members": { + "networkSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the network settings.
" + } + }, + "vpcId": { + "target": "com.amazonaws.workspacesweb#VpcId", + "traits": { + "smithy.api#documentation": "The VPC ID of the network settings.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary of network settings.
" + } + }, + "com.amazonaws.workspacesweb#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\S+$" + } + }, + "com.amazonaws.workspacesweb#Portal": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the web portal.
" + } + }, + "rendererType": { + "target": "com.amazonaws.workspacesweb#RendererType", + "traits": { + "smithy.api#documentation": "The renderer that is used in streaming sessions.
" + } + }, + "browserType": { + "target": "com.amazonaws.workspacesweb#BrowserType", + "traits": { + "smithy.api#documentation": "The browser that users see when using a streaming session.
" + } + }, + "portalStatus": { + "target": "com.amazonaws.workspacesweb#PortalStatus", + "traits": { + "smithy.api#documentation": "The status of the web portal.
" + } + }, + "portalEndpoint": { + "target": "com.amazonaws.workspacesweb#PortalEndpoint", + "traits": { + "smithy.api#documentation": "The endpoint URL of the web portal that users access in order to start streaming\n sessions.
" + } + }, + "displayName": { + "target": "com.amazonaws.workspacesweb#DisplayName", + "traits": { + "smithy.api#documentation": "The name of the web portal.
" + } + }, + "creationDate": { + "target": "com.amazonaws.workspacesweb#Timestamp", + "traits": { + "smithy.api#documentation": "The creation date of the web portal.
" + } + }, + "browserSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the browser settings that is associated with this web portal.
" + } + }, + "userSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the trust store that is associated with the web portal.
" + } + }, + "networkSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the network settings that is associated with the web portal.
" + } + }, + "trustStoreArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the trust store that is associated with the web portal.
" + } + }, + "statusReason": { + "target": "com.amazonaws.workspacesweb#StatusReason", + "traits": { + "smithy.api#documentation": "A message that explains why the web portal is in its current status.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The web portal.
" + } + }, + "com.amazonaws.workspacesweb#PortalEndpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 253 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]?((?!-)([A-Za-z0-9-]*[A-Za-z0-9])\\.)+[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.workspacesweb#PortalList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspacesweb#PortalSummary" + } + }, + "com.amazonaws.workspacesweb#PortalStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Incomplete", + "name": "INCOMPLETE" + }, + { + "value": "Pending", + "name": "PENDING" + }, + { + "value": "Active", + "name": "ACTIVE" + } + ] + } + }, + "com.amazonaws.workspacesweb#PortalSummary": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the web portal.
" + } + }, + "rendererType": { + "target": "com.amazonaws.workspacesweb#RendererType", + "traits": { + "smithy.api#documentation": "The renderer that is used in streaming sessions.
" + } + }, + "browserType": { + "target": "com.amazonaws.workspacesweb#BrowserType", + "traits": { + "smithy.api#documentation": "The browser type of the web portal.
" + } + }, + "portalStatus": { + "target": "com.amazonaws.workspacesweb#PortalStatus", + "traits": { + "smithy.api#documentation": "The status of the web portal.
" + } + }, + "portalEndpoint": { + "target": "com.amazonaws.workspacesweb#PortalEndpoint", + "traits": { + "smithy.api#documentation": "The endpoint URL of the web portal that users access in order to start streaming\n sessions.
" + } + }, + "displayName": { + "target": "com.amazonaws.workspacesweb#DisplayName", + "traits": { + "smithy.api#documentation": "The name of the web portal.
" + } + }, + "creationDate": { + "target": "com.amazonaws.workspacesweb#Timestamp", + "traits": { + "smithy.api#documentation": "The creation date of the web portal.
" + } + }, + "browserSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the browser settings that is associated with the web portal.
" + } + }, + "userSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the user settings that is associated with the web portal.
" + } + }, + "networkSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the network settings that is associated with the web portal.
" + } + }, + "trustStoreArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the trust that is associated with this web portal.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary of the portal.
" + } + }, + "com.amazonaws.workspacesweb#QuotaCode": { + "type": "string" + }, + "com.amazonaws.workspacesweb#RendererType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AppStream", + "name": "APPSTREAM" + } + ] + } + }, + "com.amazonaws.workspacesweb#ResourceId": { + "type": "string" + }, + "com.amazonaws.workspacesweb#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspacesweb#ExceptionMessage" + }, + "resourceId": { + "target": "com.amazonaws.workspacesweb#ResourceId", + "traits": { + "smithy.api#documentation": "Hypothetical identifier of the resource affected.
" + } + }, + "resourceType": { + "target": "com.amazonaws.workspacesweb#ResourceType", + "traits": { + "smithy.api#documentation": "Hypothetical type of the resource affected.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The resource cannot be found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.workspacesweb#ResourceType": { + "type": "string" + }, + "com.amazonaws.workspacesweb#RetryAfterSeconds": { + "type": "integer" + }, + "com.amazonaws.workspacesweb#SamlMetadata": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 204800 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.workspacesweb#SecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w+\\-]+$" + } + }, + "com.amazonaws.workspacesweb#SecurityGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspacesweb#SecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.workspacesweb#ServiceCode": { + "type": "string" + }, + "com.amazonaws.workspacesweb#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspacesweb#ExceptionMessage" + }, + "resourceId": { + "target": "com.amazonaws.workspacesweb#ResourceId", + "traits": { + "smithy.api#documentation": "Identifier of the resource affected.
" + } + }, + "resourceType": { + "target": "com.amazonaws.workspacesweb#ResourceType", + "traits": { + "smithy.api#documentation": "Type of the resource affected.
" + } + }, + "serviceCode": { + "target": "com.amazonaws.workspacesweb#ServiceCode", + "traits": { + "smithy.api#documentation": "The originating service.
" + } + }, + "quotaCode": { + "target": "com.amazonaws.workspacesweb#QuotaCode", + "traits": { + "smithy.api#documentation": "The originating quota.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The service quota has been exceeded.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.workspacesweb#StatusReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.workspacesweb#StringType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 131072 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.workspacesweb#SubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^subnet-([0-9a-f]{8}|[0-9a-f]{17})$" + } + }, + "com.amazonaws.workspacesweb#SubnetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspacesweb#SubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 3 + } + } + }, + "com.amazonaws.workspacesweb#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.workspacesweb#TagKey", + "traits": { + "smithy.api#documentation": "The key of the tag.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.workspacesweb#TagValue", + "traits": { + "smithy.api#documentation": "The value of the tag
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The tag.
" + } + }, + "com.amazonaws.workspacesweb#TagExceptionMessage": { + "type": "string" + }, + "com.amazonaws.workspacesweb#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.workspacesweb#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspacesweb#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.workspacesweb#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspacesweb#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.workspacesweb#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#TooManyTagsException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Adds or overwrites one or more tags for the specified resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn+}", + "code": 200 + } + } + }, + "com.amazonaws.workspacesweb#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.workspacesweb#TagList", + "traits": { + "smithy.api#documentation": "The tags of the resource.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.workspacesweb#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.workspacesweb#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspacesweb#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.workspacesweb#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspacesweb#ExceptionMessage" + }, + "serviceCode": { + "target": "com.amazonaws.workspacesweb#ServiceCode", + "traits": { + "smithy.api#documentation": "The originating service.
" + } + }, + "quotaCode": { + "target": "com.amazonaws.workspacesweb#QuotaCode", + "traits": { + "smithy.api#documentation": "The originating quota.
" + } + }, + "retryAfterSeconds": { + "target": "com.amazonaws.workspacesweb#RetryAfterSeconds", + "traits": { + "smithy.api#documentation": "Advice to clients on when the call can be safely retried.
", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "There is a throttling error.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.workspacesweb#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.workspacesweb#TooManyTagsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspacesweb#TagExceptionMessage" + }, + "resourceName": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "Name of the resource affected.
" + } + } + }, + "traits": { + "smithy.api#documentation": "There are too many tags.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.workspacesweb#TrustStore": { + "type": "structure", + "members": { + "associatedPortalArns": { + "target": "com.amazonaws.workspacesweb#ArnList", + "traits": { + "smithy.api#documentation": "A list of web portal ARNs that this trust store is associated with.
" + } + }, + "trustStoreArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the trust store.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A trust store that can be associated with a web portal. A trust store contains\n certificate authority (CA) certificates. Once associated with a web portal, the browser in\n a streaming session will recognize certificates that have been issued using any of the CAs\n in the trust store. If your organization has internal websites that use certificates issued\n by private CAs, you should add the private CA certificate to the trust store.
" + } + }, + "com.amazonaws.workspacesweb#TrustStoreSummary": { + "type": "structure", + "members": { + "trustStoreArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the trust store.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary of the trust store.
" + } + }, + "com.amazonaws.workspacesweb#TrustStoreSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspacesweb#TrustStoreSummary" + } + }, + "com.amazonaws.workspacesweb#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes one or more tags from the specified resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn+}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workspacesweb#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.workspacesweb#TagKeyList", + "traits": { + "smithy.api#documentation": "The list of tag keys to remove from the resource.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspacesweb#UpdateBrowserSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#UpdateBrowserSettingsRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#UpdateBrowserSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates browser settings.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/browserSettings/{browserSettingsArn+}", + "code": 200 + } + } + }, + "com.amazonaws.workspacesweb#UpdateBrowserSettingsRequest": { + "type": "structure", + "members": { + "browserSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the browser settings.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "browserPolicy": { + "target": "com.amazonaws.workspacesweb#BrowserPolicy", + "traits": { + "smithy.api#documentation": "A JSON string containing Chrome Enterprise policies that will be applied to all\n streaming sessions.
" + } + }, + "clientToken": { + "target": "com.amazonaws.workspacesweb#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.workspacesweb#UpdateBrowserSettingsResponse": { + "type": "structure", + "members": { + "browserSettings": { + "target": "com.amazonaws.workspacesweb#BrowserSettings", + "traits": { + "smithy.api#documentation": "The browser settings.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#UpdateIdentityProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#UpdateIdentityProviderRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#UpdateIdentityProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the identity provider.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/identityProviders/{identityProviderArn+}", + "code": 200 + } + } + }, + "com.amazonaws.workspacesweb#UpdateIdentityProviderRequest": { + "type": "structure", + "members": { + "identityProviderArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the identity provider.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identityProviderName": { + "target": "com.amazonaws.workspacesweb#IdentityProviderName", + "traits": { + "smithy.api#documentation": "The name of the identity provider.
" + } + }, + "identityProviderType": { + "target": "com.amazonaws.workspacesweb#IdentityProviderType", + "traits": { + "smithy.api#documentation": "The type of the identity provider.
" + } + }, + "identityProviderDetails": { + "target": "com.amazonaws.workspacesweb#IdentityProviderDetails", + "traits": { + "smithy.api#documentation": "The details of the identity provider.
" + } + }, + "clientToken": { + "target": "com.amazonaws.workspacesweb#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.workspacesweb#UpdateIdentityProviderResponse": { + "type": "structure", + "members": { + "identityProvider": { + "target": "com.amazonaws.workspacesweb#IdentityProvider", + "traits": { + "smithy.api#documentation": "The identity provider.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#UpdateNetworkSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#UpdateNetworkSettingsRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#UpdateNetworkSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates network settings.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/networkSettings/{networkSettingsArn+}", + "code": 200 + } + } + }, + "com.amazonaws.workspacesweb#UpdateNetworkSettingsRequest": { + "type": "structure", + "members": { + "networkSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the network settings.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "vpcId": { + "target": "com.amazonaws.workspacesweb#VpcId", + "traits": { + "smithy.api#documentation": "The VPC that streaming instances will connect to.
" + } + }, + "subnetIds": { + "target": "com.amazonaws.workspacesweb#SubnetIdList", + "traits": { + "smithy.api#documentation": "The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.
" + } + }, + "securityGroupIds": { + "target": "com.amazonaws.workspacesweb#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "One or more security groups used to control access from streaming instances to your VPC.
" + } + }, + "clientToken": { + "target": "com.amazonaws.workspacesweb#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.workspacesweb#UpdateNetworkSettingsResponse": { + "type": "structure", + "members": { + "networkSettings": { + "target": "com.amazonaws.workspacesweb#NetworkSettings", + "traits": { + "smithy.api#documentation": "The network settings.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#UpdatePortal": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#UpdatePortalRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#UpdatePortalResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a web portal.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/portals/{portalArn+}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workspacesweb#UpdatePortalRequest": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the web portal.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "displayName": { + "target": "com.amazonaws.workspacesweb#DisplayName", + "traits": { + "smithy.api#documentation": "The name of the web portal. This is not visible to users who log into the web portal.
" + } + } + } + }, + "com.amazonaws.workspacesweb#UpdatePortalResponse": { + "type": "structure", + "members": { + "portal": { + "target": "com.amazonaws.workspacesweb#Portal", + "traits": { + "smithy.api#documentation": "The web portal.
" + } + } + } + }, + "com.amazonaws.workspacesweb#UpdateTrustStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#UpdateTrustStoreRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#UpdateTrustStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the trust store.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/trustStores/{trustStoreArn+}", + "code": 200 + } + } + }, + "com.amazonaws.workspacesweb#UpdateTrustStoreRequest": { + "type": "structure", + "members": { + "trustStoreArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the trust store.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "certificatesToAdd": { + "target": "com.amazonaws.workspacesweb#CertificateList", + "traits": { + "smithy.api#documentation": "A list of CA certificates to add to the trust store.
" + } + }, + "certificatesToDelete": { + "target": "com.amazonaws.workspacesweb#CertificateThumbprintList", + "traits": { + "smithy.api#documentation": "A list of CA certificates to delete from a trust store.
" + } + }, + "clientToken": { + "target": "com.amazonaws.workspacesweb#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.workspacesweb#UpdateTrustStoreResponse": { + "type": "structure", + "members": { + "trustStoreArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the trust store.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#UpdateUserSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#UpdateUserSettingsRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#UpdateUserSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the user settings.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/userSettings/{userSettingsArn+}", + "code": 200 + } + } + }, + "com.amazonaws.workspacesweb#UpdateUserSettingsRequest": { + "type": "structure", + "members": { + "userSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the user settings.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "copyAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType", + "traits": { + "smithy.api#documentation": "Specifies whether the user can copy text from the streaming session to the local\n device.
" + } + }, + "pasteAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType", + "traits": { + "smithy.api#documentation": "Specifies whether the user can paste text from the local device to the streaming\n session.
" + } + }, + "downloadAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType", + "traits": { + "smithy.api#documentation": "Specifies whether the user can download files from the streaming session to the local\n device.
" + } + }, + "uploadAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType", + "traits": { + "smithy.api#documentation": "Specifies whether the user can upload files from the local device to the streaming\n session.
" + } + }, + "printAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType", + "traits": { + "smithy.api#documentation": "Specifies whether the user can print to the local device.
" + } + }, + "clientToken": { + "target": "com.amazonaws.workspacesweb#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.workspacesweb#UpdateUserSettingsResponse": { + "type": "structure", + "members": { + "userSettings": { + "target": "com.amazonaws.workspacesweb#UserSettings", + "traits": { + "smithy.api#documentation": "The user settings.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspacesweb#UserSettings": { + "type": "structure", + "members": { + "userSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the user settings.
", + "smithy.api#required": {} + } + }, + "associatedPortalArns": { + "target": "com.amazonaws.workspacesweb#ArnList", + "traits": { + "smithy.api#documentation": "A list of web portal ARNs that this user settings is associated with.
" + } + }, + "copyAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType", + "traits": { + "smithy.api#documentation": "Specifies whether the user can copy text from the streaming session to the local\n device.
" + } + }, + "pasteAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType", + "traits": { + "smithy.api#documentation": "Specifies whether the user can paste text from the local device to the streaming\n session.
" + } + }, + "downloadAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType", + "traits": { + "smithy.api#documentation": "Specifies whether the user can download files from the streaming session to the local\n device.
" + } + }, + "uploadAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType", + "traits": { + "smithy.api#documentation": "Specifies whether the user can upload files from the local device to the streaming\n session.
" + } + }, + "printAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType", + "traits": { + "smithy.api#documentation": "Specifies whether the user can print to the local device.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A user settings resource that can be associated with a web portal. Once associated with\n a web portal, user settings control how users can transfer data between a streaming session\n and the their local devices.
" + } + }, + "com.amazonaws.workspacesweb#UserSettingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspacesweb#UserSettingsSummary" + } + }, + "com.amazonaws.workspacesweb#UserSettingsSummary": { + "type": "structure", + "members": { + "userSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the user settings.
" + } + }, + "copyAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType", + "traits": { + "smithy.api#documentation": "Specifies whether the user can copy text from the streaming session to the local\n device.
" + } + }, + "pasteAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType", + "traits": { + "smithy.api#documentation": "Specifies whether the user can paste text from the local device to the streaming\n session.
" + } + }, + "downloadAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType", + "traits": { + "smithy.api#documentation": "Specifies whether the user can download files from the streaming session to the local\n device.
" + } + }, + "uploadAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType", + "traits": { + "smithy.api#documentation": "Specifies whether the user can upload files from the local device to the streaming\n session.
" + } + }, + "printAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType", + "traits": { + "smithy.api#documentation": "Specifies whether the user can print to the local device.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary of user settings.
" + } + }, + "com.amazonaws.workspacesweb#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspacesweb#ExceptionMessage" + }, + "reason": { + "target": "com.amazonaws.workspacesweb#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "Reason the request failed validation
" + } + }, + "fieldList": { + "target": "com.amazonaws.workspacesweb#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "The field that caused the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "There is a validation error.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.workspacesweb#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.workspacesweb#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field that failed validation.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "com.amazonaws.workspacesweb#ExceptionMessage", + "traits": { + "smithy.api#documentation": "The message describing why the field failed validation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a field passed inside a request that resulted in an exception.
" + } + }, + "com.amazonaws.workspacesweb#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspacesweb#ValidationExceptionField" + } + }, + "com.amazonaws.workspacesweb#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "unknownOperation", + "name": "UNKNOWN_OPERATION" + }, + { + "value": "cannotParse", + "name": "CANNOT_PARSE" + }, + { + "value": "fieldValidationFailed", + "name": "FIELD_VALIDATION_FAILED" + }, + { + "value": "other", + "name": "OTHER" + } + ] + } + }, + "com.amazonaws.workspacesweb#VpcId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^vpc-[0-9a-z]*$" + } + }, + "com.amazonaws.workspacesweb#keyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[\\w+=\\/,.@-]+:kms:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:key\\/[a-zA-Z0-9-]+$" + } + } + } +} diff --git a/aws/sdk/aws-models/workspaces.json b/aws/sdk/aws-models/workspaces.json index 849aacd66ee3f3b047217db336f6149c680891be..a2a2e8e7ec974fd2a362cb1930c0f6a3bc72186b 100644 --- a/aws/sdk/aws-models/workspaces.json +++ b/aws/sdk/aws-models/workspaces.json @@ -970,7 +970,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new updated WorkSpace image based on the specified source image. The \n new updated WorkSpace image has the latest drivers and other updates required by \n the Amazon WorkSpaces components.
\n \nTo determine which WorkSpace images need to be updated with the latest Amazon \n WorkSpaces requirements, use \n \n DescribeWorkspaceImages.
\n \nOnly Windows 10 WorkSpace images can be programmatically updated at this time.
\nMicrosoft Windows updates and other application updates are not included \n in the update process.
\nThe source WorkSpace image is not deleted. You can delete the source image after you've \n verified your new updated image and created a new bundle.
\nCreates a new updated WorkSpace image based on the specified source image. The \n new updated WorkSpace image has the latest drivers and other updates required by \n the Amazon WorkSpaces components.
\n \nTo determine which WorkSpace images need to be updated with the latest Amazon \n WorkSpaces requirements, use \n \n DescribeWorkspaceImages.
\n \nOnly Windows 10, Windows Sever 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time.
\nMicrosoft Windows updates and other application updates are not included \n in the update process.
\nThe source WorkSpace image is not deleted. You can delete the source image after you've \n verified your new updated image and created a new bundle.
\nAmazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows and\n Amazon Linux desktops for your users.
", + "smithy.api#title": "Amazon WorkSpaces", + "smithy.api#xmlNamespace": { + "uri": "http://workspaces.amazonaws.com/api/v1" + } + }, "version": "2015-04-08", "operations": [ { @@ -5607,25 +5625,7 @@ { "target": "com.amazonaws.workspaces#UpdateWorkspaceImagePermission" } - ], - "traits": { - "aws.api#service": { - "sdkId": "WorkSpaces", - "arnNamespace": "workspaces", - "cloudFormationName": "WorkSpaces", - "cloudTrailEventSource": "workspaces.amazonaws.com", - "endpointPrefix": "workspaces" - }, - "aws.auth#sigv4": { - "name": "workspaces" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows and\n Amazon Linux desktops for your users.
", - "smithy.api#title": "Amazon WorkSpaces", - "smithy.api#xmlNamespace": { - "uri": "http://workspaces.amazonaws.com/api/v1" - } - } + ] } } }