The request could not be processed because of a conflict in the current status of the\n resource. For example, this happens if you try to enable a Region that is currently being disabled\n (in a status of DISABLING).
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, "com.amazonaws.account#ContactInformation": { "type": "structure", "members": { @@ -313,7 +1500,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified alternate contact from an Amazon Web Services account.
\nFor complete details about how to use the alternate contact operations, see Access or\n updating the alternate contacts.
\nBefore you can update the alternate contact information for an \n Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management\n and Organizations. For more information, see Enabling trusted access for \n Amazon Web Services Account Management.
\nDeletes the specified alternate contact from an Amazon Web Services account.
\nFor complete details about how to use the alternate contact operations, see Access or\n updating the alternate contacts.
\nBefore you can update the alternate contact information for an \n Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management\n and Organizations. For more information, see Enabling trusted access for \n Amazon Web Services Account Management.
\nDisables (opts-out) a particular Region for an account.
", + "smithy.api#http": { + "uri": "/disableRegion", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.account#DisableRegionRequest": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.account#AccountId", + "traits": { + "smithy.api#documentation": "Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this parameter, the\n caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must also be a member account in the same organization. The organization must\n have all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.
\nThe management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.
To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.
" + } + }, + "RegionName": { + "target": "com.amazonaws.account#RegionName", + "traits": { + "smithy.api#documentation": "Specifies the Region-code for a given Region name (for example, af-south-1). When\n you disable a Region, AWS performs actions to deactivate that Region in your account, such\n as destroying IAM resources in the Region. This process takes a few minutes for most\n accounts, but this can take several hours. You cannot enable the Region until the\n disabling process is fully completed.
Enables (opts-in) a particular Region for an account.
", + "smithy.api#http": { + "uri": "/enableRegion", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.account#EnableRegionRequest": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.account#AccountId", + "traits": { + "smithy.api#documentation": "Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this parameter, the\n caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must also be a member account in the same organization. The organization must\n have all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.
\nThe management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.
To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.
" + } + }, + "RegionName": { + "target": "com.amazonaws.account#RegionName", + "traits": { + "smithy.api#documentation": "Specifies the Region-code for a given Region name (for example, af-south-1). When\n you enable a Region, AWS performs actions to prepare your account in that Region, such\n as distributing your IAM resources to the Region. This process takes a few minutes for\n most accounts, but it can take several hours. You cannot use the Region until this\n process is complete. Furthermore, you cannot disable the Region until the enabling\n process is fully completed.
Retrieves the specified alternate contact attached to an Amazon Web Services account.
\nFor complete details about how to use the alternate contact operations, see Access or\n updating the alternate contacts.
\nBefore you can update the alternate contact information for an \n Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management\n and Organizations. For more information, see Enabling trusted access for \n Amazon Web Services Account Management.
\nRetrieves the specified alternate contact attached to an Amazon Web Services account.
\nFor complete details about how to use the alternate contact operations, see Access or\n updating the alternate contacts.
\nBefore you can update the alternate contact information for an \n Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management\n and Organizations. For more information, see Enabling trusted access for \n Amazon Web Services Account Management.
\nRetrieves the primary contact information of an Amazon Web Services account.
\nFor complete details about how to use the primary contact operations, see Update\n the primary and alternate contact information.
", + "smithy.api#documentation": "Retrieves the primary contact information of an Amazon Web Services account.
\nFor complete details about how to use the primary contact operations, see Update\n the primary and alternate contact information.
", "smithy.api#http": { "uri": "/getContactInformation", "method": "POST", @@ -491,7 +1788,7 @@ "AccountId": { "target": "com.amazonaws.account#AccountId", "traits": { - "smithy.api#documentation": "Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this parameter, the\n caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must also be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.
\nThe management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.
To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to\n the account whose contacts you wish to retrieve or modify.
" + "smithy.api#documentation": "Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this parameter, the\n caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must also be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.
\nThe management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.
To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to\n the account whose contacts you wish to retrieve or modify.
" } } }, @@ -513,6 +1810,82 @@ "smithy.api#output": {} } }, + "com.amazonaws.account#GetRegionOptStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.account#GetRegionOptStatusRequest" + }, + "output": { + "target": "com.amazonaws.account#GetRegionOptStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.account#AccessDeniedException" + }, + { + "target": "com.amazonaws.account#InternalServerException" + }, + { + "target": "com.amazonaws.account#TooManyRequestsException" + }, + { + "target": "com.amazonaws.account#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the opt-in status of a particular Region.
", + "smithy.api#http": { + "uri": "/getRegionOptStatus", + "method": "POST", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#suppress": [ + "HttpMethodSemantics" + ] + } + }, + "com.amazonaws.account#GetRegionOptStatusRequest": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.account#AccountId", + "traits": { + "smithy.api#documentation": "Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this parameter, the\n caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must also be a member account in the same organization. The organization must\n have all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.
\nThe management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.
To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.
" + } + }, + "RegionName": { + "target": "com.amazonaws.account#RegionName", + "traits": { + "smithy.api#documentation": "Specifies the Region-code for a given Region name (for example, af-south-1). This\n function will return the status of whatever Region you pass into this parameter.
The Region code that was passed in.
" + } + }, + "RegionOptStatus": { + "target": "com.amazonaws.account#RegionOptStatus", + "traits": { + "smithy.api#documentation": "One of the potential statuses a Region can undergo (Enabled, Enabling, Disabled,\n Disabling, Enabled_By_Default).
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.account#InternalServerException": { "type": "structure", "members": { @@ -530,6 +1903,105 @@ "smithy.api#retryable": {} } }, + "com.amazonaws.account#ListRegions": { + "type": "operation", + "input": { + "target": "com.amazonaws.account#ListRegionsRequest" + }, + "output": { + "target": "com.amazonaws.account#ListRegionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.account#AccessDeniedException" + }, + { + "target": "com.amazonaws.account#InternalServerException" + }, + { + "target": "com.amazonaws.account#TooManyRequestsException" + }, + { + "target": "com.amazonaws.account#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all the Regions for a given account and their respective opt-in statuses.\n Optionally, this list can be filtered by the region-opt-status-contains\n parameter.
Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this parameter, the\n caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must also be a member account in the same organization. The organization must\n have all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.
\nThe management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.
To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.
" + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The total number of items to return in the command’s output. If the total number of\n items available is more than the value specified, a NextToken is provided\n in the command’s output. To resume pagination, provide the NextToken value\n in the starting-token argument of a subsequent command. Do not use the\n NextToken response element directly outside of the Amazon Web Services CLI. For usage\n examples, see Pagination in the Amazon Web Services Command Line Interface User\n Guide.
A token used to specify where to start paginating. This is the NextToken\n from a previously truncated response. For usage examples, see Pagination in the\n Amazon Web Services Command Line Interface User Guide.
A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default)\n to use to filter the list of Regions for a given account. For example, passing in a\n value of ENABLING will only return a list of Regions with a Region status of\n ENABLING.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.account#ListRegionsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "If there is more data to be returned, this will be populated. It should be passed into\n the next-token request parameter of list-regions.
This is a list of Regions for a given account, or if the filtered parameter was used,\n a list of Regions that match the filter criteria set in the filter\n parameter.
Modifies the specified alternate contact attached to an Amazon Web Services account.
\nFor complete details about how to use the alternate contact operations, see Access or\n updating the alternate contacts.
\nBefore you can update the alternate contact information for an \n Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management\n and Organizations. For more information, see Enabling trusted access for \n Amazon Web Services Account Management.
\nModifies the specified alternate contact attached to an Amazon Web Services account.
\nFor complete details about how to use the alternate contact operations, see Access or\n updating the alternate contacts.
\nBefore you can update the alternate contact information for an \n Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management\n and Organizations. For more information, see Enabling trusted access for \n Amazon Web Services Account Management.
\nUpdates the primary contact information of an Amazon Web Services account.
\nFor complete details about how to use the primary contact operations, see Update\n the primary and alternate contact information.
", + "smithy.api#documentation": "Updates the primary contact information of an Amazon Web Services account.
\nFor complete details about how to use the primary contact operations, see Update\n the primary and alternate contact information.
", "smithy.api#http": { "uri": "/putContactInformation", "method": "POST", @@ -687,7 +2159,7 @@ "AccountId": { "target": "com.amazonaws.account#AccountId", "traits": { - "smithy.api#documentation": "Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this parameter, the\n caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must also be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.
\nThe management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.
To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to\n the account whose contacts you wish to retrieve or modify.
" + "smithy.api#documentation": "Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this parameter, the\n caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must also be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.
\nThe management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.
To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to\n the account whose contacts you wish to retrieve or modify.
" } } }, @@ -695,6 +2167,96 @@ "smithy.api#input": {} } }, + "com.amazonaws.account#Region": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.account#RegionName", + "traits": { + "smithy.api#documentation": "The Region code of a given Region (for example, us-east-1).
One of potential statuses a Region can undergo (Enabled, Enabling, Disabled, Disabling,\n Enabled_By_Default).
" + } + } + }, + "traits": { + "smithy.api#documentation": "This is a structure that expresses the Region for a given account, consisting of a\n name and opt-in status.
" + } + }, + "com.amazonaws.account#RegionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.account#RegionOptList": { + "type": "list", + "member": { + "target": "com.amazonaws.account#Region" + } + }, + "com.amazonaws.account#RegionOptResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.account#DisableRegion" + }, + { + "target": "com.amazonaws.account#EnableRegion" + }, + { + "target": "com.amazonaws.account#GetRegionOptStatus" + }, + { + "target": "com.amazonaws.account#ListRegions" + } + ], + "traits": { + "aws.api#arn": { + "template": "RegionOpt" + } + } + }, + "com.amazonaws.account#RegionOptStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "ENABLING", + "name": "ENABLING" + }, + { + "value": "DISABLING", + "name": "DISABLING" + }, + { + "value": "DISABLED", + "name": "DISABLED" + }, + { + "value": "ENABLED_BY_DEFAULT", + "name": "ENABLED_BY_DEFAULT" + } + ] + } + }, + "com.amazonaws.account#RegionOptStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.account#RegionOptStatus" + } + }, "com.amazonaws.account#ResourceNotFoundException": { "type": "structure", "members": { @@ -711,6 +2273,12 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.account#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.account#StateOrRegion": { "type": "string", "traits": { @@ -754,10 +2322,23 @@ "type": "structure", "members": { "message": { - "target": "smithy.api#String", + "target": "com.amazonaws.account#SensitiveString", "traits": { + "smithy.api#documentation": "The message that informs you about what was invalid about the request.
", "smithy.api#required": {} } + }, + "reason": { + "target": "com.amazonaws.account#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "The reason that validation failed.
" + } + }, + "fieldList": { + "target": "com.amazonaws.account#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "The field where the invalid entry was detected.
" + } } }, "traits": { @@ -766,6 +2347,49 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.account#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The field name where the invalid entry was detected.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "com.amazonaws.account#SensitiveString", + "traits": { + "smithy.api#documentation": "A message about the validation exception.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input failed to meet the constraints specified by the AWS service in a specified field.
" + } + }, + "com.amazonaws.account#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.account#ValidationExceptionField" + } + }, + "com.amazonaws.account#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "invalidRegionOptTarget", + "name": "INVALID_REGION_OPT_TARGET" + }, + { + "value": "fieldValidationFailed", + "name": "FIELD_VALIDATION_FAILED" + } + ] + } + }, "com.amazonaws.account#WebsiteUrl": { "type": "string", "traits": { diff --git a/codegen/sdk-codegen/aws-models/appconfigdata.json b/codegen/sdk-codegen/aws-models/appconfigdata.json index dce683a2a86..6b56ffe56fd 100644 --- a/codegen/sdk-codegen/aws-models/appconfigdata.json +++ b/codegen/sdk-codegen/aws-models/appconfigdata.json @@ -1,8 +1,19 @@ { - "smithy": "1.0", + "smithy": "2.0", "shapes": { "com.amazonaws.appconfigdata#AppConfigData": { "type": "service", + "version": "2021-11-11", + "operations": [ + { + "target": "com.amazonaws.appconfigdata#GetLatestConfiguration" + } + ], + "resources": [ + { + "target": "com.amazonaws.appconfigdata#ConfigurationSession" + } + ], "traits": { "aws.api#dataPlane": {}, "aws.api#service": { @@ -16,20 +27,922 @@ "name": "appconfig" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "AppConfig Data provides the data plane APIs your application uses to retrieve configuration data.\n Here's how it works:
\nYour application retrieves configuration data by first establishing a configuration\n session using the AppConfig Data StartConfigurationSession API action. Your session's\n client then makes periodic calls to GetLatestConfiguration to check for\n and retrieve the latest data available.
\nWhen calling StartConfigurationSession, your code sends the following\n information:
Identifiers (ID or name) of an AppConfig application, environment, and\n configuration profile that the session tracks.
\n(Optional) The minimum amount of time the session's client must wait between calls\n to GetLatestConfiguration.
In response, AppConfig provides an InitialConfigurationToken to be given to\n the session's client and used the first time it calls GetLatestConfiguration\n for that session.
When calling GetLatestConfiguration, your client code sends the most recent\n ConfigurationToken value it has and receives in response:
\n NextPollConfigurationToken: the ConfigurationToken value\n to use on the next call to GetLatestConfiguration.
\n NextPollIntervalInSeconds: the duration the client should wait before\n making its next call to GetLatestConfiguration. This duration may vary\n over the course of the session, so it should be used instead of the value sent on the\n StartConfigurationSession call.
The configuration: the latest data intended for the session. This may be empty if\n the client already has the latest version of the configuration.
\nFor more information and to view example CLI commands that show how to retrieve a\n configuration using the AppConfig Data StartConfigurationSession and\n GetLatestConfiguration API actions, see Receiving the\n configuration in the AppConfig User Guide.
AppConfig Data provides the data plane APIs your application uses to retrieve\n configuration data. Here's how it works:
\nYour application retrieves configuration data by first establishing a configuration\n session using the AppConfig Data StartConfigurationSession API action.\n Your session's client then makes periodic calls to GetLatestConfiguration\n to check for and retrieve the latest data available.
\nWhen calling StartConfigurationSession, your code sends the following\n information:
Identifiers (ID or name) of an AppConfig application, environment, and\n configuration profile that the session tracks.
\n(Optional) The minimum amount of time the session's client must wait between calls\n to GetLatestConfiguration.
In response, AppConfig provides an InitialConfigurationToken to be given to\n the session's client and used the first time it calls GetLatestConfiguration\n for that session.
This token should only be used once in your first call to\n GetLatestConfiguration. You must use the new token\n in the GetLatestConfiguration response\n (NextPollConfigurationToken) in each subsequent call to\n GetLatestConfiguration.
When calling GetLatestConfiguration, your client code sends the most recent\n ConfigurationToken value it has and receives in response:
\n NextPollConfigurationToken: the ConfigurationToken value\n to use on the next call to GetLatestConfiguration.
\n NextPollIntervalInSeconds: the duration the client should wait before\n making its next call to GetLatestConfiguration. This duration may vary\n over the course of the session, so it should be used instead of the value sent on the\n StartConfigurationSession call.
The configuration: the latest data intended for the session. This may be empty if\n the client already has the latest version of the configuration.
\nThe InitialConfigurationToken and\n NextPollConfigurationToken should only be used once. To support long poll\n use cases, the tokens are valid for up to 24 hours. If a\n GetLatestConfiguration call uses an expired token, the system returns\n BadRequestException.
For more information and to view example CLI commands that show how to retrieve a\n configuration using the AppConfig Data StartConfigurationSession and\n GetLatestConfiguration API actions, see Retrieving the\n configuration in the AppConfig User Guide.
Retrieves the latest deployed configuration. This API may return empty configuration\n data if the client already has the latest version. For more information about this API\n action and to view example CLI commands that show how to use it with the StartConfigurationSession API action, see Receiving the\n configuration in the AppConfig User Guide.
\nNote the following important information.
\nEach configuration token is only valid for one call to GetLatestConfiguration.\n The GetLatestConfiguration response includes a NextPollConfigurationToken that\n should always replace the token used for the just-completed call in preparation\n for the next one.
\n GetLatestConfiguration is a priced call. For more information, see\n Pricing.
Retrieves the latest deployed configuration. This API may return empty configuration\n data if the client already has the latest version. For more information about this API\n action and to view example CLI commands that show how to use it with the StartConfigurationSession API action, see Retrieving the\n configuration in the AppConfig User Guide.
\nNote the following important information.
\nEach configuration token is only valid for one call to\n GetLatestConfiguration. The GetLatestConfiguration\n response includes a NextPollConfigurationToken that should always\n replace the token used for the just-completed call in preparation for the next\n one.
\n GetLatestConfiguration is a priced call. For more information, see\n Pricing.
Token describing the current state of the configuration session. To obtain a token,\n first call the StartConfigurationSession API. Note that every call to\n GetLatestConfiguration will return a new ConfigurationToken\n (NextPollConfigurationToken in the response) and MUST be provided to\n subsequent GetLatestConfiguration API calls.
Token describing the current state of the configuration session. To obtain a token,\n first call the StartConfigurationSession API. Note that every call to\n GetLatestConfiguration will return a new ConfigurationToken\n (NextPollConfigurationToken in the response) and must\n be provided to subsequent GetLatestConfiguration API calls.
This token should only be used once. To support long poll\n use cases, the token is valid for up to 24 hours. If a\n GetLatestConfiguration call uses an expired token, the system returns\n BadRequestException.
The latest token describing the current state of the configuration session. This MUST be\n provided to the next call to GetLatestConfiguration.\n
The latest token describing the current state of the configuration session. This\n must be provided to the next call to\n GetLatestConfiguration.\n
This token should only be used once. To support long poll\n use cases, the token is valid for up to 24 hours. If a\n GetLatestConfiguration call uses an expired token, the system returns\n BadRequestException.
The amount of time the client should wait before polling for configuration updates\n again. Use RequiredMinimumPollIntervalInSeconds to set the desired poll\n interval.
The data of the configuration. This may be empty if the client already has the latest\n version of configuration.
", "smithy.api#httpPayload": {} } + }, + "VersionLabel": { + "target": "com.amazonaws.appconfigdata#String", + "traits": { + "smithy.api#documentation": "The user-defined label for the AppConfig hosted configuration version. This attribute doesn't apply if the configuration is not from an AppConfig hosted configuration version. If the client already has the latest version of the configuration data, this value is empty.
", + "smithy.api#httpHeader": "Version-Label" + } } } }, @@ -182,12 +1103,15 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 64 + "max": 128 } } }, "com.amazonaws.appconfigdata#Integer": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.appconfigdata#InternalServerException": { "type": "structure", @@ -250,7 +1174,6 @@ "com.amazonaws.appconfigdata#OptionalPollSeconds": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 15, "max": 86400 @@ -272,7 +1195,7 @@ "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.
" + "smithy.api#documentation": "A map indicating which parameters in the request reference the resource that was not\n found.
" } } }, @@ -343,7 +1266,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a configuration session used to retrieve a deployed configuration. For more\n information about this API action and to view example CLI commands that show how to use\n it with the GetLatestConfiguration API action, see Receiving the\n configuration in the AppConfig User Guide.
", + "smithy.api#documentation": "Starts a configuration session used to retrieve a deployed configuration. For more\n information about this API action and to view example CLI commands that show how to use\n it with the GetLatestConfiguration API action, see Retrieving the\n configuration in the AppConfig User Guide.
", "smithy.api#http": { "method": "POST", "uri": "/configurationsessions", @@ -378,7 +1301,7 @@ "RequiredMinimumPollIntervalInSeconds": { "target": "com.amazonaws.appconfigdata#OptionalPollSeconds", "traits": { - "smithy.api#documentation": "Sets a constraint on a session. If you specify a value of, for example, 60 seconds, then\n the client that established the session can't call GetLatestConfiguration\n more frequently then every 60 seconds.
" + "smithy.api#documentation": "Sets a constraint on a session. If you specify a value of, for example, 60 seconds, then\n the client that established the session can't call GetLatestConfiguration\n more frequently than every 60 seconds.
" } } } @@ -389,7 +1312,7 @@ "InitialConfigurationToken": { "target": "com.amazonaws.appconfigdata#Token", "traits": { - "smithy.api#documentation": "Token encapsulating state about the configuration session. Provide this token to the\n GetLatestConfiguration API to retrieve configuration data.
This token should only be used once in your first call to\n GetLatestConfiguration. You MUST use the new token in the\n GetLatestConfiguration response\n (NextPollConfigurationToken) in each subsequent call to\n GetLatestConfiguration.
Token encapsulating state about the configuration session. Provide this token to the\n GetLatestConfiguration API to retrieve configuration data.
This token should only be used once in your first call to\n GetLatestConfiguration. You must use the new token\n in the GetLatestConfiguration response\n (NextPollConfigurationToken) in each subsequent call to\n GetLatestConfiguration.
The InitialConfigurationToken and\n NextPollConfigurationToken should only be used once. To support long poll\n use cases, the tokens are valid for up to 24 hours. If a\n GetLatestConfiguration call uses an expired token, the system returns\n BadRequestException.
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" + "smithy.api#title": "Amazon Import/Export Snowball", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://snowball-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://snowball-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://snowball.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://snowball.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://snowball.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://snowball.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://snowball.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://snowball-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseDualStack": false, + "UseFIPS": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseDualStack": false, + "UseFIPS": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseDualStack": true, + "UseFIPS": false, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } } }, "com.amazonaws.snowball#Address": { @@ -283,6 +1394,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.snowball#CancelClusterResult": { @@ -322,6 +1436,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.snowball#CancelJobResult": { @@ -454,7 +1571,7 @@ "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 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 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:
\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 type of job for this cluster. Currently, the only job type supported for clusters\n is LOCAL_USE.
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 job for this cluster. Currently, the only job type supported for clusters\n is LOCAL_USE.
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": {} } }, @@ -686,14 +1806,14 @@ "SnowballType": { "target": "com.amazonaws.snowball#SnowballType", "traits": { - "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#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:
\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 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.
\nAllows you to securely operate and manage Snow devices in a cluster remotely from outside\n of your internal network. When set to INSTALLED_AUTOSTART, remote management will\n automatically be available when the device arrives at your location. Otherwise, you need to\n use the Snowball Client to manage the device.
Creates 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: V3_5C\n
\nCapacity: T32
\nDescription: Snowball Edge Compute Optimized without GPU
\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.
\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.
\nDefines the Amazon S3 buckets associated with this job.
\n\nWith IMPORT jobs, you specify the bucket or buckets that your transferred\n data will be imported into.
With EXPORT jobs, you specify the bucket or buckets that your transferred\n data will be exported from. Optionally, you can also specify a KeyRange value. If\n you choose to export a range, you define the length of the range by providing either an\n inclusive BeginMarker value, an inclusive EndMarker value, or both.\n Ranges are UTF-8 binary sorted.
Defines the Amazon S3 buckets associated with this job.
\nWith IMPORT jobs, you specify the bucket or buckets that your transferred\n data will be imported into.
With EXPORT jobs, you specify the bucket or buckets that your transferred\n data will be exported from. Optionally, you can also specify a KeyRange value. If\n you choose to export a range, you define the length of the range by providing either an\n inclusive BeginMarker value, an inclusive EndMarker value, or both.\n Ranges are UTF-8 binary sorted.
If your job is being created in one of the US regions, you have the option of\n specifying what size Snow device you'd like for this job. In all other regions, Snowballs come\n with 80 TB in storage capacity.
\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": "If your job is being created in one of the US regions, you have the option of\n specifying what size Snow device you'd like for this job. In all other regions, Snowballs come\n with 80 TB in storage capacity.
\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.
" } }, "ShippingOption": { "target": "com.amazonaws.snowball#ShippingOption", "traits": { - "smithy.api#documentation": "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\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 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:
\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 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.
" + "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.
\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": { @@ -853,7 +1976,7 @@ "DeviceConfiguration": { "target": "com.amazonaws.snowball#DeviceConfiguration", "traits": { - "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.
" + "smithy.api#documentation": "Defines the device configuration for an Snowcone job.
\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": { @@ -868,6 +1991,9 @@ "smithy.api#documentation": "The ID of the long-term pricing type for the device.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.snowball#CreateJobResult": { @@ -911,7 +2037,7 @@ "IsLongTermPricingAutoRenew": { "target": "com.amazonaws.snowball#JavaBoolean", "traits": { - "smithy.api#documentation": "snowballty
\nSpecifies whether the current long-term pricing type for the device should be\n renewed.
" + "smithy.api#documentation": "Specifies whether the current long-term pricing type for the device should be\n renewed.
" } }, "SnowballType": { @@ -920,6 +2046,9 @@ "smithy.api#documentation": "The type of Snow Family devices to use for the long-term pricing job.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.snowball#CreateLongTermPricingResult": { @@ -978,6 +2107,9 @@ "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:
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.snowball#CreateReturnShippingLabelResult": { @@ -1027,6 +2159,32 @@ "smithy.api#documentation": "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 name of the dependent service.
" + } + }, + "ServiceVersion": { + "target": "com.amazonaws.snowball#ServiceVersion", + "traits": { + "smithy.api#documentation": "The version of the dependent service.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The name and version of the service dependant on the requested service.
" + } + }, + "com.amazonaws.snowball#DependentServiceList": { + "type": "list", + "member": { + "target": "com.amazonaws.snowball#DependentService" + } + }, "com.amazonaws.snowball#DescribeAddress": { "type": "operation", "input": { @@ -1054,6 +2212,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.snowball#DescribeAddressResult": { @@ -1108,6 +2269,9 @@ "smithy.api#documentation": "HTTP requests are stateless. To identify what object comes \"next\" in the list of\n ADDRESS objects, you have the option of specifying a value for\n NextToken as the starting point for your list of returned addresses.
The Kubernetes version for EKS Anywhere on the Snow Family device.
" + } + }, + "EKSAnywhereVersion": { + "target": "com.amazonaws.snowball#String", + "traits": { + "smithy.api#documentation": "The version of EKS Anywhere on the Snow Family device.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing the metadata and configuration settings of EKS Anywhere on the Snow Family device.
" + } + }, "com.amazonaws.snowball#Ec2AmiResource": { "type": "structure", "members": { @@ -1388,7 +2581,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. This is the only valid status for calling this API as the\n manifest and UnlockCode code value are used for securing your device and should\n only be used when you have the device. 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. This is the only valid status for calling this API as the\n manifest and UnlockCode code value are used for securing your device and should\n only be used when you have the device. 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": { @@ -1401,6 +2594,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.snowball#GetJobManifestResult": { @@ -1431,7 +2627,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\n started for the first time. The only valid status for calling this API is\n WithCustomer as the manifest and Unlock code values are used for\n securing your device and should only be used when you have the device.
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 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. The only valid status for calling this API is\n WithCustomer as the manifest and Unlock code values are used for\n securing your device and should only be used when you have the device.
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\n is 1. If you want to increase your service limit, contact Amazon Web Services 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.
\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": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#input": {} + } }, "com.amazonaws.snowball#GetSnowballUsageResult": { "type": "structure", @@ -1520,6 +2722,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.snowball#GetSoftwareUpdatesResult": { @@ -1709,7 +2914,7 @@ } }, "traits": { - "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.
" + "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.
\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.
\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": { @@ -1784,7 +2989,7 @@ "SnowballCapacityPreference": { "target": "com.amazonaws.snowball#SnowballCapacity", "traits": { - "smithy.api#documentation": "The Snow device capacity preference for this job, specified at job creation. In US\n regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB\n capacity Snowballs.
\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 Snow device capacity preference for this job, specified at job creation. In US\n regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB\n capacity Snowballs.
\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.
" } }, "Notification": { @@ -2109,6 +3314,9 @@ "smithy.api#documentation": "HTTP requests are stateless. To identify what object comes \"next\" in the list of\n JobListEntry objects, you have the option of specifying NextToken\n as the starting point for your returned list.
HTTP requests are stateless. To identify what object comes \"next\" in the list of\n ClusterListEntry objects, you have the option of specifying\n NextToken as the starting point for your returned list.
HTTP requests are stateless. To identify what object comes \"next\" in the list of\n compatible images, you can specify a value for NextToken as the starting point\n for your list of returned images.
HTTP requests are stateless. To identify what object comes \"next\" in the list of\n JobListEntry objects, you have the option of specifying NextToken\n as the starting point for your returned list.
Because HTTP requests are stateless, this is the starting point for your next list of\n ListLongTermPricing to return.
Lists all supported versions for Snow on-device services. Returns an\n array of ServiceVersion object containing the supported versions for a particular service.
The name of the service for which you're requesting supported versions.
", + "smithy.api#required": {} + } + }, + "DependentServices": { + "target": "com.amazonaws.snowball#DependentServiceList", + "traits": { + "smithy.api#documentation": "A list of names and versions of dependant services of the requested service.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.snowball#ListLimit", + "traits": { + "smithy.api#documentation": "The maximum number of ListServiceVersions objects to return.
Because HTTP requests are stateless, this is the starting point for the next list of returned \n ListServiceVersionsRequest versions.
A list of supported versions.
", + "smithy.api#required": {} + } + }, + "ServiceName": { + "target": "com.amazonaws.snowball#ServiceName", + "traits": { + "smithy.api#documentation": "The name of the service for which the system provided supported versions.
", + "smithy.api#required": {} + } + }, + "DependentServices": { + "target": "com.amazonaws.snowball#DependentServiceList", + "traits": { + "smithy.api#documentation": "A list of names and versions of dependant services of the service for which the system provided supported versions.
" + } + }, + "NextToken": { + "target": "com.amazonaws.snowball#String", + "traits": { + "smithy.api#documentation": "Because HTTP requests are stateless, this is the starting point of the next list of returned \n ListServiceVersionsResult results.
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.
" + "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": { @@ -2529,7 +3833,7 @@ } }, "traits": { - "smithy.api#documentation": "The Amazon Simple Notification Service (Amazon SNS) notification settings associated\n with a specific job. The Notification object is returned as a part of the\n response syntax of the DescribeJob action in the JobMetadata data\n type.
When the notification settings are defined during job creation, you can choose to\n notify based on a specific set of job states using the JobStatesToNotify array of\n strings, or you can specify that you want to have Amazon SNS notifications sent out for all\n job states with NotifyAll set to true.
The Amazon Simple Notification Service (Amazon SNS) notification settings associated\n with a specific job. The Notification object is returned as a part of the\n response syntax of the DescribeJob action in the JobMetadata data\n type.
When the notification settings are defined during job creation, you can choose to\n notify based on a specific set of job states using the JobStatesToNotify array of\n strings, or you can specify that you want to have Amazon SNS notifications sent out for all\n job states with NotifyAll set to true.
Represents the Storage Gateway service Tape Gateway type on a Snow Family device.
" } + }, + "EKSOnDeviceService": { + "target": "com.amazonaws.snowball#EKSOnDeviceServiceConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of EKS Anywhere on the Snow Family device.
" + } } }, "traits": { @@ -2633,6 +3943,43 @@ "target": "com.amazonaws.snowball#S3Resource" } }, + "com.amazonaws.snowball#ServiceName": { + "type": "enum", + "members": { + "KUBERNETES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KUBERNETES" + } + }, + "EKS_ANYWHERE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_ANYWHERE" + } + } + } + }, + "com.amazonaws.snowball#ServiceVersion": { + "type": "structure", + "members": { + "Version": { + "target": "com.amazonaws.snowball#String", + "traits": { + "smithy.api#documentation": "The version number of the requested service.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The version of the requested service.
" + } + }, + "com.amazonaws.snowball#ServiceVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.snowball#ServiceVersion" + } + }, "com.amazonaws.snowball#Shipment": { "type": "structure", "members": { @@ -2676,7 +4023,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 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 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:
\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 updated ID for the forwarding address for a cluster. This field is not\n supported in most regions.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.snowball#UpdateClusterResult": { @@ -3196,7 +4546,7 @@ "SnowballCapacityPreference": { "target": "com.amazonaws.snowball#SnowballCapacity", "traits": { - "smithy.api#documentation": "The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs are only available in the US\n regions.
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 updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs are only available in the US\n regions.
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.
" } }, "ForwardingAddressId": { @@ -3205,6 +4555,9 @@ "smithy.api#documentation": "The updated ID for the forwarding address for a job. This field is not\n supported in most regions.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.snowball#UpdateJobResult": { @@ -3248,6 +4601,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.snowball#UpdateJobShipmentStateResult": { @@ -3293,6 +4649,9 @@ "smithy.api#documentation": "If set to true, specifies that the current long-term pricing type for the\n device should be automatically renewed before the long-term pricing contract expires.