The full name of the primary contact address.
", + "smithy.api#required": {} + } + }, + "AddressLine1": { + "target": "com.amazonaws.account#AddressLine", + "traits": { + "smithy.api#documentation": "The first line of the primary contact address.
", + "smithy.api#required": {} + } + }, + "AddressLine2": { + "target": "com.amazonaws.account#AddressLine", + "traits": { + "smithy.api#documentation": "The second line of the primary contact address, if any.
" + } + }, + "AddressLine3": { + "target": "com.amazonaws.account#AddressLine", + "traits": { + "smithy.api#documentation": "The third line of the primary contact address, if any.
" + } + }, + "City": { + "target": "com.amazonaws.account#City", + "traits": { + "smithy.api#documentation": "The city of the primary contact address.
", + "smithy.api#required": {} + } + }, + "StateOrRegion": { + "target": "com.amazonaws.account#StateOrRegion", + "traits": { + "smithy.api#documentation": "The state or region of the primary contact address. This field is required in selected countries.
" + } + }, + "DistrictOrCounty": { + "target": "com.amazonaws.account#DistrictOrCounty", + "traits": { + "smithy.api#documentation": "The district or county of the primary contact address, if any.
" + } + }, + "PostalCode": { + "target": "com.amazonaws.account#PostalCode", + "traits": { + "smithy.api#documentation": "The postal code of the primary contact address.
", + "smithy.api#required": {} + } + }, + "CountryCode": { + "target": "com.amazonaws.account#CountryCode", + "traits": { + "smithy.api#documentation": "The ISO-3166 two-letter country code for the primary contact address.
", + "smithy.api#required": {} + } + }, + "PhoneNumber": { + "target": "com.amazonaws.account#ContactInformationPhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number of the primary contact information. The number will be validated and, in some countries, checked for activation.
", + "smithy.api#required": {} + } + }, + "CompanyName": { + "target": "com.amazonaws.account#CompanyName", + "traits": { + "smithy.api#documentation": "The name of the company associated with the primary contact information, if any.
" + } + }, + "WebsiteUrl": { + "target": "com.amazonaws.account#WebsiteUrl", + "traits": { + "smithy.api#documentation": "The URL of the website associated with the primary contact information, if any.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the details of the primary contact information associated with an Amazon Web Services account.
" + } + }, + "com.amazonaws.account#ContactInformationPhoneNumber": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#pattern": "^[+][\\s0-9()-]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.account#ContactInformationResource": { + "type": "resource", + "put": { + "target": "com.amazonaws.account#PutContactInformation" + }, + "read": { + "target": "com.amazonaws.account#GetContactInformation" + }, + "traits": { + "aws.api#arn": { + "template": "ContactInformation" + } + } + }, + "com.amazonaws.account#CountryCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.account#DeleteAlternateContact": { "type": "operation", "input": { "target": "com.amazonaws.account#DeleteAlternateContactRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.account#AccessDeniedException" @@ -158,10 +313,10 @@ } ], "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.
", + "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.
\nSpecifies the 12 digit account ID number of the Amazon Web Services account that \n you want to access or modify with this operation.
\nIf you do not specify this parameter, it defaults to the Amazon Web Services account of the \n identity used to call the operation.
\nTo use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account, and \n the specified account ID must be a member account in the same organization. The\n organization must have all features \n enabled, and the organization must have trusted access enabled for the \n 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, then \n don't specify this parameter, and call the operation using an identity belonging to\n the account whose contacts you wish to retrieve or modify.
" } } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.account#DistrictOrCounty": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.account#EmailAddress": { @@ -192,7 +360,17 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "[\\w+=,.-]+@[\\w.-]+\\.[\\w]+", + "smithy.api#pattern": "^[\\s]*[\\w+=.#!&-]+@[\\w.-]+\\.[\\w]+[\\s]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.account#FullName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, "smithy.api#sensitive": {} } }, @@ -222,13 +400,16 @@ } ], "traits": { - "smithy.api#documentation": "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.
", + "smithy.api#documentation": "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.
\nSpecifies the 12 digit account ID number of the Amazon Web Services account that \n you want to access or modify with this operation.
\nIf you do not specify this parameter, it defaults to the Amazon Web Services account of the \n identity used to call the operation.
\nTo use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account, and \n the specified account ID must be a member account in the same organization. The\n organization must have all features \n enabled, and the organization must have trusted access enabled for the \n 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, then \n don't specify this parameter, and call the operation using an identity belonging to\n the account whose contacts you wish to retrieve or modify.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.account#GetAlternateContactResponse": { @@ -258,6 +442,75 @@ "smithy.api#documentation": "A structure that contains the details for the specified alternate contact.
" } } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.account#GetContactInformation": { + "type": "operation", + "input": { + "target": "com.amazonaws.account#GetContactInformationRequest" + }, + "output": { + "target": "com.amazonaws.account#GetContactInformationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.account#AccessDeniedException" + }, + { + "target": "com.amazonaws.account#InternalServerException" + }, + { + "target": "com.amazonaws.account#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.account#TooManyRequestsException" + }, + { + "target": "com.amazonaws.account#ValidationException" + } + ], + "traits": { + "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", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#suppress": [ + "HttpMethodSemantics" + ] + } + }, + "com.amazonaws.account#GetContactInformationRequest": { + "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 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.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.account#GetContactInformationResponse": { + "type": "structure", + "members": { + "ContactInformation": { + "target": "com.amazonaws.account#ContactInformation", + "traits": { + "smithy.api#documentation": "Contains the details of the primary contact information associated with an Amazon Web Services account.
" + } + } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.account#InternalServerException": { @@ -298,11 +551,24 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.account#PostalCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.account#PutAlternateContact": { "type": "operation", "input": { "target": "com.amazonaws.account#PutAlternateContactRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.account#AccessDeniedException" @@ -318,10 +584,10 @@ } ], "traits": { - "smithy.api#documentation": "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.
", + "smithy.api#documentation": "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.
\nSpecifies the 12 digit account ID number of the Amazon Web Services account that \n you want to access or modify with this operation.
\nIf you do not specify this parameter, it defaults to the Amazon Web Services account of the \n identity used to call the operation.
\nTo use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account, and \n the specified account ID must be a member account in the same organization. The\n organization must have all features \n enabled, and the organization must have trusted access enabled for the \n 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, then \n don't specify this parameter, and call the operation using an identity belonging to\n the account whose contacts you wish to retrieve or modify.
" } } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.account#PutContactInformation": { + "type": "operation", + "input": { + "target": "com.amazonaws.account#PutContactInformationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "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": "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", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.account#PutContactInformationRequest": { + "type": "structure", + "members": { + "ContactInformation": { + "target": "com.amazonaws.account#ContactInformation", + "traits": { + "smithy.api#documentation": "Contains the details of the primary contact information associated with an Amazon Web Services account.
", + "smithy.api#required": {} + } + }, + "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.
" + } + } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.account#ResourceNotFoundException": { @@ -389,6 +711,16 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.account#StateOrRegion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.account#Title": { "type": "string", "traits": { @@ -433,6 +765,16 @@ "smithy.api#error": "client", "smithy.api#httpError": 400 } + }, + "com.amazonaws.account#WebsiteUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#sensitive": {} + } } } } \ No newline at end of file diff --git a/codegen/sdk/aws-models/appsync.json b/codegen/sdk/aws-models/appsync.json index cfe7a8408ec..192cdbc1643 100644 --- a/codegen/sdk/aws-models/appsync.json +++ b/codegen/sdk/aws-models/appsync.json @@ -105,6 +105,9 @@ { "target": "com.amazonaws.appsync#DisassociateApi" }, + { + "target": "com.amazonaws.appsync#EvaluateMappingTemplate" + }, { "target": "com.amazonaws.appsync#FlushApiCache" }, @@ -704,7 +707,8 @@ "ttl": { "target": "com.amazonaws.appsync#Long", "traits": { - "smithy.api#documentation": "The TTL in seconds for a resolver that has caching activated.
\nValid values are 1–3,600 seconds.
" + "smithy.api#documentation": "The TTL in seconds for a resolver that has caching activated.
\nValid values are 1–3,600 seconds.
", + "smithy.api#required": {} } }, "cachingKeys": { @@ -754,7 +758,7 @@ "appIdClientRegex": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "A regular expression for validating the incoming Amazon Cognito user pool app client\n ID.
" + "smithy.api#documentation": "A regular expression for validating the incoming Amazon Cognito user pool app client\n ID. If this value isn't set, no filtering is applied.
" } } }, @@ -813,6 +817,16 @@ ] } }, + "com.amazonaws.appsync#Context": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 28000 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, "com.amazonaws.appsync#CreateApiCache": { "type": "operation", "input": { @@ -2361,9 +2375,97 @@ "smithy.api#documentation": "Describes an OpenSearch data source configuration.
\nAs of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This\n configuration is deprecated. For new data sources, use OpenSearchServiceDataSourceConfig to specify an OpenSearch data\n source.
" } }, + "com.amazonaws.appsync#ErrorDetail": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appsync#ErrorMessage", + "traits": { + "smithy.api#documentation": "The error payload.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the list of errors generated when attempting to evaluate a mapping\n template.
" + } + }, "com.amazonaws.appsync#ErrorMessage": { "type": "string" }, + "com.amazonaws.appsync#EvaluateMappingTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#EvaluateMappingTemplateRequest" + }, + "output": { + "target": "com.amazonaws.appsync#EvaluateMappingTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + } + ], + "traits": { + "smithy.api#documentation": "Evaluates a given template and returns the response. The mapping template can be a\n request or response template.
\nRequest templates take the incoming request after a GraphQL operation is parsed and\n convert it into a request configuration for the selected data source operation. Response\n templates interpret responses from the data source and map it to the shape of the GraphQL\n field output type.
\nMapping templates are written in the Apache Velocity Template Language (VTL).
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/dataplane-evaluatetemplate", + "code": 200 + } + } + }, + "com.amazonaws.appsync#EvaluateMappingTemplateRequest": { + "type": "structure", + "members": { + "template": { + "target": "com.amazonaws.appsync#Template", + "traits": { + "smithy.api#documentation": "The mapping template; this can be a request or response template. A\n template is required for this action.
The map that holds all of the contextual information for your resolver invocation. A\n context is required for this action.
The mapping template; this can be a request or response template.
" + } + }, + "error": { + "target": "com.amazonaws.appsync#ErrorDetail", + "traits": { + "smithy.api#documentation": "The ErrorDetail object.
A regular expression for validating the incoming Amazon Cognito user pool app client\n ID.
" + "smithy.api#documentation": "A regular expression for validating the incoming Amazon Cognito user pool app client\n ID. If this value isn't set, no filtering is applied.
" } } }, diff --git a/codegen/sdk/aws-models/athena.json b/codegen/sdk/aws-models/athena.json index a81769341db..1c13f999657 100644 --- a/codegen/sdk/aws-models/athena.json +++ b/codegen/sdk/aws-models/athena.json @@ -114,6 +114,9 @@ { "target": "com.amazonaws.athena#GetQueryResults" }, + { + "target": "com.amazonaws.athena#GetQueryRuntimeStatistics" + }, { "target": "com.amazonaws.athena#GetTableMetadata" }, @@ -1549,6 +1552,49 @@ } } }, + "com.amazonaws.athena#GetQueryRuntimeStatistics": { + "type": "operation", + "input": { + "target": "com.amazonaws.athena#GetQueryRuntimeStatisticsInput" + }, + "output": { + "target": "com.amazonaws.athena#GetQueryRuntimeStatisticsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.athena#InternalServerException" + }, + { + "target": "com.amazonaws.athena#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "Returns query execution runtime statistics related to a single execution of a query if you\n have access to the workgroup in which the query ran. The query execution runtime statistics\n is returned only when QueryExecutionStatus$State is in a SUCCEEDED\n or FAILED state.
" + } + }, + "com.amazonaws.athena#GetQueryRuntimeStatisticsInput": { + "type": "structure", + "members": { + "QueryExecutionId": { + "target": "com.amazonaws.athena#QueryExecutionId", + "traits": { + "smithy.api#documentation": "The unique ID of the query execution.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.athena#GetQueryRuntimeStatisticsOutput": { + "type": "structure", + "members": { + "QueryRuntimeStatistics": { + "target": "com.amazonaws.athena#QueryRuntimeStatistics", + "traits": { + "smithy.api#documentation": "Runtime statistics about the query execution.
" + } + } + } + }, "com.amazonaws.athena#GetTableMetadata": { "type": "operation", "input": { @@ -1848,7 +1894,12 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of engine versions that are available to choose from, including the\n Auto option.
" + "smithy.api#documentation": "Returns a list of engine versions that are available to choose from, including the\n Auto option.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } } }, "com.amazonaws.athena#ListEngineVersionsInput": { @@ -2834,6 +2885,202 @@ "smithy.api#documentation": "The completion date, current state, submission time, and state change reason (if\n applicable) for the query execution.
" } }, + "com.amazonaws.athena#QueryRuntimeStatistics": { + "type": "structure", + "members": { + "Timeline": { + "target": "com.amazonaws.athena#QueryRuntimeStatisticsTimeline" + }, + "Rows": { + "target": "com.amazonaws.athena#QueryRuntimeStatisticsRows" + }, + "OutputStage": { + "target": "com.amazonaws.athena#QueryStage", + "traits": { + "smithy.api#documentation": "Stage statistics such as input and output rows and bytes, execution time, and stage state. This \n information also includes substages and the query stage plan.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The query execution timeline, statistics on input and output rows and bytes, and the different\n query stages that form the query execution plan.
" + } + }, + "com.amazonaws.athena#QueryRuntimeStatisticsRows": { + "type": "structure", + "members": { + "InputRows": { + "target": "com.amazonaws.athena#Long", + "traits": { + "smithy.api#documentation": "The number of rows read to execute the query.
" + } + }, + "InputBytes": { + "target": "com.amazonaws.athena#Long", + "traits": { + "smithy.api#documentation": "The number of bytes read to execute the query.
" + } + }, + "OutputBytes": { + "target": "com.amazonaws.athena#Long", + "traits": { + "smithy.api#documentation": "The number of bytes returned by the query.
" + } + }, + "OutputRows": { + "target": "com.amazonaws.athena#Long", + "traits": { + "smithy.api#documentation": "The number of rows returned by the query.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Statistics such as input rows and bytes read by the query, rows and bytes output by the query,\n and the number of rows written by the query.
" + } + }, + "com.amazonaws.athena#QueryRuntimeStatisticsTimeline": { + "type": "structure", + "members": { + "QueryQueueTimeInMillis": { + "target": "com.amazonaws.athena#Long", + "traits": { + "smithy.api#documentation": "The number of milliseconds that the query was in your query queue waiting for\n resources. Note that if transient errors occur, Athena might automatically\n add the query back to the queue.
" + } + }, + "QueryPlanningTimeInMillis": { + "target": "com.amazonaws.athena#Long", + "traits": { + "smithy.api#documentation": "The number of milliseconds that Athena took to plan the query processing\n flow. This includes the time spent retrieving table partitions from the data source.\n Note that because the query engine performs the query planning, query planning time is a\n subset of engine processing time.
" + } + }, + "EngineExecutionTimeInMillis": { + "target": "com.amazonaws.athena#Long", + "traits": { + "smithy.api#documentation": "The number of milliseconds that the query took to execute.
" + } + }, + "ServiceProcessingTimeInMillis": { + "target": "com.amazonaws.athena#Long", + "traits": { + "smithy.api#documentation": "The number of milliseconds that Athena took to finalize and publish the\n query results after the query engine finished running the query.
" + } + }, + "TotalExecutionTimeInMillis": { + "target": "com.amazonaws.athena#Long", + "traits": { + "smithy.api#documentation": "The number of milliseconds that Athena took to run the query.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Timeline statistics such as query queue time, planning time, execution time, service processing\n time, and total execution time.
" + } + }, + "com.amazonaws.athena#QueryStage": { + "type": "structure", + "members": { + "StageId": { + "target": "com.amazonaws.athena#Long", + "traits": { + "smithy.api#documentation": "The identifier for a stage.
" + } + }, + "State": { + "target": "com.amazonaws.athena#String", + "traits": { + "smithy.api#documentation": "State of the stage after query execution.
" + } + }, + "OutputBytes": { + "target": "com.amazonaws.athena#Long", + "traits": { + "smithy.api#documentation": "The number of bytes output from the stage after execution.
" + } + }, + "OutputRows": { + "target": "com.amazonaws.athena#Long", + "traits": { + "smithy.api#documentation": "The number of rows output from the stage after execution.
" + } + }, + "InputBytes": { + "target": "com.amazonaws.athena#Long", + "traits": { + "smithy.api#documentation": "The number of bytes input into the stage for execution.
" + } + }, + "InputRows": { + "target": "com.amazonaws.athena#Long", + "traits": { + "smithy.api#documentation": "The number of rows input into the stage for execution.
" + } + }, + "ExecutionTime": { + "target": "com.amazonaws.athena#Long", + "traits": { + "smithy.api#documentation": "Time taken to execute this stage.
" + } + }, + "QueryStagePlan": { + "target": "com.amazonaws.athena#QueryStagePlanNode", + "traits": { + "smithy.api#documentation": "Stage plan information such as name, identifier, sub plans, and source stages.
" + } + }, + "SubStages": { + "target": "com.amazonaws.athena#QueryStages", + "traits": { + "smithy.api#documentation": "List of sub query stages that form this stage execution plan.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Stage statistics such as input and output rows and bytes, execution time and stage state. This \n information also includes substages and the query stage plan.
" + } + }, + "com.amazonaws.athena#QueryStagePlanNode": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.athena#String", + "traits": { + "smithy.api#documentation": "Name of the query stage plan that describes the operation this stage is performing as part of\n query execution.
" + } + }, + "Identifier": { + "target": "com.amazonaws.athena#String", + "traits": { + "smithy.api#documentation": "Information about the operation this query stage plan node is performing.
" + } + }, + "Children": { + "target": "com.amazonaws.athena#QueryStagePlanNodes", + "traits": { + "smithy.api#documentation": "Stage plan information such as name, identifier, sub plans, and remote sources of child plan nodes/
" + } + }, + "RemoteSources": { + "target": "com.amazonaws.athena#StringList", + "traits": { + "smithy.api#documentation": "Source plan node IDs.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Stage plan information such as name, identifier, sub plans, and remote sources.
" + } + }, + "com.amazonaws.athena#QueryStagePlanNodes": { + "type": "list", + "member": { + "target": "com.amazonaws.athena#QueryStagePlanNode" + } + }, + "com.amazonaws.athena#QueryStages": { + "type": "list", + "member": { + "target": "com.amazonaws.athena#QueryStage" + } + }, "com.amazonaws.athena#QueryString": { "type": "string", "traits": { @@ -3165,6 +3412,12 @@ "com.amazonaws.athena#String": { "type": "string" }, + "com.amazonaws.athena#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.athena#String" + } + }, "com.amazonaws.athena#TableMetadata": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/auditmanager.json b/codegen/sdk/aws-models/auditmanager.json index 5bfa55b90b2..16b096d820f 100644 --- a/codegen/sdk/aws-models/auditmanager.json +++ b/codegen/sdk/aws-models/auditmanager.json @@ -461,7 +461,7 @@ "evidenceByTypeConfigurationDataCount": { "target": "com.amazonaws.auditmanager#Integer", "traits": { - "smithy.api#documentation": "The number of evidence that falls under the configuration data category. This\n evidence is collected from configuration snapshots of other Amazon Web Services such as Amazon EC2, Amazon S3, or IAM.
" + "smithy.api#documentation": "The number of evidence that falls under the configuration data category. This evidence\n is collected from configuration snapshots of other Amazon Web Services such as\n Amazon EC2, Amazon S3, or IAM.
" } }, "evidenceByTypeManualCount": { @@ -718,7 +718,7 @@ "complianceType": { "target": "com.amazonaws.auditmanager#ComplianceType", "traits": { - "smithy.api#documentation": "The compliance type that the shared custom framework supports, such as CIS or HIPAA.
" + "smithy.api#documentation": "The compliance type that the shared custom framework supports, such as CIS or\n HIPAA.
" } } }, @@ -2064,7 +2064,7 @@ "controlsCountByNoncompliantEvidence": { "target": "com.amazonaws.auditmanager#NullableInteger", "traits": { - "smithy.api#documentation": "The number of controls in the control domain that collected non-compliant evidence on the\n lastUpdated date.
The number of controls in the control domain that collected non-compliant evidence on\n the lastUpdated date.
A breakdown of the compliance check status for the evidence that’s associated with the control\n domain.
" + "smithy.api#documentation": "A breakdown of the compliance check status for the evidence that’s associated with the\n control domain.
" } }, "lastUpdated": { @@ -2087,7 +2087,7 @@ } }, "traits": { - "smithy.api#documentation": "A summary of the latest analytics data for a specific control domain.
\nControl domain insights are grouped by control domain, and ranked by the highest total count of non-compliant evidence.
" + "smithy.api#documentation": "A summary of the latest analytics data for a specific control domain.
\nControl domain insights are grouped by control domain, and ranked by the highest total\n count of non-compliant evidence.
" } }, "com.amazonaws.auditmanager#ControlDomainInsightsList": { @@ -2143,7 +2143,7 @@ } }, "traits": { - "smithy.api#documentation": "A summary of the latest analytics data for a specific control in a specific active\n assessment.
\nControl insights are grouped by control domain, and ranked by the highest total count of non-compliant evidence. \n
" + "smithy.api#documentation": "A summary of the latest analytics data for a specific control in a specific active\n assessment.
\nControl insights are grouped by control domain, and ranked by the highest total count of\n non-compliant evidence.
" } }, "com.amazonaws.auditmanager#ControlInsightsMetadataItem": { @@ -2175,7 +2175,7 @@ } }, "traits": { - "smithy.api#documentation": "A summary of the latest analytics data for a specific control.
\nThis data reflects the total counts for the specified control across all active assessments. Control insights are grouped by control domain, and ranked by the highest total count of non-compliant evidence.
" + "smithy.api#documentation": "A summary of the latest analytics data for a specific control.
\nThis data reflects the total counts for the specified control across all active\n assessments. Control insights are grouped by control domain, and ranked by the highest\n total count of non-compliant evidence.
" } }, "com.amazonaws.auditmanager#ControlMappingSource": { @@ -2480,6 +2480,9 @@ { "target": "com.amazonaws.auditmanager#ResourceNotFoundException" }, + { + "target": "com.amazonaws.auditmanager#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.auditmanager#ValidationException" } @@ -2511,6 +2514,9 @@ { "target": "com.amazonaws.auditmanager#ResourceNotFoundException" }, + { + "target": "com.amazonaws.auditmanager#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.auditmanager#ValidationException" } @@ -2717,7 +2723,7 @@ "assessmentReportsDestination": { "target": "com.amazonaws.auditmanager#AssessmentReportsDestination", "traits": { - "smithy.api#documentation": "The assessment report storage destination for the assessment that's being created.
", + "smithy.api#documentation": "The assessment report storage destination for the assessment that's being created.\n
", "smithy.api#required": {} } }, @@ -2775,6 +2781,9 @@ { "target": "com.amazonaws.auditmanager#ResourceNotFoundException" }, + { + "target": "com.amazonaws.auditmanager#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.auditmanager#ValidationException" } @@ -2930,12 +2939,12 @@ "roleType": { "target": "com.amazonaws.auditmanager#RoleType", "traits": { - "smithy.api#documentation": "The type of customer persona.
\nIn CreateAssessment, roleType can only be\n PROCESS_OWNER.
In UpdateSettings, roleType can only be\n PROCESS_OWNER.
In BatchCreateDelegationByAssessment, roleType can only be\n RESOURCE_OWNER.
The type of customer persona.
\nIn CreateAssessment, roleType can only be\n PROCESS_OWNER.
In UpdateSettings, roleType can only be\n PROCESS_OWNER.
In BatchCreateDelegationByAssessment, roleType can only be\n RESOURCE_OWNER.
A collection of attributes that's used to create a delegation for an assessment in\n Audit Manager.
" + "smithy.api#documentation": "A collection of attributes that's used to create a delegation for an assessment in\n Audit Manager.
" } }, "com.amazonaws.auditmanager#CreateDelegationRequests": { @@ -3239,7 +3248,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Deletes a share request for a custom framework in Audit Manager.\n
", + "smithy.api#documentation": "Deletes a share request for a custom framework in Audit Manager.
", "smithy.api#http": { "method": "DELETE", "uri": "/assessmentFrameworkShareRequests/{requestId}", @@ -3295,7 +3304,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an assessment report in Audit Manager.
\nWhen you run the DeleteAssessmentReport operation, Audit Manager attempts to delete the following data:
The specified assessment report that’s stored in your S3 bucket
\nThe associated metadata that’s stored in Audit Manager
\nIf Audit Manager can’t access the assessment report in your S3 bucket, the report\n isn’t deleted. In this event, the DeleteAssessmentReport operation doesn’t\n fail. Instead, it proceeds to delete the associated metadata only. You must then delete the\n assessment report from the S3 bucket yourself.
This scenario happens when Audit Manager receives a 403 (Forbidden) or\n 404 (Not Found) error from Amazon S3. To avoid this, make sure that\n your S3 bucket is available, and that you configured the correct permissions for Audit Manager to delete resources in your S3 bucket. For an example permissions policy that\n you can use, see Assessment report destination permissions in the Audit Manager User Guide. For information about the issues that could cause a 403\n (Forbidden) or 404 (Not Found) error from Amazon S3, see\n List of Error Codes in the Amazon Simple Storage Service API\n Reference.
Deletes an assessment report in Audit Manager.
\nWhen you run the DeleteAssessmentReport operation, Audit Manager\n attempts to delete the following data:
The specified assessment report that’s stored in your S3 bucket
\nThe associated metadata that’s stored in Audit Manager
\nIf Audit Manager can’t access the assessment report in your S3 bucket, the report\n isn’t deleted. In this event, the DeleteAssessmentReport operation doesn’t\n fail. Instead, it proceeds to delete the associated metadata only. You must then delete the\n assessment report from the S3 bucket yourself.
This scenario happens when Audit Manager receives a 403 (Forbidden) or\n 404 (Not Found) error from Amazon S3. To avoid this, make sure that\n your S3 bucket is available, and that you configured the correct permissions for Audit Manager to delete resources in your S3 bucket. For an example permissions policy that\n you can use, see Assessment report destination permissions in the Audit Manager User Guide. For information about the issues that could cause a 403\n (Forbidden) or 404 (Not Found) error from Amazon S3, see\n List of Error Codes in the Amazon Simple Storage Service API\n Reference.
Deregisters an account in Audit Manager.
\nWhen you deregister your account from Audit Manager, your data isn’t deleted. If you want\n to delete your resource data, you must perform that task separately before you\n deregister your account. Either, you can do this in the Audit Manager console. Or,\n you can use one of the delete API operations that are provided by Audit Manager.
\nTo delete your Audit Manager resource data, see the following instructions:
\n\n DeleteAssessment (see also: Deleting an\n assessment in the Audit Manager User\n Guide)
\n\n DeleteAssessmentFramework (see also: Deleting a\n custom framework in the Audit Manager User\n Guide)
\n\n DeleteAssessmentFrameworkShare (see also: Deleting a share request in the Audit Manager User\n Guide)
\n\n DeleteAssessmentReport (see also: Deleting an assessment report in the Audit Manager\n User Guide)
\n\n DeleteControl (see also: Deleting a custom\n control in the Audit Manager User\n Guide)
\nAt this time, Audit Manager doesn't provide an option to delete evidence. All\n available delete operations are listed above.
\nDeregisters an account in Audit Manager.
\nWhen you deregister your account from Audit Manager, your data isn’t deleted. If\n you want to delete your resource data, you must perform that task separately before you\n deregister your account. Either, you can do this in the Audit Manager console. Or,\n you can use one of the delete API operations that are provided by Audit Manager.
\nTo delete your Audit Manager resource data, see the following instructions:
\n\n DeleteAssessment (see also: Deleting an\n assessment in the Audit Manager User\n Guide)
\n\n DeleteAssessmentFramework (see also: Deleting a\n custom framework in the Audit Manager User\n Guide)
\n\n DeleteAssessmentFrameworkShare (see also: Deleting a share request in the Audit Manager User\n Guide)
\n\n DeleteAssessmentReport (see also: Deleting an assessment report in the Audit Manager\n User Guide)
\n\n DeleteControl (see also: Deleting a custom\n control in the Audit Manager User\n Guide)
\nAt this time, Audit Manager doesn't provide an option to delete evidence. All\n available delete operations are listed above.
\nRemoves the specified Amazon Web Services account as a delegated administrator for\n Audit Manager.
\nWhen you remove a delegated administrator from your Audit Manager settings, you\n continue to have access to the evidence that you previously collected under that\n account. This is also the case when you deregister a delegated administrator from\n Organizations. However, Audit Manager will stop collecting and attaching\n evidence to that delegated administrator account moving forward.
\nWhen you deregister a delegated administrator account for Audit Manager, the data for that\n account isn’t deleted. If you want to delete resource data for a delegated administrator\n account, you must perform that task separately before you deregister the account.\n Either, you can do this in the Audit Manager console. Or, you can use one of the\n delete API operations that are provided by Audit Manager.
\nTo delete your Audit Manager resource data, see the following instructions:
\n\n DeleteAssessment (see also: Deleting an\n assessment in the Audit Manager User\n Guide)
\n\n DeleteAssessmentFramework (see also: Deleting a\n custom framework in the Audit Manager User\n Guide)
\n\n DeleteAssessmentFrameworkShare (see also: Deleting a share request in the Audit Manager User\n Guide)
\n\n DeleteAssessmentReport (see also: Deleting an assessment report in the Audit Manager\n User Guide)
\n\n DeleteControl (see also: Deleting a custom\n control in the Audit Manager User\n Guide)
\nAt this time, Audit Manager doesn't provide an option to delete evidence. All\n available delete operations are listed above.
\nRemoves the specified Amazon Web Services account as a delegated administrator for\n Audit Manager.
\nWhen you remove a delegated administrator from your Audit Manager settings, you\n continue to have access to the evidence that you previously collected under that\n account. This is also the case when you deregister a delegated administrator from\n Organizations. However, Audit Manager will stop collecting and attaching\n evidence to that delegated administrator account moving forward.
\nWhen you deregister a delegated administrator account for Audit Manager, the data\n for that account isn’t deleted. If you want to delete resource data for a delegated\n administrator account, you must perform that task separately before you deregister the\n account. Either, you can do this in the Audit Manager console. Or, you can use one\n of the delete API operations that are provided by Audit Manager.
\nTo delete your Audit Manager resource data, see the following instructions:
\n\n DeleteAssessment (see also: Deleting an\n assessment in the Audit Manager User\n Guide)
\n\n DeleteAssessmentFramework (see also: Deleting a\n custom framework in the Audit Manager User\n Guide)
\n\n DeleteAssessmentFrameworkShare (see also: Deleting a share request in the Audit Manager User\n Guide)
\n\n DeleteAssessmentReport (see also: Deleting an assessment report in the Audit Manager\n User Guide)
\n\n DeleteControl (see also: Deleting a custom\n control in the Audit Manager User\n Guide)
\nAt this time, Audit Manager doesn't provide an option to delete evidence. All\n available delete operations are listed above.
\nThe evaluation status for evidence that falls under the compliance check category. For\n evidence collected from Security Hub, a Pass or\n Fail result is shown. For evidence collected from Config, a Compliant or Noncompliant\n result is shown.
" + "smithy.api#documentation": "The evaluation status for evidence that falls under the compliance check category. For\n evidence collected from Security Hub, a Pass or\n Fail result is shown. For evidence collected from Config, a Compliant or Noncompliant\n result is shown.
" } }, "awsOrganization": { @@ -3725,24 +3734,24 @@ "noncompliantEvidenceCount": { "target": "com.amazonaws.auditmanager#NullableInteger", "traits": { - "smithy.api#documentation": "The number of compliance check evidence that Audit Manager classified as non-compliant.\n This includes evidence that was collected from Security Hub with a\n Fail ruling, or collected from Config with a\n Non-compliant ruling.
" + "smithy.api#documentation": "The number of compliance check evidence that Audit Manager classified as\n non-compliant. This includes evidence that was collected from Security Hub with a\n Fail ruling, or collected from Config with a\n Non-compliant ruling.
" } }, "compliantEvidenceCount": { "target": "com.amazonaws.auditmanager#NullableInteger", "traits": { - "smithy.api#documentation": "The number of compliance check evidence that Audit Manager classified as compliant. This\n includes evidence that was collected from Security Hub with a\n Pass ruling, or collected from Config with a\n Compliant ruling.
" + "smithy.api#documentation": "The number of compliance check evidence that Audit Manager classified as compliant.\n This includes evidence that was collected from Security Hub with a\n Pass ruling, or collected from Config with a\n Compliant ruling.
" } }, "inconclusiveEvidenceCount": { "target": "com.amazonaws.auditmanager#NullableInteger", "traits": { - "smithy.api#documentation": "The number of evidence that a compliance check ruling isn't available for. Evidence is\n inconclusive when the associated control uses Security Hub or Config as a data source but you didn't enable those services. This is also the case when a\n control uses a data source that doesn’t support compliance checks (for example, manual\n evidence, API calls, or CloudTrail).
\nIf evidence has a compliance check status of not applicable in the\n console, it's classified as inconclusive in\n EvidenceInsights data.
The number of evidence that a compliance check ruling isn't available for. Evidence is\n inconclusive when the associated control uses Security Hub or Config as a data source but you didn't enable those services. This is also the case when a\n control uses a data source that doesn’t support compliance checks (for example, manual\n evidence, API calls, or CloudTrail).
\nIf evidence has a compliance check status of not applicable in\n the console, it's classified as inconclusive in\n EvidenceInsights data.
A breakdown of the latest compliance check status for the evidence in your Audit Manager\n assessments.
" + "smithy.api#documentation": "A breakdown of the latest compliance check status for the evidence in your Audit Manager assessments.
" } }, "com.amazonaws.auditmanager#EvidenceList": { @@ -4686,7 +4695,7 @@ "evidenceFolders": { "target": "com.amazonaws.auditmanager#AssessmentEvidenceFolders", "traits": { - "smithy.api#documentation": " The list of evidence folders that the\n GetEvidenceFoldersByAssessmentControl API returned.
The list of evidence folders that the\n GetEvidenceFoldersByAssessmentControl API returned.
The number of compliance check evidence that Audit Manager classified as non-compliant\n on the lastUpdated date. This includes evidence that was collected from\n Security Hub with a Fail ruling, or collected from\n Config with a Non-compliant ruling.
The number of compliance check evidence that Audit Manager classified as\n non-compliant on the lastUpdated date. This includes evidence that was\n collected from Security Hub with a Fail ruling, or collected\n from Config with a Non-compliant ruling.
The number of compliance check evidence that Audit Manager classified as compliant on\n the lastUpdated date. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling.
The number of compliance check evidence that Audit Manager classified as compliant\n on the lastUpdated date. This includes evidence that was collected from\n Security Hub with a Pass ruling, or collected from\n Config with a Compliant ruling.
The number of evidence without a compliance check ruling. Evidence is inconclusive when the\n associated control uses Security Hub or Config as a data source\n but you didn't enable those services. This is also the case when a control uses a data\n source that doesn’t support compliance checks (for example: manual evidence, API calls, or\n CloudTrail).
\nIf evidence has a compliance check status of not applicable, it's classed\n as inconclusive in Insights data.
The number of evidence without a compliance check ruling. Evidence is inconclusive when\n the associated control uses Security Hub or Config as a data\n source but you didn't enable those services. This is also the case when a control uses a\n data source that doesn’t support compliance checks (for example: manual evidence, API\n calls, or CloudTrail).
\nIf evidence has a compliance check status of not applicable,\n it's classed as inconclusive in Insights data.
The number of assessment controls that collected non-compliant evidence on the\n lastUpdated date.
The number of assessment controls that collected non-compliant evidence on the\n lastUpdated date.
A summary of the latest analytics data for all your active assessments.
\nThis summary is a snapshot of the data that your active assessments collected on the\n lastUpdated date. It’s important to understand that the following totals\n are daily counts based on this date — they aren’t a total sum to date.
The Insights data is eventually consistent. This means that, when you read\n data from Insights, the response might not instantly reflect the results of a\n recently completed write or update operation. If you repeat your read request after a few\n hours, the response should return the latest data.
If you delete an assessment or change its status to inactive,\n InsightsByAssessment includes data for that assessment as\n follows.
\n Inactive assessments - If Audit Manager collected\n evidence for your assessment before you changed it inactive, that evidence is\n included in the InsightsByAssessment counts for that day.
\n Deleted assessments - If Audit Manager collected\n evidence for your assessment before you deleted it, that evidence isn't included\n in the InsightsByAssessment counts for that day.
A summary of the latest analytics data for all your active assessments.
\nThis summary is a snapshot of the data that your active assessments collected on the\n lastUpdated date. It’s important to understand that the following totals\n are daily counts based on this date — they aren’t a total sum to date.
The Insights data is eventually consistent. This means that, when you read\n data from Insights, the response might not instantly reflect the results of a\n recently completed write or update operation. If you repeat your read request after a few\n hours, the response should return the latest data.
If you delete an assessment or change its status to inactive,\n InsightsByAssessment includes data for that assessment as\n follows.
\n Inactive assessments - If Audit Manager\n collected evidence for your assessment before you changed it inactive, that\n evidence is included in the InsightsByAssessment counts for that\n day.
\n Deleted assessments - If Audit Manager\n collected evidence for your assessment before you deleted it, that evidence isn't\n included in the InsightsByAssessment counts for that day.
The number of compliance check evidence that Audit Manager classified as non-compliant.\n This includes evidence that was collected from Security Hub with a\n Fail ruling, or collected from Config with a\n Non-compliant ruling.
" + "smithy.api#documentation": "The number of compliance check evidence that Audit Manager classified as\n non-compliant. This includes evidence that was collected from Security Hub with a\n Fail ruling, or collected from Config with a\n Non-compliant ruling.
" } }, "compliantEvidenceCount": { "target": "com.amazonaws.auditmanager#NullableInteger", "traits": { - "smithy.api#documentation": "The number of compliance check evidence that Audit Manager classified as compliant.\n This includes evidence that was collected from Security Hub with a\n Pass ruling, or collected from Config with a\n Compliant ruling.
" + "smithy.api#documentation": "The number of compliance check evidence that Audit Manager classified as compliant.\n This includes evidence that was collected from Security Hub with a\n Pass ruling, or collected from Config with a\n Compliant ruling.
" } }, "inconclusiveEvidenceCount": { "target": "com.amazonaws.auditmanager#NullableInteger", "traits": { - "smithy.api#documentation": "The amount of evidence without a compliance check ruling. Evidence is inconclusive if the\n associated control uses Security Hub or Config as a data source\n and you didn't enable those services. This is also the case if a control uses a data source\n that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail).
\nIf evidence has a compliance check status of not applicable, it's\n classified as inconclusive in InsightsByAssessment\n data.
The amount of evidence without a compliance check ruling. Evidence is inconclusive if\n the associated control uses Security Hub or Config as a data\n source and you didn't enable those services. This is also the case if a control uses a data\n source that doesn’t support compliance checks (for example, manual evidence, API calls, or\n CloudTrail).
\nIf evidence has a compliance check status of not applicable,\n it's classified as inconclusive in\n InsightsByAssessment data.
The number of assessment controls that collected non-compliant evidence on the\n lastUpdated date.
The number of assessment controls that collected non-compliant evidence on the\n lastUpdated date.
A summary of the latest analytics data for a specific active assessment.
\nThis summary is a snapshot of the data that was collected on the lastUpdated\n date. It’s important to understand that the totals in InsightsByAssessment are\n daily counts based on this date — they aren’t a total sum to date.
The InsightsByAssessment data is eventually consistent. This means that\n when you read data from InsightsByAssessment, the response might not instantly\n reflect the results of a recently completed write or update operation. If you repeat your\n read request after a few hours, the response returns the latest data.
If you delete an assessment or change its status to inactive,\n InsightsByAssessment includes data for that assessment as\n follows.
\n Inactive assessments - If Audit Manager collected\n evidence for your assessment before you changed it inactive, that evidence is\n included in the InsightsByAssessment counts for that day.
\n Deleted assessments - If Audit Manager collected\n evidence for your assessment before you deleted it, that evidence isn't included\n in the InsightsByAssessment counts for that day.
A summary of the latest analytics data for a specific active assessment.
\nThis summary is a snapshot of the data that was collected on the\n lastUpdated date. It’s important to understand that the totals in\n InsightsByAssessment are daily counts based on this date — they aren’t a\n total sum to date.
The InsightsByAssessment data is eventually consistent. This means that\n when you read data from InsightsByAssessment, the response might not instantly\n reflect the results of a recently completed write or update operation. If you repeat your\n read request after a few hours, the response returns the latest data.
If you delete an assessment or change its status to inactive,\n InsightsByAssessment includes data for that assessment as\n follows.
\n Inactive assessments - If Audit Manager\n collected evidence for your assessment before you changed it inactive, that\n evidence is included in the InsightsByAssessment counts for that\n day.
\n Deleted assessments - If Audit Manager\n collected evidence for your assessment before you deleted it, that evidence isn't\n included in the InsightsByAssessment counts for that day.
Lists the latest analytics data for controls within a specific control domain and a\n specific active assessment.
\nControl insights are listed only if the control belongs to the control domain and assessment\n that was specified. Moreover, the control must have collected evidence on the\n lastUpdated date of controlInsightsByAssessment. If neither\n of these conditions are met, no data is listed for that control.
Lists the latest analytics data for controls within a specific control domain and a\n specific active assessment.
\nControl insights are listed only if the control belongs to the control domain and\n assessment that was specified. Moreover, the control must have collected evidence on the\n lastUpdated date of controlInsightsByAssessment. If neither\n of these conditions are met, no data is listed for that control.
The assessment control analytics data that the\n ListAssessmentControlInsightsByControlDomain API returned.
The assessment control analytics data that the\n ListAssessmentControlInsightsByControlDomain API returned.
Lists the latest analytics data for control domains across all of your active\n assessments.
\nA control domain is listed only if at least one of the controls within that domain collected\n evidence on the lastUpdated date of controlDomainInsights. If\n this condition isn’t met, no data is listed for that control domain.
Lists the latest analytics data for control domains across all of your active\n assessments.
\nA control domain is listed only if at least one of the controls within that domain\n collected evidence on the lastUpdated date of\n controlDomainInsights. If this condition isn’t met, no data is listed\n for that control domain.
Lists analytics data for control domains within a specified active assessment.
\nA control domain is listed only if at least one of the controls within that domain collected\n evidence on the lastUpdated date of controlDomainInsights. If\n this condition isn’t met, no data is listed for that domain.
Lists analytics data for control domains within a specified active assessment.
\nA control domain is listed only if at least one of the controls within that domain\n collected evidence on the lastUpdated date of\n controlDomainInsights. If this condition isn’t met, no data is listed\n for that domain.
The control domain analytics data that the\n ListControlDomainInsightsByAssessment API returned.
The control domain analytics data that the\n ListControlDomainInsightsByAssessment API returned.
Lists the latest analytics data for controls within a specific control domain across all\n active assessments.
\nControl insights are listed only if the control belongs to the control domain that was\n specified and the control collected evidence on the lastUpdated date of\n controlInsightsMetadata. If neither of these conditions are met, no data\n is listed for that control.
Lists the latest analytics data for controls within a specific control domain across all\n active assessments.
\nControl insights are listed only if the control belongs to the control domain that\n was specified and the control collected evidence on the lastUpdated date of\n controlInsightsMetadata. If neither of these conditions are met, no data\n is listed for that control.
Returns a list of keywords that are pre-mapped to the specified control data source.
", + "smithy.api#documentation": "Returns a list of keywords that are pre-mapped to the specified control data source.\n
", "smithy.api#http": { "method": "GET", "uri": "/dataSourceKeywords", @@ -6555,6 +6564,22 @@ "target": "com.amazonaws.auditmanager#ServiceMetadata" } }, + "com.amazonaws.auditmanager#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.auditmanager#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "You've reached your account quota for this resource type. To perform the requested\n action, delete some existing resources or request a quota increase from\n the Service Quotas console. For a list of Audit Manager service quotas, see Quotas and\n restrictions for Audit Manager.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, "com.amazonaws.auditmanager#SettingAttribute": { "type": "string", "traits": { @@ -6759,7 +6784,7 @@ } }, "traits": { - "smithy.api#documentation": "The keyword to search for in CloudTrail logs, Config rules,\n Security Hub checks, and Amazon Web Services API names.
" + "smithy.api#documentation": "The keyword to search for in CloudTrail logs, Config rules,\n Security Hub checks, and Amazon Web Services API names.
\nTo learn more about the supported keywords that you can use when mapping a control data\n source, see the following pages in the Audit Manager User\n Guide:
\nCreates a share request for a custom framework in Audit Manager.
\nThe share request specifies a recipient and notifies them that a custom framework is available. Recipients have 120 days to accept or decline the request. If no action is taken, the share request expires.
\nWhen you create a share request, Audit Manager stores a snapshot of your custom\n framework in the US East (N. Virginia) Amazon Web Services Region. Audit Manager also\n stores a backup of the same snapshot in the US West (Oregon) Amazon Web Services Region.
\nAudit Manager deletes the snapshot and the backup snapshot when one of the following\n events occurs:
\nThe sender revokes the share request.
\nThe recipient declines the share request.
\nThe recipient encounters an error and doesn't successfully accept the share\n request.
\nThe share request expires before the recipient responds to the request.
\nWhen a sender resends a share request, the snapshot is replaced with an updated version that\n corresponds with the latest version of the custom framework.
\nWhen a recipient accepts a share request, the snapshot is replicated into their\n Amazon Web Services account under the Amazon Web Services Region that was specified in the share request.
\nWhen you invoke the StartAssessmentFrameworkShare API, you are about to\n share a custom framework with another Amazon Web Services account. You may not share a\n custom framework that is derived from a standard framework if the standard framework is\n designated as not eligible for sharing by Amazon Web Services, unless you have obtained\n permission to do so from the owner of the standard framework. To learn more about which\n standard frameworks are eligible for sharing, see Framework sharing eligibility in the Audit Manager User\n Guide.
Creates a share request for a custom framework in Audit Manager.
\nThe share request specifies a recipient and notifies them that a custom framework is\n available. Recipients have 120 days to accept or decline the request. If no action is\n taken, the share request expires.
\nWhen you create a share request, Audit Manager stores a snapshot of your custom\n framework in the US East (N. Virginia) Amazon Web Services Region. Audit Manager also\n stores a backup of the same snapshot in the US West (Oregon) Amazon Web Services Region.
\nAudit Manager deletes the snapshot and the backup snapshot when one of the following\n events occurs:
\nThe sender revokes the share request.
\nThe recipient declines the share request.
\nThe recipient encounters an error and doesn't successfully accept the share\n request.
\nThe share request expires before the recipient responds to the request.
\nWhen a sender resends a share request, the snapshot is replaced with an updated version that\n corresponds with the latest version of the custom framework.
\nWhen a recipient accepts a share request, the snapshot is replicated into their Amazon Web Services account under the Amazon Web Services Region that was specified in the share\n request.
\nWhen you invoke the StartAssessmentFrameworkShare API, you are about to\n share a custom framework with another Amazon Web Services account. You may not share a\n custom framework that is derived from a standard framework if the standard framework is\n designated as not eligible for sharing by Amazon Web Services, unless you have obtained\n permission to do so from the owner of the standard framework. To learn more about which\n standard frameworks are eligible for sharing, see Framework sharing eligibility in the Audit Manager User\n Guide.
The name of the updated control set that the\n UpdateAssessmentControlSetStatus API returned.
The name of the updated control set that the\n UpdateAssessmentControlSetStatus API returned.
The updated share request that's returned by the\n UpdateAssessmentFrameworkShare operation.
The updated share request that's returned by the\n UpdateAssessmentFrameworkShare operation.
Attaches one or more target groups to the specified Auto Scaling group.
\nThis operation is used with the following load balancer types:
\nApplication Load Balancer - Operates at the application layer (layer 7) and\n supports HTTP and HTTPS.
\nNetwork Load Balancer - Operates at the transport layer (layer 4) and\n supports TCP, TLS, and UDP.
\nGateway Load Balancer - Operates at the network layer (layer 3).
\nTo describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from\n the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.
\nThis operation is additive and does not detach existing target groups or Classic Load\n Balancers from the Auto Scaling group.
\nFor more information, see Elastic Load Balancing and\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Attaches one or more target groups to the specified Auto Scaling group.
\nThis operation is used with the following load balancer types:
\nApplication Load Balancer - Operates at the application layer (layer 7) and supports HTTP and\n HTTPS.
\nNetwork Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and\n UDP.
\nGateway Load Balancer - Operates at the network layer (layer 3).
\nTo describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from\n the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.
\nThis operation is additive and does not detach existing target groups or Classic Load\n Balancers from the Auto Scaling group.
\nFor more information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroupsResultType": { @@ -487,7 +487,7 @@ } ], "traits": { - "smithy.api#documentation": "To attach an Application Load Balancer, Network Load Balancer, or Gateway Load\n Balancer, use the AttachLoadBalancerTargetGroups API operation\n instead.
\nAttaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling\n registers the running instances with these Classic Load Balancers.
\nTo describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach the load balancer from the Auto Scaling\n group, call the DetachLoadBalancers API.
\nThis operation is additive and does not detach existing Classic Load Balancers or\n target groups from the Auto Scaling group.
\nFor more information, see Elastic Load Balancing and\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "To attach an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer, use the AttachLoadBalancerTargetGroups API operation instead.
\nAttaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the\n running instances with these Classic Load Balancers.
\nTo describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach a load balancer from the Auto Scaling\n group, call the DetachLoadBalancers API.
\nThis operation is additive and does not detach existing Classic Load Balancers or\n target groups from the Auto Scaling group.
\nFor more information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#AttachLoadBalancersResultType": { @@ -757,7 +757,7 @@ "AutoScalingGroupNames": { "target": "com.amazonaws.autoscaling#AutoScalingGroupNames", "traits": { - "smithy.api#documentation": "The names of the Auto Scaling groups. By default, you can only specify up to 50 names. You can\n optionally increase this limit using the MaxRecords parameter.
If you omit this parameter, all Auto Scaling groups are described.
" + "smithy.api#documentation": "The names of the Auto Scaling groups. By default, you can only specify up to 50 names. You can\n optionally increase this limit using the MaxRecords property.
If you omit this property, all Auto Scaling groups are described.
" } }, "NextToken": { @@ -852,7 +852,7 @@ "LifecycleState": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { - "smithy.api#documentation": "The lifecycle state for the instance. The Quarantined state is not used.\n For information about lifecycle states, see Instance\n lifecycle in the Amazon EC2 Auto Scaling User Guide.
Valid Values: Pending | Pending:Wait |\n Pending:Proceed | Quarantined | InService |\n Terminating | Terminating:Wait |\n Terminating:Proceed | Terminated | Detaching\n | Detached | EnteringStandby | Standby |\n Warmed:Pending | Warmed:Pending:Wait |\n Warmed:Pending:Proceed | Warmed:Terminating |\n Warmed:Terminating:Wait | Warmed:Terminating:Proceed |\n Warmed:Terminated | Warmed:Stopped |\n Warmed:Running\n
The lifecycle state for the instance. The Quarantined state is not used.\n For information about lifecycle states, see Instance\n lifecycle in the Amazon EC2 Auto Scaling User Guide.
Valid values: Pending | Pending:Wait |\n Pending:Proceed | Quarantined | InService |\n Terminating | Terminating:Wait |\n Terminating:Proceed | Terminated | Detaching\n | Detached | EnteringStandby | Standby |\n Warmed:Pending | Warmed:Pending:Wait |\n Warmed:Pending:Proceed | Warmed:Terminating |\n Warmed:Terminating:Wait | Warmed:Terminating:Proceed |\n Warmed:Terminated | Warmed:Stopped |\n Warmed:Running\n
Amazon EC2 Auto Scaling is designed to automatically launch or terminate EC2 instances\n based on user-defined scaling policies, scheduled actions, and health checks.
\nFor more information about Amazon EC2 Auto Scaling, see the Amazon EC2 Auto Scaling User Guide. For information about granting IAM users required\n permissions for calls to Amazon EC2 Auto Scaling, see Granting\n IAM users required permissions for Amazon EC2 Auto Scaling resources in the\n Amazon EC2 Auto Scaling API Reference.
", + "smithy.api#documentation": "Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances\n based on user-defined scaling policies, scheduled actions, and health checks.
\nFor more information, see the Amazon EC2 Auto Scaling User Guide and the Amazon EC2 Auto Scaling API Reference.
", "smithy.api#title": "Auto Scaling", "smithy.api#xmlNamespace": { "uri": "http://autoscaling.amazonaws.com/doc/2011-01-01/" @@ -1331,26 +1331,26 @@ "VirtualName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The name of the virtual device (for example, ephemeral0).
You can specify either VirtualName or Ebs, but not\n both.
The name of the instance store volume (virtual device) to attach to an instance at\n launch. The name must be in the form ephemeralX where\n X is a number starting from zero (0), for example,\n ephemeral0.
The device name exposed to the EC2 instance (for example, /dev/sdh or\n xvdh). For more information, see Device Naming on Linux\n Instances in the Amazon EC2 User Guide for Linux Instances.
The device name assigned to the volume (for example, /dev/sdh or\n xvdh). For more information, see Device naming on Linux\n instances in the Amazon EC2 User Guide for Linux Instances.
To define a block device mapping, set the device name and exactly one of the\n following properties: Ebs, NoDevice, or\n VirtualName.
Parameters used to automatically set up EBS volumes when an instance is\n launched.
\nYou can specify either VirtualName or Ebs, but not\n both.
Information to attach an EBS volume to an instance at launch.
" } }, "NoDevice": { "target": "com.amazonaws.autoscaling#NoDevice", "traits": { - "smithy.api#documentation": "Setting this value to true suppresses the specified device included in\n the block device mapping of the AMI.
If NoDevice is true for the root device, instances might\n fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches replacement instances.
If you specify NoDevice, you cannot specify Ebs.
Setting this value to true prevents a volume that is included in the\n block device mapping of the AMI from being mapped to the specified device name at\n launch.
If NoDevice is true for the root device, instances might\n fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches replacement instances.
The action for the group to take. This parameter can be either CONTINUE\n or ABANDON.
The action for the group to take. You can specify either CONTINUE or\n ABANDON.
\n We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n
\nCreates an Auto Scaling group with the specified name and attributes.
\nIf you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit,\n call the DescribeAccountLimits API. For information about updating\n this limit, see Amazon EC2 Auto Scaling service\n quotas in the Amazon EC2 Auto Scaling User Guide.
\nFor introductory exercises for creating an Auto Scaling group, see Getting started with\n Amazon EC2 Auto Scaling and Tutorial: Set up a\n scaled and load-balanced application in the\n Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling\n groups in the Amazon EC2 Auto Scaling User Guide.
\nEvery Auto Scaling group has three size parameters (DesiredCapacity,\n MaxSize, and MinSize). Usually, you set these sizes based\n on a specific number of instances. However, if you configure a mixed instances policy\n that defines weights for the instance types, you must specify these sizes with the same\n units that you use for weighting instances.
\n We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n
\nCreates an Auto Scaling group with the specified name and attributes.
\nIf you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit,\n call the DescribeAccountLimits API. For information about updating\n this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nFor introductory exercises for creating an Auto Scaling group, see Getting started with\n Amazon EC2 Auto Scaling and Tutorial: Set up a\n scaled and load-balanced application in the\n Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling\n groups in the Amazon EC2 Auto Scaling User Guide.
\nEvery Auto Scaling group has three size properties (DesiredCapacity,\n MaxSize, and MinSize). Usually, you set these sizes based\n on a specific number of instances. However, if you configure a mixed instances policy\n that defines weights for the instance types, you must specify these sizes with the same\n units that you use for weighting instances.
Parameters used to specify the launch template and version to use to launch instances.
\nConditional: You must specify either a launch template (LaunchTemplate or\n MixedInstancesPolicy) or a launch configuration\n (LaunchConfigurationName or InstanceId).
The launch template that is specified must be configured for use with an Auto Scaling\n group. For more information, see Creating a launch\n template for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
\nInformation used to specify the launch template and version to use to launch\n instances.
\nConditional: You must specify either a launch template (LaunchTemplate or\n MixedInstancesPolicy) or a launch configuration\n (LaunchConfigurationName or InstanceId).
The launch template that is specified must be configured for use with an Auto Scaling\n group. For more information, see Creating a launch\n template for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
\nA list of Availability Zones where instances in the Auto Scaling group can be created. This\n parameter is optional if you specify one or more subnets for\n VPCZoneIdentifier.
Conditional: If your account supports EC2-Classic and VPC, this parameter is required\n to launch instances into EC2-Classic.
" + "smithy.api#documentation": "A list of Availability Zones where instances in the Auto Scaling group can be created. Used\n for launching into the default VPC subnet in each Availability Zone when not using the\n VPCZoneIdentifier property, or for attaching a network interface when\n an existing network interface ID is specified in a launch template.
A list of Classic Load Balancers associated with this Auto Scaling group. For\n Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify\n the TargetGroupARNs property instead.
A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancer,\n specify the TargetGroupARNs property instead.
The Amazon Resource Names (ARN) of the target groups to associate with the Auto Scaling group.\n Instances are registered as targets in a target group, and traffic is routed to the\n target group. For more information, see Elastic Load Balancing and\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The Amazon Resource Names (ARN) of the target groups to associate with the Auto Scaling group.\n Instances are registered as targets with the target groups. The target groups receive\n incoming traffic and route requests to one or more registered targets. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "HealthCheckType": { @@ -1685,25 +1685,25 @@ "HealthCheckGracePeriod": { "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", "traits": { - "smithy.api#documentation": "\n \n
\nThe amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n Elastic Load Balancing or custom health check. This is useful if your instances do not immediately pass\n these health checks after they enter the InService state. For more\n information, see Health\n check grace period in the Amazon EC2 Auto Scaling User Guide.
Default: 0 seconds
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n Elastic Load Balancing or custom health check. This is useful if your instances do not immediately pass\n these health checks after they enter the InService state. For more\n information, see Health\n check grace period in the Amazon EC2 Auto Scaling User Guide.
Default: 0 seconds
The name of an existing placement group into which to launch your instances. For more\n information, see Placement groups in the\n Amazon EC2 User Guide for Linux Instances.
\nA cluster placement group is a logical grouping of instances\n within a single Availability Zone. You cannot specify multiple Availability Zones\n and a cluster placement group.
\nThe name of the placement group into which to launch your instances. For more\n information, see Placement groups in the\n Amazon EC2 User Guide for Linux Instances.
\nA cluster placement group is a logical grouping of instances\n within a single Availability Zone. You cannot specify multiple Availability Zones\n and a cluster placement group.
\nA comma-separated list of subnet IDs for a virtual private cloud (VPC) where instances\n in the Auto Scaling group can be created. If you specify VPCZoneIdentifier with\n AvailabilityZones, the subnets that you specify for this parameter must\n reside in those Availability Zones.
Conditional: If your account supports EC2-Classic and VPC, this parameter is required\n to launch instances into a VPC.
" + "smithy.api#documentation": "A comma-separated list of subnet IDs for a virtual private cloud (VPC) where instances\n in the Auto Scaling group can be created. If you specify VPCZoneIdentifier with\n AvailabilityZones, the subnets that you specify must reside in those\n Availability Zones.
A policy or a list of policies that are used to select the instance to terminate.\n These policies are executed in the order that you list them. For more information, see\n Controlling which Auto Scaling\n instances terminate during scale in in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "A policy or a list of policies that are used to select the instance to terminate.\n These policies are executed in the order that you list them. For more information, see\n Work with\n Amazon EC2 Auto Scaling termination policies in the\n Amazon EC2 Auto Scaling User Guide.
\nValid values: Default | AllocationStrategy |\n ClosestToNextInstanceHour | NewestInstance |\n OldestInstance | OldestLaunchConfiguration |\n OldestLaunchTemplate |\n arn:aws:lambda:region:account-id:function:my-function:my-alias\n
Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is\n disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot\n Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of\n interruption. After launching a new instance, it then terminates an old instance. For\n more information, see Amazon EC2 Auto Scaling\n Capacity Rebalancing in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is\n disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot\n Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of\n interruption. After launching a new instance, it then terminates an old instance. For\n more information, see Use Capacity\n Rebalancing to handle Amazon EC2 Spot Interruptions in the in the Amazon EC2 Auto Scaling User Guide.
" } }, "LifecycleHookSpecificationList": { "target": "com.amazonaws.autoscaling#LifecycleHookSpecifications", "traits": { - "smithy.api#documentation": "One or more lifecycle hooks for the group, which specify actions to perform when\n Amazon EC2 Auto Scaling launches or terminates instances.
" + "smithy.api#documentation": "One or more lifecycle hooks to add to the Auto Scaling group before instances are\n launched.
" } }, "Tags": { "target": "com.amazonaws.autoscaling#Tags", "traits": { - "smithy.api#documentation": "One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2\n instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS\n volumes, specify the tags in a launch template but use caution. If the launch template\n specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling\n overrides the value of that instance tag with the value specified by the Auto Scaling group. For\n more information, see Tagging Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2\n instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS\n volumes, specify the tags in a launch template but use caution. If the launch template\n specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling\n overrides the value of that instance tag with the value specified by the Auto Scaling group. For\n more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.
" } }, "ServiceLinkedRoleARN": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\n call other Amazon Web Services on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role\n named AWSServiceRoleForAutoScaling, which it creates if it does not exist.\n For more information, see Service-linked\n roles in the Amazon EC2 Auto Scaling User Guide.
The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\n call other Amazon Web Services service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role\n named AWSServiceRoleForAutoScaling, which it creates if it does not exist.\n For more information, see Service-linked\n roles in the Amazon EC2 Auto Scaling User Guide.
Creates a launch configuration.
\nIf you exceed your maximum limit of launch configurations, the call fails. To query\n this limit, call the DescribeAccountLimits API. For information about\n updating this limit, see Amazon EC2 Auto Scaling service\n quotas in the Amazon EC2 Auto Scaling User Guide.
\nFor more information, see Launch\n configurations in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Creates a launch configuration.
\nIf you exceed your maximum limit of launch configurations, the call fails. To query\n this limit, call the DescribeAccountLimits API. For information about\n updating this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nFor more information, see Launch\n configurations in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#CreateLaunchConfigurationType": { @@ -1798,31 +1798,31 @@ "ImageId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The ID of the Amazon Machine Image (AMI) that was assigned during registration. For\n more information, see Finding an AMI in the\n Amazon EC2 User Guide for Linux Instances.
\nIf you do not specify InstanceId, you must specify\n ImageId.
The ID of the Amazon Machine Image (AMI) that was assigned during registration. For\n more information, see Finding a Linux AMI in the\n Amazon EC2 User Guide for Linux Instances.
\nIf you specify InstanceId, an ImageId is not\n required.
The name of the key pair. For more information, see Amazon EC2 Key Pairs in the\n Amazon EC2 User Guide for Linux Instances.
" + "smithy.api#documentation": "The name of the key pair. For more information, see Amazon EC2 key pairs and Linux\n instances in the Amazon EC2 User Guide for Linux Instances.
" } }, "SecurityGroups": { "target": "com.amazonaws.autoscaling#SecurityGroups", "traits": { - "smithy.api#documentation": "A list that contains the security groups to assign to the instances in the Auto Scaling\n group.
\n[EC2-VPC] Specify the security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud\n User Guide.
\n[EC2-Classic] Specify either the security group names or the security group IDs. For\n more information, see Amazon EC2 Security\n Groups in the Amazon EC2 User Guide for Linux Instances.
" + "smithy.api#documentation": "A list that contains the security group IDs to assign to the instances in the Auto Scaling\n group. For more information, see Control traffic to\n resources using security groups in the Amazon Virtual Private\n Cloud User Guide.
" } }, "ClassicLinkVPCId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "\n EC2-Classic retires on August 15, 2022. This parameter is not supported after\n that date.\n
\nThe ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more\n information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances.
" + "smithy.api#documentation": "\n EC2-Classic retires on August 15, 2022. This property is not supported after\n that date.\n
\nThe ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more\n information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances.
" } }, "ClassicLinkVPCSecurityGroups": { "target": "com.amazonaws.autoscaling#ClassicLinkVPCSecurityGroups", "traits": { - "smithy.api#documentation": "\n EC2-Classic retires on August 15, 2022. This parameter is not supported after\n that date.\n
\nThe IDs of one or more security groups for the specified ClassicLink-enabled VPC. For\n more information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances.
\nIf you specify the ClassicLinkVPCId parameter, you must specify this\n parameter.
\n EC2-Classic retires on August 15, 2022. This property is not supported after\n that date.\n
\nThe IDs of one or more security groups for the specified ClassicLink-enabled\n VPC.
\nIf you specify the ClassicLinkVPCId property, you must specify\n ClassicLinkVPCSecurityGroups.
The ID of the instance to use to create the launch configuration. The new launch\n configuration derives attributes from the instance, except for the block device\n mapping.
\nTo create a launch configuration with a block device mapping or override any other\n instance attributes, specify them as part of the same request.
\nFor more information, see Creating a launch\n configuration using an EC2 instance in the\n Amazon EC2 Auto Scaling User Guide.
\nIf you do not specify InstanceId, you must specify both\n ImageId and InstanceType.
The ID of the instance to use to create the launch configuration. The new launch\n configuration derives attributes from the instance, except for the block device\n mapping.
\nTo create a launch configuration with a block device mapping or override any other\n instance attributes, specify them as part of the same request.
\nFor more information, see Creating a launch\n configuration using an EC2 instance in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "InstanceType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "Specifies the instance type of the EC2 instance.
\nFor information about available instance types, see Available\n Instance Types in the Amazon EC2 User Guide for Linux Instances.
\nIf you do not specify InstanceId, you must specify\n InstanceType.
Specifies the instance type of the EC2 instance. For information about available\n instance types, see Available\n instance types in the Amazon EC2 User Guide for Linux Instances.
\nIf you specify InstanceId, an InstanceType is not\n required.
The ID of the kernel associated with the AMI.
" + "smithy.api#documentation": "The ID of the kernel associated with the AMI.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon EC2 User Guide for Linux\n Instances.
\nThe ID of the RAM disk to select.
" + "smithy.api#documentation": "The ID of the RAM disk to select.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon EC2 User Guide for Linux\n Instances.
\nA block device mapping, which specifies the block devices for the instance. You can\n specify virtual devices and EBS volumes. For more information, see Block Device\n Mapping in the Amazon EC2 User Guide for Linux Instances.
" + "smithy.api#documentation": "The block device mapping entries that define the block devices to attach to the\n instances at launch. By default, the block devices specified in the block device mapping\n for the AMI are used. For more information, see Block device\n mappings in the Amazon EC2 User Guide for Linux Instances.
" } }, "InstanceMonitoring": { @@ -1870,13 +1870,13 @@ "SpotPrice": { "target": "com.amazonaws.autoscaling#SpotPrice", "traits": { - "smithy.api#documentation": "The maximum hourly price to be paid for any Spot Instance launched to fulfill the\n request. Spot Instances are launched when the price you specify exceeds the current Spot\n price. For more information, see Requesting Spot\n Instances in the Amazon EC2 Auto Scaling User Guide.
\nWhen you change your maximum price by creating a new launch configuration, running\n instances will continue to run as long as the maximum price for those running\n instances is higher than the current Spot price.
\nThe maximum hourly price to be paid for any Spot Instance launched to fulfill the\n request. Spot Instances are launched when the price you specify exceeds the current Spot\n price. For more information, see Request Spot\n Instances for fault-tolerant and flexible applications in the\n Amazon EC2 Auto Scaling User Guide.
\nValid Range: Minimum value of 0.001
\nWhen you change your maximum price by creating a new launch configuration, running\n instances will continue to run as long as the maximum price for those running\n instances is higher than the current Spot price.
\nThe name or the Amazon Resource Name (ARN) of the instance profile associated with the\n IAM role for the instance. The instance profile contains the IAM role.
\nFor more information, see IAM role for applications that run\n on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The name or the Amazon Resource Name (ARN) of the instance profile associated with the\n IAM role for the instance. The instance profile contains the IAM role. For more\n information, see IAM role for applications that run\n on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide.
" } }, "EbsOptimized": { @@ -1888,13 +1888,13 @@ "AssociatePublicIpAddress": { "target": "com.amazonaws.autoscaling#AssociatePublicIpAddress", "traits": { - "smithy.api#documentation": "For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether\n to assign a public IP address to the group's instances. If you specify\n true, each instance in the Auto Scaling group receives a unique public IP address.\n For more information, see Launching Auto Scaling instances in a\n VPC in the Amazon EC2 Auto Scaling User Guide.
If you specify this parameter, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.
If the instance is launched into a default subnet, the default is to assign a\n public IP address, unless you disabled the option to assign a public IP address on\n the subnet. If the instance is launched into a nondefault subnet, the default is not\n to assign a public IP address, unless you enabled the option to assign a public IP\n address on the subnet.
\nSpecifies whether to assign a public IPv4 address to the group's instances. If the\n instance is launched into a default subnet, the default is to assign a public IPv4\n address, unless you disabled the option to assign a public IPv4 address on the subnet.\n If the instance is launched into a nondefault subnet, the default is not to assign a\n public IPv4 address, unless you enabled the option to assign a public IPv4 address on\n the subnet.
\nIf you specify true, each instance in the Auto Scaling group receives a unique\n public IPv4 address. For more information, see Launching Auto Scaling instances in a\n VPC in the Amazon EC2 Auto Scaling User Guide.
If you specify this property, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.
The tenancy of the instance. An instance with dedicated tenancy runs on\n isolated, single-tenant hardware and can only be launched into a VPC.
To launch dedicated instances into a shared tenancy VPC (a VPC with the instance\n placement tenancy attribute set to default), you must set the value of this\n parameter to dedicated.
If you specify PlacementTenancy, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.
For more information, see Configuring\n instance tenancy with Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.
\nValid Values: default | dedicated\n
The tenancy of the instance, either default or dedicated. An\n instance with dedicated tenancy runs on isolated, single-tenant hardware\n and can only be launched into a VPC. To launch dedicated instances into a shared tenancy\n VPC (a VPC with the instance placement tenancy attribute set to default),\n you must set the value of this property to dedicated. For more information,\n see Configuring\n instance tenancy with Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.
If you specify PlacementTenancy, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.
Valid values: default | dedicated\n
Creates or updates tags for the specified Auto Scaling group.
\nWhen you specify a tag with a key that already exists, the operation overwrites the\n previous tag definition, and you do not get an error message.
\nFor more information, see Tagging Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Creates or updates tags for the specified Auto Scaling group.
\nWhen you specify a tag with a key that already exists, the operation overwrites the\n previous tag definition, and you do not get an error message.
\nFor more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#CreateOrUpdateTagsType": { @@ -1981,7 +1981,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use\n with Amazon EC2 Auto Scaling.
\nTo create your customized metric specification:
\nAdd values for each required parameter from CloudWatch. You can use an existing\n metric, or a new metric that you create. To use your own metric, you must first\n publish the metric to CloudWatch. For more information, see Publish\n custom metrics in the Amazon CloudWatch User\n Guide.
\nChoose a metric that changes proportionally with capacity. The value of the\n metric should increase or decrease in inverse proportion to the number of\n capacity units. That is, the value of the metric should decrease when capacity\n increases.
\nFor more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts.
\nEach individual service provides information about the metrics, namespace, and\n dimensions they use. For more information, see Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.
\nRepresents a CloudWatch metric of your choosing for a target tracking scaling policy to use\n with Amazon EC2 Auto Scaling.
\nTo create your customized metric specification:
\nAdd values for each required property from CloudWatch. You can use an existing\n metric, or a new metric that you create. To use your own metric, you must first\n publish the metric to CloudWatch. For more information, see Publish\n custom metrics in the Amazon CloudWatch User\n Guide.
\nChoose a metric that changes proportionally with capacity. The value of the\n metric should increase or decrease in inverse proportion to the number of\n capacity units. That is, the value of the metric should decrease when capacity\n increases.
\nFor more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts.
\nEach individual service provides information about the metrics, namespace, and\n dimensions they use. For more information, see Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.
\nSpecifies that the group is to be deleted along with all instances associated with the\n group, without waiting for all instances to be terminated. This parameter also deletes\n any outstanding lifecycle actions associated with the group.
" + "smithy.api#documentation": "Specifies that the group is to be deleted along with all instances associated with the\n group, without waiting for all instances to be terminated. This action also deletes any\n outstanding lifecycle actions associated with the group.
" } } } @@ -2295,7 +2295,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the current Amazon EC2 Auto Scaling resource quotas for your account.
\nWhen you establish an Amazon Web Services account, the account has initial quotas on the maximum\n number of Auto Scaling groups and launch configurations that you can create in a given Region.\n For more information, see Amazon EC2 Auto Scaling service\n quotas in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Describes the current Amazon EC2 Auto Scaling resource quotas for your account.
\nWhen you establish an Amazon Web Services account, the account has initial quotas on the maximum\n number of Auto Scaling groups and launch configurations that you can create in a given Region.\n For more information, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#DescribeAccountLimitsAnswer": { @@ -2490,7 +2490,7 @@ "InstanceIds": { "target": "com.amazonaws.autoscaling#InstanceIds", "traits": { - "smithy.api#documentation": "The IDs of the instances. If you omit this parameter, all Auto Scaling instances are\n described. If you specify an ID that does not exist, it is ignored with no error.
\nArray Members: Maximum number of 50 items.
" + "smithy.api#documentation": "The IDs of the instances. If you omit this property, all Auto Scaling instances are described.\n If you specify an ID that does not exist, it is ignored with no error.
\nArray Members: Maximum number of 50 items.
" } }, "MaxRecords": { @@ -2561,7 +2561,7 @@ "InstanceRefreshes": { "target": "com.amazonaws.autoscaling#InstanceRefreshes", "traits": { - "smithy.api#documentation": "The instance refreshes for the specified group.
" + "smithy.api#documentation": "The instance refreshes for the specified group, sorted by creation timestamp in descending order.
" } }, "NextToken": { @@ -2697,7 +2697,7 @@ "LifecycleHookNames": { "target": "com.amazonaws.autoscaling#LifecycleHookNames", "traits": { - "smithy.api#documentation": "The names of one or more lifecycle hooks. If you omit this parameter, all lifecycle\n hooks are described.
" + "smithy.api#documentation": "The names of one or more lifecycle hooks. If you omit this property, all lifecycle\n hooks are described.
" } } } @@ -2719,7 +2719,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about the load balancer target groups for the specified Auto Scaling\n group.
\nTo determine the availability of registered instances, use the State\n element in the response. When you attach a target group to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the target group. If\n Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the target group is in the InService state, Amazon EC2 Auto Scaling can terminate and\n replace any instances that are reported as unhealthy. If no registered instances pass\n the health checks, the target group doesn't enter the InService state.
Target groups also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your target group state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.
For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Elastic Load Balancing and\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.
\nTo determine the attachment status of the target group, use the State\n element in the response. When you attach a target group to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the target group. If\n Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the target group is in the InService state, Amazon EC2 Auto Scaling can terminate and\n replace any instances that are reported as unhealthy. If no registered instances pass\n the health checks, the target group doesn't enter the InService state.
Target groups also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your target group state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.
For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#DescribeLoadBalancerTargetGroupsRequest": { @@ -2780,7 +2780,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about the load balancers for the specified Auto Scaling group.
\nThis operation describes only Classic Load Balancers. If you have Application Load\n Balancers, Network Load Balancers, or Gateway Load Balancers, use the DescribeLoadBalancerTargetGroups API instead.
\nTo determine the availability of registered instances, use the State\n element in the response. When you attach a load balancer to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the load balancer.\n If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the load balancer is in the InService state, Amazon EC2 Auto Scaling can terminate\n and replace any instances that are reported as unhealthy. If no registered instances\n pass the health checks, the load balancer doesn't enter the InService\n state.
Load balancers also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your load balancer state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.
For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Elastic Load Balancing and\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Gets information about the load balancers for the specified Auto Scaling group.
\nThis operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancer, use the\n DescribeLoadBalancerTargetGroups API instead.
\nTo determine the attachment status of the load balancer, use the State\n element in the response. When you attach a load balancer to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the load balancer.\n If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the load balancer is in the InService state, Amazon EC2 Auto Scaling can terminate\n and replace any instances that are reported as unhealthy. If no registered instances\n pass the health checks, the load balancer doesn't enter the InService\n state.
Load balancers also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your load balancer state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.
For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#DescribeLoadBalancersRequest": { @@ -2838,7 +2838,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
\nThe GroupStandbyInstances metric is not returned by default. You must\n explicitly request this metric when calling the EnableMetricsCollection API.
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
" } }, "com.amazonaws.autoscaling#DescribeMetricCollectionTypesAnswer": { @@ -2847,7 +2847,7 @@ "Metrics": { "target": "com.amazonaws.autoscaling#MetricCollectionTypes", "traits": { - "smithy.api#documentation": "One or more metrics.
" + "smithy.api#documentation": "The metrics.
" } }, "Granularities": { @@ -2966,7 +2966,7 @@ "PolicyNames": { "target": "com.amazonaws.autoscaling#PolicyNames", "traits": { - "smithy.api#documentation": "The names of one or more policies. If you omit this parameter, all policies are\n described. If a group name is provided, the results are limited to that group. If you\n specify an unknown policy name, it is ignored with no error.
\nArray Members: Maximum number of 50 items.
" + "smithy.api#documentation": "The names of one or more policies. If you omit this property, all policies are\n described. If a group name is provided, the results are limited to that group. If you\n specify an unknown policy name, it is ignored with no error.
\nArray Members: Maximum number of 50 items.
" } }, "PolicyTypes": { @@ -3021,7 +3021,7 @@ "ActivityIds": { "target": "com.amazonaws.autoscaling#ActivityIds", "traits": { - "smithy.api#documentation": "The activity IDs of the desired scaling activities. If you omit this parameter, all\n activities for the past six weeks are described. If unknown activities are requested,\n they are ignored with no error. If you specify an Auto Scaling group, the results are limited to\n that group.
\nArray Members: Maximum number of 50 IDs.
" + "smithy.api#documentation": "The activity IDs of the desired scaling activities. If you omit this property, all\n activities for the past six weeks are described. If unknown activities are requested,\n they are ignored with no error. If you specify an Auto Scaling group, the results are limited to\n that group.
\nArray Members: Maximum number of 50 IDs.
" } }, "AutoScalingGroupName": { @@ -3105,19 +3105,19 @@ "ScheduledActionNames": { "target": "com.amazonaws.autoscaling#ScheduledActionNames", "traits": { - "smithy.api#documentation": "The names of one or more scheduled actions. If you omit this parameter, all scheduled\n actions are described. If you specify an unknown scheduled action, it is ignored with no\n error.
\nArray Members: Maximum number of 50 actions.
" + "smithy.api#documentation": "The names of one or more scheduled actions. If you omit this property, all scheduled\n actions are described. If you specify an unknown scheduled action, it is ignored with no\n error.
\nArray Members: Maximum number of 50 actions.
" } }, "StartTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "The earliest scheduled start time to return. If scheduled action names are provided,\n this parameter is ignored.
" + "smithy.api#documentation": "The earliest scheduled start time to return. If scheduled action names are provided,\n this property is ignored.
" } }, "EndTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "The latest scheduled start time to return. If scheduled action names are provided,\n this parameter is ignored.
" + "smithy.api#documentation": "The latest scheduled start time to return. If scheduled action names are provided,\n this property is ignored.
" } }, "NextToken": { @@ -3151,7 +3151,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified tags.
\nYou can use filters to limit the results. For example, you can query for the tags for\n a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at\n least one of the specified values for it to be included in the results.
\nYou can also specify multiple filters. The result includes information for a\n particular tag only if it matches all the filters. If there's no match, no special\n message is returned.
\nFor more information, see Tagging Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#documentation": "Describes the specified tags.
\nYou can use filters to limit the results. For example, you can query for the tags for\n a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at\n least one of the specified values for it to be included in the results.
\nYou can also specify multiple filters. The result includes information for a\n particular tag only if it matches all the filters. If there's no match, no special\n message is returned.
\nFor more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3197,7 +3197,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the termination policies supported by Amazon EC2 Auto Scaling.
\nFor more information, see Controlling which Auto Scaling\n instances terminate during scale in in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Describes the termination policies supported by Amazon EC2 Auto Scaling.
\nFor more information, see Work with\n Amazon EC2 Auto Scaling termination policies in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#DescribeTerminationPolicyTypesAnswer": { @@ -3362,7 +3362,7 @@ } ], "traits": { - "smithy.api#documentation": "Detaches one or more target groups from the specified Auto Scaling group.
" + "smithy.api#documentation": "Detaches one or more target groups from the specified Auto Scaling group.
\nWhen you detach a target group, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the target group using the DescribeLoadBalancerTargetGroups API call. The instances remain\n running.
Detaches one or more Classic Load Balancers from the specified Auto Scaling group.
\nThis operation detaches only Classic Load Balancers. If you have Application Load\n Balancers, Network Load Balancers, or Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API instead.
\nWhen you detach a load balancer, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the load balancer using the DescribeLoadBalancers API call. The instances remain running.
Detaches one or more Classic Load Balancers from the specified Auto Scaling group.
\nThis operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or\n Gateway Load Balancer, use the DetachLoadBalancerTargetGroups API instead.
\nWhen you detach a load balancer, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the load balancer using the DescribeLoadBalancers API call. The instances remain running.
Disables group metrics for the specified Auto Scaling group.
" + "smithy.api#documentation": "Disables group metrics collection for the specified Auto Scaling group.
" } }, "com.amazonaws.autoscaling#DisableMetricsCollectionQuery": { @@ -3458,7 +3458,7 @@ "Metrics": { "target": "com.amazonaws.autoscaling#Metrics", "traits": { - "smithy.api#documentation": "Specifies one or more of the following metrics:
\n\n GroupMinSize\n
\n GroupMaxSize\n
\n GroupDesiredCapacity\n
\n GroupInServiceInstances\n
\n GroupPendingInstances\n
\n GroupStandbyInstances\n
\n GroupTerminatingInstances\n
\n GroupTotalInstances\n
\n GroupInServiceCapacity\n
\n GroupPendingCapacity\n
\n GroupStandbyCapacity\n
\n GroupTerminatingCapacity\n
\n GroupTotalCapacity\n
\n WarmPoolDesiredCapacity\n
\n WarmPoolWarmedCapacity\n
\n WarmPoolPendingCapacity\n
\n WarmPoolTerminatingCapacity\n
\n WarmPoolTotalCapacity\n
\n GroupAndWarmPoolDesiredCapacity\n
\n GroupAndWarmPoolTotalCapacity\n
If you omit this parameter, all metrics are disabled.
" + "smithy.api#documentation": "Identifies the metrics to disable.
\nYou can specify one or more of the following metrics:
\n\n GroupMinSize\n
\n GroupMaxSize\n
\n GroupDesiredCapacity\n
\n GroupInServiceInstances\n
\n GroupPendingInstances\n
\n GroupStandbyInstances\n
\n GroupTerminatingInstances\n
\n GroupTotalInstances\n
\n GroupInServiceCapacity\n
\n GroupPendingCapacity\n
\n GroupStandbyCapacity\n
\n GroupTerminatingCapacity\n
\n GroupTotalCapacity\n
\n WarmPoolDesiredCapacity\n
\n WarmPoolWarmedCapacity\n
\n WarmPoolPendingCapacity\n
\n WarmPoolTerminatingCapacity\n
\n WarmPoolTotalCapacity\n
\n GroupAndWarmPoolDesiredCapacity\n
\n GroupAndWarmPoolTotalCapacity\n
If you omit this property, all metrics are disabled.
\nFor more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.
" } } } @@ -3487,7 +3487,7 @@ "VolumeType": { "target": "com.amazonaws.autoscaling#BlockDeviceEbsVolumeType", "traits": { - "smithy.api#documentation": "The volume type. For more information, see Amazon EBS volume types in the\n Amazon EC2 User Guide for Linux Instances.
\nValid Values: standard | io1 | gp2 |\n st1 | sc1 | gp3\n
The volume type. For more information, see Amazon EBS volume types in the\n Amazon EC2 User Guide for Linux Instances.
\nValid values: standard | io1 | gp2 |\n st1 | sc1 | gp3\n
The number of input/output (I/O) operations per second (IOPS) to provision for the\n volume. For gp3 and io1 volumes, this represents the number of\n IOPS that are provisioned for the volume. For gp2 volumes, this represents\n the baseline performance of the volume and the rate at which the volume accumulates I/O\n credits for bursting.
The following are the supported values for each volume type:
\n\n gp3: 3,000-16,000 IOPS
\n io1: 100-64,000 IOPS
For io1 volumes, we guarantee 64,000 IOPS only for Instances\n built on the Nitro System. Other instance families guarantee performance up\n to 32,000 IOPS.
\n Iops is supported when the volume type is gp3 or\n io1 and required only when the volume type is io1. (Not\n used with standard, gp2, st1, or sc1\n volumes.)
The number of input/output (I/O) operations per second (IOPS) to provision for the\n volume. For gp3 and io1 volumes, this represents the number of\n IOPS that are provisioned for the volume. For gp2 volumes, this represents\n the baseline performance of the volume and the rate at which the volume accumulates I/O\n credits for bursting.
The following are the supported values for each volume type:
\n\n gp3: 3,000-16,000 IOPS
\n io1: 100-64,000 IOPS
For io1 volumes, we guarantee 64,000 IOPS only for Instances\n built on the Nitro System. Other instance families guarantee performance up\n to 32,000 IOPS.
\n Iops is supported when the volume type is gp3 or\n io1 and required only when the volume type is io1. (Not\n used with standard, gp2, st1, or sc1\n volumes.)
Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be\n attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. If your AMI uses encrypted volumes, you can also\n only launch it on supported instance types.
\nIf you are creating a volume from a snapshot, you cannot create an unencrypted\n volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using\n a launch configuration.
\nIf you enable encryption by default, the EBS volumes that you create are always\n encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key,\n regardless of whether the snapshot was encrypted.
\nFor more information, see Using Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the\n Amazon EC2 Auto Scaling User Guide.
\nSpecifies whether the volume should be encrypted. Encrypted EBS volumes can only be\n attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. If your AMI uses encrypted volumes, you can also\n only launch it on supported instance types.
\nIf you are creating a volume from a snapshot, you cannot create an unencrypted\n volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using\n a launch configuration.
\nIf you enable encryption by default, the EBS volumes that you create are always\n encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key,\n regardless of whether the snapshot was encrypted.
\nFor more information, see Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the\n Amazon EC2 Auto Scaling User Guide.
\nEnables group metrics for the specified Auto Scaling group. For more information, see Monitoring CloudWatch metrics for your Auto Scaling groups and instances in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Enables group metrics collection for the specified Auto Scaling group.
\nYou can use these metrics to track changes in an Auto Scaling group and to set alarms on\n threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch\n console. For more information, see Monitor\n CloudWatch metrics for your Auto Scaling groups and instances in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#EnableMetricsCollectionQuery": { @@ -3555,13 +3555,13 @@ "Metrics": { "target": "com.amazonaws.autoscaling#Metrics", "traits": { - "smithy.api#documentation": "Specifies which group-level metrics to start collecting. You can specify one or more\n of the following metrics:
\n\n GroupMinSize\n
\n GroupMaxSize\n
\n GroupDesiredCapacity\n
\n GroupInServiceInstances\n
\n GroupPendingInstances\n
\n GroupStandbyInstances\n
\n GroupTerminatingInstances\n
\n GroupTotalInstances\n
The instance weighting feature supports the following additional metrics:
\n\n GroupInServiceCapacity\n
\n GroupPendingCapacity\n
\n GroupStandbyCapacity\n
\n GroupTerminatingCapacity\n
\n GroupTotalCapacity\n
The warm pools feature supports the following additional metrics:
\n\n WarmPoolDesiredCapacity\n
\n WarmPoolWarmedCapacity\n
\n WarmPoolPendingCapacity\n
\n WarmPoolTerminatingCapacity\n
\n WarmPoolTotalCapacity\n
\n GroupAndWarmPoolDesiredCapacity\n
\n GroupAndWarmPoolTotalCapacity\n
If you omit this parameter, all metrics are enabled.
" + "smithy.api#documentation": "Identifies the metrics to enable.
\nYou can specify one or more of the following metrics:
\n\n GroupMinSize\n
\n GroupMaxSize\n
\n GroupDesiredCapacity\n
\n GroupInServiceInstances\n
\n GroupPendingInstances\n
\n GroupStandbyInstances\n
\n GroupTerminatingInstances\n
\n GroupTotalInstances\n
\n GroupInServiceCapacity\n
\n GroupPendingCapacity\n
\n GroupStandbyCapacity\n
\n GroupTerminatingCapacity\n
\n GroupTotalCapacity\n
\n WarmPoolDesiredCapacity\n
\n WarmPoolWarmedCapacity\n
\n WarmPoolPendingCapacity\n
\n WarmPoolTerminatingCapacity\n
\n WarmPoolTotalCapacity\n
\n GroupAndWarmPoolDesiredCapacity\n
\n GroupAndWarmPoolTotalCapacity\n
If you specify Granularity and don't specify any metrics, all metrics are\n enabled.
For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.
" } }, "Granularity": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The granularity to associate with the metrics to collect. The only valid value is\n 1Minute.
The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is\n 1Minute.
One of the following metrics:
\n\n GroupMinSize\n
\n GroupMaxSize\n
\n GroupDesiredCapacity\n
\n GroupInServiceInstances\n
\n GroupPendingInstances\n
\n GroupStandbyInstances\n
\n GroupTerminatingInstances\n
\n GroupTotalInstances\n
\n GroupInServiceCapacity\n
\n GroupPendingCapacity\n
\n GroupStandbyCapacity\n
\n GroupTerminatingCapacity\n
\n GroupTotalCapacity\n
\n WarmPoolDesiredCapacity\n
\n WarmPoolWarmedCapacity\n
\n WarmPoolPendingCapacity\n
\n WarmPoolTerminatingCapacity\n
\n WarmPoolTotalCapacity\n
\n GroupAndWarmPoolDesiredCapacity\n
\n GroupAndWarmPoolTotalCapacity\n
One of the following metrics:
\n\n GroupMinSize\n
\n GroupMaxSize\n
\n GroupDesiredCapacity\n
\n GroupInServiceInstances\n
\n GroupPendingInstances\n
\n GroupStandbyInstances\n
\n GroupTerminatingInstances\n
\n GroupTotalInstances\n
\n GroupInServiceCapacity\n
\n GroupPendingCapacity\n
\n GroupStandbyCapacity\n
\n GroupTerminatingCapacity\n
\n GroupTotalCapacity\n
\n WarmPoolDesiredCapacity\n
\n WarmPoolWarmedCapacity\n
\n WarmPoolPendingCapacity\n
\n WarmPoolTerminatingCapacity\n
\n WarmPoolTotalCapacity\n
\n GroupAndWarmPoolDesiredCapacity\n
\n GroupAndWarmPoolTotalCapacity\n
For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.
" } }, "Granularity": { @@ -3584,7 +3584,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes an enabled metric.
" + "smithy.api#documentation": "Describes an enabled Auto Scaling group metric.
" } }, "com.amazonaws.autoscaling#EnabledMetrics": { @@ -3826,7 +3826,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes a filter that is used to return a more specific list of results from a\n describe operation.
\nIf you specify multiple filters, the filters are automatically logically joined with\n an AND, and the request returns only the results that match all of the\n specified filters.
For more information, see Tagging Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Describes a filter that is used to return a more specific list of results from a\n describe operation.
\nIf you specify multiple filters, the filters are automatically logically joined with\n an AND, and the request returns only the results that match all of the\n specified filters.
For more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#Filters": { @@ -4362,13 +4362,13 @@ "SpotMaxPricePercentageOverLowestPrice": { "target": "com.amazonaws.autoscaling#NullablePositiveInteger", "traits": { - "smithy.api#documentation": "The price protection threshold for Spot Instances. This is the maximum you’ll pay for\n a Spot Instance, expressed as a percentage higher than the cheapest M, C, or R instance\n type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your\n attributes, we will exclude instance types whose price is higher than your threshold.\n The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off\n price protection, specify a high value, such as 999999.
If you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is applied based on the per\n vCPU or per memory price instead of the per instance price.
Default: 100\n
The price protection threshold for Spot Instances. This is the maximum you’ll pay for\n a Spot Instance, expressed as a percentage higher than the least expensive current\n generation M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling\n selects instance types with your attributes, we will exclude instance types whose price\n is higher than your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling\n interprets as a percentage. To turn off price protection, specify a high value, such as\n 999999.
If you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is applied based on the per\n vCPU or per memory price instead of the per instance price.
Default: 100\n
The price protection threshold for On-Demand Instances. This is the maximum you’ll pay\n for an On-Demand Instance, expressed as a percentage higher than the cheapest M, C, or R\n instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with\n your attributes, we will exclude instance types whose price is higher than your\n threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.\n To turn off price protection, specify a high value, such as 999999.
If you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is applied based on the per\n vCPU or per memory price instead of the per instance price.
Default: 20\n
The price protection threshold for On-Demand Instances. This is the maximum you’ll pay\n for an On-Demand Instance, expressed as a percentage higher than the least expensive\n current generation M, C, or R instance type with your specified attributes. When\n Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types\n whose price is higher than your threshold. The parameter accepts an integer, which\n Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value,\n such as 999999.
If you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is applied based on the per\n vCPU or per memory price instead of the per instance price.
Default: 20\n
Indicates the type of local storage that is required.
\nFor instance types with hard disk drive (HDD) storage, specify\n hdd.
For instance types with solid state drive (SSD) storage, specify\n sdd.
Default: Any local storage type
" + "smithy.api#documentation": "Indicates the type of local storage that is required.
\nFor instance types with hard disk drive (HDD) storage, specify\n hdd.
For instance types with solid state drive (SSD) storage, specify\n ssd.
Default: Any local storage type
" } }, "TotalLocalStorageGB": { @@ -4480,7 +4480,7 @@ "OnDemandAllocationStrategy": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { - "smithy.api#documentation": "The order of the launch template overrides to use in fulfilling On-Demand capacity.
\nIf you specify lowest-price, Amazon EC2 Auto Scaling uses price to determine the order,\n launching the lowest price first.
If you specify prioritized, Amazon EC2 Auto Scaling uses the priority that you assigned\n to each launch template override, launching the highest priority first. If all your\n On-Demand capacity cannot be fulfilled using your highest priority instance, then\n Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so\n on.
Default: lowest-price for Auto Scaling groups that specify InstanceRequirements in the overrides and prioritized for\n Auto Scaling groups that don't.
The order of the launch template overrides to use in fulfilling On-Demand capacity.
\nIf you specify lowest-price, Amazon EC2 Auto Scaling uses price to determine the order,\n launching the lowest price first.
If you specify prioritized, Amazon EC2 Auto Scaling uses the priority that you assigned\n to each launch template override, launching the highest priority first. If all your\n On-Demand capacity cannot be fulfilled using your highest priority instance, then\n Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so\n on.
Default: lowest-price for Auto Scaling groups that specify InstanceRequirements in the overrides and prioritized for\n Auto Scaling groups that don't.
Valid values: lowest-price | prioritized\n
Indicates how to allocate instances across Spot Instance pools.
\nIf the allocation strategy is lowest-price, the Auto Scaling group launches\n instances using the Spot pools with the lowest price, and evenly allocates your\n instances across the number of Spot pools that you specify.
If the allocation strategy is capacity-optimized (recommended), the Auto Scaling\n group launches instances using Spot pools that are optimally chosen based on the\n available Spot capacity. Alternatively, you can use\n capacity-optimized-prioritized and set the order of instance types in\n the list of launch template overrides from highest to lowest priority (from first to\n last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best-effort basis\n but optimizes for capacity first.
Default: lowest-price\n
Indicates how to allocate instances across Spot Instance pools.
\nIf the allocation strategy is lowest-price, the Auto Scaling group launches\n instances using the Spot pools with the lowest price, and evenly allocates your\n instances across the number of Spot pools that you specify.
If the allocation strategy is capacity-optimized (recommended), the Auto Scaling\n group launches instances using Spot pools that are optimally chosen based on the\n available Spot capacity. Alternatively, you can use\n capacity-optimized-prioritized and set the order of instance types in\n the list of launch template overrides from highest to lowest priority (from first to\n last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best-effort basis\n but optimizes for capacity first.
Default: lowest-price\n
Valid values: lowest-price | capacity-optimized |\n capacity-optimized-prioritized\n
The maximum price per unit hour that you are willing to pay for a Spot Instance. If\n you keep the value at its default (unspecified), Amazon EC2 Auto Scaling uses the On-Demand price as\n the maximum Spot price. To remove a value that you previously set, include the property\n but specify an empty string (\"\") for the value.
" + "smithy.api#documentation": "The maximum price per unit hour that you are willing to pay for a Spot Instance. If\n you keep the value at its default (unspecified), Amazon EC2 Auto Scaling uses the On-Demand price as\n the maximum Spot price. To remove a value that you previously set, include the property\n but specify an empty string (\"\") for the value.
\nIf your maximum price is lower than the Spot price for the instance types that you\n selected, your Spot Instances are not launched.
\nValid Range: Minimum value of 0.001
" } } }, @@ -4576,7 +4576,7 @@ "ImageId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more\n information, see Finding an AMI in the\n Amazon EC2 User Guide for Linux Instances.
", + "smithy.api#documentation": "The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more\n information, see Find a Linux AMI in the\n Amazon EC2 User Guide for Linux Instances.
", "smithy.api#required": {} } }, @@ -4595,13 +4595,13 @@ "ClassicLinkVPCId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "\n EC2-Classic retires on August 15, 2022. This parameter is not supported after\n that date.\n
\nThe ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.
" + "smithy.api#documentation": "\n EC2-Classic retires on August 15, 2022. This property is not supported after\n that date.\n
\nThe ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.
" } }, "ClassicLinkVPCSecurityGroups": { "target": "com.amazonaws.autoscaling#ClassicLinkVPCSecurityGroups", "traits": { - "smithy.api#documentation": "\n EC2-Classic retires on August 15, 2022. This parameter is not supported after\n that date.\n
\nThe IDs of one or more security groups for the VPC specified in\n ClassicLinkVPCId.
\n EC2-Classic retires on August 15, 2022. This property is not supported after\n that date.\n
\nThe IDs of one or more security groups for the VPC specified in\n ClassicLinkVPCId.
The instance type for the instances.
\nFor information about available instance types, see Available\n Instance Types in the Amazon EC2 User Guide for Linux Instances.
", + "smithy.api#documentation": "The instance type for the instances. For information about available instance types,\n see Available\n instance types in the Amazon EC2 User Guide for Linux Instances.
", "smithy.api#required": {} } }, @@ -4632,7 +4632,7 @@ "BlockDeviceMappings": { "target": "com.amazonaws.autoscaling#BlockDeviceMappings", "traits": { - "smithy.api#documentation": "A block device mapping, which specifies the block devices for the instance. For more\n information, see Block Device\n Mapping in the Amazon EC2 User Guide for Linux Instances.
" + "smithy.api#documentation": "The block device mapping entries that define the block devices to attach to the\n instances at launch. By default, the block devices specified in the block device mapping\n for the AMI are used. For more information, see Block Device\n Mapping in the Amazon EC2 User Guide for Linux Instances.
" } }, "InstanceMonitoring": { @@ -4669,7 +4669,7 @@ "AssociatePublicIpAddress": { "target": "com.amazonaws.autoscaling#AssociatePublicIpAddress", "traits": { - "smithy.api#documentation": "For Auto Scaling groups that are running in a VPC, specifies whether to assign a public IP\n address to the group's instances. For more information, see Launching Auto Scaling instances in a\n VPC in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Specifies whether to assign a public IPv4 address to the group's instances. If the\n instance is launched into a default subnet, the default is to assign a public IPv4\n address, unless you disabled the option to assign a public IPv4 address on the subnet.\n If the instance is launched into a nondefault subnet, the default is not to assign a\n public IPv4 address, unless you enabled the option to assign a public IPv4 address on\n the subnet. For more information, see Launching Auto Scaling instances in a\n VPC in the Amazon EC2 Auto Scaling User Guide.
" } }, "PlacementTenancy": { @@ -4713,7 +4713,7 @@ "LaunchConfigurationNames": { "target": "com.amazonaws.autoscaling#LaunchConfigurationNames", "traits": { - "smithy.api#documentation": "The launch configuration names. If you omit this parameter, all launch configurations\n are described.
\nArray Members: Maximum number of 50 items.
" + "smithy.api#documentation": "The launch configuration names. If you omit this property, all launch configurations\n are described.
\nArray Members: Maximum number of 50 items.
" } }, "NextToken": { @@ -4872,13 +4872,13 @@ "LifecycleTransition": { "target": "com.amazonaws.autoscaling#LifecycleTransition", "traits": { - "smithy.api#documentation": "The state of the EC2 instance to which to attach the lifecycle hook. The following are\n possible values:
\nautoscaling:EC2_INSTANCE_LAUNCHING
\nautoscaling:EC2_INSTANCE_TERMINATING
\nThe lifecycle transition.
\nValid values: autoscaling:EC2_INSTANCE_LAUNCHING |\n autoscaling:EC2_INSTANCE_TERMINATING\n
The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the\n transition state for the lifecycle hook. The notification target can be either an SQS\n queue or an SNS topic.
" + "smithy.api#documentation": "The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a\n wait state for the lifecycle hook.
" } }, "RoleARN": { @@ -4896,7 +4896,7 @@ "HeartbeatTimeout": { "target": "com.amazonaws.autoscaling#HeartbeatTimeout", "traits": { - "smithy.api#documentation": "The maximum time, in seconds, that can elapse before the lifecycle hook times out. If\n the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the\n DefaultResult parameter.
The maximum time, in seconds, that can elapse before the lifecycle hook times out. If\n the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the\n DefaultResult property.
Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses\n or if an unexpected failure occurs. The possible values are CONTINUE and\n ABANDON.
The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an\n unexpected failure occurs.
\nValid values: CONTINUE | ABANDON\n
The state of the EC2 instance to which you want to attach the lifecycle hook. The\n valid values are:
\nautoscaling:EC2_INSTANCE_LAUNCHING
\nautoscaling:EC2_INSTANCE_TERMINATING
\nThe lifecycle transition. For Auto Scaling groups, there are two major lifecycle\n transitions.
\nTo create a lifecycle hook for scale-out events, specify\n autoscaling:EC2_INSTANCE_LAUNCHING.
To create a lifecycle hook for scale-in events, specify\n autoscaling:EC2_INSTANCE_TERMINATING.
The maximum time, in seconds, that can elapse before the lifecycle hook times\n out.
\nIf the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in\n the DefaultResult parameter. You can prevent the lifecycle hook from timing\n out by calling RecordLifecycleActionHeartbeat.
The maximum time, in seconds, that can elapse before the lifecycle hook times out. The\n range is from 30 to 7200 seconds. The default value is\n 3600 seconds (1 hour).
Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses\n or if an unexpected failure occurs. The valid values are CONTINUE and\n ABANDON. The default value is ABANDON.
The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an\n unexpected failure occurs. The default value is ABANDON.
Valid values: CONTINUE | ABANDON\n
The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the\n transition state for the lifecycle hook. The notification target can be either an SQS\n queue or an SNS topic.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends\n notifications to when an instance is in a wait state for the lifecycle hook. You can\n specify an Amazon SNS topic or an Amazon SQS queue.
" } }, "RoleARN": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target.
\nValid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required\n for new lifecycle hooks, but optional when updating existing hooks.
" + "smithy.api#documentation": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target. For information about creating this role, see Configure a notification target for a lifecycle hook in the\n Amazon EC2 Auto Scaling User Guide.
\nValid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.
" } } }, @@ -5595,13 +5595,13 @@ "LaunchTemplate": { "target": "com.amazonaws.autoscaling#LaunchTemplate", "traits": { - "smithy.api#documentation": "Specifies the launch template to use and the instance types (overrides) that are used\n to launch EC2 instances to fulfill On-Demand and Spot capacities. Required when creating\n a mixed instances policy.
" + "smithy.api#documentation": "One or more launch templates and the instance types (overrides) that are used to\n launch EC2 instances to fulfill On-Demand and Spot capacities.
" } }, "InstancesDistribution": { "target": "com.amazonaws.autoscaling#InstancesDistribution", "traits": { - "smithy.api#documentation": "Specifies the instances distribution.
" + "smithy.api#documentation": "The instances distribution.
" } } }, @@ -6254,7 +6254,7 @@ "LifecycleTransition": { "target": "com.amazonaws.autoscaling#LifecycleTransition", "traits": { - "smithy.api#documentation": "The instance state to which you want to attach the lifecycle hook. The valid values\n are:
\nautoscaling:EC2_INSTANCE_LAUNCHING
\nautoscaling:EC2_INSTANCE_TERMINATING
\nRequired for new lifecycle hooks, but optional when updating existing hooks.
" + "smithy.api#documentation": "The lifecycle transition. For Auto Scaling groups, there are two major lifecycle\n transitions.
\nTo create a lifecycle hook for scale-out events, specify\n autoscaling:EC2_INSTANCE_LAUNCHING.
To create a lifecycle hook for scale-in events, specify\n autoscaling:EC2_INSTANCE_TERMINATING.
Required for new lifecycle hooks, but optional when updating existing hooks.
" } }, "RoleARN": { @@ -6266,7 +6266,7 @@ "NotificationTargetARN": { "target": "com.amazonaws.autoscaling#NotificationTargetResourceName", "traits": { - "smithy.api#documentation": "The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance\n is in the transition state for the lifecycle hook. This target can be either an SQS\n queue or an SNS topic.
\nIf you specify an empty string, this overrides the current ARN.
\nThis operation uses the JSON format when sending notifications to an Amazon SQS queue, and\n an email key-value pair format when sending notifications to an Amazon SNS topic.
\nWhen you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test\n messages contain the following additional key-value pair: \"Event\":\n \"autoscaling:TEST_NOTIFICATION\".
The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify\n you when an instance is in a wait state for the lifecycle hook. You can specify either\n an Amazon SNS topic or an Amazon SQS queue.
\nIf you specify an empty string, this overrides the current ARN.
\nThis operation uses the JSON format when sending notifications to an Amazon SQS queue, and\n an email key-value pair format when sending notifications to an Amazon SNS topic.
\nWhen you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test\n messages contain the following additional key-value pair: \"Event\":\n \"autoscaling:TEST_NOTIFICATION\".
The maximum time, in seconds, that can elapse before the lifecycle hook times out. The\n range is from 30 to 7200 seconds. The default value is\n 3600 seconds (1 hour).
If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in\n the DefaultResult parameter. You can prevent the lifecycle hook from timing\n out by calling the RecordLifecycleActionHeartbeat API.
The maximum time, in seconds, that can elapse before the lifecycle hook times out. The\n range is from 30 to 7200 seconds. The default value is\n 3600 seconds (1 hour).
Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses\n or if an unexpected failure occurs. This parameter can be either CONTINUE\n or ABANDON. The default value is ABANDON.
The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an\n unexpected failure occurs. The default value is ABANDON.
Valid values: CONTINUE | ABANDON\n
A target tracking scaling policy. Provides support for predefined or custom\n metrics.
\nThe following predefined metrics are available:
\n\n ASGAverageCPUUtilization\n
\n ASGAverageNetworkIn\n
\n ASGAverageNetworkOut\n
\n ALBRequestCountPerTarget\n
If you specify ALBRequestCountPerTarget for the metric, you must specify\n the ResourceLabel parameter with the\n PredefinedMetricSpecification.
For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API\n Reference.
\nRequired if the policy type is TargetTrackingScaling.
A target tracking scaling policy. Provides support for predefined or custom\n metrics.
\nThe following predefined metrics are available:
\n\n ASGAverageCPUUtilization\n
\n ASGAverageNetworkIn\n
\n ASGAverageNetworkOut\n
\n ALBRequestCountPerTarget\n
If you specify ALBRequestCountPerTarget for the metric, you must specify\n the ResourceLabel property with the\n PredefinedMetricSpecification.
For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API\n Reference.
\nRequired if the policy type is TargetTrackingScaling.
Creates or updates a scheduled scaling action for an Auto Scaling group.
\nFor more information, see Scheduled scaling in the\n Amazon EC2 Auto Scaling User Guide.
\nYou can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a\n scheduled action, you can delete it by calling the DeleteScheduledAction API.
" + "smithy.api#documentation": "Creates or updates a scheduled scaling action for an Auto Scaling group.
\nFor more information, see Scheduled scaling in the\n Amazon EC2 Auto Scaling User Guide.
\nYou can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a\n scheduled action, you can delete it by calling the DeleteScheduledAction API.
\nIf you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error\n message.
" } }, "com.amazonaws.autoscaling#PutScheduledUpdateGroupActionType": { @@ -6495,19 +6495,19 @@ "Time": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "This parameter is no longer used.
" + "smithy.api#documentation": "This property is no longer used.
" } }, "StartTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT\n only and in quotes (for example, \"2019-06-01T00:00:00Z\").
If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs\n the action at this time, and then performs the action based on the specified\n recurrence.
If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error\n message.
" + "smithy.api#documentation": "The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT\n only and in quotes (for example, \"2021-06-01T00:00:00Z\").
If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs\n the action at this time, and then performs the action based on the specified\n recurrence.
The date and time for the recurring schedule to end, in UTC.
" + "smithy.api#documentation": "The date and time for the recurring schedule to end, in UTC. For example,\n \"2021-06-01T00:00:00Z\".
The desired capacity is the initial capacity of the Auto Scaling group after the scheduled\n action runs and the capacity it attempts to maintain. It can scale beyond this capacity\n if you add more scaling conditions.
" + "smithy.api#documentation": "The desired capacity is the initial capacity of the Auto Scaling group after the scheduled\n action runs and the capacity it attempts to maintain. It can scale beyond this capacity\n if you add more scaling conditions.
\nYou must specify at least one of the following properties: MaxSize,\n MinSize, or DesiredCapacity.
One or more of the following processes:
\n\n Launch\n
\n Terminate\n
\n AddToLoadBalancer\n
\n AlarmNotification\n
\n AZRebalance\n
\n HealthCheck\n
\n InstanceRefresh\n
\n ReplaceUnhealthy\n
\n ScheduledActions\n
If you omit this parameter, all processes are specified.
" + "smithy.api#documentation": "One or more of the following processes:
\n\n Launch\n
\n Terminate\n
\n AddToLoadBalancer\n
\n AlarmNotification\n
\n AZRebalance\n
\n HealthCheck\n
\n InstanceRefresh\n
\n ReplaceUnhealthy\n
\n ScheduledActions\n
If you omit this property, all processes are specified.
" } } } @@ -7050,7 +7050,7 @@ "Time": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "This parameter is no longer used.
" + "smithy.api#documentation": "This property is no longer used.
" } }, "StartTime": { @@ -7444,7 +7444,7 @@ "ScalingAdjustment": { "target": "com.amazonaws.autoscaling#PolicyIncrement", "traits": { - "smithy.api#documentation": "The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current\n capacity.
", + "smithy.api#documentation": "The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current\n capacity.
\nThe amount by which to scale. The adjustment is based on the value that you specified\n in the AdjustmentType property (either an absolute number or a percentage).\n A positive value adds to the current capacity and a negative number subtracts from the\n current capacity.
\n We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n
\nUpdates the configuration for the specified Auto Scaling group.
\nTo update an Auto Scaling group, specify the name of the group and the parameter that you want\n to change. Any parameters that you don't specify are not changed by this update request.\n The new settings take effect on any scaling activities after this call returns.\n
\nIf you associate a new launch configuration or template with an Auto Scaling group, all new\n instances will get the updated configuration. Existing instances continue to run with\n the configuration that they were originally launched with. When you update a group to\n specify a mixed instances policy instead of a launch configuration or template, existing\n instances may be replaced to match the new purchasing options that you specified in the\n policy. For example, if the group currently has 100% On-Demand capacity and the policy\n specifies 50% Spot capacity, this means that half of your instances will be gradually\n terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches\n new instances before terminating the old ones, so that updating your group does not\n compromise the performance or availability of your application.
\nNote the following about changing DesiredCapacity, MaxSize,\n or MinSize:
If a scale-in activity occurs as a result of a new\n DesiredCapacity value that is lower than the current size of\n the group, the Auto Scaling group uses its termination policy to determine which\n instances to terminate.
If you specify a new value for MinSize without specifying a value\n for DesiredCapacity, and the new MinSize is larger\n than the current size of the group, this sets the group's\n DesiredCapacity to the new MinSize value.
If you specify a new value for MaxSize without specifying a value\n for DesiredCapacity, and the new MaxSize is smaller\n than the current size of the group, this sets the group's\n DesiredCapacity to the new MaxSize value.
To see which parameters have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling\n group, call the DescribePolicies API. If the group has scaling\n policies, you can update them by calling the PutScalingPolicy\n API.
" + "smithy.api#documentation": "\n We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n
\nUpdates the configuration for the specified Auto Scaling group.
\nTo update an Auto Scaling group, specify the name of the group and the property that you want\n to change. Any properties that you don't specify are not changed by this update request.\n The new settings take effect on any scaling activities after this call returns.\n
\nIf you associate a new launch configuration or template with an Auto Scaling group, all new\n instances will get the updated configuration. Existing instances continue to run with\n the configuration that they were originally launched with. When you update a group to\n specify a mixed instances policy instead of a launch configuration or template, existing\n instances may be replaced to match the new purchasing options that you specified in the\n policy. For example, if the group currently has 100% On-Demand capacity and the policy\n specifies 50% Spot capacity, this means that half of your instances will be gradually\n terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches\n new instances before terminating the old ones, so that updating your group does not\n compromise the performance or availability of your application.
\nNote the following about changing DesiredCapacity, MaxSize,\n or MinSize:
If a scale-in activity occurs as a result of a new\n DesiredCapacity value that is lower than the current size of\n the group, the Auto Scaling group uses its termination policy to determine which\n instances to terminate.
If you specify a new value for MinSize without specifying a value\n for DesiredCapacity, and the new MinSize is larger\n than the current size of the group, this sets the group's\n DesiredCapacity to the new MinSize value.
If you specify a new value for MaxSize without specifying a value\n for DesiredCapacity, and the new MaxSize is smaller\n than the current size of the group, this sets the group's\n DesiredCapacity to the new MaxSize value.
To see which properties have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling\n group, call the DescribePolicies API. If the group has scaling\n policies, you can update them by calling the PutScalingPolicy\n API.
" } }, "com.amazonaws.autoscaling#UpdateAutoScalingGroupType": { @@ -7840,13 +7840,13 @@ "VPCZoneIdentifier": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen2047", "traits": { - "smithy.api#documentation": "A comma-separated list of subnet IDs for a virtual private cloud (VPC). If you specify\n VPCZoneIdentifier with AvailabilityZones, the subnets that\n you specify for this parameter must reside in those Availability Zones.
A comma-separated list of subnet IDs for a virtual private cloud (VPC). If you specify\n VPCZoneIdentifier with AvailabilityZones, the subnets that\n you specify must reside in those Availability Zones.
A policy or a list of policies that are used to select the instances to terminate. The\n policies are executed in the order that you list them. For more information, see Controlling which Auto Scaling instances terminate during scale in in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "A policy or a list of policies that are used to select the instances to terminate. The\n policies are executed in the order that you list them. For more information, see Work with\n Amazon EC2 Auto Scaling termination policies in the\n Amazon EC2 Auto Scaling User Guide.
\nValid values: Default | AllocationStrategy |\n ClosestToNextInstanceHour | NewestInstance |\n OldestInstance | OldestLaunchConfiguration |\n OldestLaunchTemplate |\n arn:aws:lambda:region:account-id:function:my-function:my-alias\n
Enables or disables Capacity Rebalancing. For more information, see Amazon EC2 Auto Scaling\n Capacity Rebalancing in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Enables or disables Capacity Rebalancing. For more information, see Use Capacity\n Rebalancing to handle Amazon EC2 Spot Interruptions in the Amazon EC2 Auto Scaling User Guide.
" } }, "Context": { diff --git a/codegen/sdk/aws-models/chime.json b/codegen/sdk/aws-models/chime.json index 830e5103ca3..abcb2b00de9 100644 --- a/codegen/sdk/aws-models/chime.json +++ b/codegen/sdk/aws-models/chime.json @@ -184,6 +184,74 @@ ] } }, + "com.amazonaws.chime#Address": { + "type": "structure", + "members": { + "streetName": { + "target": "com.amazonaws.chime#SensitiveNonEmptyString", + "traits": { + "smithy.api#documentation": "The address street, such as 8th Avenue.
The address suffix, such as the N in 8th Avenue N.
An address suffix location, such as the S. Unit A in Central Park S. Unit A.
An address prefix location, such as the N in N. Third St..
The numeric portion of an address.
" + } + }, + "city": { + "target": "com.amazonaws.chime#SensitiveNonEmptyString", + "traits": { + "smithy.api#documentation": "The city of an address.
" + } + }, + "state": { + "target": "com.amazonaws.chime#SensitiveNonEmptyString", + "traits": { + "smithy.api#documentation": "The state of an address.
" + } + }, + "postalCode": { + "target": "com.amazonaws.chime#SensitiveNonEmptyString", + "traits": { + "smithy.api#documentation": "The postal code of an address.
" + } + }, + "postalCodePlus4": { + "target": "com.amazonaws.chime#SensitiveNonEmptyString", + "traits": { + "smithy.api#documentation": "The Zip + 4 or postal code + 4 of an address.
" + } + }, + "country": { + "target": "com.amazonaws.chime#SensitiveNonEmptyString", + "traits": { + "smithy.api#documentation": "The country of an address.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A validated address.
" + } + }, "com.amazonaws.chime#AlexaForBusinessMetadata": { "type": "structure", "members": { @@ -1748,6 +1816,65 @@ "target": "com.amazonaws.chime#CallingRegion" } }, + "com.amazonaws.chime#CandidateAddress": { + "type": "structure", + "members": { + "streetInfo": { + "target": "com.amazonaws.chime#SensitiveNonEmptyString", + "traits": { + "smithy.api#documentation": "The street information of a candidate address
" + } + }, + "streetNumber": { + "target": "com.amazonaws.chime#SensitiveNonEmptyString", + "traits": { + "smithy.api#documentation": "The numeric portion of a candidate address.
" + } + }, + "city": { + "target": "com.amazonaws.chime#SensitiveNonEmptyString", + "traits": { + "smithy.api#documentation": "The city of a candidate address.
" + } + }, + "state": { + "target": "com.amazonaws.chime#SensitiveNonEmptyString", + "traits": { + "smithy.api#documentation": "The state of a candidate address.
" + } + }, + "postalCode": { + "target": "com.amazonaws.chime#SensitiveNonEmptyString", + "traits": { + "smithy.api#documentation": "The postal code of a candidate address.
" + } + }, + "postalCodePlus4": { + "target": "com.amazonaws.chime#SensitiveNonEmptyString", + "traits": { + "smithy.api#documentation": "The Zip + 4 or postal code + 4 of a candidate address.
" + } + }, + "country": { + "target": "com.amazonaws.chime#SensitiveNonEmptyString", + "traits": { + "smithy.api#documentation": "The country of a candidate address.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A suggested address.
" + } + }, + "com.amazonaws.chime#CandidateAddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.chime#CandidateAddress", + "traits": { + "smithy.api#xmlName": "CandidateAddress" + } + } + }, "com.amazonaws.chime#Capability": { "type": "string", "traits": { @@ -12555,13 +12682,13 @@ "EnableSIPLogs": { "target": "com.amazonaws.chime#Boolean", "traits": { - "smithy.api#documentation": "Boolean that enables SIP message logs to CloudWatch logs.
" + "smithy.api#documentation": "When true, enables SIP message logs for sending to Amazon CloudWatch Logs.
" } }, "EnableMediaMetricLogs": { "target": "com.amazonaws.chime#Boolean", "traits": { - "smithy.api#documentation": "Boolean that enables logging of detailed media metrics for Voice Connectors to CloudWatch logs.
" + "smithy.api#documentation": "Boolean that enables the logging of Voice Connector metrics to Cloudwatch.
" } } }, @@ -14696,7 +14823,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming\n configuration specifies whether media streaming is enabled for sending to Indonesians.\n It also sets the retention period, in hours, for the Amazon Kinesis data.
", + "smithy.api#documentation": "Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming\n configuration specifies whether media streaming is enabled for sending to Kinesis.\n It also sets the retention period, in hours, for the Amazon Kinesis data.
", "smithy.api#http": { "method": "PUT", "uri": "/voice-connectors/{VoiceConnectorId}/streaming-configuration", @@ -15783,6 +15910,13 @@ } } }, + "com.amazonaws.chime#SensitiveNonEmptyString": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\S", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.chime#SensitiveString": { "type": "string", "traits": { @@ -17603,6 +17737,9 @@ }, { "target": "com.amazonaws.chime#UpdateVoiceConnectorGroup" + }, + { + "target": "com.amazonaws.chime#ValidateE911Address" } ] }, @@ -19745,6 +19882,138 @@ ] } }, + "com.amazonaws.chime#ValidateE911Address": { + "type": "operation", + "input": { + "target": "com.amazonaws.chime#ValidateE911AddressRequest" + }, + "output": { + "target": "com.amazonaws.chime#ValidateE911AddressResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chime#BadRequestException" + }, + { + "target": "com.amazonaws.chime#ForbiddenException" + }, + { + "target": "com.amazonaws.chime#NotFoundException" + }, + { + "target": "com.amazonaws.chime#ServiceFailureException" + }, + { + "target": "com.amazonaws.chime#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chime#ThrottledClientException" + }, + { + "target": "com.amazonaws.chime#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "Validates an address to be used for 911 calls made with Amazon \n Chime Voice Connectors. You can use validated addresses \n in a Presence Information Data Format Location Object file that you include in SIP requests.\n That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.
", + "smithy.api#http": { + "method": "POST", + "uri": "/emergency-calling/address", + "code": 202 + } + } + }, + "com.amazonaws.chime#ValidateE911AddressRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.chime#NonEmptyString", + "traits": { + "smithy.api#documentation": "The AWS account ID.
", + "smithy.api#required": {} + } + }, + "StreetNumber": { + "target": "com.amazonaws.chime#SensitiveNonEmptyString", + "traits": { + "smithy.api#documentation": "The address street number, such as 200 or 2121.
The address street information, such as 8th Avenue.
The address city, such as Portland.
The address state, such as ME.
The address country, such as US.
The address postal code, such as 04352.
Number indicating the result of address validation. \n 0 means the address was perfect as is and successfully validated.\n 1 means the address was corrected. 2 means the address sent was \n not close enough and was not validated.
The ID that represents the address.
" + } + }, + "Address": { + "target": "com.amazonaws.chime#Address", + "traits": { + "smithy.api#documentation": "The validated address.
" + } + }, + "CandidateAddressList": { + "target": "com.amazonaws.chime#CandidateAddressList", + "traits": { + "smithy.api#documentation": "The list of address suggestions.
" + } + } + } + }, + "com.amazonaws.chime#ValidationResult": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 2 + } + } + }, "com.amazonaws.chime#VideoArtifactsConfiguration": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/cloudwatch.json b/codegen/sdk/aws-models/cloudwatch.json index 51733b6f5c5..f7d974be62b 100644 --- a/codegen/sdk/aws-models/cloudwatch.json +++ b/codegen/sdk/aws-models/cloudwatch.json @@ -53,6 +53,34 @@ "smithy.api#box": {} } }, + "com.amazonaws.cloudwatch#ActionsSuppressedBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "WaitPeriod", + "name": "WaitPeriod" + }, + { + "value": "ExtensionPeriod", + "name": "ExtensionPeriod" + }, + { + "value": "Alarm", + "name": "Alarm" + } + ] + } + }, + "com.amazonaws.cloudwatch#ActionsSuppressedReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, "com.amazonaws.cloudwatch#AlarmArn": { "type": "string", "traits": { @@ -472,7 +500,7 @@ "StateUpdatedTimestamp": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { - "smithy.api#documentation": "The time stamp of the last update to the alarm state.
" + "smithy.api#documentation": "Tracks the timestamp of any state update, even if StateValue doesn't change.
The state value for the alarm.
" } + }, + "StateTransitionedTimestamp": { + "target": "com.amazonaws.cloudwatch#Timestamp", + "traits": { + "smithy.api#documentation": "\n\t\t\tThe timestamp \n\t\t\tof the last change \n\t\t\tto the alarm's StateValue.\n\t\t
\n\t\t\tWhen the value is ALARM, \n\t\t\tit means \n\t\t\tthat the actions are suppressed\n\t\t\tbecause the suppressor alarm is \n\t\t\tin ALARM\n\t\t\tWhen the value is WaitPeriod, \n\t\t\tit means that \n\t\t\tthe actions are suppressed \n\t\t\tbecause the composite alarm is waiting\n\t\t\tfor the suppressor alarm \n\t\t\tto go \n\t\t\tinto \n\t\t\tinto the ALARM state. \n\t\t\tThe maximum waiting time is as specified\n\t\t\tin ActionsSuppressorWaitPeriod. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t\tWhen the value is ExtensionPeriod,\n\t\t\tit means \n\t\t\tthat the actions are suppressed\n\t\t\tbecause the composite alarm is waiting \n\t\t\tafter the suppressor alarm went out\n\t\t\tof the ALARM state. \n\t\t\tThe maximum waiting time is as specified \n\t\t\tin ActionsSuppressorExtensionPeriod. \n\t\t\tAfter this time,\n\t\t\tthe composite alarm performs its actions.\n\t\t
\n\t\t\tCaptures the reason for action suppression.\n\t\t
" + } + }, + "ActionsSuppressor": { + "target": "com.amazonaws.cloudwatch#AlarmArn", + "traits": { + "smithy.api#documentation": "\n\t\t\tActions will be suppressed \n\t\t\tif the suppressor alarm is \n\t\t\tin the ALARM state. \n\t\t\tActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) \n\t\t\tfrom an existing alarm. \n\t\t
\n\t\t\tThe maximum time \n\t\t\tin seconds \n\t\t\tthat the composite alarm waits\n\t\t\tfor the suppressor alarm \n\t\t\tto go \n\t\t\tinto the ALARM state. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t
\n\t\t\t\t WaitPeriod \n\t\t\t\tis required only \n\t\t\t\twhen ActionsSuppressor is specified.\n\t\t\t
\n\t\t\tThe maximum time \n\t\t\tin seconds\n\t\t\tthat the composite alarm waits \n\t\t\tafter suppressor alarm goes out \n\t\t\tof the ALARM state. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t
\n\t\t\t\t ExtensionPeriod \n\t\t\t\tis required only \n\t\t\t\twhen ActionsSuppressor is specified.\n\t\t\t
A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.
\n\t\tTags can help you organize and categorize your\n\t\t\tresources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with\n\t\t\tcertain tag values.
" } + }, + "ActionsSuppressor": { + "target": "com.amazonaws.cloudwatch#AlarmArn", + "traits": { + "smithy.api#documentation": "\n\t\t\tActions will be suppressed \n\t\t\tif the suppressor alarm is \n\t\t\tin the ALARM state.\n\t\t\tActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) \n\t\t\tfrom an existing alarm.\n\t\t
\n\t\t\tThe maximum time \n\t\t\tin seconds \n\t\t\tthat the composite alarm waits\n\t\t\tfor the suppressor alarm \n\t\t\tto go \n\t\t\tinto the ALARM state. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t
\n\t\t\t\t WaitPeriod \n\t\t\t\tis required only \n\t\t\t\twhen ActionsSuppressor is specified.\n\t\t\t
\n\t\t\tThe maximum time \n\t\t\tin seconds\n\t\t\tthat the composite alarm waits \n\t\t\tafter suppressor alarm goes out \n\t\t\tof the ALARM state. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t
\n\t\t\t\t ExtensionPeriod \n\t\t\t\tis required only \n\t\t\t\twhen ActionsSuppressor is specified.\n\t\t\t
Compliance score for the conformance pack.
" + } + }, + "ConformancePackName": { + "target": "com.amazonaws.configservice#ConformancePackName", + "traits": { + "smithy.api#documentation": "The name of the conformance pack.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.configservice#LastUpdatedTime", + "traits": { + "smithy.api#documentation": "The time that the conformance pack compliance score was last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A compliance score is the percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in the conformance pack.\n\t\t\tThis metric provides you with a high-level view of the compliance state of your conformance packs, and can be used to identify, investigate, and understand\n\t\t\tcompliance deviations in your conformance packs.
" + } + }, + "com.amazonaws.configservice#ConformancePackComplianceScores": { + "type": "list", + "member": { + "target": "com.amazonaws.configservice#ConformancePackComplianceScore" + } + }, + "com.amazonaws.configservice#ConformancePackComplianceScoresFilters": { + "type": "structure", + "members": { + "ConformancePackNames": { + "target": "com.amazonaws.configservice#ConformancePackNameFilter", + "traits": { + "smithy.api#documentation": "The name of a conformance pack whose score should be included in the compliance score result.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A list of filters to apply to the conformance pack compliance score result set.
" + } + }, "com.amazonaws.configservice#ConformancePackComplianceSummary": { "type": "structure", "members": { @@ -2101,6 +2151,18 @@ "smithy.api#pattern": "^[a-zA-Z][-a-zA-Z0-9]*$" } }, + "com.amazonaws.configservice#ConformancePackNameFilter": { + "type": "list", + "member": { + "target": "com.amazonaws.configservice#ConformancePackName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, "com.amazonaws.configservice#ConformancePackNamesList": { "type": "list", "member": { @@ -6728,6 +6790,9 @@ "smithy.api#error": "client" } }, + "com.amazonaws.configservice#LastUpdatedTime": { + "type": "timestamp" + }, "com.amazonaws.configservice#LaterTime": { "type": "timestamp" }, @@ -6841,6 +6906,87 @@ } } }, + "com.amazonaws.configservice#ListConformancePackComplianceScores": { + "type": "operation", + "input": { + "target": "com.amazonaws.configservice#ListConformancePackComplianceScoresRequest" + }, + "output": { + "target": "com.amazonaws.configservice#ListConformancePackComplianceScoresResponse" + }, + "errors": [ + { + "target": "com.amazonaws.configservice#InvalidLimitException" + }, + { + "target": "com.amazonaws.configservice#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.configservice#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of conformance pack compliance scores. \n\t\t\tA compliance score is the percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in the conformance pack.\n\t\t\tThis metric provides you with a high-level view of the compliance state of your conformance packs, and can be used to identify, investigate, and understand\n\t\t\tcompliance deviations in your conformance packs.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "Limit" + } + } + }, + "com.amazonaws.configservice#ListConformancePackComplianceScoresRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.configservice#ConformancePackComplianceScoresFilters", + "traits": { + "smithy.api#documentation": "Filters the results based on the ConformancePackComplianceScoresFilters.
Determines the order in which conformance pack compliance scores are sorted. Either in ascending or descending order.
" + } + }, + "SortBy": { + "target": "com.amazonaws.configservice#SortBy", + "traits": { + "smithy.api#documentation": "Sorts your conformance pack compliance scores in either ascending or descending order, depending on SortOrder.
The maximum number of conformance pack compliance scores returned on each page.
" + } + }, + "NextToken": { + "target": "com.amazonaws.configservice#NextToken", + "traits": { + "smithy.api#documentation": "The nextToken string in a prior request that you can use to get the paginated response for next set of conformance pack compliance scores.
The nextToken string that you can use to get the next page of results in a paginated response.
A list of ConformancePackComplianceScore objects
The type of engine for the endpoint. Valid values, depending on the\n EndpointType value, include \"mysql\", \"oracle\",\n \"postgres\", \"mariadb\", \"aurora\", \n \"aurora-postgresql\", \"opensearch\", \"redshift\", \"s3\",\n \"db2\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\",\n \"kinesis\", \"kafka\", \"elasticsearch\", \"docdb\",\n \"sqlserver\", and \"neptune\".
The type of engine for the endpoint. Valid values, depending on the\n EndpointType value, include \"mysql\", \"oracle\",\n \"postgres\", \"mariadb\", \"aurora\", \n \"aurora-postgresql\", \"opensearch\", \"redshift\", \"s3\",\n \"db2\", db2-zos, \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\",\n \"kinesis\", \"kafka\", \"elasticsearch\", \"docdb\",\n \"sqlserver\", \"neptune\", and babelfish.
The state of the tables described.
\nValid states: Table does not exist | Before load | Full load | Table completed | Table\n cancelled | Table error | Table all | Table updates | Table is being reloaded
" + "smithy.api#documentation": "The state of the tables described.
\nValid states: Table does not exist | Before load | Full load | Table completed | Table\n cancelled | Table error | Table is being reloaded
" } }, "ValidationPendingRecords": { diff --git a/codegen/sdk/aws-models/detective.json b/codegen/sdk/aws-models/detective.json index a974a116bf7..fd0d91ac747 100644 --- a/codegen/sdk/aws-models/detective.json +++ b/codegen/sdk/aws-models/detective.json @@ -34,6 +34,9 @@ "input": { "target": "com.amazonaws.detective#AcceptInvitationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.detective#ConflictException" @@ -101,6 +104,18 @@ "smithy.api#pattern": "^[0-9]+$" } }, + "com.amazonaws.detective#AccountIdExtendedList": { + "type": "list", + "member": { + "target": "com.amazonaws.detective#AccountId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, "com.amazonaws.detective#AccountIdList": { "type": "list", "member": { @@ -171,7 +186,7 @@ "name": "detective" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Detective uses machine learning and purpose-built visualizations to help you to\n analyze and investigate security issues across your Amazon Web Services (Amazon Web Services) workloads. Detective automatically extracts time-based events such\n as login attempts, API calls, and network traffic from CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by\n Amazon GuardDuty.
\nThe Detective API primarily supports the creation and management of behavior\n graphs. A behavior graph contains the extracted data from a set of member accounts, and is\n created and managed by an administrator account.
\nTo add a member account to the behavior graph, the administrator account sends an\n invitation to the account. When the account accepts the invitation, it becomes a member\n account in the behavior graph.
\nDetective is also integrated with Organizations. The organization\n management account designates the Detective administrator account for the\n organization. That account becomes the administrator account for the organization behavior\n graph. The Detective administrator account can enable any organization account as\n a member account in the organization behavior graph. The organization accounts do not\n receive invitations. The Detective administrator account can also invite other\n accounts to the organization behavior graph.
\nEvery behavior graph is specific to a Region. You can only use the API to manage\n behavior graphs that belong to the Region that is associated with the currently selected\n endpoint.
\nThe administrator account for a behavior graph can use the Detective API to do\n the following:
\nEnable and disable Detective. Enabling Detective creates a new\n behavior graph.
\nView the list of member accounts in a behavior graph.
\nAdd member accounts to a behavior graph.
\nRemove member accounts from a behavior graph.
\nApply tags to a behavior graph.
\nThe organization management account can use the Detective API to select the\n delegated administrator for Detective.
\nThe Detective administrator account for an organization can use the Detective API to do the following:
\nPerform all of the functions of an administrator account.
\nDetermine whether to automatically enable new organization accounts as member\n accounts in the organization behavior graph.
\nAn invited member account can use the Detective API to do the following:
\nView the list of behavior graphs that they are invited to.
\nAccept an invitation to contribute to a behavior graph.
\nDecline an invitation to contribute to a behavior graph.
\nRemove their account from a behavior graph.
\nAll API actions are logged as CloudTrail events. See Logging Detective API Calls with CloudTrail.
\nWe replaced the term \"master account\" with the term \"administrator account.\" An\n administrator account is used to centrally manage multiple accounts. In the case of\n Detective, the administrator account manages the accounts in their behavior\n graph.
\nDetective uses machine learning and purpose-built visualizations to help you to\n analyze and investigate security issues across your Amazon Web Services (Amazon Web Services) workloads. Detective automatically extracts time-based events such\n as login attempts, API calls, and network traffic from CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by\n Amazon GuardDuty.
\nThe Detective API primarily supports the creation and management of behavior\n graphs. A behavior graph contains the extracted data from a set of member accounts, and is\n created and managed by an administrator account.
\nTo add a member account to the behavior graph, the administrator account sends an\n invitation to the account. When the account accepts the invitation, it becomes a member\n account in the behavior graph.
\nDetective is also integrated with Organizations. The organization\n management account designates the Detective administrator account for the\n organization. That account becomes the administrator account for the organization behavior\n graph. The Detective administrator account is also the delegated administrator\n account for Detective in Organizations.
\nThe Detective administrator account can enable any organization account as a\n member account in the organization behavior graph. The organization accounts do not receive\n invitations. The Detective administrator account can also invite other accounts to\n the organization behavior graph.
\nEvery behavior graph is specific to a Region. You can only use the API to manage\n behavior graphs that belong to the Region that is associated with the currently selected\n endpoint.
\nThe administrator account for a behavior graph can use the Detective API to do\n the following:
\nEnable and disable Detective. Enabling Detective creates a new\n behavior graph.
\nView the list of member accounts in a behavior graph.
\nAdd member accounts to a behavior graph.
\nRemove member accounts from a behavior graph.
\nApply tags to a behavior graph.
\nThe organization management account can use the Detective API to select the\n delegated administrator for Detective.
\nThe Detective administrator account for an organization can use the Detective API to do the following:
\nPerform all of the functions of an administrator account.
\nDetermine whether to automatically enable new organization accounts as member\n accounts in the organization behavior graph.
\nAn invited member account can use the Detective API to do the following:
\nView the list of behavior graphs that they are invited to.
\nAccept an invitation to contribute to a behavior graph.
\nDecline an invitation to contribute to a behavior graph.
\nRemove their account from a behavior graph.
\nAll API actions are logged as CloudTrail events. See Logging Detective API Calls with CloudTrail.
\nWe replaced the term \"master account\" with the term \"administrator account.\" An\n administrator account is used to centrally manage multiple accounts. In the case of\n Detective, the administrator account manages the accounts in their behavior\n graph.
\nGets data source package information for the behavior graph.
", + "smithy.api#http": { + "method": "POST", + "uri": "/graph/datasources/get", + "code": 200 + } + } + }, + "com.amazonaws.detective#BatchGetGraphMemberDatasourcesRequest": { + "type": "structure", + "members": { + "GraphArn": { + "target": "com.amazonaws.detective#GraphArn", + "traits": { + "smithy.api#documentation": "The ARN of the behavior graph.
", + "smithy.api#required": {} + } + }, + "AccountIds": { + "target": "com.amazonaws.detective#AccountIdExtendedList", + "traits": { + "smithy.api#documentation": "The list of Amazon Web Services accounts to get data source package information\n on.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.detective#BatchGetGraphMemberDatasourcesResponse": { + "type": "structure", + "members": { + "MemberDatasources": { + "target": "com.amazonaws.detective#MembershipDatasourcesList", + "traits": { + "smithy.api#documentation": "Details on the status of data source packages for members of the behavior graph.
" + } + }, + "UnprocessedAccounts": { + "target": "com.amazonaws.detective#UnprocessedAccountList", + "traits": { + "smithy.api#documentation": "Accounts that data source package information could not be retrieved for.
" + } + } + } + }, + "com.amazonaws.detective#BatchGetMembershipDatasources": { + "type": "operation", + "input": { + "target": "com.amazonaws.detective#BatchGetMembershipDatasourcesRequest" + }, + "output": { + "target": "com.amazonaws.detective#BatchGetMembershipDatasourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.detective#InternalServerException" + }, + { + "target": "com.amazonaws.detective#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.detective#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information on the data source package history for an account.
", + "smithy.api#http": { + "method": "POST", + "uri": "/membership/datasources/get", + "code": 200 + } + } + }, + "com.amazonaws.detective#BatchGetMembershipDatasourcesRequest": { + "type": "structure", + "members": { + "GraphArns": { + "target": "com.amazonaws.detective#GraphArnList", + "traits": { + "smithy.api#documentation": "The ARN of the behavior graph.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.detective#BatchGetMembershipDatasourcesResponse": { + "type": "structure", + "members": { + "MembershipDatasources": { + "target": "com.amazonaws.detective#MembershipDatasourcesList", + "traits": { + "smithy.api#documentation": "Details on the data source package history for an member of the behavior graph.
" + } + }, + "UnprocessedGraphs": { + "target": "com.amazonaws.detective#UnprocessedGraphList", + "traits": { + "smithy.api#documentation": "Graphs that data source package information could not be retrieved for.
" + } + } + } + }, "com.amazonaws.detective#Boolean": { "type": "boolean" }, @@ -389,11 +537,127 @@ } } }, + "com.amazonaws.detective#DatasourcePackage": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DETECTIVE_CORE", + "name": "DETECTIVE_CORE" + }, + { + "value": "EKS_AUDIT", + "name": "EKS_AUDIT" + } + ] + } + }, + "com.amazonaws.detective#DatasourcePackageIngestDetail": { + "type": "structure", + "members": { + "DatasourcePackageIngestState": { + "target": "com.amazonaws.detective#DatasourcePackageIngestState", + "traits": { + "smithy.api#documentation": "Details on which data source packages are ingested for a member account.
" + } + }, + "LastIngestStateChange": { + "target": "com.amazonaws.detective#LastIngestStateChangeDates", + "traits": { + "smithy.api#documentation": "The date a data source package was enabled for this account
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the data source packages ingested by your behavior graph.
" + } + }, + "com.amazonaws.detective#DatasourcePackageIngestDetails": { + "type": "map", + "key": { + "target": "com.amazonaws.detective#DatasourcePackage" + }, + "value": { + "target": "com.amazonaws.detective#DatasourcePackageIngestDetail" + } + }, + "com.amazonaws.detective#DatasourcePackageIngestHistory": { + "type": "map", + "key": { + "target": "com.amazonaws.detective#DatasourcePackage" + }, + "value": { + "target": "com.amazonaws.detective#LastIngestStateChangeDates" + } + }, + "com.amazonaws.detective#DatasourcePackageIngestState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "STARTED", + "name": "STARTED" + }, + { + "value": "STOPPED", + "name": "STOPPED" + }, + { + "value": "DISABLED", + "name": "DISABLED" + } + ] + } + }, + "com.amazonaws.detective#DatasourcePackageIngestStates": { + "type": "map", + "key": { + "target": "com.amazonaws.detective#DatasourcePackage" + }, + "value": { + "target": "com.amazonaws.detective#DatasourcePackageIngestState" + } + }, + "com.amazonaws.detective#DatasourcePackageList": { + "type": "list", + "member": { + "target": "com.amazonaws.detective#DatasourcePackage" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.detective#DatasourcePackageUsageInfo": { + "type": "structure", + "members": { + "VolumeUsageInBytes": { + "target": "com.amazonaws.detective#ByteValue", + "traits": { + "smithy.api#documentation": "Total volume of data in bytes per day ingested for a given data source package.
" + } + }, + "VolumeUsageUpdateTime": { + "target": "com.amazonaws.detective#Timestamp", + "traits": { + "smithy.api#documentation": "The data and time when the member account data volume was last updated. The value is an\n ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.
Information on the usage of a data source package in the behavior graph.
" + } + }, "com.amazonaws.detective#DeleteGraph": { "type": "operation", "input": { "target": "com.amazonaws.detective#DeleteGraphRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.detective#InternalServerException" @@ -546,6 +810,12 @@ }, "com.amazonaws.detective#DisableOrganizationAdminAccount": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.detective#InternalServerException" @@ -558,7 +828,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes the Detective administrator account for the organization in the current\n Region. Deletes the behavior graph for that account.
\nCan only be called by the organization management account. Before you can select a\n different Detective administrator account, you must remove the Detective\n administrator account in all Regions.
", + "smithy.api#documentation": "Removes the Detective administrator account in the current Region. Deletes the\n organization behavior graph.
\nCan only be called by the organization management account.
\nRemoving the Detective administrator account does not affect the delegated\n administrator account for Detective in Organizations.
\nTo remove the delegated administrator account in Organizations, use the Organizations API. Removing the delegated administrator account also removes the Detective administrator account in all Regions, except for Regions where the Detective administrator account is the organization management account.
", "smithy.api#http": { "method": "POST", "uri": "/orgs/disableAdminAccount", @@ -571,6 +841,9 @@ "input": { "target": "com.amazonaws.detective#DisassociateMembershipRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.detective#ConflictException" @@ -630,6 +903,9 @@ "input": { "target": "com.amazonaws.detective#EnableOrganizationAdminAccountRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.detective#InternalServerException" @@ -642,7 +918,7 @@ } ], "traits": { - "smithy.api#documentation": "Designates the Detective administrator account for the organization in the\n current Region.
\nIf the account does not have Detective enabled, then enables Detective\n for that account and creates a new behavior graph.
\nCan only be called by the organization management account.
\nThe Detective administrator account for an organization must be the same in all\n Regions. If you already designated a Detective administrator account in another\n Region, then you must designate the same account.
", + "smithy.api#documentation": "Designates the Detective administrator account for the organization in the\n current Region.
\nIf the account does not have Detective enabled, then enables Detective\n for that account and creates a new behavior graph.
\nCan only be called by the organization management account.
\nIf the organization has a delegated administrator account in Organizations, then the\n Detective administrator account must be either the delegated administrator\n account or the organization management account.
\nIf the organization does not have a delegated administrator account in Organizations, then you can choose any account in the organization. If you choose an account other\n than the organization management account, Detective calls Organizations to\n make that account the delegated administrator account for Detective. The\n organization management account cannot be the delegated administrator account.
", "smithy.api#http": { "method": "POST", "uri": "/orgs/enableAdminAccount", @@ -662,6 +938,28 @@ } } }, + "com.amazonaws.detective#ErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INVALID_GRAPH_ARN", + "name": "InvalidGraphArn" + }, + { + "value": "INVALID_REQUEST_BODY", + "name": "InvalidRequestBody" + }, + { + "value": "INTERNAL_ERROR", + "name": "InternalError" + } + ] + } + }, + "com.amazonaws.detective#ErrorCodeReason": { + "type": "string" + }, "com.amazonaws.detective#ErrorMessage": { "type": "string" }, @@ -755,6 +1053,18 @@ "smithy.api#pattern": "^arn:aws[-\\w]{0,10}?:detective:[-\\w]{2,20}?:\\d{12}?:graph:[abcdef\\d]{32}?$" } }, + "com.amazonaws.detective#GraphArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.detective#GraphArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.detective#GraphList": { "type": "list", "member": { @@ -789,6 +1099,89 @@ ] } }, + "com.amazonaws.detective#LastIngestStateChangeDates": { + "type": "map", + "key": { + "target": "com.amazonaws.detective#DatasourcePackageIngestState" + }, + "value": { + "target": "com.amazonaws.detective#TimestampForCollection" + } + }, + "com.amazonaws.detective#ListDatasourcePackages": { + "type": "operation", + "input": { + "target": "com.amazonaws.detective#ListDatasourcePackagesRequest" + }, + "output": { + "target": "com.amazonaws.detective#ListDatasourcePackagesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.detective#InternalServerException" + }, + { + "target": "com.amazonaws.detective#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.detective#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists data source packages in the behavior graph.
", + "smithy.api#http": { + "method": "POST", + "uri": "/graph/datasources/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.detective#ListDatasourcePackagesRequest": { + "type": "structure", + "members": { + "GraphArn": { + "target": "com.amazonaws.detective#GraphArn", + "traits": { + "smithy.api#documentation": "The ARN of the behavior graph.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.detective#PaginationToken", + "traits": { + "smithy.api#documentation": "For requests to get the next page of results, the pagination token that was returned\n with the previous set of results. The initial request does not include a pagination\n token.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.detective#MemberResultsLimit", + "traits": { + "smithy.api#documentation": "The maximum number of results to return.
" + } + } + } + }, + "com.amazonaws.detective#ListDatasourcePackagesResponse": { + "type": "structure", + "members": { + "DatasourcePackages": { + "target": "com.amazonaws.detective#DatasourcePackageIngestDetails", + "traits": { + "smithy.api#documentation": "Details on the data source packages active in the behavior graph.
" + } + }, + "NextToken": { + "target": "com.amazonaws.detective#PaginationToken", + "traits": { + "smithy.api#documentation": "For requests to get the next page of results, the pagination token that was returned\n with the previous set of results. The initial request does not include a pagination\n token.
" + } + } + } + }, "com.amazonaws.detective#ListGraphs": { "type": "operation", "input": { @@ -1047,7 +1440,7 @@ "Administrators": { "target": "com.amazonaws.detective#AdministratorList", "traits": { - "smithy.api#documentation": "The list of delegated administrator accounts.
" + "smithy.api#documentation": "The list of Detective administrator accounts.
" } }, "NextToken": { @@ -1173,12 +1566,18 @@ "VolumeUsageInBytes": { "target": "com.amazonaws.detective#ByteValue", "traits": { + "smithy.api#deprecated": { + "message": "This property is deprecated. Use VolumeUsageByDatasourcePackage instead." + }, "smithy.api#documentation": "The data volume in bytes per day for the member account.
" } }, "VolumeUsageUpdatedTime": { "target": "com.amazonaws.detective#Timestamp", "traits": { + "smithy.api#deprecated": { + "message": "This property is deprecated. Use VolumeUsageByDatasourcePackage instead." + }, "smithy.api#documentation": "The data and time when the member account data volume was last updated. The value is an\n ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.
The member account data volume as a percentage of the maximum allowed data volume. 0\n indicates 0 percent, and 100 indicates 100 percent.
\nNote that this is not the percentage of the behavior graph data volume.
\nFor example, the data volume for the behavior graph is 80 GB per day. The maximum data\n volume is 160 GB per day. If the data volume for the member account is 40 GB per day, then\n PercentOfGraphUtilization is 25. It represents 25% of the maximum allowed\n data volume.
The date and time when the graph utilization percentage was last updated. The value is\n an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.
The type of behavior graph membership.
\nFor an organization account in the organization behavior graph, the type is\n ORGANIZATION.
For an account that was invited to a behavior graph, the type is\n INVITATION.
Details on the volume of usage for each data source package in a behavior graph.
" + } + }, + "DatasourcePackageIngestStates": { + "target": "com.amazonaws.detective#DatasourcePackageIngestStates", + "traits": { + "smithy.api#documentation": "The state of a data source package for the behavior graph.
" + } } }, "traits": { @@ -1269,6 +1680,38 @@ ] } }, + "com.amazonaws.detective#MembershipDatasources": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.detective#AccountId", + "traits": { + "smithy.api#documentation": "The account identifier of the Amazon Web Services account.
" + } + }, + "GraphArn": { + "target": "com.amazonaws.detective#GraphArn", + "traits": { + "smithy.api#documentation": "The ARN of the organization behavior graph.
" + } + }, + "DatasourcePackageIngestHistory": { + "target": "com.amazonaws.detective#DatasourcePackageIngestHistory", + "traits": { + "smithy.api#documentation": "Details on when a data source package was added to a behavior graph.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details on data source packages for members of the behavior graph.
" + } + }, + "com.amazonaws.detective#MembershipDatasourcesList": { + "type": "list", + "member": { + "target": "com.amazonaws.detective#MembershipDatasources" + } + }, "com.amazonaws.detective#PaginationToken": { "type": "string", "traits": { @@ -1289,6 +1732,9 @@ "input": { "target": "com.amazonaws.detective#RejectInvitationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.detective#ConflictException" @@ -1324,6 +1770,27 @@ } } }, + "com.amazonaws.detective#Resource": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.detective#ResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.detective#Resource" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.detective#ResourceNotFoundException": { "type": "structure", "members": { @@ -1342,6 +1809,12 @@ "members": { "Message": { "target": "com.amazonaws.detective#ErrorMessage" + }, + "Resources": { + "target": "com.amazonaws.detective#ResourceList", + "traits": { + "smithy.api#documentation": "The type of resource that has exceeded the service quota.
" + } } }, "traits": { @@ -1355,6 +1828,9 @@ "input": { "target": "com.amazonaws.detective#StartMonitoringMemberRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.detective#ConflictException" @@ -1504,6 +1980,20 @@ "smithy.api#timestampFormat": "date-time" } }, + "com.amazonaws.detective#TimestampForCollection": { + "type": "structure", + "members": { + "Timestamp": { + "target": "com.amazonaws.detective#Timestamp", + "traits": { + "smithy.api#documentation": "The data and time when data collection began for a source package. The value is an\n ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.
Details on when data collection began for a source package.
" + } + }, "com.amazonaws.detective#TooManyRequestsException": { "type": "structure", "members": { @@ -1543,6 +2033,32 @@ "target": "com.amazonaws.detective#UnprocessedAccount" } }, + "com.amazonaws.detective#UnprocessedGraph": { + "type": "structure", + "members": { + "GraphArn": { + "target": "com.amazonaws.detective#GraphArn", + "traits": { + "smithy.api#documentation": "The ARN of the organization behavior graph.
" + } + }, + "Reason": { + "target": "com.amazonaws.detective#UnprocessedReason", + "traits": { + "smithy.api#documentation": "The reason data source package information could not be processed for a behavior\n graph.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Behavior graphs that could not be processed in the request.
" + } + }, + "com.amazonaws.detective#UnprocessedGraphList": { + "type": "list", + "member": { + "target": "com.amazonaws.detective#UnprocessedGraph" + } + }, "com.amazonaws.detective#UnprocessedReason": { "type": "string" }, @@ -1599,11 +2115,64 @@ "type": "structure", "members": {} }, + "com.amazonaws.detective#UpdateDatasourcePackages": { + "type": "operation", + "input": { + "target": "com.amazonaws.detective#UpdateDatasourcePackagesRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.detective#InternalServerException" + }, + { + "target": "com.amazonaws.detective#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.detective#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.detective#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Starts a data source packages for the behavior graph.
", + "smithy.api#http": { + "method": "POST", + "uri": "/graph/datasources/update", + "code": 200 + } + } + }, + "com.amazonaws.detective#UpdateDatasourcePackagesRequest": { + "type": "structure", + "members": { + "GraphArn": { + "target": "com.amazonaws.detective#GraphArn", + "traits": { + "smithy.api#documentation": "The ARN of the behavior graph.
", + "smithy.api#required": {} + } + }, + "DatasourcePackages": { + "target": "com.amazonaws.detective#DatasourcePackageList", + "traits": { + "smithy.api#documentation": "The data source package start for the behavior graph.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.detective#UpdateOrganizationConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.detective#UpdateOrganizationConfigurationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.detective#InternalServerException" @@ -1647,6 +2216,18 @@ "members": { "Message": { "target": "com.amazonaws.detective#ErrorMessage" + }, + "ErrorCode": { + "target": "com.amazonaws.detective#ErrorCode", + "traits": { + "smithy.api#documentation": "The error code associated with the validation failure.
" + } + }, + "ErrorCodeReason": { + "target": "com.amazonaws.detective#ErrorCodeReason", + "traits": { + "smithy.api#documentation": "An explanation of why validation failed.
" + } } }, "traits": { @@ -1654,6 +2235,15 @@ "smithy.api#error": "client", "smithy.api#httpError": 400 } + }, + "com.amazonaws.detective#VolumeUsageByDatasourcePackage": { + "type": "map", + "key": { + "target": "com.amazonaws.detective#DatasourcePackage" + }, + "value": { + "target": "com.amazonaws.detective#DatasourcePackageUsageInfo" + } } } } diff --git a/codegen/sdk/aws-models/docdb.json b/codegen/sdk/aws-models/docdb.json index a6bbbf10283..c6f3fb0d650 100644 --- a/codegen/sdk/aws-models/docdb.json +++ b/codegen/sdk/aws-models/docdb.json @@ -84,6 +84,9 @@ "input": { "target": "com.amazonaws.docdb#AddTagsToResourceMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.docdb#DBClusterNotFoundFault" @@ -1150,6 +1153,12 @@ "smithy.api#required": {} } }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.docdb#BooleanOptional", + "traits": { + "smithy.api#documentation": "A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
" + } + }, "PromotionTier": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { @@ -1604,6 +1613,12 @@ "smithy.api#documentation": "Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
" } }, + "CloneGroupId": { + "target": "com.amazonaws.docdb#String", + "traits": { + "smithy.api#documentation": "Identifies the clone group to which the DB cluster is associated.
" + } + }, "ClusterCreateTime": { "target": "com.amazonaws.docdb#TStamp", "traits": { @@ -2337,6 +2352,12 @@ "smithy.api#documentation": "The identifier of the CA certificate for this DB instance.
" } }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.docdb#BooleanOptional", + "traits": { + "smithy.api#documentation": "A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
" + } + }, "PromotionTier": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { @@ -2802,6 +2823,9 @@ "input": { "target": "com.amazonaws.docdb#DeleteDBClusterParameterGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.docdb#DBParameterGroupNotFoundFault" @@ -2937,6 +2961,9 @@ "input": { "target": "com.amazonaws.docdb#DeleteDBSubnetGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.docdb#DBSubnetGroupNotFoundFault" @@ -5413,6 +5440,12 @@ "smithy.api#documentation": "Indicates the certificate that needs to be associated with the instance.
" } }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.docdb#BooleanOptional", + "traits": { + "smithy.api#documentation": "A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
" + } + }, "PromotionTier": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { @@ -6159,6 +6192,9 @@ "input": { "target": "com.amazonaws.docdb#RemoveTagsFromResourceMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.docdb#DBClusterNotFoundFault" @@ -6496,6 +6532,12 @@ "smithy.api#required": {} } }, + "RestoreType": { + "target": "com.amazonaws.docdb#String", + "traits": { + "smithy.api#documentation": "The type of restore to be performed. You can specify one of the following values:
\n\n full-copy - The new DB cluster is restored as a full copy of the\n source DB cluster.
\n copy-on-write - The new DB cluster is restored as a clone of the\n source DB cluster.
Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.
If you don't specify a RestoreType value, then the new DB cluster is\n restored as a full copy of the source DB cluster.
The instance is currently unavailable. Wait a few minutes and try again.
", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, "com.amazonaws.ec2instanceconnect#InstanceId": { "type": "string", "traits": { @@ -201,6 +218,9 @@ { "target": "com.amazonaws.ec2instanceconnect#EC2InstanceStateInvalidException" }, + { + "target": "com.amazonaws.ec2instanceconnect#EC2InstanceUnavailableException" + }, { "target": "com.amazonaws.ec2instanceconnect#InvalidArgsException" }, @@ -285,6 +305,9 @@ { "target": "com.amazonaws.ec2instanceconnect#EC2InstanceTypeInvalidException" }, + { + "target": "com.amazonaws.ec2instanceconnect#EC2InstanceUnavailableException" + }, { "target": "com.amazonaws.ec2instanceconnect#InvalidArgsException" }, diff --git a/codegen/sdk/aws-models/ec2.json b/codegen/sdk/aws-models/ec2.json index 4d64eac8e42..09177545928 100644 --- a/codegen/sdk/aws-models/ec2.json +++ b/codegen/sdk/aws-models/ec2.json @@ -48367,6 +48367,10 @@ { "value": "c7g.16xlarge", "name": "c7g_16xlarge" + }, + { + "value": "mac2.metal", + "name": "mac2_metal" } ] } diff --git a/codegen/sdk/aws-models/frauddetector.json b/codegen/sdk/aws-models/frauddetector.json index 937f105ab9a..2343d1eeb6d 100644 --- a/codegen/sdk/aws-models/frauddetector.json +++ b/codegen/sdk/aws-models/frauddetector.json @@ -29,6 +29,78 @@ ] }, "shapes": { + "com.amazonaws.frauddetector#ATIMetricDataPoint": { + "type": "structure", + "members": { + "cr": { + "target": "com.amazonaws.frauddetector#float", + "traits": { + "smithy.api#documentation": "\n The challenge rate. This indicates the percentage of login events that the model recommends to challenge such as \n one-time password, multi-factor authentication, and investigations.\n
" + } + }, + "adr": { + "target": "com.amazonaws.frauddetector#float", + "traits": { + "smithy.api#documentation": "\n The anomaly discovery rate. This metric quantifies the percentage of anomalies that can be detected by the model at the selected score threshold. \n A lower score threshold increases the percentage of anomalies captured by the model, but would also require challenging a larger percentage of \n login events, leading to a higher customer friction.\n
" + } + }, + "threshold": { + "target": "com.amazonaws.frauddetector#float", + "traits": { + "smithy.api#documentation": "\n The model's threshold that specifies an acceptable fraud capture rate. For example, a threshold of 500 means any model score 500 or above is \n labeled as fraud.\n
" + } + }, + "atodr": { + "target": "com.amazonaws.frauddetector#float", + "traits": { + "smithy.api#documentation": "\n The account takeover discovery rate. This metric quantifies the percentage of account compromise events that can be detected by the model at the selected score threshold.\n This metric is only available if 50 or more entities with at-least one labeled account takeover event is present in the ingested dataset.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The Account Takeover Insights (ATI) model performance metrics data points.\n
" + } + }, + "com.amazonaws.frauddetector#ATIMetricDataPointsList": { + "type": "list", + "member": { + "target": "com.amazonaws.frauddetector#ATIMetricDataPoint" + } + }, + "com.amazonaws.frauddetector#ATIModelPerformance": { + "type": "structure", + "members": { + "asi": { + "target": "com.amazonaws.frauddetector#float", + "traits": { + "smithy.api#documentation": "\n The anomaly separation index (ASI) score. This metric summarizes the overall ability of the model to separate anomalous activities from the normal behavior. Depending on the business, a \n large fraction of these anomalous activities can be malicious and correspond to the account takeover attacks. A model with no separability power will have the lowest possible \n ASI score of 0.5, whereas the a model with a high separability power will have the highest possible ASI score of 1.0\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The Account Takeover Insights (ATI) model performance score.\n
" + } + }, + "com.amazonaws.frauddetector#ATITrainingMetricsValue": { + "type": "structure", + "members": { + "metricDataPoints": { + "target": "com.amazonaws.frauddetector#ATIMetricDataPointsList", + "traits": { + "smithy.api#documentation": "\n The model's performance metrics data points.\n
" + } + }, + "modelPerformance": { + "target": "com.amazonaws.frauddetector#ATIModelPerformance", + "traits": { + "smithy.api#documentation": "\n The model's overall performance scores.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The Account Takeover Insights (ATI) model training metric details. \n
" + } + }, "com.amazonaws.frauddetector#AWSHawksNestServiceFacade": { "type": "service", "traits": { @@ -273,6 +345,68 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.frauddetector#AggregatedLogOddsMetric": { + "type": "structure", + "members": { + "variableNames": { + "target": "com.amazonaws.frauddetector#ListOfStrings", + "traits": { + "smithy.api#documentation": "\n The names of all the variables. \n
", + "smithy.api#required": {} + } + }, + "aggregatedVariablesImportance": { + "target": "com.amazonaws.frauddetector#float", + "traits": { + "smithy.api#documentation": "\n The relative importance of the variables in the list to the other event variable. \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The log odds metric details.
\n \nAccount Takeover Insights (ATI) model uses event variables from the login data you \n provide to continuously calculate a set of variables (aggregated variables) based on historical events. For example, your ATI model might calculate the number of times an user has logged in using the same IP address. \n In this case, event variables used to derive the aggregated variables are IP address and user.
\n The names of all the event variables that were used to derive the aggregated variables. \n
" + } + }, + "relativeImpact": { + "target": "com.amazonaws.frauddetector#string", + "traits": { + "smithy.api#documentation": "\n The relative impact of the aggregated variables in terms of magnitude on the prediction scores. \n
" + } + }, + "logOddsImpact": { + "target": "com.amazonaws.frauddetector#float", + "traits": { + "smithy.api#documentation": "\n The raw, uninterpreted value represented as log-odds of the fraud. These values are usually between -10 to +10, but range from -infinity to +infinity.
\nA positive value indicates that the variables drove the risk score up.
\nA negative value indicates that the variables drove the risk score down.
\n\n The details of the impact of aggregated variables on the prediction score.
\n \nAccount Takeover Insights (ATI) model uses the login data you \n provide to continuously calculate a set of variables (aggregated variables) based on historical events. For example, the model might calculate the number of times an user has logged in using the same IP address. \n In this case, event variables used to derive the aggregated variables are IP address and user.
\n List of variables' metrics.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the relative importance of the aggregated variables.
\n \nAccount Takeover Insights (ATI) model uses event variables from the login data you \n provide to continuously calculate a set of variables (aggregated variables) based on historical events. For example, your ATI model might calculate the number of times an user has logged in using the same IP address. \n In this case, event variables used to derive the aggregated variables are IP address and user.
The file-specific model training validation messages.
" + "smithy.api#documentation": "The file-specific model training data validation messages.
" } }, "fieldLevelMessages": { @@ -1473,7 +1607,7 @@ } }, "traits": { - "smithy.api#documentation": "The model training validation messages.
" + "smithy.api#documentation": "The model training data validation metrics.
" } }, "com.amazonaws.frauddetector#DeleteAuditHistory": { @@ -4834,8 +4968,7 @@ "labelMapper": { "target": "com.amazonaws.frauddetector#labelMapper", "traits": { - "smithy.api#documentation": "The label mapper maps the Amazon Fraud Detector supported model classification labels (FRAUD, LEGIT) to the appropriate event type labels. For example, if \"FRAUD\" and \"LEGIT\" are Amazon Fraud Detector supported labels, this mapper could be: {\"FRAUD\" => [\"0\"], \"LEGIT\" => [\"1\"]} or {\"FRAUD\" => [\"false\"], \"LEGIT\" => [\"true\"]} or {\"FRAUD\" => [\"fraud\", \"abuse\"], \"LEGIT\" => [\"legit\", \"safe\"]}. The value part of the mapper is a list, because you may have multiple label variants from your event type for a single Amazon Fraud Detector label.\n
The label mapper maps the Amazon Fraud Detector supported model classification labels (FRAUD, LEGIT) to the appropriate event type labels. For example, if \"FRAUD\" and \"LEGIT\" are Amazon Fraud Detector supported labels, this mapper could be: {\"FRAUD\" => [\"0\"], \"LEGIT\" => [\"1\"]} or {\"FRAUD\" => [\"false\"], \"LEGIT\" => [\"true\"]} or {\"FRAUD\" => [\"fraud\", \"abuse\"], \"LEGIT\" => [\"legit\", \"safe\"]}. The value part of the mapper is a list, because you may have multiple label variants from your event type for a single Amazon Fraud Detector label.\n
The model version ARN.
" } + }, + "trainingResultV2": { + "target": "com.amazonaws.frauddetector#TrainingResultV2", + "traits": { + "smithy.api#documentation": "\n The training result details. The details include the relative importance of the variables.\n
" + } } }, "traits": { @@ -5591,6 +5746,78 @@ } } }, + "com.amazonaws.frauddetector#OFIMetricDataPoint": { + "type": "structure", + "members": { + "fpr": { + "target": "com.amazonaws.frauddetector#float", + "traits": { + "smithy.api#documentation": "\n The false positive rate. This is the percentage of total legitimate events that are incorrectly predicted as fraud.\n
" + } + }, + "precision": { + "target": "com.amazonaws.frauddetector#float", + "traits": { + "smithy.api#documentation": "\n The percentage of fraud events correctly predicted as fraudulent as compared to all events predicted as fraudulent.\n
" + } + }, + "tpr": { + "target": "com.amazonaws.frauddetector#float", + "traits": { + "smithy.api#documentation": "\n The true positive rate. This is the percentage of total fraud the model detects. Also known as capture rate.\n
" + } + }, + "threshold": { + "target": "com.amazonaws.frauddetector#float", + "traits": { + "smithy.api#documentation": "\n The model threshold that specifies an acceptable fraud capture rate. For example, a threshold of 500 means any model score 500 or above is labeled as fraud.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The Online Fraud Insights (OFI) model performance metrics data points. \n
" + } + }, + "com.amazonaws.frauddetector#OFIMetricDataPointsList": { + "type": "list", + "member": { + "target": "com.amazonaws.frauddetector#OFIMetricDataPoint" + } + }, + "com.amazonaws.frauddetector#OFIModelPerformance": { + "type": "structure", + "members": { + "auc": { + "target": "com.amazonaws.frauddetector#float", + "traits": { + "smithy.api#documentation": "\n The area under the curve (auc). This summarizes the total positive rate (tpr) and false positive rate (FPR) across all possible model score thresholds.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The Online Fraud Insights (OFI) model performance score.\n
" + } + }, + "com.amazonaws.frauddetector#OFITrainingMetricsValue": { + "type": "structure", + "members": { + "metricDataPoints": { + "target": "com.amazonaws.frauddetector#OFIMetricDataPointsList", + "traits": { + "smithy.api#documentation": "\n The model's performance metrics data points.\n
" + } + }, + "modelPerformance": { + "target": "com.amazonaws.frauddetector#OFIModelPerformance", + "traits": { + "smithy.api#documentation": "\n The model's overall performance score.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The Online Fraud Insights (OFI) model training metric details. \n
" + } + }, "com.amazonaws.frauddetector#Outcome": { "type": "structure", "members": { @@ -5653,6 +5880,12 @@ "traits": { "smithy.api#documentation": "\nThe details of the event variable's impact on the prediction score.\n
" } + }, + "aggregatedVariablesImpactExplanations": { + "target": "com.amazonaws.frauddetector#ListOfAggregatedVariablesImpactExplanations", + "traits": { + "smithy.api#documentation": "\n The details of the aggregated variables impact on the prediction score. \n
\n \nAccount Takeover Insights (ATI) model uses event variables from the login data you \n provide to continuously calculate a set of variables (aggregated variables) based on historical events. For example, your ATI model might calculate the number of times an user has logged in using the same IP address. \n In this case, event variables used to derive the aggregated variables are IP address and user.
\n The false positive rate. This is the percentage of total legitimate events that are incorrectly predicted as fraud.\n
" + } + }, + "precision": { + "target": "com.amazonaws.frauddetector#float", + "traits": { + "smithy.api#documentation": "\n The percentage of fraud events correctly predicted as fraudulent as compared to all events predicted as fraudulent.\n
" + } + }, + "tpr": { + "target": "com.amazonaws.frauddetector#float", + "traits": { + "smithy.api#documentation": "\n The true positive rate. This is the percentage of total fraud the model detects. Also known as capture rate.\n
" + } + }, + "threshold": { + "target": "com.amazonaws.frauddetector#float", + "traits": { + "smithy.api#documentation": "\n The model threshold that specifies an acceptable fraud capture rate. For example, a threshold of 500 means any \n model score 500 or above is labeled as fraud.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The performance metrics data points for Transaction Fraud Insights (TFI) model. \n
" + } + }, + "com.amazonaws.frauddetector#TFIMetricDataPointsList": { + "type": "list", + "member": { + "target": "com.amazonaws.frauddetector#TFIMetricDataPoint" + } + }, + "com.amazonaws.frauddetector#TFIModelPerformance": { + "type": "structure", + "members": { + "auc": { + "target": "com.amazonaws.frauddetector#float", + "traits": { + "smithy.api#documentation": "\n The area under the curve (auc). This summarizes the total positive rate (tpr) and false positive rate (FPR) across all possible model score thresholds.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The Transaction Fraud Insights (TFI) model performance score.\n
" + } + }, + "com.amazonaws.frauddetector#TFITrainingMetricsValue": { + "type": "structure", + "members": { + "metricDataPoints": { + "target": "com.amazonaws.frauddetector#TFIMetricDataPointsList", + "traits": { + "smithy.api#documentation": "\n The model's performance metrics data points.\n
" + } + }, + "modelPerformance": { + "target": "com.amazonaws.frauddetector#TFIModelPerformance", + "traits": { + "smithy.api#documentation": "\n The model performance score.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The Transaction Fraud Insights (TFI) model training metric details. \n
" + } + }, "com.amazonaws.frauddetector#Tag": { "type": "structure", "members": { @@ -6512,10 +6817,7 @@ } }, "labelSchema": { - "target": "com.amazonaws.frauddetector#LabelSchema", - "traits": { - "smithy.api#required": {} - } + "target": "com.amazonaws.frauddetector#LabelSchema" } }, "traits": { @@ -6557,6 +6859,32 @@ "smithy.api#documentation": "The training metric details.
" } }, + "com.amazonaws.frauddetector#TrainingMetricsV2": { + "type": "structure", + "members": { + "ofi": { + "target": "com.amazonaws.frauddetector#OFITrainingMetricsValue", + "traits": { + "smithy.api#documentation": "\n The Online Fraud Insights (OFI) model training metric details. \n
" + } + }, + "tfi": { + "target": "com.amazonaws.frauddetector#TFITrainingMetricsValue", + "traits": { + "smithy.api#documentation": "\n The Transaction Fraud Insights (TFI) model training metric details. \n
" + } + }, + "ati": { + "target": "com.amazonaws.frauddetector#ATITrainingMetricsValue", + "traits": { + "smithy.api#documentation": "\n The Account Takeover Insights (ATI) model training metric details. \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The training metrics details.\n
" + } + }, "com.amazonaws.frauddetector#TrainingResult": { "type": "structure", "members": { @@ -6583,6 +6911,32 @@ "smithy.api#documentation": "The training result details.
" } }, + "com.amazonaws.frauddetector#TrainingResultV2": { + "type": "structure", + "members": { + "dataValidationMetrics": { + "target": "com.amazonaws.frauddetector#DataValidationMetrics" + }, + "trainingMetricsV2": { + "target": "com.amazonaws.frauddetector#TrainingMetricsV2", + "traits": { + "smithy.api#documentation": "\n The training metric details.\n
" + } + }, + "variableImportanceMetrics": { + "target": "com.amazonaws.frauddetector#VariableImportanceMetrics" + }, + "aggregatedVariablesImportanceMetrics": { + "target": "com.amazonaws.frauddetector#AggregatedVariablesImportanceMetrics", + "traits": { + "smithy.api#documentation": "\n The variable importance metrics of the aggregated variables.\n
\nAccount Takeover Insights (ATI) model uses event variables from the login data you \n provide to continuously calculate a set of variables (aggregated variables) based on historical events. For example, your ATI model might calculate the number of times an user has logged in using the same IP address. \n In this case, event variables used to derive the aggregated variables are IP address and user.
\n The training result details.\n
" + } + }, "com.amazonaws.frauddetector#UnlabeledEventsTreatment": { "type": "string", "traits": { @@ -7750,7 +8104,7 @@ "target": "com.amazonaws.frauddetector#string" }, "value": { - "target": "com.amazonaws.frauddetector#NonEmptyListOfStrings" + "target": "com.amazonaws.frauddetector#ListOfStrings" } }, "com.amazonaws.frauddetector#labelsMaxResults": { @@ -7936,7 +8290,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 1024 + "max": 8192 }, "smithy.api#sensitive": {} } diff --git a/codegen/sdk/aws-models/global-accelerator.json b/codegen/sdk/aws-models/global-accelerator.json index 09856786086..49902d97403 100644 --- a/codegen/sdk/aws-models/global-accelerator.json +++ b/codegen/sdk/aws-models/global-accelerator.json @@ -47,7 +47,7 @@ "IpAddressType": { "target": "com.amazonaws.globalaccelerator#IpAddressType", "traits": { - "smithy.api#documentation": "The value for the address type must be IPv4.\n\t\t\t
" + "smithy.api#documentation": "The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.
" } }, "Enabled": { @@ -65,7 +65,7 @@ "DnsName": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.
\n\t\tThe naming convention for the DNS name is the following: A lowercase letter a,\n\t\t\tfollowed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example:\n\t\t\ta1234567890abcdef.awsglobalaccelerator.com.
\n\t\tFor more information about the default DNS name, see \n\t\t\tSupport for DNS Addressing in Global Accelerator in the AWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.
\n\t\tThe naming convention for the DNS name for an accelerator is the following: A lowercase letter a,\n\t\t\tfollowed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example:\n\t\t\ta1234567890abcdef.awsglobalaccelerator.com.
\nIf you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four \n\t\t\tstatic addresses for the accelerator (two IPv4 addresses and two IPv6 addresses).
\n\t\tFor more information about the default DNS name, see \n\t\t\tSupport for DNS Addressing in Global Accelerator in the Global Accelerator Developer Guide.
" } }, "Status": { @@ -85,6 +85,18 @@ "traits": { "smithy.api#documentation": "The date and time that the accelerator was last modified.
" } + }, + "DualStackDnsName": { + "target": "com.amazonaws.globalaccelerator#GenericString", + "traits": { + "smithy.api#documentation": "The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses:\n\t\t\ttwo IPv4 addresses and two IPv6 addresses.
\n\t\tThe naming convention for the dual-stack DNS name is the following: A lowercase letter a,\n\t\t\tfollowed by a 16-bit random hex string, followed by .dualstack.awsglobalaccelerator.com. For example:\n\t\t\ta1234567890abcdef.dualstack.awsglobalaccelerator.com.
\n\t\tNote: Global Accelerator also assigns a default DNS name, DnsName, to your accelerator that points just to the static IPv4 addresses.
\n\t\tFor more information, see \n\t\t\tSupport for DNS Addressing in Global Accelerator in the Global Accelerator Developer Guide.
" + } + }, + "Events": { + "target": "com.amazonaws.globalaccelerator#AcceleratorEvents", + "traits": { + "smithy.api#documentation": "A history of changes that you make to an accelerator in Global Accelerator.
" + } } }, "traits": { @@ -97,19 +109,19 @@ "FlowLogsEnabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { - "smithy.api#documentation": "Indicates whether flow logs are enabled. The default value is false. If the value is true,\n\t\t\t\tFlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow Logs in\n\t\t\tthe AWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Indicates whether flow logs are enabled. The default value is false. If the value is true,\n\t\t\t\tFlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow logs in\n\t\t the Global Accelerator Developer Guide.
" } }, "FlowLogsS3Bucket": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is\n\t\t\t\ttrue. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the\n\t\t\tbucket.
The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is\n\t\t true. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the\n\t\t\tbucket.
The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if\n\t\t\t\tFlowLogsEnabled is true.
If you don’t specify a prefix, the flow logs are stored in the\n\t\t\troot of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
\n\t\ts3-bucket_name//AWSLogs/aws_account_id
" + "smithy.api#documentation": "The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if\n\t\t\t\tFlowLogsEnabled is true.
If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
\n\t\ts3-bucket_name//AWSLogs/aws_account_id
" } } }, @@ -117,6 +129,32 @@ "smithy.api#documentation": "Attributes of an accelerator.
" } }, + "com.amazonaws.globalaccelerator#AcceleratorEvent": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.globalaccelerator#GenericString", + "traits": { + "smithy.api#documentation": "A string that contains an Event message describing changes or errors\n\t\t\twhen you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.
A timestamp for when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains a Timestamp value and Message for changes \n\t\t\tthat you make to an accelerator in Global Accelerator. Messages stored here provide progress or error information when \n\t\t\tyou update an accelerator from IPv4 to dual-stack, or from dual-stack to IPv4. Global Accelerator stores a maximum \n\t\t\tof ten event messages.
Advertises an IPv4 address range that is provisioned for use with your AWS resources \n\t\t\tthrough bring your own IP addresses (BYOIP). It can take a few minutes before traffic to \n\t\t\tthe specified addresses starts routing to AWS because of propagation delays.
\n\t\tTo stop advertising the BYOIP address range, use \n\t\t\tWithdrawByoipCidr.
\n\t\tFor more information, see Bring Your Own \n\t\t\tIP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources \n\t\t\tthrough bring your own IP addresses (BYOIP). It can take a few minutes before traffic to \n\t\t\tthe specified addresses starts routing to Amazon Web Services because of propagation delays.
\n\t\tTo stop advertising the BYOIP address range, use \n\t\t\tWithdrawByoipCidr.
\n\t\tFor more information, see Bring your own \n\t\t IP addresses (BYOIP) in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#AdvertiseByoipCidrRequest": { @@ -305,7 +343,13 @@ "input": { "target": "com.amazonaws.globalaccelerator#AllowCustomRoutingTrafficRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ + { + "target": "com.amazonaws.globalaccelerator#EndpointGroupNotFoundException" + }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, @@ -398,12 +442,12 @@ "Events": { "target": "com.amazonaws.globalaccelerator#ByoipCidrEvents", "traits": { - "smithy.api#documentation": "A history of status changes for an IP address range that you bring to AWS Global Accelerator\n\t\t\tthrough bring your own IP address (BYOIP).
" + "smithy.api#documentation": "A history of status changes for an IP address range that you bring to Global Accelerator\n\t\t\tthrough bring your own IP address (BYOIP).
" } } }, "traits": { - "smithy.api#documentation": "Information about an IP address range that is provisioned for use with your AWS resources through \n\t\t\tbring your own IP address (BYOIP).
\n\t\tThe following describes each BYOIP State that your IP address range can be in.
\n PENDING_PROVISIONING — \n\t\t\t\tYou’ve submitted a request to provision an IP address range but it is not yet provisioned with \n\t\t\t\tAWS Global Accelerator.
\n\n READY — The address range is provisioned \n\t\t\t\twith AWS Global Accelerator and can be advertised.
\n\n PENDING_ADVERTISING — You’ve submitted a \n\t\t\t\trequest for AWS Global Accelerator to advertise an address range but it is not yet being advertised.
\n\n ADVERTISING — The address range is \n\t\t\t\tbeing advertised by AWS Global Accelerator.
\n\n PENDING_WITHDRAWING — You’ve submitted \n\t\t\t\ta request to withdraw an address range from being advertised but it is still being advertised \n\t\t\t\tby AWS Global Accelerator.
\n\n PENDING_DEPROVISIONING — You’ve submitted a \n\t\t\t\trequest to deprovision an address range from AWS Global Accelerator but it is still provisioned.
\n\n DEPROVISIONED — The address range is deprovisioned \n\t\t\t\tfrom AWS Global Accelerator.
\n\n FAILED_PROVISION — The request to \n\t\t\t\tprovision the address range from AWS Global Accelerator was not successful. Please make sure that\n\t\t\t\tyou provide all of the correct information, and try again. If the request fails\n\t\t\t\ta second time, contact AWS support.
\n\n FAILED_ADVERTISING — The request for AWS Global Accelerator\n\t\t\t\tto advertise the address range was not successful. Please make sure that\n\t\t\t\tyou provide all of the correct information, and try again. If the request fails\n\t\t\t\ta second time, contact AWS support.
\n\n FAILED_WITHDRAW — The request to withdraw \n\t\t\t\tthe address range from advertising by AWS Global Accelerator was not successful. Please make sure that\n\t\t\t\tyou provide all of the correct information, and try again. If the request fails\n\t\t\t\ta second time, contact AWS support.
\n\n FAILED_DEPROVISION — The request to \n\t\t\t\tdeprovision the address range from AWS Global Accelerator was not successful. Please make sure that\n\t\t\t\tyou provide all of the correct information, and try again. If the request fails\n\t\t\t\ta second time, contact AWS support.
\nInformation about an IP address range that is provisioned for use with your Amazon Web Services resources through \n\t\t\tbring your own IP address (BYOIP).
\n\t\tThe following describes each BYOIP State that your IP address range can be in.
\n PENDING_PROVISIONING — \n\t\t\t\tYou’ve submitted a request to provision an IP address range but it is not yet provisioned with \n\t\t\t Global Accelerator.
\n\n READY — The address range is provisioned \n\t\t\t with Global Accelerator and can be advertised.
\n\n PENDING_ADVERTISING — You’ve submitted a \n\t\t\t request for Global Accelerator to advertise an address range but it is not yet being advertised.
\n\n ADVERTISING — The address range is \n\t\t\t being advertised by Global Accelerator.
\n\n PENDING_WITHDRAWING — You’ve submitted \n\t\t\t\ta request to withdraw an address range from being advertised but it is still being advertised \n\t\t\t\tby Global Accelerator.
\n\n PENDING_DEPROVISIONING — You’ve submitted a \n\t\t\t request to deprovision an address range from Global Accelerator but it is still provisioned.
\n\n DEPROVISIONED — The address range is deprovisioned \n\t\t\t from Global Accelerator.
\n\n FAILED_PROVISION — The request to \n\t\t\t provision the address range from Global Accelerator was not successful. Please make sure that\n\t\t\t\tyou provide all of the correct information, and try again. If the request fails\n\t\t\t\ta second time, contact Amazon Web Services support.
\n\n FAILED_ADVERTISING — The request for Global Accelerator\n\t\t\t\tto advertise the address range was not successful. Please make sure that\n\t\t\t\tyou provide all of the correct information, and try again. If the request fails\n\t\t\t\ta second time, contact Amazon Web Services support.
\n\n FAILED_WITHDRAW — The request to withdraw \n\t\t\t the address range from advertising by Global Accelerator was not successful. Please make sure that\n\t\t\t\tyou provide all of the correct information, and try again. If the request fails\n\t\t\t\ta second time, contact Amazon Web Services support.
\n\n FAILED_DEPROVISION — The request to \n\t\t\t deprovision the address range from Global Accelerator was not successful. Please make sure that\n\t\t\t\tyou provide all of the correct information, and try again. If the request fails\n\t\t\t\ta second time, contact Amazon Web Services support.
\nA string that contains an Event message describing changes that you make in the status \n\t\t\tof an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).
A string that contains an Event message describing changes that you make in the status \n\t\t\tof an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).
A timestamp when you make a status change for an IP address range that you bring to AWS Global Accelerator through \n\t\t\tbring your own IP address (BYOIP).
" + "smithy.api#documentation": "A timestamp for when you make a status change for an IP address range that you bring to Global Accelerator through \n\t\t\tbring your own IP address (BYOIP).
" } } }, "traits": { - "smithy.api#documentation": "A complex type that contains a Message and a Timestamp value for changes \n\t\t\tthat you make in the status an IP address range that you bring to AWS Global Accelerator through bring your own IP \n\t\t\taddress (BYOIP).
A complex type that contains a Message and a Timestamp value for changes \n\t\t\tthat you make in the status of an IP address range that you bring to Global Accelerator through bring your own IP \n\t\t\taddress (BYOIP).
Provides authorization for Amazon to bring a specific IP address range to a specific AWS \n\t\t\taccount using bring your own IP addresses (BYOIP).
\n\t\tFor more information, see Bring Your Own \n\t\t\tIP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Provides authorization for Amazon to bring a specific IP address range to a specific Amazon Web Services \n\t\t\taccount using bring your own IP addresses (BYOIP).
\n\t\tFor more information, see Bring your own \n\t\t IP addresses (BYOIP) in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#ClientAffinity": { @@ -572,7 +616,7 @@ } ], "traits": { - "smithy.api#documentation": "Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic\n\t\t\tto one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers.
\t\n\t\tGlobal Accelerator is a global service that supports endpoints in multiple AWS Regions but you must specify the \n\t\t\t\tUS West (Oregon) Region to create or update accelerators.
\n\t\tCreate an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic\n\t\t\tto one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers.
\t\n\t\tGlobal Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the \n\t\t\t\tUS West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2\n\t\t\t\ton AWS CLI commands.
The name of an accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or\n\t\t\thyphens (-), and must not begin or end with a hyphen.
", + "smithy.api#documentation": "The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, \n\t\t\tperiods (.), or hyphens (-), and must not begin or end with a hyphen or period.
", "smithy.api#required": {} } }, "IpAddressType": { "target": "com.amazonaws.globalaccelerator#IpAddressType", "traits": { - "smithy.api#documentation": "The value for the address type must be IPv4.
" + "smithy.api#documentation": "The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.
" } }, "IpAddresses": { "target": "com.amazonaws.globalaccelerator#IpAddresses", "traits": { - "smithy.api#documentation": "Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses \n\t\t\tfrom your own pool to use for the accelerator's static IP addresses when you create an accelerator. You can \n\t\t\tspecify one or two addresses, separated by a space. Do not include the /32 suffix.
\n\t\tOnly one IP address from each of your IP address ranges can be used for each accelerator. If you specify only \n\t\t\tone IP address from your IP address range, Global Accelerator assigns a second static IP address for the \n\t\t\taccelerator from the AWS IP address pool.
\n\t\tNote that you can't update IP addresses for an existing accelerator. To change them, you must create a new \n\t\t\taccelerator with the new addresses.
\n\t\tFor more information, see Bring Your Own \n\t\t\tIP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address \n\t\t\tfrom your own pool to use for the accelerator's static IPv4 address when you create an accelerator.
\n\tAfter you bring an address range to Amazon Web Services, it appears in your account as an address pool. \n\t \tWhen you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns \n\t \tyou a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges \n\t \tto Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is \n\t\t\tbecause Global Accelerator assigns each address range to a different network zone, for high availability.
\n\t\tYou can specify one or two addresses, separated by a space. Do not include the /32 suffix.
\n\t\tNote that you can't update IP addresses for an existing accelerator. To change them, you must create a new \n\t\t\taccelerator with the new addresses.
\n\t\tFor more information, see Bring \n\t\t your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
" } }, "Enabled": { @@ -614,7 +658,7 @@ "Tags": { "target": "com.amazonaws.globalaccelerator#Tags", "traits": { - "smithy.api#documentation": "Create tags for an accelerator.
\n\t\tFor more information, see Tagging\n\t\t\tin AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Create tags for an accelerator.
\n\t\tFor more information, see Tagging\n\t\t in Global Accelerator in the Global Accelerator Developer Guide.
" } } } @@ -653,7 +697,7 @@ } ], "traits": { - "smithy.api#documentation": "Create a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands\n\t\tof Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints.
\n\tBe aware that, by default, all destination EC2 instances in a VPC subnet endpoint cannot receive\n\t\t\ttraffic. To enable all destinations to receive traffic, or to specify individual port\n\t\t\tmappings that can receive traffic, see the \n\t\t\t\tAllowCustomRoutingTraffic operation.
\n\tGlobal Accelerator is a global service that supports endpoints in multiple AWS Regions but you must specify the \n\t\t\tUS West (Oregon) Region to create or update accelerators.
\n\tCreate a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands\n\t of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints.
\n\tBe aware that, by default, all destination EC2 instances in a VPC subnet endpoint cannot receive\n\t\t\ttraffic. To enable all destinations to receive traffic, or to specify individual port\n\t\t\tmappings that can receive traffic, see the \n\t\t\t\tAllowCustomRoutingTraffic operation.
\n\tGlobal Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the \n\t\t\tUS West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2\n\t\t\ton AWS CLI commands.
The value for the address type must be IPv4.
" + "smithy.api#documentation": "The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
" } }, "IpAddresses": { "target": "com.amazonaws.globalaccelerator#IpAddresses", "traits": { - "smithy.api#documentation": "Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses \n\t\t\t\tfrom your own pool to use for the accelerator's static IP addresses when you create an accelerator. You can \n\t\t\t\tspecify one or two addresses, separated by a space. Do not include the /32 suffix.
\n\t\t\tOnly one IP address from each of your IP address ranges can be used for each accelerator. If you specify only \n\t\t\t\tone IP address from your IP address range, Global Accelerator assigns a second static IP address for the \n\t\t\t\taccelerator from the AWS IP address pool.
\n\t\t\tNote that you can't update IP addresses for an existing accelerator. To change them, you must create a new \n\t\t\t\taccelerator with the new addresses.
\n\t\t\tFor more information, see Bring \n\t\t\t\tyour own IP addresses (BYOIP) in the AWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address \n\t\t\tfrom your own pool to use for the accelerator's static IPv4 address when you create an accelerator.
\n\t\tAfter you bring an address range to Amazon Web Services, it appears in your account as an address pool. \n\t\t\tWhen you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns \n\t\t\tyou a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges \n\t\t\tto Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is \n\t\t\tbecause Global Accelerator assigns each address range to a different network zone, for high availability.
\n\t\tYou can specify one or two addresses, separated by a space. Do not include the /32 suffix.
\n\t\tNote that you can't update IP addresses for an existing accelerator. To change them, you must create a new \n\t\t\taccelerator with the new addresses.
\n\t\tFor more information, see Bring \n\t\t\tyour own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
" } }, "Enabled": { @@ -695,7 +739,7 @@ "Tags": { "target": "com.amazonaws.globalaccelerator#Tags", "traits": { - "smithy.api#documentation": "Create tags for an accelerator.
\n\tFor more information, see Tagging\n\t\tin AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Create tags for an accelerator.
\n\tFor more information, see Tagging\n\t in Global Accelerator in the Global Accelerator Developer Guide.
" } } } @@ -746,7 +790,7 @@ } ], "traits": { - "smithy.api#documentation": "Create an endpoint group for the specified listener for a custom routing accelerator. \n\t\tAn endpoint group is a collection of endpoints in one AWS\n\t\tRegion.
" + "smithy.api#documentation": "Create an endpoint group for the specified listener for a custom routing accelerator. \n\t An endpoint group is a collection of endpoints in one Amazon Web Services\n\t\tRegion.
" } }, "com.amazonaws.globalaccelerator#CreateCustomRoutingEndpointGroupRequest": { @@ -762,7 +806,7 @@ "EndpointGroupRegion": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "The AWS Region where the endpoint group is located. A listener can have only one endpoint group in a\n\t\tspecific Region.
", + "smithy.api#documentation": "The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a\n\t\tspecific Region.
", "smithy.api#required": {} } }, @@ -893,7 +937,7 @@ } ], "traits": { - "smithy.api#documentation": "Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS\n\t\t\tRegion. A resource must be valid and active when you add it as an endpoint.
" + "smithy.api#documentation": "Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one Amazon Web Services\n\t\t\tRegion. A resource must be valid and active when you add it as an endpoint.
" } }, "com.amazonaws.globalaccelerator#CreateEndpointGroupRequest": { @@ -909,7 +953,7 @@ "EndpointGroupRegion": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "The AWS Region where the endpoint group is located. A listener can have only one endpoint group in a\n\t\t\tspecific Region.
", + "smithy.api#documentation": "The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a\n\t\t\tspecific Region.
", "smithy.api#required": {} } }, @@ -922,19 +966,19 @@ "TrafficDialPercentage": { "target": "com.amazonaws.globalaccelerator#TrafficDialPercentage", "traits": { - "smithy.api#documentation": "The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for\n\t\t\tthis listener.
\n\t\tUse this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is\n\t\t\tapplied to the traffic that would otherwise have been routed to the Region based on optimal routing.
\n\t\tThe default value is 100.
" + "smithy.api#documentation": "The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for\n\t\t\tthis listener.
\n\t\tUse this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is\n\t\t\tapplied to the traffic that would otherwise have been routed to the Region based on optimal routing.
\n\t\tThe default value is 100.
" } }, "HealthCheckPort": { "target": "com.amazonaws.globalaccelerator#HealthCheckPort", "traits": { - "smithy.api#documentation": "The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port\n\t\t\tis the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the\n\t\t\tfirst port in the list.
" + "smithy.api#documentation": "The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port\n\t is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the\n\t\t\tfirst port in the list.
" } }, "HealthCheckProtocol": { "target": "com.amazonaws.globalaccelerator#HealthCheckProtocol", "traits": { - "smithy.api#documentation": "The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default\n\t\t\tvalue is TCP.
" + "smithy.api#documentation": "The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default\n\t\t\tvalue is TCP.
" } }, "HealthCheckPath": { @@ -966,7 +1010,7 @@ "PortOverrides": { "target": "com.amazonaws.globalaccelerator#PortOverrides", "traits": { - "smithy.api#documentation": "Override specific listener ports used to route traffic to endpoints that are part of this endpoint group.\n\t\t\tFor example, you can create a port override in which the listener \n\t\t\treceives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 \n\t\t\tand 1443, respectively, on the endpoints.
\n\t\tFor more information, see \n\t\t\tPort overrides in the AWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Override specific listener ports used to route traffic to endpoints that are part of this endpoint group.\n\t\t\tFor example, you can create a port override in which the listener \n\t\t\treceives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 \n\t\t\tand 1443, respectively, on the endpoints.
\n\t\tFor more information, see \n\t\t\tOverriding listener ports in the Global Accelerator Developer Guide.
" } } } @@ -1038,7 +1082,7 @@ "ClientAffinity": { "target": "com.amazonaws.globalaccelerator#ClientAffinity", "traits": { - "smithy.api#documentation": "Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,\n\t\t\tregardless of the port and protocol of the client request. Client affinity gives you control over whether to always\n\t\t\troute each client to the same specific endpoint.
\n\t\tAWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client\n\t\t\taffinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port,\n\t\t\tdestination IP address, destination port, and protocol—to select the hash value, and then chooses the best\n\t\t\tendpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not\n\t\t\tbe always routed to the same endpoint because the hash value changes.
If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP\n\t\t\tinstead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties—\n\t\t\tsource (client) IP address and destination IP address—to select the hash value.
The default value is NONE.
Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,\n\t\t\tregardless of the port and protocol of the client request. Client affinity gives you control over whether to always\n\t\t\troute each client to the same specific endpoint.
\n\tGlobal Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client\n\t affinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port,\n\t\t\tdestination IP address, destination port, and protocol—to select the hash value, and then chooses the best\n\t\t\tendpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not\n\t\t\tbe always routed to the same endpoint because the hash value changes.
If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP\n\t\t instead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties—\n\t\t\tsource (client) IP address and destination IP address—to select the hash value.
The default value is NONE.
The value for the address type must be IPv4.
" + "smithy.api#documentation": "The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
" } }, "Enabled": { @@ -1098,7 +1142,7 @@ "DnsName": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.
\n\t\tThe naming convention for the DNS name is the following: A lowercase letter a,\n\t\t\tfollowed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example:\n\t\t\ta1234567890abcdef.awsglobalaccelerator.com.
\n\t\tFor more information about the default DNS name, see \n\t\t\tSupport for DNS Addressing in Global Accelerator in the AWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.
\n\t\tThe naming convention for the DNS name is the following: A lowercase letter a,\n\t\t\tfollowed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example:\n\t\t\ta1234567890abcdef.awsglobalaccelerator.com.
\n\t\tIf you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four \n\t\t\tstatic addresses for the accelerator (two IPv4 addresses and two IPv6 addresses).
\n\t\tFor more information about the default DNS name, see \n\t\t\tSupport for DNS Addressing in Global Accelerator in the Global Accelerator Developer Guide.
" } }, "Status": { @@ -1130,13 +1174,13 @@ "FlowLogsEnabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { - "smithy.api#documentation": "Indicates whether flow logs are enabled. The default value is false. If the value is true,\n\t\t\tFlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow Logs in\n\t\t\tthe AWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Indicates whether flow logs are enabled. The default value is false. If the value is true,\n\t\t\tFlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow logs in\n\t\t the Global Accelerator Developer Guide.
" } }, "FlowLogsS3Bucket": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is\n\t\t\ttrue. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the\n\t\t\tbucket.
The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is\n\t\t true. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the\n\t\t\tbucket.
The AWS Region where the endpoint group is located.
" + "smithy.api#documentation": "The Amazon Web Services Region where the endpoint group is located.
" } }, "DestinationDescriptions": { @@ -1334,7 +1378,7 @@ } }, "traits": { - "smithy.api#documentation": "A complex type for the endpoint group for a custom routing accelerator. An AWS Region can have only one endpoint group for a specific listener.\n\t\t
" + "smithy.api#documentation": "A complex type for the endpoint group for a custom routing accelerator. An Amazon Web Services Region can have only one endpoint group for a specific listener.\n\t\t
" } }, "com.amazonaws.globalaccelerator#CustomRoutingEndpointGroups": { @@ -1401,6 +1445,9 @@ "input": { "target": "com.amazonaws.globalaccelerator#DeleteAcceleratorRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AcceleratorNotDisabledException" @@ -1419,7 +1466,7 @@ } ], "traits": { - "smithy.api#documentation": "Delete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources\n\t\t\t(listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false.
When you create an accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. \n\t\t\tAlternatively, you can bring your own IP address ranges to Global Accelerator and assign IP addresses from those ranges. \n\t\t
\n\t\tThe IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and\n\t\t\tit no longer accepts or routes traffic. However, when you delete an accelerator, you lose the \n\t\t\tstatic IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them.\n\t\t\tAs a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You \n\t\t\tcan use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, \n\t\t\tsee Authentication and Access Control in\n\t\t\tthe AWS Global Accelerator Developer Guide.
\nDelete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources\n\t\t\t(listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false.
When you create an accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. \n\t Alternatively, you can bring your own IP address ranges to Global Accelerator and assign IP addresses from those ranges. \n\t\t
\n\t\tThe IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and\n\t\t\tit no longer accepts or routes traffic. However, when you delete an accelerator, you lose the \n\t\t\tstatic IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them.\n\t\t\tAs a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You \n\t\t\tcan use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, \n\t\t\tsee Identity and access management in\n\t\t the Global Accelerator Developer Guide.
\nDelete a custom routing accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources\n\t\t(listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false.
When you create a custom routing accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. \n\t
\n\t\tThe IP \n\t\t\taddresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and\n\t\t\tit no longer accepts or routes traffic. However, when you delete an accelerator, you lose the \n\t\t\tstatic IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them.\n\t\t\tAs a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You \n\t\t\tcan use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, \n\t\t\tsee Authentication and Access Control in\n\t\t\tthe AWS Global Accelerator Developer Guide.
\nDelete a custom routing accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources\n\t\t(listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false.
When you create a custom routing accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. \n\t
\n\t\tThe IP \n\t\t\taddresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and\n\t\t\tit no longer accepts or routes traffic. However, when you delete an accelerator, you lose the \n\t\t\tstatic IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them.\n\t\t\tAs a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You \n\t\t\tcan use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, \n\t\t\tsee Identity and access management in\n\t\t the Global Accelerator Developer Guide.
\nReleases the specified address range that you provisioned to use with your AWS resources \n\t\t\tthrough bring your own IP addresses (BYOIP) and deletes the corresponding address pool.
\n\t\tBefore you can release an address range, you must stop advertising it by using WithdrawByoipCidr and you must not have \n\t\t\tany accelerators that are using static IP addresses allocated from its address range.\n\t\t
\n\t\tFor more information, see Bring Your Own \n\t\t\tIP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Releases the specified address range that you provisioned to use with your Amazon Web Services resources \n\t\t\tthrough bring your own IP addresses (BYOIP) and deletes the corresponding address pool.
\n\t\tBefore you can release an address range, you must stop advertising it by using WithdrawByoipCidr and you must not have \n\t\t\tany accelerators that are using static IP addresses allocated from its address range.\n\t\t
\n\t\tFor more information, see Bring \n\t\t\tyour own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#DeprovisionByoipCidrRequest": { @@ -2122,7 +2190,7 @@ "EndpointGroupRegion": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "The AWS Region for the endpoint group.
" + "smithy.api#documentation": "The Amazon Web Services Region for the endpoint group.
" } }, "DestinationSocketAddress": { @@ -2134,7 +2202,7 @@ "IpAddressType": { "target": "com.amazonaws.globalaccelerator#IpAddressType", "traits": { - "smithy.api#documentation": "The IP address type, which must be IPv4.
" + "smithy.api#documentation": "The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
" } }, "DestinationTrafficState": { @@ -2191,13 +2259,13 @@ "Weight": { "target": "com.amazonaws.globalaccelerator#EndpointWeight", "traits": { - "smithy.api#documentation": "The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic\n\t\t\tbased on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The\n\t\t\tresult is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second\n\t\t\tand third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the\n\t\t\t\tAWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic\n\t\t\tbased on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The\n\t\t\tresult is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second\n\t\t\tand third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint weights in the\n\t Global Accelerator Developer Guide.
" } }, "ClientIPPreservationEnabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { - "smithy.api#documentation": "Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. \n\t\t\tThe value is true or false. The default value is true for new accelerators.
\n\t\tIf the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as \n\t\t\ttraffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.
For more information, see \n\t\t\tPreserve Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Indicates whether client IP address preservation is enabled for an endpoint. \n\t\t\tThe value is true or false. The default value is true for new accelerators.
\n\t\tIf the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as \n\t\t\ttraffic travels to applications on the endpoint fronted by the accelerator.
Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load \n\t\t\tBalancers and Amazon EC2 instances.
\n\t\tFor more information, see \n\t\t\tPreserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
" } } }, @@ -2229,7 +2297,7 @@ "Weight": { "target": "com.amazonaws.globalaccelerator#EndpointWeight", "traits": { - "smithy.api#documentation": "The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic\n\t\t\tbased on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The\n\t\t\tresult is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second\n\t\t\tand third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the\n\t\t\t\tAWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic\n\t\t\tbased on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The\n\t\t\tresult is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second\n\t\t\tand third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint weights in the\n\t Global Accelerator Developer Guide.
" } }, "HealthState": { @@ -2247,7 +2315,7 @@ "ClientIPPreservationEnabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { - "smithy.api#documentation": "Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. \n\t\t\tThe value is true or false. The default value is true for new accelerators.
\n\t\tIf the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as \n\t\t\ttraffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.
For more information, see \n\t\t\tViewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Indicates whether client IP address preservation is enabled for an endpoint. \n\t\t\tThe value is true or false. The default value is true for new accelerators.
\n\t\tIf the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as \n\t\t\ttraffic travels to applications on the endpoint fronted by the accelerator.
Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load \n\t\t\tBalancers and Amazon EC2 instances.
\n\t\tFor more information, see \n\t\t\tPreserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
" } } }, @@ -2273,7 +2341,7 @@ "EndpointGroupRegion": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "The AWS Region where the endpoint group is located.
" + "smithy.api#documentation": "The Amazon Web Services Region where the endpoint group is located.
" } }, "EndpointDescriptions": { @@ -2285,13 +2353,13 @@ "TrafficDialPercentage": { "target": "com.amazonaws.globalaccelerator#TrafficDialPercentage", "traits": { - "smithy.api#documentation": "The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for\n\t\t\tthis listener.
\n\t\tUse this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is\n\t\t\tapplied to the traffic that would otherwise have been routed to the Region based on optimal routing.
\n\t\tThe default value is 100.
" + "smithy.api#documentation": "The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for\n\t\t\tthis listener.
\n\t\tUse this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is\n\t\t\tapplied to the traffic that would otherwise have been routed to the Region based on optimal routing.
\n\t\tThe default value is 100.
" } }, "HealthCheckPort": { "target": "com.amazonaws.globalaccelerator#HealthCheckPort", "traits": { - "smithy.api#documentation": "The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
\n\t\t \n\t\tThe default port is the port for the listener that this endpoint group is associated with. If the listener port is a\n\t\t\tlist, Global Accelerator uses the first specified port in the list of ports.
" + "smithy.api#documentation": "The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
\n\t\t\n\t\tThe default port is the port for the listener that this endpoint group is associated with. If the listener port is a\n\t\t list, Global Accelerator uses the first specified port in the list of ports.
" } }, "HealthCheckProtocol": { @@ -2321,12 +2389,12 @@ "PortOverrides": { "target": "com.amazonaws.globalaccelerator#PortOverrides", "traits": { - "smithy.api#documentation": "Allows you to override the destination ports used to route traffic to an endpoint. \n\t\t\tUsing a port override lets you to map a list of external destination ports (that your\n\t\t\tusers send traffic to) to a list of internal destination ports that you want an application \n\t\t\tendpoint to receive traffic on.
" + "smithy.api#documentation": "Allows you to override the destination ports used to route traffic to an endpoint. \n\t\t\tUsing a port override lets you map a list of external destination ports (that your\n\t\t\tusers send traffic to) to a list of internal destination ports that you want an application \n\t\t\tendpoint to receive traffic on.
" } } }, "traits": { - "smithy.api#documentation": "A complex type for the endpoint group. An AWS Region can have only one endpoint group for a specific listener.\n\t\t
" + "smithy.api#documentation": "A complex type for the endpoint group. An Amazon Web Services Region can have only one endpoint group for a specific listener.\n\t\t
" } }, "com.amazonaws.globalaccelerator#EndpointGroupAlreadyExistsException": { @@ -2410,6 +2478,21 @@ }, "com.amazonaws.globalaccelerator#GlobalAccelerator_V20180706": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Global Accelerator", + "arnNamespace": "globalaccelerator", + "cloudFormationName": "GlobalAccelerator", + "cloudTrailEventSource": "globalaccelerator.amazonaws.com", + "endpointPrefix": "globalaccelerator" + }, + "aws.auth#sigv4": { + "name": "globalaccelerator" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "This is the Global Accelerator API Reference. This guide is for developers who need detailed information about\n\t\t Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the \n\t \tGlobal Accelerator Developer Guide.
\n\tGlobal Accelerator is a service in which you create accelerators to improve the performance \n\t\t\tof your applications for local and global users. Depending on the type of accelerator you choose, you can\n\t\t\tgain additional benefits.
\n\t\tBy using a standard accelerator, you can improve availability of your internet applications \n\t\t\t that are used by a global audience. With a standard accelerator, Global Accelerator directs traffic to optimal endpoints over the Amazon Web Services \n\t\t\t\tglobal network.
\nFor other scenarios, you might choose a custom routing accelerator. With a custom routing accelerator, you \n\t\t\t\tcan use application logic to directly map one or more users to a specific endpoint among many endpoints.
\nGlobal Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the \n\t\t \tUS West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2\n\t\t \ton AWS CLI commands.
By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses \n\t\t\tare anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack,\n\t\t\tGlobal Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses. \n\t\t\tWith a standard accelerator for IPv4, instead of using the addresses that Global Accelerator provides, you can configure \n\t\t\tthese entry points to be IPv4 addresses from your own IP address ranges that you bring toGlobal Accelerator (BYOIP).
\n\t\t\n\t\t\n\tFor a standard accelerator, \n\t they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases \n\t\t\tthe availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers, \n\t \tAmazon EC2 instances, or Elastic IP addresses that are located in one Amazon Web Services Region or multiple Amazon Web Services Regions. For custom routing\n\t accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that\n\t\t\tare virtual private cloud (VPC) subnets.
\n\t\t\n\t\tThe static IP addresses remain assigned to your accelerator for as long as it exists, even if you\n\t\t\t\tdisable the accelerator and it no longer accepts or routes traffic. However, when you\n\t\t\t\t\tdelete an accelerator, you lose the static IP addresses that\n\t\t\t\tare assigned to it, so you can no longer route traffic by using them. You can use\n\t\t\t\tIAM policies like tag-based permissions with Global Accelerator to limit the users who have\n\t\t\t\tpermissions to delete an accelerator. For more information, see Tag-based policies.
\nFor standard accelerators, Global Accelerator uses the Amazon Web Services global network to route traffic to the optimal regional endpoint based\n\t\t\ton health, client location, and policies that you configure. The service reacts instantly to\n\t\t\tchanges in health or configuration to ensure that internet traffic from clients is always\n\t\t\tdirected to healthy endpoints.
\n\t\tFor more information about understanding and using Global Accelerator, see the\n\t\t\tGlobal Accelerator Developer Guide.
", + "smithy.api#title": "AWS Global Accelerator" + }, "version": "2018-08-08", "operations": [ { @@ -2553,22 +2636,7 @@ { "target": "com.amazonaws.globalaccelerator#WithdrawByoipCidr" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Global Accelerator", - "arnNamespace": "globalaccelerator", - "cloudFormationName": "GlobalAccelerator", - "cloudTrailEventSource": "globalaccelerator.amazonaws.com", - "endpointPrefix": "globalaccelerator" - }, - "aws.auth#sigv4": { - "name": "globalaccelerator" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "This is the AWS Global Accelerator API Reference. This guide is for developers who need detailed information about\n\t\t\tAWS Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the \n\t\t\tAWS Global Accelerator Developer Guide.
\n \n\t\tAWS Global Accelerator is a service in which you create accelerators to improve the performance \n\t\t\tof your applications for local and global users. Depending on the type of accelerator you choose, you can\n\t\t\tgain additional benefits.
\n\t\tBy using a standard accelerator, you can improve availability of your internet applications \n\t\t\t\tthat are used by a global audience. With a standard accelerator, Global Accelerator directs traffic to optimal endpoints over the AWS \n\t\t\t\tglobal network.
\nFor other scenarios, you might choose a custom routing accelerator. With a custom routing accelerator, you \n\t\t\t\tcan use application logic to directly map one or more users to a specific endpoint among many endpoints.
\nGlobal Accelerator is a global service that supports endpoints in multiple AWS Regions but you must specify the \n\t\t\t\tUS West (Oregon) Region to create or update accelerators.
\n\t\tBy default, Global Accelerator provides you with two static IP addresses that you associate with your accelerator. With\n\t\t\ta standard accelerator, instead of using the \n\t\t\tIP addresses that Global Accelerator provides, you can configure these entry points to be IPv4 addresses from your own IP address ranges \n\t\t\tthat you bring to Global Accelerator. The static IP addresses are anycast from the AWS edge network. For a standard accelerator, \n\t\t\tthey distribute incoming application traffic across multiple endpoint resources in multiple AWS Regions, which increases \n\t\t\tthe availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers, \n\t\t\tAmazon EC2 instances, or Elastic IP addresses that are located in one AWS Region or multiple Regions. For custom routing\n\t\t\taccelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that\n\t\t\tare virtual private cloud (VPC) subnets.
\n\t\t\n\t\tThe static IP addresses remain assigned to your accelerator for as long as it exists, even if you\n\t\t\t\tdisable the accelerator and it no longer accepts or routes traffic. However, when you\n\t\t\t\t\tdelete an accelerator, you lose the static IP addresses that\n\t\t\t\tare assigned to it, so you can no longer route traffic by using them. You can use\n\t\t\t\tIAM policies like tag-based permissions with Global Accelerator to limit the users who have\n\t\t\t\tpermissions to delete an accelerator. For more information, see Tag-based policies.
\nFor standard accelerators, Global Accelerator uses the AWS global network to route traffic to the optimal regional endpoint based\n\t\t\ton health, client location, and policies that you configure. The service reacts instantly to\n\t\t\tchanges in health or configuration to ensure that internet traffic from clients is always\n\t\t\tdirected to healthy endpoints.
\n\t\t\n\t\tFor a list of the AWS Regions where Global Accelerator and other services are currently supported, see the \n\t\t\tAWS \n\t\t\t\tRegion Table.
\n\n\t\tAWS Global Accelerator includes the following components:
\n\t\tGlobal Accelerator provides you with a set of two static IP addresses that are anycast from the AWS edge\n\t\t\t\t\tnetwork. If you bring your own IP address range to AWS (BYOIP) to use with a standard accelerator, you \n\t\t\t\t\tcan instead assign IP addresses from your own pool to use with your accelerator. For more information, \n\t\t\t\t\tsee \n\t\t\t\t\t\tBring your own IP addresses (BYOIP) in AWS Global Accelerator.
\n\t\t\t\t\tThe IP addresses serve as single fixed entry points for your clients. If you already have Elastic\n\t\t\t\t\t\tLoad Balancing load balancers, Amazon EC2 instances, or Elastic IP address resources set up for your applications, \n\t\t\t\t\t\tyou can easily add those to a standard accelerator in Global Accelerator. This allows Global Accelerator to use static IP addresses \n\t\t\t\t\t\tto access the resources.
\n\t\t\t\t\tThe static IP addresses remain assigned to your accelerator for as long as it exists, even\n\t\t\t\t\t\tif you disable the accelerator and it no longer accepts or routes traffic.\n\t\t\t\t\t\tHowever, when you delete an accelerator, you lose the\n\t\t\t\t\t\tstatic IP addresses that are assigned to it, so you can no longer route\n\t\t\t\t\t\ttraffic by using them. You can use IAM policies like tag-based permissions\n\t\t\t\t\t\twith Global Accelerator to delete an accelerator. For more information, see Tag-based policies.
\n\t\t\t\tAn accelerator directs traffic to endpoints over the AWS global network to improve the\n\t\t\t\t\tperformance of your internet applications. Each accelerator includes one or more listeners.
\n\t\t\t\t\tThere are two types of accelerators:
\n\t\t\t\t\tA standard accelerator directs traffic to the optimal AWS endpoint based \n\t\t\t\t\t\t\ton several factors, including the user’s location, the health of the endpoint, and the endpoint weights \n\t\t\t\t\t\t\tthat you configure. This improves the availability and performance of your applications.\n\t\t\t\t\t\t\tEndpoints can be Network Load Balancers, Application Load Balancers, Amazon EC2 instances, or Elastic IP addresses.
\nA custom routing accelerator directs traffic to one of possibly thousands of\n\t\t\t\t\t\t\t\tAmazon EC2 instances running in a single or multiple virtual private\n\t\t\t\t\t\t\t\tclouds (VPCs). With custom routing, listener ports are mapped to\n\t\t\t\t\t\t\t\tstatically associate port ranges with VPC subnets, which\n\t\t\t\t\t\t\t\tallows Global Accelerator to determine an EC2 instance IP address at the time of\n\t\t\t\t\t\t\t\tconnection. By default, all port mapping destinations in a VPC\n\t\t\t\t\t\t\t\tsubnet can't receive traffic. You can choose to configure all\n\t\t\t\t\t\t\t\tdestinations in the subnet to receive traffic, or to specify\n\t\t\t\t\t\t\t\tindividual port mappings that can receive traffic.
\nFor more information, see Types of accelerators.
\n\t\t\t\tGlobal Accelerator assigns each accelerator a default Domain Name System (DNS) name, similar to\n\t\t\t\t\ta1234567890abcdef.awsglobalaccelerator.com, that points to\n\t\t\t\t\tthe static IP addresses that Global Accelerator assigns to you or that you choose from your\n\t\t\t\t\town IP address range. Depending on the use\n\t\t\t\t\tcase, you can use your accelerator's static IP addresses or DNS name to\n\t\t\t\t\troute traffic to your accelerator, or set up DNS records to route traffic using\n\t\t\t\t\tyour own custom domain name.
A network zone services the static IP addresses for your accelerator from a unique IP subnet. Similar to an\n\t\t\t\t\tAWS Availability Zone, a network zone is an isolated unit with its own set of physical infrastructure.\n\t\t\t\t\tWhen you configure an accelerator, by default, Global Accelerator allocates two IPv4 addresses for it. If one IP address from a\n\t\t\t\t\tnetwork zone becomes unavailable due to IP address blocking by certain client networks, or network\n\t\t\t\t\tdisruptions, then client applications can retry on the healthy static IP address from the other isolated\n\t\t\t\t\tnetwork zone.
\n\t\t\t\tA listener processes inbound connections from clients to Global Accelerator, based on the port (or port range) \n\t\t\t\t\tand protocol (or protocols) that you configure. A listener can be configured for TCP, UDP, or both TCP and UDP protocols. Each \n\t\t\t\t\tlistener has one or more endpoint groups associated with it, and traffic is forwarded \n\t\t\t\t\tto endpoints in one of the groups. You associate endpoint groups with listeners by specifying the Regions that you \n\t\t\t\t\twant to distribute traffic to. With a standard accelerator, traffic is distributed to optimal endpoints within the endpoint \n\t\t\t\t\tgroups associated with a listener.
\nEach endpoint group is associated with a specific AWS Region. Endpoint groups include one or\n\t\t\t\t\tmore endpoints in the Region. With a standard accelerator, you can increase or reduce the percentage of\n\t\t\t\t\ttraffic that would be otherwise directed to an endpoint group by adjusting a\n\t\t\t\t\tsetting called a traffic dial. The traffic dial lets\n\t\t\t\t\tyou easily do performance testing or blue/green deployment testing, for example, for new\n\t\t\t\t\treleases across different AWS Regions.
\n\t\t\t\tAn endpoint is a resource that Global Accelerator directs traffic to.
\n\t\t\t\t\tEndpoints for standard accelerators can be Network Load Balancers, Application Load Balancers, Amazon EC2 instances, or Elastic IP\n\t\t\t\t\t\taddresses. An Application Load Balancer endpoint can be internet-facing or internal. Traffic for\n\t\t\t\t\t\tstandard accelerators is routed to endpoints based on the health of the\n\t\t\t\t\t\tendpoint along with configuration options that you choose, such as endpoint\n\t\t\t\t\t\tweights. For each endpoint, you can configure weights, which are numbers\n\t\t\t\t\t\tthat you can use to specify the proportion of traffic to route to each one.\n\t\t\t\t\t\tThis can be useful, for example, to do performance testing within a\n\t\t\t\t\t\tRegion.
\n\t\t\t\t\tEndpoints for custom routing accelerators are virtual private cloud (VPC) subnets with one\n\t\t\t\t\t\tor many EC2 instances.
\n\t\t\t\tThere was an internal error for AWS Global Accelerator.
", + "smithy.api#documentation": "There was an internal error for Global Accelerator.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -2721,6 +2789,21 @@ } } }, + "com.amazonaws.globalaccelerator#IpAddressFamily": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "IPv4", + "name": "IPv4" + }, + { + "value": "IPv6", + "name": "IPv6" + } + ] + } + }, "com.amazonaws.globalaccelerator#IpAddressType": { "type": "string", "traits": { @@ -2728,6 +2811,10 @@ { "value": "IPV4", "name": "IPV4" + }, + { + "value": "DUAL_STACK", + "name": "DUAL_STACK" } ] } @@ -2750,7 +2837,10 @@ "IpFamily": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "The types of IP addresses included in this IP set.
" + "smithy.api#deprecated": { + "message": "IpFamily has been replaced by IpAddressFamily" + }, + "smithy.api#documentation": "IpFamily is deprecated and has been replaced by IpAddressFamily.
" } }, "IpAddresses": { @@ -2758,6 +2848,12 @@ "traits": { "smithy.api#documentation": "The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.
" } + }, + "IpAddressFamily": { + "target": "com.amazonaws.globalaccelerator#IpAddressFamily", + "traits": { + "smithy.api#documentation": "The types of IP addresses included in this IP set.
" + } } }, "traits": { @@ -2778,7 +2874,7 @@ } }, "traits": { - "smithy.api#documentation": "Processing your request would cause you to exceed an AWS Global Accelerator limit.
", + "smithy.api#documentation": "Processing your request would cause you to exceed an Global Accelerator limit.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -2803,10 +2899,11 @@ } ], "traits": { - "smithy.api#documentation": "List the accelerators for an AWS account.
", + "smithy.api#documentation": "List the accelerators for an Amazon Web Services account.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Accelerators", "pageSize": "MaxResults" } } @@ -2872,6 +2969,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "ByoipCidrs", "pageSize": "MaxResults" } } @@ -2930,10 +3028,11 @@ } ], "traits": { - "smithy.api#documentation": "List the custom routing accelerators for an AWS account.
", + "smithy.api#documentation": "List the custom routing accelerators for an Amazon Web Services account.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Accelerators", "pageSize": "MaxResults" } } @@ -3071,6 +3170,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Listeners", "pageSize": "MaxResults" } } @@ -3142,10 +3242,11 @@ } ], "traits": { - "smithy.api#documentation": "Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance\n\t\tIP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator.\n\t\tFor each subnet endpoint that you add, Global Accelerator creates a new static port mapping for the accelerator. The port \n\t\tmappings don't change after Global Accelerator generates them, so you can retrieve and cache the full mapping on your servers.
\n\tIf you remove a subnet from your accelerator, Global Accelerator removes (reclaims) the port mappings. If you add a subnet to \n\t\tyour accelerator, Global Accelerator creates new port mappings (the existing ones don't change). If you add or remove EC2 instances\n\t\tin your subnet, the port mappings don't change, because the mappings are created when you add the subnet to Global Accelerator.
\n\tThe mappings also include a flag for each destination denoting which destination IP addresses and\n\t\tports are allowed or denied traffic.
", + "smithy.api#documentation": "Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance\n\t\tIP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator.\n\t\tFor each subnet endpoint that you add, Global Accelerator creates a new static port mapping for the accelerator. The port \n\t mappings don't change after Global Accelerator generates them, so you can retrieve and cache the full mapping on your servers.
\nIf you remove a subnet from your accelerator, Global Accelerator removes (reclaims) the port mappings. If you add a subnet to \n your accelerator, Global Accelerator creates new port mappings (the existing ones don't change). If you add or remove EC2 instances\n in your subnet, the port mappings don't change, because the mappings are created when you add the subnet to Global Accelerator.
\n\tThe mappings also include a flag for each destination denoting which destination IP addresses and\n\t\tports are allowed or denied traffic.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "PortMappings", "pageSize": "MaxResults" } } @@ -3177,6 +3278,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "DestinationPortMappings", "pageSize": "MaxResults" } } @@ -3303,6 +3405,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "EndpointGroups", "pageSize": "MaxResults" } } @@ -3375,6 +3478,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Listeners", "pageSize": "MaxResults" } } @@ -3440,7 +3544,7 @@ } ], "traits": { - "smithy.api#documentation": "List all tags for an accelerator.
\n\t\tFor more information, see Tagging\n\t\t\tin AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "List all tags for an accelerator.
\n\t\tFor more information, see Tagging\n\t\t in Global Accelerator in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#ListTagsForResourceRequest": { @@ -3490,7 +3594,7 @@ "ClientAffinity": { "target": "com.amazonaws.globalaccelerator#ClientAffinity", "traits": { - "smithy.api#documentation": "Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,\n\t\t\tregardless of the port and protocol of the client request. Client affinity gives you control over whether to always\n\t\t\troute each client to the same specific endpoint.
\n\t\tAWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client\n\t\t\taffinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port,\n\t\t\tdestination IP address, destination port, and protocol—to select the hash value, and then chooses the best\n\t\t\tendpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not\n\t\t\tbe always routed to the same endpoint because the hash value changes.
If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP\n\t\t\tinstead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties—\n\t\t\tsource (client) IP address and destination IP address—to select the hash value.
The default value is NONE.
Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,\n\t\t\tregardless of the port and protocol of the client request. Client affinity gives you control over whether to always\n\t\t\troute each client to the same specific endpoint.
\n\tGlobal Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client\n\t affinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port,\n\t\t\tdestination IP address, destination port, and protocol—to select the hash value, and then chooses the best\n\t\t\tendpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not\n\t\t\tbe always routed to the same endpoint because the hash value changes.
If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP\n\t\t instead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties—\n\t\t\tsource (client) IP address and destination IP address—to select the hash value.
The default value is NONE.
Returns the ports and associated IP addresses and ports of Amazon EC2 instances in your virtual\n\t\t\tprivate cloud (VPC) subnets. Custom routing is a port mapping protocol in AWS Global Accelerator that\n\t\t\tstatically associates port ranges with VPC subnets, which allows Global Accelerator to route to\n\t\t\tspecific instances and ports within one or more subnets.
" + "smithy.api#documentation": "Returns the ports and associated IP addresses and ports of Amazon EC2 instances in your virtual\n\t\t private cloud (VPC) subnets. Custom routing is a port mapping protocol in Global Accelerator that\n\t\t statically associates port ranges with VPC subnets, which allows Global Accelerator to route to\n\t\t\tspecific instances and ports within one or more subnets.
" } }, "com.amazonaws.globalaccelerator#PortMappings": { @@ -3603,18 +3707,18 @@ "ListenerPort": { "target": "com.amazonaws.globalaccelerator#PortNumber", "traits": { - "smithy.api#documentation": "The listener port that you want to map to a specific endpoint port. This is the port that user traffic\n\t\tarrives to the Global Accelerator on.
" + "smithy.api#documentation": "The listener port that you want to map to a specific endpoint port. This is the port that user traffic\n\t\t arrives to the Global Accelerator on.
" } }, "EndpointPort": { "target": "com.amazonaws.globalaccelerator#PortNumber", "traits": { - "smithy.api#documentation": "The endpoint port that you want a listener port to be mapped to. This is the port on the endpoint,\n\t\t\tsuch as the Application Load Balancer or Amazon EC2 instance.
" + "smithy.api#documentation": "The endpoint port that you want a listener port to be mapped to. This is the port on the endpoint,\n\t\t such as the Application Load Balancer or Amazon EC2 instance.
" } } }, "traits": { - "smithy.api#documentation": "Override specific listener ports used to route traffic to endpoints that are part of an endpoint group.\n\t\t\tFor example, you can create a port override in which the listener \n\t\t\treceives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 \n\t\t\tand 1443, respectively, on the endpoints.
\n\t\tFor more information, see \n\t\t\tPort overrides in the AWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Override specific listener ports used to route traffic to endpoints that are part of an endpoint group.\n\t\t\tFor example, you can create a port override in which the listener \n\t\t\treceives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 \n\t\t\tand 1443, respectively, on the endpoints.
\n\t\tFor more information, see \n\t\t Overriding listener ports in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#PortOverrides": { @@ -3708,7 +3812,7 @@ } ], "traits": { - "smithy.api#documentation": "Provisions an IP address range to use with your AWS resources through bring your own IP\n\t\t\taddresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, \n\t\t\tit is ready to be advertised using \n\t\t\tAdvertiseByoipCidr.
\n\t\tFor more information, see Bring Your Own \n\t\t\tIP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP\n\t\t\taddresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, \n\t\t\tit is ready to be advertised using \n\t\t\tAdvertiseByoipCidr.
\n\t\tFor more information, see Bring your own \n\t\t\tIP addresses (BYOIP) in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#ProvisionByoipCidrRequest": { @@ -3746,6 +3850,9 @@ "input": { "target": "com.amazonaws.globalaccelerator#RemoveCustomRoutingEndpointsRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AccessDeniedException" @@ -3887,7 +3994,7 @@ } ], "traits": { - "smithy.api#documentation": "Add tags to an accelerator resource.
\n\t\tFor more information, see Tagging\n\t\t\tin AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Add tags to an accelerator resource.
\n\t\tFor more information, see Tagging\n\t\t in Global Accelerator in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#TagResourceRequest": { @@ -3971,7 +4078,7 @@ } ], "traits": { - "smithy.api#documentation": "Remove tags from a Global Accelerator resource. When you specify a tag key, the action removes both that key and its associated value.\n\t\t\tThe operation succeeds even if you attempt to remove tags from an accelerator that was already removed.
\n\t\tFor more information, see Tagging\n\t\t\tin AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Remove tags from a Global Accelerator resource. When you specify a tag key, the action removes both that key and its associated value.\n\t\t\tThe operation succeeds even if you attempt to remove tags from an accelerator that was already removed.
\n\t\tFor more information, see Tagging\n\t\t in Global Accelerator in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#UntagResourceRequest": { @@ -4009,6 +4116,9 @@ { "target": "com.amazonaws.globalaccelerator#AcceleratorNotFoundException" }, + { + "target": "com.amazonaws.globalaccelerator#AccessDeniedException" + }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, @@ -4017,7 +4127,7 @@ } ], "traits": { - "smithy.api#documentation": "Update an accelerator.
\n\t\t\n\t\tGlobal Accelerator is a global service that supports endpoints in multiple AWS Regions but you must specify the \n\t\t\t\tUS West (Oregon) Region to create or update accelerators.
\n\t\tUpdate an accelerator.
\n\t\t\n\t\tGlobal Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the \n\t\t\t\tUS West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2\n\t\t\t\ton AWS CLI commands.
Update whether flow logs are enabled. The default value is false. If the value is true,\n\t\t\t\tFlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow Logs in\n\t\t\tthe AWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Update whether flow logs are enabled. The default value is false. If the value is true,\n\t\t\t\tFlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow Logs in\n\t\t the Global Accelerator Developer Guide.
" } }, "FlowLogsS3Bucket": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is\n\t\t\t\ttrue. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the\n\t\t\tbucket.
The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is\n\t\t true. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the\n\t\t\tbucket.
Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if\n\t\t\t\tFlowLogsEnabled is true.
If you don’t specify a prefix, the flow logs are stored in the\n\t\t\troot of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
\n\t\t\ts3-bucket_name//AWSLogs/aws_account_id
" + "smithy.api#documentation": "Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if\n\t\t\t\tFlowLogsEnabled is true.
If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), \n\t\t\tlike the following:
\n\t\t\ts3-bucket_name//AWSLogs/aws_account_id
" } } } @@ -4100,13 +4210,13 @@ "Name": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "The name of the accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or\n\t\t\thyphens (-), and must not begin or end with a hyphen.
" + "smithy.api#documentation": "The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, \n\t\t\tperiods (.), or hyphens (-), and must not begin or end with a hyphen or period.
" } }, "IpAddressType": { "target": "com.amazonaws.globalaccelerator#IpAddressType", "traits": { - "smithy.api#documentation": "The IP address type, which must be IPv4.
" + "smithy.api#documentation": "The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.
" } }, "Enabled": { @@ -4190,13 +4300,13 @@ "FlowLogsEnabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { - "smithy.api#documentation": "Update whether flow logs are enabled. The default value is false. If the value is true,\n\t\tFlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow Logs in\n\t\tthe AWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Update whether flow logs are enabled. The default value is false. If the value is true,\n\t\tFlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow logs in\n\t the Global Accelerator Developer Guide.
" } }, "FlowLogsS3Bucket": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is\n\t\ttrue. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the\n\t\tbucket.
The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is\n\t true. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the\n\t\tbucket.
The name of the accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or\n\t\thyphens (-), and must not begin or end with a hyphen.
" + "smithy.api#documentation": "The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, \n\t\tperiods (.), or hyphens (-), and must not begin or end with a hyphen or period.
" } }, "IpAddressType": { "target": "com.amazonaws.globalaccelerator#IpAddressType", "traits": { - "smithy.api#documentation": "The value for the address type must be IPv4.
" + "smithy.api#documentation": "The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
" } }, "Enabled": { @@ -4366,19 +4476,19 @@ "TrafficDialPercentage": { "target": "com.amazonaws.globalaccelerator#TrafficDialPercentage", "traits": { - "smithy.api#documentation": "The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for\n\t\t\tthis listener.
\n\t\tUse this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is\n\t\t\tapplied to the traffic that would otherwise have been routed to the Region based on optimal routing.
\n\t\tThe default value is 100.
" + "smithy.api#documentation": "The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for\n\t\t\tthis listener.
\n\t\tUse this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is\n\t\t\tapplied to the traffic that would otherwise have been routed to the Region based on optimal routing.
\n\t\tThe default value is 100.
" } }, "HealthCheckPort": { "target": "com.amazonaws.globalaccelerator#HealthCheckPort", "traits": { - "smithy.api#documentation": "The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port\n\t\t\tis the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses\n\t\t\tthe first port in the list.
" + "smithy.api#documentation": "The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port\n\t is the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses\n\t\t\tthe first port in the list.
" } }, "HealthCheckProtocol": { "target": "com.amazonaws.globalaccelerator#HealthCheckProtocol", "traits": { - "smithy.api#documentation": "The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default\n\t\t\tvalue is TCP.
" + "smithy.api#documentation": "The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default\n\t\t\tvalue is TCP.
" } }, "HealthCheckPath": { @@ -4402,7 +4512,7 @@ "PortOverrides": { "target": "com.amazonaws.globalaccelerator#PortOverrides", "traits": { - "smithy.api#documentation": "Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. \n\t\t\tFor example, you can create a port override in which the listener \n\t\t\treceives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 \n\t\t\tand 1443, respectively, on the endpoints.
\n\t\tFor more information, see \n\t\t\tPort overrides in the AWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. \n\t\t\tFor example, you can create a port override in which the listener \n\t\t\treceives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 \n\t\t\tand 1443, respectively, on the endpoints.
\n\t\tFor more information, see \n\t\t\tOverriding listener ports in the Global Accelerator Developer Guide.
" } } } @@ -4472,7 +4582,7 @@ "ClientAffinity": { "target": "com.amazonaws.globalaccelerator#ClientAffinity", "traits": { - "smithy.api#documentation": "Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,\n\t\t\tregardless of the port and protocol of the client request. Client affinity gives you control over whether to always\n\t\t\troute each client to the same specific endpoint.
\n\t\tAWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client\n\t\t\taffinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port,\n\t\t\tdestination IP address, destination port, and protocol—to select the hash value, and then chooses the best\n\t\t\tendpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not\n\t\t\tbe always routed to the same endpoint because the hash value changes.
If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP\n\t\t\tinstead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties—\n\t\t\tsource (client) IP address and destination IP address—to select the hash value.
The default value is NONE.
Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,\n\t\t\tregardless of the port and protocol of the client request. Client affinity gives you control over whether to always\n\t\t\troute each client to the same specific endpoint.
\n\tGlobal Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client\n\t affinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port,\n\t\t\tdestination IP address, destination port, and protocol—to select the hash value, and then chooses the best\n\t\t\tendpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not\n\t\t\tbe always routed to the same endpoint because the hash value changes.
If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP\n\t\t instead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties—\n\t\t\tsource (client) IP address and destination IP address—to select the hash value.
The default value is NONE.
Stops advertising an address range that is provisioned as an address pool.\n\t\t\tYou can perform this operation at most once every 10 seconds, even if you specify different address\n\t\t\tranges each time.
\n\t\tIt can take a few minutes before traffic to the specified addresses stops routing to AWS because of\n\t\t\tpropagation delays.
\n\t\tFor more information, see Bring Your Own \n\t\t\tIP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Stops advertising an address range that is provisioned as an address pool.\n\t\t\tYou can perform this operation at most once every 10 seconds, even if you specify different address\n\t\t\tranges each time.
\n\tIt can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of\n\t\t\tpropagation delays.
\n\t\tFor more information, see Bring your own \n\t\t\tIP addresses (BYOIP) in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#WithdrawByoipCidrRequest": { diff --git a/codegen/sdk/aws-models/guardduty.json b/codegen/sdk/aws-models/guardduty.json index f423054f022..f0f8fbbda41 100644 --- a/codegen/sdk/aws-models/guardduty.json +++ b/codegen/sdk/aws-models/guardduty.json @@ -1510,6 +1510,37 @@ "target": "com.amazonaws.guardduty#Condition" } }, + "com.amazonaws.guardduty#CriterionKey": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EC2_INSTANCE_ARN", + "name": "EC2_INSTANCE_ARN" + }, + { + "value": "SCAN_ID", + "name": "SCAN_ID" + }, + { + "value": "ACCOUNT_ID", + "name": "ACCOUNT_ID" + }, + { + "value": "GUARDDUTY_FINDING_ID", + "name": "GUARDDUTY_FINDING_ID" + }, + { + "value": "SCAN_START_TIME", + "name": "SCAN_START_TIME" + }, + { + "value": "SCAN_STATUS", + "name": "SCAN_STATUS" + } + ] + } + }, "com.amazonaws.guardduty#DNSLogsConfigurationResult": { "type": "structure", "members": { @@ -1549,6 +1580,10 @@ { "value": "KUBERNETES_AUDIT_LOGS", "name": "KUBERNETES_AUDIT_LOGS" + }, + { + "value": "EC2_MALWARE_SCAN", + "name": "EC2_MALWARE_SCAN" } ] } @@ -1569,6 +1604,13 @@ "smithy.api#documentation": "Describes whether any Kubernetes logs are enabled as data sources.
", "smithy.api#jsonName": "kubernetes" } + }, + "MalwareProtection": { + "target": "com.amazonaws.guardduty#MalwareProtectionConfiguration", + "traits": { + "smithy.api#documentation": "Describes whether Malware Protection is enabled as a data source.
", + "smithy.api#jsonName": "malwareProtection" + } } }, "traits": { @@ -1616,6 +1658,13 @@ "smithy.api#documentation": "An object that contains information on the status of all Kubernetes data sources.
", "smithy.api#jsonName": "kubernetes" } + }, + "MalwareProtection": { + "target": "com.amazonaws.guardduty#MalwareProtectionConfigurationResult", + "traits": { + "smithy.api#documentation": "Describes the configuration of Malware Protection data sources.
", + "smithy.api#jsonName": "malwareProtection" + } } }, "traits": { @@ -1699,6 +1748,13 @@ "smithy.api#documentation": "Describes whether any Kubernetes logs are enabled as data sources.
", "smithy.api#jsonName": "kubernetes" } + }, + "MalwareProtection": { + "target": "com.amazonaws.guardduty#MalwareProtectionDataSourceFreeTrial", + "traits": { + "smithy.api#documentation": "Describes whether Malware Protection is enabled as a data source.
", + "smithy.api#jsonName": "malwareProtection" + } } }, "traits": { @@ -2140,6 +2196,99 @@ "type": "structure", "members": {} }, + "com.amazonaws.guardduty#DescribeMalwareScans": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DescribeMalwareScansRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DescribeMalwareScansResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of malware scans.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/malware-scans", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Scans", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#DescribeMalwareScansRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that the request is associated with.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to\n null on your first call to the list action. For subsequent calls to the action, fill nextToken\n in the request with the value of NextToken from the previous response to continue listing\n data.
", + "smithy.api#jsonName": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.guardduty#IntegerValueWithMax", + "traits": { + "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items that you want in the\n response. The default value is 50. The maximum value is 50.
", + "smithy.api#jsonName": "maxResults" + } + }, + "FilterCriteria": { + "target": "com.amazonaws.guardduty#FilterCriteria", + "traits": { + "smithy.api#documentation": "Represents the criteria to be used in the filter for describing scan entries.
", + "smithy.api#jsonName": "filterCriteria" + } + }, + "SortCriteria": { + "target": "com.amazonaws.guardduty#SortCriteria", + "traits": { + "smithy.api#documentation": "Represents the criteria used for sorting scan entries.
", + "smithy.api#jsonName": "sortCriteria" + } + } + } + }, + "com.amazonaws.guardduty#DescribeMalwareScansResponse": { + "type": "structure", + "members": { + "Scans": { + "target": "com.amazonaws.guardduty#Scans", + "traits": { + "smithy.api#documentation": "Contains information about malware scans.
", + "smithy.api#jsonName": "scans", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more items.
", + "smithy.api#jsonName": "nextToken" + } + } + } + }, "com.amazonaws.guardduty#DescribeOrganizationConfiguration": { "type": "operation", "input": { @@ -2663,139 +2812,383 @@ "com.amazonaws.guardduty#Double": { "type": "double" }, - "com.amazonaws.guardduty#EksClusterDetails": { + "com.amazonaws.guardduty#EbsSnapshotPreservation": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NO_RETENTION", + "name": "NO_RETENTION" + }, + { + "value": "RETENTION_WITH_FINDING", + "name": "RETENTION_WITH_FINDING" + } + ] + } + }, + "com.amazonaws.guardduty#EbsVolumeDetails": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.guardduty#String", + "ScannedVolumeDetails": { + "target": "com.amazonaws.guardduty#VolumeDetails", "traits": { - "smithy.api#documentation": "EKS cluster name.
", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "List of EBS volumes that were scanned.
", + "smithy.api#jsonName": "scannedVolumeDetails" } }, - "Arn": { + "SkippedVolumeDetails": { + "target": "com.amazonaws.guardduty#VolumeDetails", + "traits": { + "smithy.api#documentation": "List of EBS volumes that were skipped from the malware scan.
", + "smithy.api#jsonName": "skippedVolumeDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains list of scanned and skipped EBS volumes with details.
" + } + }, + "com.amazonaws.guardduty#EbsVolumeScanDetails": { + "type": "structure", + "members": { + "ScanId": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "EKS cluster ARN.
", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "Unique Id of the malware scan that generated the finding.
", + "smithy.api#jsonName": "scanId" } }, - "VpcId": { - "target": "com.amazonaws.guardduty#String", + "ScanStartedAt": { + "target": "com.amazonaws.guardduty#Timestamp", "traits": { - "smithy.api#documentation": "The VPC ID to which the EKS cluster is attached.
", - "smithy.api#jsonName": "vpcId" + "smithy.api#documentation": "Returns the start date and time of the malware scan.
", + "smithy.api#jsonName": "scanStartedAt" } }, - "Status": { + "ScanCompletedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "Returns the completion date and time of the malware scan.
", + "smithy.api#jsonName": "scanCompletedAt" + } + }, + "TriggerFindingId": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "The EKS cluster status.
", - "smithy.api#jsonName": "status" + "smithy.api#documentation": "GuardDuty finding ID that triggered a malware scan.
", + "smithy.api#jsonName": "triggerFindingId" } }, - "Tags": { - "target": "com.amazonaws.guardduty#Tags", + "Sources": { + "target": "com.amazonaws.guardduty#Sources", "traits": { - "smithy.api#documentation": "The EKS cluster tags.
", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "Contains list of threat intelligence sources used to detect threats.
", + "smithy.api#jsonName": "sources" } }, - "CreatedAt": { - "target": "com.amazonaws.guardduty#Timestamp", + "ScanDetections": { + "target": "com.amazonaws.guardduty#ScanDetections", "traits": { - "smithy.api#documentation": "The timestamp when the EKS cluster was created.
", - "smithy.api#jsonName": "createdAt" + "smithy.api#documentation": "Contains a complete view providing malware scan result details.
", + "smithy.api#jsonName": "scanDetections" } } }, "traits": { - "smithy.api#documentation": "Details about the EKS cluster involved in a Kubernetes finding.
" + "smithy.api#documentation": "Contains details from the malware scan that created a finding.
" } }, - "com.amazonaws.guardduty#Email": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 + "com.amazonaws.guardduty#EbsVolumesResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.guardduty#DataSourceStatus", + "traits": { + "smithy.api#documentation": "Describes whether scanning EBS volumes is enabled as a data source.
", + "smithy.api#jsonName": "status" + } } - } - }, - "com.amazonaws.guardduty#EnableOrganizationAdminAccount": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#EnableOrganizationAdminAccountRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#EnableOrganizationAdminAccountResponse" }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], "traits": { - "smithy.api#documentation": "Enables an Amazon Web Services account within the organization as the GuardDuty delegated\n administrator.
", - "smithy.api#http": { - "method": "POST", - "uri": "/admin/enable", - "code": 200 - } + "smithy.api#documentation": "Describes the configuration of scanning EBS volumes as a data source.
" } }, - "com.amazonaws.guardduty#EnableOrganizationAdminAccountRequest": { + "com.amazonaws.guardduty#EcsClusterDetails": { "type": "structure", "members": { - "AdminAccountId": { + "Name": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services Account ID for the organization account to be enabled as a GuardDuty delegated\n administrator.
", - "smithy.api#jsonName": "adminAccountId", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the ECS Cluster.
", + "smithy.api#jsonName": "name" } - } - } - }, - "com.amazonaws.guardduty#EnableOrganizationAdminAccountResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.guardduty#Eq": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#String" - } - }, - "com.amazonaws.guardduty#Equals": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#String" - } - }, - "com.amazonaws.guardduty#Evidence": { - "type": "structure", - "members": { - "ThreatIntelligenceDetails": { - "target": "com.amazonaws.guardduty#ThreatIntelligenceDetails", + }, + "Arn": { + "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "A list of threat intelligence details related to the evidence.
", - "smithy.api#jsonName": "threatIntelligenceDetails" + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the cluster.
", + "smithy.api#jsonName": "arn" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The status of the ECS cluster.
", + "smithy.api#jsonName": "status" + } + }, + "ActiveServicesCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The number of services that are running on the cluster in an ACTIVE state.
", + "smithy.api#jsonName": "activeServicesCount" + } + }, + "RegisteredContainerInstancesCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The number of container instances registered into the cluster.
", + "smithy.api#jsonName": "registeredContainerInstancesCount" + } + }, + "RunningTasksCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The number of tasks in the cluster that are in the RUNNING state.
", + "smithy.api#jsonName": "runningTasksCount" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#Tags", + "traits": { + "smithy.api#documentation": "The tags of the ECS Cluster.
", + "smithy.api#jsonName": "tags" + } + }, + "TaskDetails": { + "target": "com.amazonaws.guardduty#EcsTaskDetails", + "traits": { + "smithy.api#documentation": "Contains information about the details of the ECS Task.
", + "smithy.api#jsonName": "taskDetails" } } }, "traits": { - "smithy.api#documentation": "Contains information about the reason that the finding was generated.
" + "smithy.api#documentation": "Contains information about the details of the ECS Cluster.
" } }, - "com.amazonaws.guardduty#Feedback": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { + "com.amazonaws.guardduty#EcsTaskDetails": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task.
", + "smithy.api#jsonName": "arn" + } + }, + "DefinitionArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The ARN of the task definition that creates the task.
", + "smithy.api#jsonName": "definitionArn" + } + }, + "Version": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The version counter for the task.
", + "smithy.api#jsonName": "version" + } + }, + "TaskCreatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp for the time when the task was created.
", + "smithy.api#jsonName": "createdAt" + } + }, + "StartedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp for the time when the task started.
", + "smithy.api#jsonName": "startedAt" + } + }, + "StartedBy": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Contains the tag specified when a task is started.
", + "smithy.api#jsonName": "startedBy" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#Tags", + "traits": { + "smithy.api#documentation": "The tags of the ECS Task.
", + "smithy.api#jsonName": "tags" + } + }, + "Volumes": { + "target": "com.amazonaws.guardduty#Volumes", + "traits": { + "smithy.api#documentation": "The list of data volume definitions for the task.
", + "smithy.api#jsonName": "volumes" + } + }, + "Containers": { + "target": "com.amazonaws.guardduty#Containers", + "traits": { + "smithy.api#documentation": "The containers that's associated with the task.
", + "smithy.api#jsonName": "containers" + } + }, + "Group": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the task group that's associated with the task.
", + "smithy.api#jsonName": "group" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the task in an ECS cluster.
" + } + }, + "com.amazonaws.guardduty#EksClusterDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "EKS cluster name.
", + "smithy.api#jsonName": "name" + } + }, + "Arn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "EKS cluster ARN.
", + "smithy.api#jsonName": "arn" + } + }, + "VpcId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The VPC ID to which the EKS cluster is attached.
", + "smithy.api#jsonName": "vpcId" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The EKS cluster status.
", + "smithy.api#jsonName": "status" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#Tags", + "traits": { + "smithy.api#documentation": "The EKS cluster tags.
", + "smithy.api#jsonName": "tags" + } + }, + "CreatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the EKS cluster was created.
", + "smithy.api#jsonName": "createdAt" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the EKS cluster involved in a Kubernetes finding.
" + } + }, + "com.amazonaws.guardduty#Email": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.guardduty#EnableOrganizationAdminAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#EnableOrganizationAdminAccountRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#EnableOrganizationAdminAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Enables an Amazon Web Services account within the organization as the GuardDuty delegated\n administrator.
", + "smithy.api#http": { + "method": "POST", + "uri": "/admin/enable", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#EnableOrganizationAdminAccountRequest": { + "type": "structure", + "members": { + "AdminAccountId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Account ID for the organization account to be enabled as a GuardDuty delegated\n administrator.
", + "smithy.api#jsonName": "adminAccountId", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.guardduty#EnableOrganizationAdminAccountResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.guardduty#Eq": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#Equals": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#Evidence": { + "type": "structure", + "members": { + "ThreatIntelligenceDetails": { + "target": "com.amazonaws.guardduty#ThreatIntelligenceDetails", + "traits": { + "smithy.api#documentation": "A list of threat intelligence details related to the evidence.
", + "smithy.api#jsonName": "threatIntelligenceDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the reason that the finding was generated.
" + } + }, + "com.amazonaws.guardduty#Feedback": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { "value": "USEFUL", "name": "USEFUL" }, @@ -2806,6 +3199,12 @@ ] } }, + "com.amazonaws.guardduty#FilePaths": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#ScanFilePath" + } + }, "com.amazonaws.guardduty#FilterAction": { "type": "string", "traits": { @@ -2825,6 +3224,84 @@ } } }, + "com.amazonaws.guardduty#FilterCondition": { + "type": "structure", + "members": { + "EqualsValue": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "Represents an equal\n condition to be applied to\n a single field when querying for scan entries.
", + "smithy.api#jsonName": "equalsValue" + } + }, + "GreaterThan": { + "target": "com.amazonaws.guardduty#LongValue", + "traits": { + "smithy.api#documentation": "Represents a greater than condition to be applied to a single field\n when querying for scan entries.
", + "smithy.api#jsonName": "greaterThan" + } + }, + "LessThan": { + "target": "com.amazonaws.guardduty#LongValue", + "traits": { + "smithy.api#documentation": "Represents a less than condition to be applied to a single field when\n querying for scan entries.
", + "smithy.api#jsonName": "lessThan" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the condition.
" + } + }, + "com.amazonaws.guardduty#FilterCriteria": { + "type": "structure", + "members": { + "FilterCriterion": { + "target": "com.amazonaws.guardduty#FilterCriterionList", + "traits": { + "smithy.api#documentation": "Represents a condition that when matched will be added to the response of the operation.
", + "smithy.api#jsonName": "filterCriterion" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the criteria to be used in the filter for describing scan entries.
" + } + }, + "com.amazonaws.guardduty#FilterCriterion": { + "type": "structure", + "members": { + "CriterionKey": { + "target": "com.amazonaws.guardduty#CriterionKey", + "traits": { + "smithy.api#documentation": "An enum value representing possible scan properties to match with given scan entries.
", + "smithy.api#jsonName": "criterionKey" + } + }, + "FilterCondition": { + "target": "com.amazonaws.guardduty#FilterCondition", + "traits": { + "smithy.api#documentation": "Contains information about the condition.
", + "smithy.api#jsonName": "filterCondition" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a condition that when matched will be added to the response of the operation.
" + } + }, + "com.amazonaws.guardduty#FilterCriterionList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#FilterCriterion" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, "com.amazonaws.guardduty#FilterDescription": { "type": "string", "traits": { @@ -3661,13 +4138,13 @@ } } }, - "com.amazonaws.guardduty#GetMasterAccount": { + "com.amazonaws.guardduty#GetMalwareScanSettings": { "type": "operation", "input": { - "target": "com.amazonaws.guardduty#GetMasterAccountRequest" + "target": "com.amazonaws.guardduty#GetMalwareScanSettingsRequest" }, "output": { - "target": "com.amazonaws.guardduty#GetMasterAccountResponse" + "target": "com.amazonaws.guardduty#GetMalwareScanSettingsResponse" }, "errors": [ { @@ -3678,32 +4155,90 @@ } ], "traits": { - "smithy.api#deprecated": { - "message": "This operation is deprecated, use GetAdministratorAccount instead" - }, - "smithy.api#documentation": "Provides the details for the GuardDuty administrator account associated with the current\n GuardDuty member account.
", + "smithy.api#documentation": "Returns the details of the malware scan settings.
", "smithy.api#http": { "method": "GET", - "uri": "/detector/{DetectorId}/master", + "uri": "/detector/{DetectorId}/malware-scan-settings", "code": 200 } } }, - "com.amazonaws.guardduty#GetMasterAccountRequest": { + "com.amazonaws.guardduty#GetMalwareScanSettingsRequest": { "type": "structure", "members": { "DetectorId": { "target": "com.amazonaws.guardduty#DetectorId", "traits": { - "smithy.api#documentation": "The unique ID of the detector of the GuardDuty member account.
", + "smithy.api#documentation": "The unique ID of the detector that the scan setting is associated with.
", "smithy.api#httpLabel": {}, "smithy.api#jsonName": "detectorId", "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#deprecated": { + } + }, + "com.amazonaws.guardduty#GetMalwareScanSettingsResponse": { + "type": "structure", + "members": { + "ScanResourceCriteria": { + "target": "com.amazonaws.guardduty#ScanResourceCriteria", + "traits": { + "smithy.api#documentation": "Represents the criteria to be used in the filter for scanning resources.
", + "smithy.api#jsonName": "scanResourceCriteria" + } + }, + "EbsSnapshotPreservation": { + "target": "com.amazonaws.guardduty#EbsSnapshotPreservation", + "traits": { + "smithy.api#documentation": "An enum value representing possible snapshot preservations.
", + "smithy.api#jsonName": "ebsSnapshotPreservation" + } + } + } + }, + "com.amazonaws.guardduty#GetMasterAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetMasterAccountRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetMasterAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "This operation is deprecated, use GetAdministratorAccount instead" + }, + "smithy.api#documentation": "Provides the details for the GuardDuty administrator account associated with the current\n GuardDuty member account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/master", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetMasterAccountRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty member account.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#deprecated": { "message": "This input is deprecated, use GetAdministratorAccountRequest instead" } } @@ -4198,6 +4733,9 @@ { "target": "com.amazonaws.guardduty#DeleteThreatIntelSet" }, + { + "target": "com.amazonaws.guardduty#DescribeMalwareScans" + }, { "target": "com.amazonaws.guardduty#DescribeOrganizationConfiguration" }, @@ -4240,6 +4778,9 @@ { "target": "com.amazonaws.guardduty#GetIPSet" }, + { + "target": "com.amazonaws.guardduty#GetMalwareScanSettings" + }, { "target": "com.amazonaws.guardduty#GetMasterAccount" }, @@ -4318,6 +4859,9 @@ { "target": "com.amazonaws.guardduty#UpdateIPSet" }, + { + "target": "com.amazonaws.guardduty#UpdateMalwareScanSettings" + }, { "target": "com.amazonaws.guardduty#UpdateMemberDetectors" }, @@ -4338,6 +4882,35 @@ "smithy.api#pattern": "^arn:[A-Za-z_.-]{1,20}:guardduty:[A-Za-z0-9_/.-]{0,63}:\\d+:detector/[A-Za-z0-9_/.-]{32,264}$" } }, + "com.amazonaws.guardduty#HighestSeverityThreatDetails": { + "type": "structure", + "members": { + "Severity": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Severity level of the highest severity threat detected.
", + "smithy.api#jsonName": "severity" + } + }, + "ThreatName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Threat name of the highest severity threat detected as part of the malware scan.
", + "smithy.api#jsonName": "threatName" + } + }, + "Count": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of infected files with the highest severity threat detected.
", + "smithy.api#jsonName": "count" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details of the highest severity threat detected during scan and number of infected files.
" + } + }, "com.amazonaws.guardduty#HostPath": { "type": "structure", "members": { @@ -4375,6 +4948,12 @@ "smithy.api#documentation": "Contains information about the EC2 instance profile.
" } }, + "com.amazonaws.guardduty#InstanceArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov):[a-z]+:[a-z]+(-[0-9]+|-[a-z]+)+:([0-9]{12}):[a-z\\-]+\\/[a-zA-Z0-9]*$" + } + }, "com.amazonaws.guardduty#InstanceDetails": { "type": "structure", "members": { @@ -4477,6 +5056,15 @@ "com.amazonaws.guardduty#Integer": { "type": "integer" }, + "com.amazonaws.guardduty#IntegerValueWithMax": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.guardduty#InternalServerErrorException": { "type": "structure", "members": { @@ -5776,6 +6364,67 @@ "com.amazonaws.guardduty#Long": { "type": "long" }, + "com.amazonaws.guardduty#LongValue": { + "type": "long" + }, + "com.amazonaws.guardduty#MalwareProtectionConfiguration": { + "type": "structure", + "members": { + "ScanEc2InstanceWithFindings": { + "target": "com.amazonaws.guardduty#ScanEc2InstanceWithFindings", + "traits": { + "smithy.api#documentation": "Describes the configuration of Malware Protection for EC2 instances with findings.
", + "smithy.api#jsonName": "scanEc2InstanceWithFindings" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes whether Malware Protection will be enabled as a data source.
" + } + }, + "com.amazonaws.guardduty#MalwareProtectionConfigurationResult": { + "type": "structure", + "members": { + "ScanEc2InstanceWithFindings": { + "target": "com.amazonaws.guardduty#ScanEc2InstanceWithFindingsResult", + "traits": { + "smithy.api#documentation": "Describes the configuration of Malware Protection for EC2 instances with findings.
", + "smithy.api#jsonName": "scanEc2InstanceWithFindings" + } + }, + "ServiceRole": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The GuardDuty Malware Protection service role.
", + "smithy.api#jsonName": "serviceRole" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information on the status of all Malware Protection data sources.
" + } + }, + "com.amazonaws.guardduty#MalwareProtectionDataSourceFreeTrial": { + "type": "structure", + "members": { + "ScanEc2InstanceWithFindings": { + "target": "com.amazonaws.guardduty#DataSourceFreeTrial", + "traits": { + "smithy.api#documentation": "Describes whether Malware Protection for EC2 instances with findings is enabled as a data source.
", + "smithy.api#jsonName": "scanEc2InstanceWithFindings" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides details about Malware Protection when it is enabled as a data source.
" + } + }, + "com.amazonaws.guardduty#MapEquals": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#ScanConditionPair" + } + }, "com.amazonaws.guardduty#Master": { "type": "structure", "members": { @@ -6094,6 +6743,15 @@ "target": "com.amazonaws.guardduty#NetworkInterface" } }, + "com.amazonaws.guardduty#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, "com.amazonaws.guardduty#NotEquals": { "type": "list", "member": { @@ -6167,6 +6825,13 @@ "smithy.api#documentation": "Describes the configuration of Kubernetes data sources for new members of the organization.
", "smithy.api#jsonName": "kubernetes" } + }, + "MalwareProtection": { + "target": "com.amazonaws.guardduty#OrganizationMalwareProtectionConfiguration", + "traits": { + "smithy.api#documentation": "Describes the configuration of Malware Protection for new members of the organization.
", + "smithy.api#jsonName": "malwareProtection" + } } }, "traits": { @@ -6190,12 +6855,49 @@ "smithy.api#documentation": "Describes the configuration of Kubernetes data sources.
", "smithy.api#jsonName": "kubernetes" } + }, + "MalwareProtection": { + "target": "com.amazonaws.guardduty#OrganizationMalwareProtectionConfigurationResult", + "traits": { + "smithy.api#documentation": "Describes the configuration of Malware Protection data source for an organization.
", + "smithy.api#jsonName": "malwareProtection" + } } }, "traits": { "smithy.api#documentation": "An object that contains information on which data sources are automatically enabled for\n new members within the organization.
" } }, + "com.amazonaws.guardduty#OrganizationEbsVolumes": { + "type": "structure", + "members": { + "AutoEnable": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Whether scanning EBS volumes should be auto-enabled for new members joining the organization.
", + "smithy.api#jsonName": "autoEnable" + } + } + }, + "traits": { + "smithy.api#documentation": "Organization-wide EBS volumes scan configuration.
" + } + }, + "com.amazonaws.guardduty#OrganizationEbsVolumesResult": { + "type": "structure", + "members": { + "AutoEnable": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "An object that contains the status of whether scanning EBS volumes should be auto-enabled for new members joining the organization.
", + "smithy.api#jsonName": "autoEnable" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information on the status of whether EBS volumes scanning will be enabled as a data source for an organization.
" + } + }, "com.amazonaws.guardduty#OrganizationKubernetesAuditLogsConfiguration": { "type": "structure", "members": { @@ -6260,6 +6962,36 @@ "smithy.api#documentation": "The current configuration of all Kubernetes data sources for the organization.
" } }, + "com.amazonaws.guardduty#OrganizationMalwareProtectionConfiguration": { + "type": "structure", + "members": { + "ScanEc2InstanceWithFindings": { + "target": "com.amazonaws.guardduty#OrganizationScanEc2InstanceWithFindings", + "traits": { + "smithy.api#documentation": "Whether Malware Protection for EC2 instances with findings should be auto-enabled for new members joining the organization.
", + "smithy.api#jsonName": "scanEc2InstanceWithFindings" + } + } + }, + "traits": { + "smithy.api#documentation": "Organization-wide Malware Protection configurations.
" + } + }, + "com.amazonaws.guardduty#OrganizationMalwareProtectionConfigurationResult": { + "type": "structure", + "members": { + "ScanEc2InstanceWithFindings": { + "target": "com.amazonaws.guardduty#OrganizationScanEc2InstanceWithFindingsResult", + "traits": { + "smithy.api#documentation": "Describes the configuration for scanning EC2 instances with findings for an organization.
", + "smithy.api#jsonName": "scanEc2InstanceWithFindings" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information on the status of all Malware Protection data source for an organization.
" + } + }, "com.amazonaws.guardduty#OrganizationS3LogsConfiguration": { "type": "structure", "members": { @@ -6292,6 +7024,36 @@ "smithy.api#documentation": "The current configuration of S3 data event logs as a data source for the\n organization.
" } }, + "com.amazonaws.guardduty#OrganizationScanEc2InstanceWithFindings": { + "type": "structure", + "members": { + "EbsVolumes": { + "target": "com.amazonaws.guardduty#OrganizationEbsVolumes", + "traits": { + "smithy.api#documentation": "Whether scanning EBS volumes should be auto-enabled for new members joining the organization.
", + "smithy.api#jsonName": "ebsVolumes" + } + } + }, + "traits": { + "smithy.api#documentation": "Organization-wide EC2 instances with findings scan configuration.
" + } + }, + "com.amazonaws.guardduty#OrganizationScanEc2InstanceWithFindingsResult": { + "type": "structure", + "members": { + "EbsVolumes": { + "target": "com.amazonaws.guardduty#OrganizationEbsVolumesResult", + "traits": { + "smithy.api#documentation": "Describes the configuration for scanning EBS volumes for an organization.
", + "smithy.api#jsonName": "ebsVolumes" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information on the status of scanning EC2 instances with findings for an organization.
" + } + }, "com.amazonaws.guardduty#Owner": { "type": "structure", "members": { @@ -6386,6 +7148,14 @@ "target": "com.amazonaws.guardduty#PortProbeDetail" } }, + "com.amazonaws.guardduty#PositiveLong": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.guardduty#PrivateIpAddressDetails": { "type": "structure", "members": { @@ -6616,124 +7386,578 @@ "smithy.api#jsonName": "kubernetesDetails" } }, - "ResourceType": { - "target": "com.amazonaws.guardduty#String", + "ResourceType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The type of Amazon Web Services resource.
", + "smithy.api#jsonName": "resourceType" + } + }, + "EbsVolumeDetails": { + "target": "com.amazonaws.guardduty#EbsVolumeDetails", + "traits": { + "smithy.api#documentation": "Contains list of scanned and skipped EBS volumes with details.
", + "smithy.api#jsonName": "ebsVolumeDetails" + } + }, + "EcsClusterDetails": { + "target": "com.amazonaws.guardduty#EcsClusterDetails", + "traits": { + "smithy.api#documentation": "Contains information about the details of the ECS Cluster.
", + "smithy.api#jsonName": "ecsClusterDetails" + } + }, + "ContainerDetails": { + "target": "com.amazonaws.guardduty#Container", + "traits": { + "smithy.api#jsonName": "containerDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the Amazon Web Services resource associated with the activity that prompted\n GuardDuty to generate a finding.
" + } + }, + "com.amazonaws.guardduty#ResourceDetails": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.guardduty#InstanceArn", + "traits": { + "smithy.api#documentation": "InstanceArn that was scanned in the scan entry.
", + "smithy.api#jsonName": "instanceArn" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the resources that were scanned in the scan entry.
" + } + }, + "com.amazonaws.guardduty#ResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#S3BucketDetail": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3 bucket.
", + "smithy.api#jsonName": "arn" + } + }, + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the S3 bucket.
", + "smithy.api#jsonName": "name" + } + }, + "Type": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Describes whether the bucket is a source or destination bucket.
", + "smithy.api#jsonName": "type" + } + }, + "CreatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the bucket was created at.
", + "smithy.api#jsonName": "createdAt" + } + }, + "Owner": { + "target": "com.amazonaws.guardduty#Owner", + "traits": { + "smithy.api#documentation": "The owner of the S3 bucket.
", + "smithy.api#jsonName": "owner" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#Tags", + "traits": { + "smithy.api#documentation": "All tags attached to the S3 bucket
", + "smithy.api#jsonName": "tags" + } + }, + "DefaultServerSideEncryption": { + "target": "com.amazonaws.guardduty#DefaultServerSideEncryption", + "traits": { + "smithy.api#documentation": "Describes the server side encryption method used in the S3 bucket.
", + "smithy.api#jsonName": "defaultServerSideEncryption" + } + }, + "PublicAccess": { + "target": "com.amazonaws.guardduty#PublicAccess", + "traits": { + "smithy.api#documentation": "Describes the public access policies that apply to the S3 bucket.
", + "smithy.api#jsonName": "publicAccess" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the S3 bucket.
" + } + }, + "com.amazonaws.guardduty#S3BucketDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#S3BucketDetail" + } + }, + "com.amazonaws.guardduty#S3LogsConfiguration": { + "type": "structure", + "members": { + "Enable": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "The status of S3 data event logs as a data source.
", + "smithy.api#jsonName": "enable", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes whether S3 data event logs will be enabled as a data source.
" + } + }, + "com.amazonaws.guardduty#S3LogsConfigurationResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.guardduty#DataSourceStatus", + "traits": { + "smithy.api#documentation": "A value that describes whether S3 data event logs are automatically enabled for new\n members of the organization.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes whether S3 data event logs will be enabled as a data source.
" + } + }, + "com.amazonaws.guardduty#Scan": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that the request is associated with.
", + "smithy.api#jsonName": "detectorId" + } + }, + "AdminDetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique detector ID of the administrator account that the request is associated with. Note that\n this value will be the same as the one used for DetectorId if the account is an administrator.
The unique scan ID associated with a scan entry.
", + "smithy.api#jsonName": "scanId" + } + }, + "ScanStatus": { + "target": "com.amazonaws.guardduty#ScanStatus", + "traits": { + "smithy.api#documentation": "An enum value representing possible scan statuses.
", + "smithy.api#jsonName": "scanStatus" + } + }, + "FailureReason": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "Represents the reason for FAILED scan status.
", + "smithy.api#jsonName": "failureReason" + } + }, + "ScanStartTime": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the scan was triggered.
", + "smithy.api#jsonName": "scanStartTime" + } + }, + "ScanEndTime": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the scan was finished.
", + "smithy.api#jsonName": "scanEndTime" + } + }, + "TriggerDetails": { + "target": "com.amazonaws.guardduty#TriggerDetails", + "traits": { + "smithy.api#documentation": "Represents the reason the scan was triggered.
", + "smithy.api#jsonName": "triggerDetails" + } + }, + "ResourceDetails": { + "target": "com.amazonaws.guardduty#ResourceDetails", + "traits": { + "smithy.api#documentation": "Represents the resources that were scanned in the scan entry.
", + "smithy.api#jsonName": "resourceDetails" + } + }, + "ScanResultDetails": { + "target": "com.amazonaws.guardduty#ScanResultDetails", + "traits": { + "smithy.api#documentation": "Represents the result of the scan.
", + "smithy.api#jsonName": "scanResultDetails" + } + }, + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "The ID for the account that belongs to the scan.
", + "smithy.api#jsonName": "accountId" + } + }, + "TotalBytes": { + "target": "com.amazonaws.guardduty#PositiveLong", + "traits": { + "smithy.api#documentation": "Represents total bytes that were scanned.
", + "smithy.api#jsonName": "totalBytes" + } + }, + "FileCount": { + "target": "com.amazonaws.guardduty#PositiveLong", + "traits": { + "smithy.api#documentation": "Represents the number of files that were scanned.
", + "smithy.api#jsonName": "fileCount" + } + }, + "AttachedVolumes": { + "target": "com.amazonaws.guardduty#VolumeDetails", + "traits": { + "smithy.api#documentation": "List of volumes that were attached to the original instance to be scanned.
", + "smithy.api#jsonName": "attachedVolumes" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a malware scan.
" + } + }, + "com.amazonaws.guardduty#ScanCondition": { + "type": "structure", + "members": { + "MapEquals": { + "target": "com.amazonaws.guardduty#MapEquals", + "traits": { + "smithy.api#documentation": "Represents an mapEqual\n condition to be applied to\n a single field when triggering for malware scan.
", + "smithy.api#jsonName": "mapEquals", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the condition.
" + } + }, + "com.amazonaws.guardduty#ScanConditionPair": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.guardduty#TagKey", + "traits": { + "smithy.api#documentation": "Represents key\n in the map condition.
", + "smithy.api#jsonName": "key", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.guardduty#TagValue", + "traits": { + "smithy.api#documentation": "Represents optional value\n in the map condition. If not specified, only key\n will be matched.
", + "smithy.api#jsonName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents key, value pair to be matched against given resource property.
" + } + }, + "com.amazonaws.guardduty#ScanCriterion": { + "type": "map", + "key": { + "target": "com.amazonaws.guardduty#ScanCriterionKey" + }, + "value": { + "target": "com.amazonaws.guardduty#ScanCondition" + }, + "traits": { + "smithy.api#documentation": "Represents a map of resource properties that match specified conditions and values when triggering malware scans.
" + } + }, + "com.amazonaws.guardduty#ScanCriterionKey": { + "type": "string", + "traits": { + "smithy.api#documentation": "An enum value representing possible resource properties to match with given scan condition.
", + "smithy.api#enum": [ + { + "value": "EC2_INSTANCE_TAG", + "name": "EC2_INSTANCE_TAG" + } + ] + } + }, + "com.amazonaws.guardduty#ScanDetections": { + "type": "structure", + "members": { + "ScannedItemCount": { + "target": "com.amazonaws.guardduty#ScannedItemCount", + "traits": { + "smithy.api#documentation": "Total number of scanned files.
", + "smithy.api#jsonName": "scannedItemCount" + } + }, + "ThreatsDetectedItemCount": { + "target": "com.amazonaws.guardduty#ThreatsDetectedItemCount", + "traits": { + "smithy.api#documentation": "Total number of infected files.
", + "smithy.api#jsonName": "threatsDetectedItemCount" + } + }, + "HighestSeverityThreatDetails": { + "target": "com.amazonaws.guardduty#HighestSeverityThreatDetails", + "traits": { + "smithy.api#documentation": "Details of the highest severity threat detected during malware scan and number of infected files.
", + "smithy.api#jsonName": "highestSeverityThreatDetails" + } + }, + "ThreatDetectedByName": { + "target": "com.amazonaws.guardduty#ThreatDetectedByName", + "traits": { + "smithy.api#documentation": "Contains details about identified threats organized by threat name.
", + "smithy.api#jsonName": "threatDetectedByName" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains a complete view providing malware scan result details.
" + } + }, + "com.amazonaws.guardduty#ScanEc2InstanceWithFindings": { + "type": "structure", + "members": { + "EbsVolumes": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Describes the configuration for scanning EBS volumes as data source.
", + "smithy.api#jsonName": "ebsVolumes" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes whether Malware Protection for EC2 instances with findings will be enabled as a data source.
" + } + }, + "com.amazonaws.guardduty#ScanEc2InstanceWithFindingsResult": { + "type": "structure", + "members": { + "EbsVolumes": { + "target": "com.amazonaws.guardduty#EbsVolumesResult", + "traits": { + "smithy.api#documentation": "Describes the configuration of scanning EBS volumes as a data source.
", + "smithy.api#jsonName": "ebsVolumes" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information on the status of whether Malware Protection for EC2 instances with findings will be enabled as a data source.
" + } + }, + "com.amazonaws.guardduty#ScanFilePath": { + "type": "structure", + "members": { + "FilePath": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The file path of the infected file.
", + "smithy.api#jsonName": "filePath" + } + }, + "VolumeArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "EBS volume Arn details of the infected file.
", + "smithy.api#jsonName": "volumeArn" + } + }, + "Hash": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The hash value of the infected file.
", + "smithy.api#jsonName": "hash" + } + }, + "FileName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "File name of the infected file.
", + "smithy.api#jsonName": "fileName" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details of infected file including name, file path and hash.
" + } + }, + "com.amazonaws.guardduty#ScanResourceCriteria": { + "type": "structure", + "members": { + "Include": { + "target": "com.amazonaws.guardduty#ScanCriterion", + "traits": { + "smithy.api#documentation": "Represents condition that when matched will allow a malware scan for a certain resource.
", + "smithy.api#jsonName": "include" + } + }, + "Exclude": { + "target": "com.amazonaws.guardduty#ScanCriterion", "traits": { - "smithy.api#documentation": "The type of Amazon Web Services resource.
", - "smithy.api#jsonName": "resourceType" + "smithy.api#documentation": "Represents condition that when matched will prevent a malware scan for a certain resource.
", + "smithy.api#jsonName": "exclude" } } }, "traits": { - "smithy.api#documentation": "Contains information about the Amazon Web Services resource associated with the activity that prompted\n GuardDuty to generate a finding.
" + "smithy.api#documentation": "Contains information about criteria used to filter resources before triggering malware scan.
" } }, - "com.amazonaws.guardduty#ResourceList": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#String" + "com.amazonaws.guardduty#ScanResult": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CLEAN", + "name": "CLEAN" + }, + { + "value": "INFECTED", + "name": "INFECTED" + } + ] } }, - "com.amazonaws.guardduty#S3BucketDetail": { + "com.amazonaws.guardduty#ScanResultDetails": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.guardduty#String", + "ScanResult": { + "target": "com.amazonaws.guardduty#ScanResult", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3 bucket.
", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "An enum value representing possible scan results.
", + "smithy.api#jsonName": "scanResult" } - }, + } + }, + "traits": { + "smithy.api#documentation": "Represents the result of the scan.
" + } + }, + "com.amazonaws.guardduty#ScanStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.guardduty#ScanThreatName": { + "type": "structure", + "members": { "Name": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "The name of the S3 bucket.
", + "smithy.api#documentation": "The name of the identified threat.
", "smithy.api#jsonName": "name" } }, - "Type": { + "Severity": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "Describes whether the bucket is a source or destination bucket.
", - "smithy.api#jsonName": "type" - } - }, - "CreatedAt": { - "target": "com.amazonaws.guardduty#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time the bucket was created at.
", - "smithy.api#jsonName": "createdAt" - } - }, - "Owner": { - "target": "com.amazonaws.guardduty#Owner", - "traits": { - "smithy.api#documentation": "The owner of the S3 bucket.
", - "smithy.api#jsonName": "owner" - } - }, - "Tags": { - "target": "com.amazonaws.guardduty#Tags", - "traits": { - "smithy.api#documentation": "All tags attached to the S3 bucket
", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "Severity of threat identified as part of the malware scan.
", + "smithy.api#jsonName": "severity" } }, - "DefaultServerSideEncryption": { - "target": "com.amazonaws.guardduty#DefaultServerSideEncryption", + "ItemCount": { + "target": "com.amazonaws.guardduty#Integer", "traits": { - "smithy.api#documentation": "Describes the server side encryption method used in the S3 bucket.
", - "smithy.api#jsonName": "defaultServerSideEncryption" + "smithy.api#documentation": "Total number of files infected with given threat.
", + "smithy.api#jsonName": "itemCount" } }, - "PublicAccess": { - "target": "com.amazonaws.guardduty#PublicAccess", + "FilePaths": { + "target": "com.amazonaws.guardduty#FilePaths", "traits": { - "smithy.api#documentation": "Describes the public access policies that apply to the S3 bucket.
", - "smithy.api#jsonName": "publicAccess" + "smithy.api#documentation": "List of infected files in EBS volume with details.
", + "smithy.api#jsonName": "filePaths" } } }, "traits": { - "smithy.api#documentation": "Contains information on the S3 bucket.
" + "smithy.api#documentation": "Contains files infected with the given threat providing details of malware name and severity.
" } }, - "com.amazonaws.guardduty#S3BucketDetails": { + "com.amazonaws.guardduty#ScanThreatNames": { "type": "list", "member": { - "target": "com.amazonaws.guardduty#S3BucketDetail" + "target": "com.amazonaws.guardduty#ScanThreatName" } }, - "com.amazonaws.guardduty#S3LogsConfiguration": { + "com.amazonaws.guardduty#ScannedItemCount": { "type": "structure", "members": { - "Enable": { - "target": "com.amazonaws.guardduty#Boolean", + "TotalGb": { + "target": "com.amazonaws.guardduty#Integer", "traits": { - "smithy.api#documentation": "The status of S3 data event logs as a data source.
", - "smithy.api#jsonName": "enable", - "smithy.api#required": {} + "smithy.api#documentation": "Total GB of files scanned for malware.
", + "smithy.api#jsonName": "totalGb" } - } - }, - "traits": { - "smithy.api#documentation": "Describes whether S3 data event logs will be enabled as a data source.
" - } - }, - "com.amazonaws.guardduty#S3LogsConfigurationResult": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.guardduty#DataSourceStatus", + }, + "Files": { + "target": "com.amazonaws.guardduty#Integer", "traits": { - "smithy.api#documentation": "A value that describes whether S3 data event logs are automatically enabled for new\n members of the organization.
", - "smithy.api#jsonName": "status", - "smithy.api#required": {} + "smithy.api#documentation": "Number of files scanned.
", + "smithy.api#jsonName": "files" + } + }, + "Volumes": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of scanned volumes.
", + "smithy.api#jsonName": "volumes" } } }, "traits": { - "smithy.api#documentation": "Describes whether S3 data event logs will be enabled as a data source.
" + "smithy.api#documentation": "Total number of scanned files.
" + } + }, + "com.amazonaws.guardduty#Scans": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#Scan" } }, "com.amazonaws.guardduty#SecurityContext": { @@ -6858,6 +8082,20 @@ "smithy.api#documentation": "Contains additional information about the generated finding.
", "smithy.api#jsonName": "additionalInfo" } + }, + "FeatureName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the feature that generated a finding.
", + "smithy.api#jsonName": "featureName" + } + }, + "EbsVolumeScanDetails": { + "target": "com.amazonaws.guardduty#EbsVolumeScanDetails", + "traits": { + "smithy.api#documentation": "Returns details from the malware scan that created a finding.
", + "smithy.api#jsonName": "ebsVolumeScanDetails" + } } }, "traits": { @@ -6914,6 +8152,12 @@ "target": "com.amazonaws.guardduty#String" } }, + "com.amazonaws.guardduty#Sources": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, "com.amazonaws.guardduty#StartMonitoringMembers": { "type": "operation", "input": { @@ -7162,6 +8406,42 @@ "target": "com.amazonaws.guardduty#Tag" } }, + "com.amazonaws.guardduty#ThreatDetectedByName": { + "type": "structure", + "members": { + "ItemCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of infected files identified.
", + "smithy.api#jsonName": "itemCount" + } + }, + "UniqueThreatNameCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of unique threats by name identified, as part of the malware scan.
", + "smithy.api#jsonName": "uniqueThreatNameCount" + } + }, + "Shortened": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Flag to determine if the finding contains every single infected file-path and/or every threat.
", + "smithy.api#jsonName": "shortened" + } + }, + "ThreatNames": { + "target": "com.amazonaws.guardduty#ScanThreatNames", + "traits": { + "smithy.api#documentation": "List of identified threats with details, organized by threat name.
", + "smithy.api#jsonName": "threatNames" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about identified threats organized by threat name.
" + } + }, "com.amazonaws.guardduty#ThreatIntelSetFormat": { "type": "string", "traits": { @@ -7282,6 +8562,21 @@ "target": "com.amazonaws.guardduty#String" } }, + "com.amazonaws.guardduty#ThreatsDetectedItemCount": { + "type": "structure", + "members": { + "Files": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of infected files.
", + "smithy.api#jsonName": "files" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains total number of infected files.
" + } + }, "com.amazonaws.guardduty#Timestamp": { "type": "timestamp" }, @@ -7307,6 +8602,28 @@ "smithy.api#documentation": "Contains the total usage with the corresponding currency unit for that value.
" } }, + "com.amazonaws.guardduty#TriggerDetails": { + "type": "structure", + "members": { + "GuardDutyFindingId": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "The ID of the GuardDuty finding that triggered the BirdDog scan.
", + "smithy.api#jsonName": "guardDutyFindingId" + } + }, + "Description": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "The description of the scan trigger.
", + "smithy.api#jsonName": "description" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the reason the scan was triggered.
" + } + }, "com.amazonaws.guardduty#UnarchiveFindings": { "type": "operation", "input": { @@ -7738,6 +9055,63 @@ "type": "structure", "members": {} }, + "com.amazonaws.guardduty#UpdateMalwareScanSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#UpdateMalwareScanSettingsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#UpdateMalwareScanSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the malware scan settings.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/malware-scan-settings", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#UpdateMalwareScanSettingsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that specifies the GuardDuty service where you want to\n update scan settings.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "ScanResourceCriteria": { + "target": "com.amazonaws.guardduty#ScanResourceCriteria", + "traits": { + "smithy.api#documentation": "Represents the criteria to be used in the filter for selecting resources to scan.
", + "smithy.api#jsonName": "scanResourceCriteria" + } + }, + "EbsSnapshotPreservation": { + "target": "com.amazonaws.guardduty#EbsSnapshotPreservation", + "traits": { + "smithy.api#documentation": "An enum value representing possible snapshot preservations.
", + "smithy.api#jsonName": "ebsSnapshotPreservation" + } + } + } + }, + "com.amazonaws.guardduty#UpdateMalwareScanSettingsResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.guardduty#UpdateMemberDetectors": { "type": "operation", "input": { @@ -8190,6 +9564,69 @@ "smithy.api#documentation": "Volume used by the Kubernetes workload.
" } }, + "com.amazonaws.guardduty#VolumeDetail": { + "type": "structure", + "members": { + "VolumeArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "EBS volume Arn information.
", + "smithy.api#jsonName": "volumeArn" + } + }, + "VolumeType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The EBS volume type.
", + "smithy.api#jsonName": "volumeType" + } + }, + "DeviceName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The device name for the EBS volume.
", + "smithy.api#jsonName": "deviceName" + } + }, + "VolumeSizeInGB": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "EBS volume size in GB.
", + "smithy.api#jsonName": "volumeSizeInGB" + } + }, + "EncryptionType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "EBS volume encryption type.
", + "smithy.api#jsonName": "encryptionType" + } + }, + "SnapshotArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Snapshot Arn of the EBS volume.
", + "smithy.api#jsonName": "snapshotArn" + } + }, + "KmsKeyArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "KMS key Arn used to encrypt the EBS volume.
", + "smithy.api#jsonName": "kmsKeyArn" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains EBS volume details.
" + } + }, + "com.amazonaws.guardduty#VolumeDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#VolumeDetail" + } + }, "com.amazonaws.guardduty#VolumeMount": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/iotdeviceadvisor.json b/codegen/sdk/aws-models/iotdeviceadvisor.json index 5047ac1e5a0..077844bed4e 100644 --- a/codegen/sdk/aws-models/iotdeviceadvisor.json +++ b/codegen/sdk/aws-models/iotdeviceadvisor.json @@ -624,7 +624,7 @@ "name": "iotdeviceadvisor" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Amazon Web Services IoT Core Device Advisor is a cloud-based, fully managed test capability for\n validating IoT devices during device software development. Device Advisor provides\n pre-built tests that you can use to validate IoT devices for reliable and secure\n connectivity with Amazon Web Services IoT Core before deploying devices to production. By using Device Advisor,\n you can confirm that your devices can connect to Amazon Web Services IoT Core, follow security\n best practices and, if applicable, receive software updates from IoT Device Management.\n You can also download signed qualification reports to submit to the Amazon Web Services Partner Network\n to get your device qualified for the Amazon Web Services Partner Device Catalog without the need to send\n your device in and wait for it to be tested.
", + "smithy.api#documentation": "Amazon Web Services IoT Core Device Advisor is a cloud-based, fully managed test capability for validating IoT\n devices during device software development. Device Advisor provides pre-built tests that you\n can use to validate IoT devices for reliable and secure connectivity with Amazon Web Services IoT Core\n before deploying devices to production. By using Device Advisor, you can confirm that your\n devices can connect to Amazon Web Services IoT Core, follow security best practices and, if applicable,\n receive software updates from IoT Device Management. You can also download signed\n qualification reports to submit to the Amazon Web Services Partner Network to get your device\n qualified for the Amazon Web Services Partner Device Catalog without the need to send your device in\n and wait for it to be tested.
", "smithy.api#title": "AWS IoT Core Device Advisor" }, "version": "2020-09-18", @@ -673,6 +673,9 @@ } ] }, + "com.amazonaws.iotdeviceadvisor#IsLongDurationTestBoolean": { + "type": "boolean" + }, "com.amazonaws.iotdeviceadvisor#ListSuiteDefinitions": { "type": "operation", "input": { @@ -728,7 +731,7 @@ "suiteDefinitionInformationList": { "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionInformationList", "traits": { - "smithy.api#documentation": "An array of objects that provide summaries of information about the suite definitions in the list.
" + "smithy.api#documentation": "An array of objects that provide summaries of information about the suite definitions\n in the list.
" } }, "nextToken": { @@ -808,7 +811,7 @@ "suiteRunsList": { "target": "com.amazonaws.iotdeviceadvisor#SuiteRunsList", "traits": { - "smithy.api#documentation": "An array of objects that provide summaries of information about the suite runs in the list.
" + "smithy.api#documentation": "An array of objects that provide summaries of information about the suite runs in the\n list.
" } }, "nextToken": { @@ -895,6 +898,21 @@ "com.amazonaws.iotdeviceadvisor#ParallelRun": { "type": "boolean" }, + "com.amazonaws.iotdeviceadvisor#Protocol": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MqttV3_1_1", + "name": "MqttV3_1_1" + }, + { + "value": "MqttV5", + "name": "MqttV5" + } + ] + } + }, "com.amazonaws.iotdeviceadvisor#QualificationReportDownloadUrl": { "type": "string" }, @@ -955,7 +973,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a Device Advisor test suite run.
\nRequires permission to access the StartSuiteRun action.
", + "smithy.api#documentation": "Starts a Device Advisor test suite run.
\nRequires permission to access the StartSuiteRun action.
", "smithy.api#http": { "method": "POST", "uri": "/suiteDefinitions/{suiteDefinitionId}/suiteRuns", @@ -1152,6 +1170,12 @@ "smithy.api#documentation": "Gets the tests intended for qualification in a suite.
" } }, + "isLongDurationTest": { + "target": "com.amazonaws.iotdeviceadvisor#IsLongDurationTestBoolean", + "traits": { + "smithy.api#documentation": "Verifies if the test suite is a long duration test.
" + } + }, "rootGroup": { "target": "com.amazonaws.iotdeviceadvisor#RootGroup", "traits": { @@ -1163,6 +1187,12 @@ "traits": { "smithy.api#documentation": "Gets the device permission ARN.
" } + }, + "protocol": { + "target": "com.amazonaws.iotdeviceadvisor#Protocol", + "traits": { + "smithy.api#documentation": "Gets the MQTT protocol that is configured in the suite definition.
" + } } }, "traits": { @@ -1196,6 +1226,18 @@ "smithy.api#documentation": "Specifies if the test suite is intended for qualification.
" } }, + "isLongDurationTest": { + "target": "com.amazonaws.iotdeviceadvisor#IsLongDurationTestBoolean", + "traits": { + "smithy.api#documentation": "Verifies if the test suite is a long duration test.
" + } + }, + "protocol": { + "target": "com.amazonaws.iotdeviceadvisor#Protocol", + "traits": { + "smithy.api#documentation": "Gets the MQTT protocol that is configured in the suite definition.
" + } + }, "createdAt": { "target": "com.amazonaws.iotdeviceadvisor#Timestamp", "traits": { @@ -1383,6 +1425,9 @@ "target": "com.amazonaws.iotdeviceadvisor#SuiteRunInformation" } }, + "com.amazonaws.iotdeviceadvisor#SystemMessage": { + "type": "string" + }, "com.amazonaws.iotdeviceadvisor#TagKeyList": { "type": "list", "member": { @@ -1489,7 +1534,7 @@ "status": { "target": "com.amazonaws.iotdeviceadvisor#Status", "traits": { - "smithy.api#documentation": "Provides the test case run status. Status is one of the following:
\n\n PASS: Test passed.
\n FAIL: Test failed.
\n PENDING: Test has not started running but is scheduled.
\n RUNNING: Test is running.
\n STOPPING: Test is performing cleanup steps. You will see this status only if you stop a suite run.
\n STOPPED Test is stopped. You will see this status only if you stop a suite run.
\n PASS_WITH_WARNINGS: Test passed with warnings.
\n ERORR: Test faced an error when running due to an internal issue.
Provides the test case run status. Status is one of the following:
\n\n PASS: Test passed.
\n FAIL: Test failed.
\n PENDING: Test has not started running but is scheduled.
\n RUNNING: Test is running.
\n STOPPING: Test is performing cleanup steps. You will see this\n status only if you stop a suite run.
\n STOPPED Test is stopped. You will see this status only if you\n stop a suite run.
\n PASS_WITH_WARNINGS: Test passed with warnings.
\n ERORR: Test faced an error when running due to an internal\n issue.
Provides test case run failure result.
" } + }, + "testScenarios": { + "target": "com.amazonaws.iotdeviceadvisor#TestCaseScenariosList", + "traits": { + "smithy.api#documentation": "Provides the test scenarios for the test case run.
" + } } }, "traits": { @@ -1536,6 +1587,111 @@ "smithy.api#documentation": "Tests under each group result.
" } }, + "com.amazonaws.iotdeviceadvisor#TestCaseScenario": { + "type": "structure", + "members": { + "testCaseScenarioId": { + "target": "com.amazonaws.iotdeviceadvisor#TestCaseScenarioId", + "traits": { + "smithy.api#documentation": "Provides test case scenario ID.
" + } + }, + "testCaseScenarioType": { + "target": "com.amazonaws.iotdeviceadvisor#TestCaseScenarioType", + "traits": { + "smithy.api#documentation": "Provides test case scenario type. Type is one of the following:
\nAdvanced
\nBasic
\nProvides the test case scenario status. Status is one of the following:
\n\n PASS: Test passed.
\n FAIL: Test failed.
\n PENDING: Test has not started running but is scheduled.
\n RUNNING: Test is running.
\n STOPPING: Test is performing cleanup steps. You will see this\n status only if you stop a suite run.
\n STOPPED Test is stopped. You will see this status only if you\n stop a suite run.
\n PASS_WITH_WARNINGS: Test passed with warnings.
\n ERORR: Test faced an error when running due to an internal\n issue.
Provides test case scenario failure result.
" + } + }, + "systemMessage": { + "target": "com.amazonaws.iotdeviceadvisor#SystemMessage", + "traits": { + "smithy.api#documentation": "\n \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides test case scenario.
" + } + }, + "com.amazonaws.iotdeviceadvisor#TestCaseScenarioId": { + "type": "string" + }, + "com.amazonaws.iotdeviceadvisor#TestCaseScenarioStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PASS", + "name": "PASS" + }, + { + "value": "FAIL", + "name": "FAIL" + }, + { + "value": "CANCELED", + "name": "CANCELED" + }, + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "STOPPING", + "name": "STOPPING" + }, + { + "value": "STOPPED", + "name": "STOPPED" + }, + { + "value": "PASS_WITH_WARNINGS", + "name": "PASS_WITH_WARNINGS" + }, + { + "value": "ERROR", + "name": "ERROR" + } + ] + } + }, + "com.amazonaws.iotdeviceadvisor#TestCaseScenarioType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Advanced", + "name": "Advanced" + }, + { + "value": "Basic", + "name": "Basic" + } + ] + } + }, + "com.amazonaws.iotdeviceadvisor#TestCaseScenariosList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotdeviceadvisor#TestCaseScenario" + } + }, "com.amazonaws.iotdeviceadvisor#TestResult": { "type": "structure", "members": { @@ -1641,7 +1797,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a Device Advisor test suite.
\nRequires permission to access the UpdateSuiteDefinition action.
", + "smithy.api#documentation": "Updates a Device Advisor test suite.
\nRequires permission to access the UpdateSuiteDefinition action.
", "smithy.api#http": { "method": "PATCH", "uri": "/suiteDefinitions/{suiteDefinitionId}", diff --git a/codegen/sdk/aws-models/iotsitewise.json b/codegen/sdk/aws-models/iotsitewise.json index 242b15219d4..2ad4d868311 100644 --- a/codegen/sdk/aws-models/iotsitewise.json +++ b/codegen/sdk/aws-models/iotsitewise.json @@ -91,6 +91,9 @@ { "target": "com.amazonaws.iotsitewise#CreateAssetModel" }, + { + "target": "com.amazonaws.iotsitewise#CreateBulkImportJob" + }, { "target": "com.amazonaws.iotsitewise#CreateDashboard" }, @@ -139,6 +142,9 @@ { "target": "com.amazonaws.iotsitewise#DescribeAssetProperty" }, + { + "target": "com.amazonaws.iotsitewise#DescribeBulkImportJob" + }, { "target": "com.amazonaws.iotsitewise#DescribeDashboard" }, @@ -199,6 +205,9 @@ { "target": "com.amazonaws.iotsitewise#ListAssociatedAssets" }, + { + "target": "com.amazonaws.iotsitewise#ListBulkImportJobs" + }, { "target": "com.amazonaws.iotsitewise#ListDashboards" }, @@ -2725,6 +2734,15 @@ } } }, + "com.amazonaws.iotsitewise#Bucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + } + } + }, "com.amazonaws.iotsitewise#CapabilityConfiguration": { "type": "string", "traits": { @@ -2777,6 +2795,51 @@ "smithy.api#pattern": "^\\S{36,64}$" } }, + "com.amazonaws.iotsitewise#ColumnName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALIAS", + "name": "ALIAS" + }, + { + "value": "ASSET_ID", + "name": "ASSET_ID" + }, + { + "value": "PROPERTY_ID", + "name": "PROPERTY_ID" + }, + { + "value": "DATA_TYPE", + "name": "DATA_TYPE" + }, + { + "value": "TIMESTAMP_SECONDS", + "name": "TIMESTAMP_SECONDS" + }, + { + "value": "TIMESTAMP_NANO_OFFSET", + "name": "TIMESTAMP_NANO_OFFSET" + }, + { + "value": "QUALITY", + "name": "QUALITY" + }, + { + "value": "VALUE", + "name": "VALUE" + } + ] + } + }, + "com.amazonaws.iotsitewise#ColumnNames": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#ColumnName" + } + }, "com.amazonaws.iotsitewise#CompositeModelProperty": { "type": "structure", "members": { @@ -3241,6 +3304,115 @@ } } }, + "com.amazonaws.iotsitewise#CreateBulkImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#CreateBulkImportJobRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#CreateBulkImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#ConflictingOperationException" + }, + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#LimitExceededException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "This API operation is in preview release for IoT SiteWise and is subject to change. \n We recommend that you use this operation only with test data, and not in production environments.
\nDefines a job to ingest data to IoT SiteWise from Amazon S3. For more information, \n see Create a bulk import job (CLI) \n in the Amazon Simple Storage Service User Guide.
\nYou must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job. \n For more information about how to configure storage settings, \n see PutStorageConfiguration.
\nThe unique name that helps identify the job request.
", + "smithy.api#required": {} + } + }, + "jobRoleArn": { + "target": "com.amazonaws.iotsitewise#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.
", + "smithy.api#required": {} + } + }, + "files": { + "target": "com.amazonaws.iotsitewise#Files", + "traits": { + "smithy.api#documentation": "The files in the specified Amazon S3 bucket that contain your data.
", + "smithy.api#required": {} + } + }, + "errorReportLocation": { + "target": "com.amazonaws.iotsitewise#ErrorReportLocation", + "traits": { + "smithy.api#documentation": "The Amazon S3 destination where errors associated with the job creation request are saved.
", + "smithy.api#required": {} + } + }, + "jobConfiguration": { + "target": "com.amazonaws.iotsitewise#JobConfiguration", + "traits": { + "smithy.api#documentation": "Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotsitewise#CreateBulkImportJobResponse": { + "type": "structure", + "members": { + "jobId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "The ID of the job.
", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.iotsitewise#Name", + "traits": { + "smithy.api#documentation": "The unique name that helps identify the job request.
", + "smithy.api#required": {} + } + }, + "jobStatus": { + "target": "com.amazonaws.iotsitewise#JobStatus", + "traits": { + "smithy.api#documentation": "The status of the bulk import job can be one of following values.
\n\n PENDING – IoT SiteWise is waiting for the current bulk import job to finish.
\n CANCELLED – The bulk import job has been canceled.
\n RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.
\n COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.
\n FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. \n You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
\n COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors.\n You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
The column names specified in the .csv file.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A .csv file.
" + } + }, "com.amazonaws.iotsitewise#CustomerManagedS3Storage": { "type": "structure", "members": { @@ -4773,6 +4959,121 @@ } } }, + "com.amazonaws.iotsitewise#DescribeBulkImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#DescribeBulkImportJobRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#DescribeBulkImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "This API operation is in preview release for IoT SiteWise and is subject to change. \n We recommend that you use this operation only with test data, and not in production environments.
\nRetrieves information about a bulk import job request. For more information, \n see Describe a bulk import job (CLI) \n in the Amazon Simple Storage Service User Guide.
", + "smithy.api#endpoint": { + "hostPrefix": "data." + }, + "smithy.api#http": { + "method": "GET", + "uri": "/jobs/{jobId}", + "code": 200 + } + } + }, + "com.amazonaws.iotsitewise#DescribeBulkImportJobRequest": { + "type": "structure", + "members": { + "jobId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "The ID of the job.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotsitewise#DescribeBulkImportJobResponse": { + "type": "structure", + "members": { + "jobId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "The ID of the job.
", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.iotsitewise#Name", + "traits": { + "smithy.api#documentation": "The unique name that helps identify the job request.
", + "smithy.api#required": {} + } + }, + "jobStatus": { + "target": "com.amazonaws.iotsitewise#JobStatus", + "traits": { + "smithy.api#documentation": "The status of the bulk import job can be one of following values.
\n\n PENDING – IoT SiteWise is waiting for the current bulk import job to finish.
\n CANCELLED – The bulk import job has been canceled.
\n RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.
\n COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.
\n FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. \n You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
\n COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors.\n You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.
", + "smithy.api#required": {} + } + }, + "files": { + "target": "com.amazonaws.iotsitewise#Files", + "traits": { + "smithy.api#documentation": "The files in the specified Amazon S3 bucket that contain your data.
", + "smithy.api#required": {} + } + }, + "errorReportLocation": { + "target": "com.amazonaws.iotsitewise#ErrorReportLocation", + "traits": { + "smithy.api#documentation": "The Amazon S3 destination where errors associated with the job creation request are saved.
", + "smithy.api#required": {} + } + }, + "jobConfiguration": { + "target": "com.amazonaws.iotsitewise#JobConfiguration", + "traits": { + "smithy.api#documentation": "Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
", + "smithy.api#required": {} + } + }, + "jobCreationDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", + "traits": { + "smithy.api#documentation": "The date the job was created, in Unix epoch TIME.
", + "smithy.api#required": {} + } + }, + "jobLastUpdateDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", + "traits": { + "smithy.api#documentation": "The date the job was last updated, in Unix epoch time.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.iotsitewise#DescribeDashboard": { "type": "operation", "input": { @@ -5956,6 +6257,28 @@ "com.amazonaws.iotsitewise#ErrorMessage": { "type": "string" }, + "com.amazonaws.iotsitewise#ErrorReportLocation": { + "type": "structure", + "members": { + "bucket": { + "target": "com.amazonaws.iotsitewise#Bucket", + "traits": { + "smithy.api#documentation": "The name of the Amazon S3 bucket to which errors associated with the bulk import job are sent.
", + "smithy.api#required": {} + } + }, + "prefix": { + "target": "com.amazonaws.iotsitewise#String", + "traits": { + "smithy.api#documentation": "Amazon S3 uses the prefix as a folder name to organize data in the bucket. \n Each Amazon S3 object has a key that is its unique identifier in the bucket. \n Each object in a bucket has exactly one key. The prefix must end with a forward slash (/). \n For more information, see Organizing objects using prefixes \n in the Amazon Simple Storage Service User Guide.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon S3 destination where errors associated with the job creation request are saved.
" + } + }, "com.amazonaws.iotsitewise#ExceptionMessage": { "type": "string" }, @@ -5996,6 +6319,54 @@ "target": "com.amazonaws.iotsitewise#ExpressionVariable" } }, + "com.amazonaws.iotsitewise#File": { + "type": "structure", + "members": { + "bucket": { + "target": "com.amazonaws.iotsitewise#Bucket", + "traits": { + "smithy.api#documentation": "The name of the Amazon S3 bucket from which data is imported.
", + "smithy.api#required": {} + } + }, + "key": { + "target": "com.amazonaws.iotsitewise#String", + "traits": { + "smithy.api#documentation": "The key of the Amazon S3 object that contains your data. Each object has a key that is a\n unique identifier. Each object has exactly one key.
", + "smithy.api#required": {} + } + }, + "versionId": { + "target": "com.amazonaws.iotsitewise#String", + "traits": { + "smithy.api#documentation": "The version ID to identify a specific version of the Amazon S3 object that contains your data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The file in Amazon S3 where your data is saved.
" + } + }, + "com.amazonaws.iotsitewise#FileFormat": { + "type": "structure", + "members": { + "csv": { + "target": "com.amazonaws.iotsitewise#Csv", + "traits": { + "smithy.api#documentation": "The .csv file format.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The file format of the data.
" + } + }, + "com.amazonaws.iotsitewise#Files": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#File" + } + }, "com.amazonaws.iotsitewise#ForwardingConfig": { "type": "structure", "members": { @@ -6972,6 +7343,87 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.iotsitewise#JobConfiguration": { + "type": "structure", + "members": { + "fileFormat": { + "target": "com.amazonaws.iotsitewise#FileFormat", + "traits": { + "smithy.api#documentation": "The file format of the data in Amazon S3.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
" + } + }, + "com.amazonaws.iotsitewise#JobStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "CANCELLED", + "name": "CANCELLED" + }, + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "COMPLETED_WITH_FAILURES", + "name": "COMPLETED_WITH_FAILURES" + } + ] + } + }, + "com.amazonaws.iotsitewise#JobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#JobSummary" + } + }, + "com.amazonaws.iotsitewise#JobSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "The ID of the job.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.iotsitewise#Name", + "traits": { + "smithy.api#documentation": "The unique name that helps identify the job request.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.iotsitewise#JobStatus", + "traits": { + "smithy.api#documentation": "The status of the bulk import job can be one of following values.
\n\n PENDING – IoT SiteWise is waiting for the current bulk import job to finish.
\n CANCELLED – The bulk import job has been canceled.
\n RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.
\n COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.
\n FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. \n You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
\n COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors.\n You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
Contains a job summary information.
" + } + }, "com.amazonaws.iotsitewise#KmsKeyId": { "type": "string", "traits": { @@ -7478,6 +7930,125 @@ } } }, + "com.amazonaws.iotsitewise#ListBulkImportJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#ListBulkImportJobsRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#ListBulkImportJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "This API operation is in preview release for IoT SiteWise and is subject to change. \n We recommend that you use this operation only with test data, and not in production environments.
\nRetrieves a paginated list of bulk import job requests. For more information, \n see List bulk import jobs (CLI) \n in the Amazon Simple Storage Service User Guide.
", + "smithy.api#endpoint": { + "hostPrefix": "data." + }, + "smithy.api#http": { + "method": "GET", + "uri": "/jobs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "jobSummaries", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iotsitewise#ListBulkImportJobsFilter": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALL", + "name": "ALL" + }, + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "CANCELLED", + "name": "CANCELLED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "COMPLETED_WITH_FAILURES", + "name": "COMPLETED_WITH_FAILURES" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + } + ] + } + }, + "com.amazonaws.iotsitewise#ListBulkImportJobsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.iotsitewise#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return for each paginated request.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "filter": { + "target": "com.amazonaws.iotsitewise#ListBulkImportJobsFilter", + "traits": { + "smithy.api#documentation": "You can use a filter to select the bulk import jobs that you want to retrieve.
", + "smithy.api#httpQuery": "filter" + } + } + } + }, + "com.amazonaws.iotsitewise#ListBulkImportJobsResponse": { + "type": "structure", + "members": { + "jobSummaries": { + "target": "com.amazonaws.iotsitewise#JobSummaries", + "traits": { + "smithy.api#documentation": "One or more job summaries to list.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no additional results.
" + } + } + } + }, "com.amazonaws.iotsitewise#ListDashboards": { "type": "operation", "input": { @@ -9189,6 +9760,9 @@ ] } }, + "com.amazonaws.iotsitewise#String": { + "type": "string" + }, "com.amazonaws.iotsitewise#TagKey": { "type": "string", "traits": { diff --git a/codegen/sdk/aws-models/kendra.json b/codegen/sdk/aws-models/kendra.json index 03288c8b7fc..7f772930c3c 100644 --- a/codegen/sdk/aws-models/kendra.json +++ b/codegen/sdk/aws-models/kendra.json @@ -2115,7 +2115,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an access configuration for your documents. This includes \n user and group access information for your documents. This is useful \n for user context filtering, where search results are filtered based \n on the user or their group access to documents.
\nYou can use this to re-configure your existing document level access \n control without indexing all of your documents again. For example, your \n index contains top-secret company documents that only certain employees \n or users should access. One of these users leaves the company or switches \n to a team that should be blocked from access to top-secret documents. \n Your documents in your index still give this user access to top-secret \n documents due to the user having access at the time your documents were \n indexed. You can create a specific access control configuration for this \n user with deny access. You can later update the access control \n configuration to allow access in the case the user returns to the company \n and re-joins the 'top-secret' team. You can re-configure access control \n for your documents circumstances change.
\nTo apply your access control configuration to certain documents, you call \n the BatchPutDocument \n API with the AccessControlConfigurationId included in the \n Document \n object. If you use an S3 bucket as a data source, you update the \n .metadata.json with the AccessControlConfigurationId \n and synchronize your data source. Amazon Kendra currently only supports \n access control configuration for S3 data sources and documents indexed using the \n BatchPutDocument API.
Creates an access configuration for your documents. This includes \n user and group access information for your documents. This is useful \n for user context filtering, where search results are filtered based \n on the user or their group access to documents.
\nYou can use this to re-configure your existing document level access control without\n indexing all of your documents again. For example, your index contains top-secret\n company documents that only certain employees or users should access. One of these users\n leaves the company or switches to a team that should be blocked from accessing \n top-secret documents. The user still has access to top-secret documents because the user \n had access when your documents were previously indexed. You \n can create a specific access control configuration for the user with deny \n access. You can later update the access control configuration to allow access if the \n user returns to the company and re-joins the 'top-secret' team. You can re-configure \n access control for your documents as circumstances change.
\nTo apply your access control configuration to certain documents, you call \n the BatchPutDocument \n API with the AccessControlConfigurationId included in the \n Document \n object. If you use an S3 bucket as a data source, you update the \n .metadata.json with the AccessControlConfigurationId \n and synchronize your data source. Amazon Kendra currently only supports \n access control configuration for S3 data sources and documents indexed using the \n BatchPutDocument API.
The identifier of the access control configuration you want to get information on.
", + "smithy.api#documentation": "The identifier of the access control configuration\n you want to get information on.
", "smithy.api#required": {} } } @@ -4042,7 +4042,7 @@ "HierarchicalAccessControlList": { "target": "com.amazonaws.kendra#HierarchicalPrincipalList", "traits": { - "smithy.api#documentation": "The list of principal lists that \n define the hierarchy for which documents users should have access to.
" + "smithy.api#documentation": "The list of principal \n lists that define the hierarchy for which documents users should have access to.
" } } } @@ -7706,7 +7706,7 @@ "NextToken": { "target": "com.amazonaws.kendra#String", "traits": { - "smithy.api#documentation": "If the previous response was incomplete (because there is more data \n to retrieve), Amazon Kendra returns a pagination token in the response. \n You can use this pagination token to retrieve the next set of access \n control configurations.
" + "smithy.api#documentation": "If the previous response was incomplete (because\n there's more data to retrieve), Amazon Kendra returns a pagination token \n in the response. You can use this pagination token to retrieve the next set \n of access control configurations.
" } }, "MaxResults": { @@ -7723,7 +7723,7 @@ "NextToken": { "target": "com.amazonaws.kendra#String", "traits": { - "smithy.api#documentation": "If the response is truncated, Amazon Kendra returns this token \n that you can use in the subsequent request to retrieve the next set of \n access control configurations.
" + "smithy.api#documentation": "If the response is truncated, Amazon Kendra returns this\n token, which you can use in the subsequent request to retrieve the \n next set of access control configurations.
" } }, "AccessControlConfigurations": { @@ -10921,7 +10921,7 @@ "SecretArn": { "target": "com.amazonaws.kendra#SecretArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Secrets Manager \n secret that contains the user name and password required to \n connect to the SharePoint instance. \n If you use SharePoint Server, you also need to provide the sever \n domain name as part of the credentials. For\n more information, see Using a\n Microsoft SharePoint Data Source.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Secrets Manager \n secret that contains the user name and password required to \n connect to the SharePoint instance. \n If you use SharePoint Server, you also need to provide the sever \n domain name as part of the credentials. For\n more information, see Using a\n Microsoft SharePoint Data Source.
\nYou can also provide OAuth authentication credentials of user name, \n password, client ID, and client secret. For more information, see \n Authentication \n for a SharePoint data source.
", "smithy.api#required": {} } }, @@ -10978,12 +10978,33 @@ "traits": { "smithy.api#documentation": "The path to the SSL certificate stored in an Amazon S3 bucket. You use \n this to connect to SharePoint.
" } + }, + "AuthenticationType": { + "target": "com.amazonaws.kendra#SharePointOnlineAuthenticationType", + "traits": { + "smithy.api#documentation": "Whether you want to connect to SharePoint using basic authentication of \n user name and password, or OAuth authentication of user name, password, \n client ID, and client secret. You can use OAuth authentication for \n SharePoint Online.
" + } } }, "traits": { "smithy.api#documentation": "Provides the configuration information to connect to Microsoft\n SharePoint as your data source.
" } }, + "com.amazonaws.kendra#SharePointOnlineAuthenticationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HTTP_BASIC", + "name": "HTTP_BASIC" + }, + { + "value": "OAUTH2", + "name": "OAUTH2" + } + ] + } + }, "com.amazonaws.kendra#SharePointUrlList": { "type": "list", "member": { @@ -12128,7 +12149,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an access control configuration for your documents in an index. This \n includes user and group access information for your documents. This is useful \n for user context filtering, where search results are filtered based on the user \n or their group access to documents.
\nYou can update an access control configuration you created without indexing all \n of your documents again. For example, your index contains top-secret company \n documents that only certain employees or users should access. You created an 'allow' \n access control configuration for one user who recently joined the 'top-secret' team, \n switching from a team with 'deny' access to top-secret documents. However, the user \n suddenly returns to their previous team and should no longer have access to top secret \n documents. You can update the access control configuration to re-configure access \n control for your documents as circumstances change.
\nYou call the BatchPutDocument \n API to apply the updated access control configuration, with the \n AccessControlConfigurationId included in the \n Document \n object. If you use an S3 bucket as a data source, you synchronize your data source to \n apply the the AccessControlConfigurationId in the .metadata.json file. \n Amazon Kendra currently only supports access control configuration for S3 data \n sources and documents indexed using the BatchPutDocument API.
Updates an access control configuration for your documents in an index. This \n includes user and group access information for your documents. This is useful \n for user context filtering, where search results are filtered based on the user \n or their group access to documents.
\nYou can update an access control configuration you created without indexing all \n of your documents again. For example, your index contains top-secret company \n documents that only certain employees or users should access. You created an 'allow' \n access control configuration for one user who recently joined the 'top-secret' team, \n switching from a team with 'deny' access to top-secret documents. However, the user \n suddenly returns to their previous team and should no longer have access to top secret \n documents. You can update the access control configuration to re-configure access \n control for your documents as circumstances change.
\nYou call the BatchPutDocument API to\n apply the updated access control configuration, with the\n AccessControlConfigurationId included in the \n Document\n object. If you use an S3 bucket as a data source, you synchronize your data source to\n apply the AccessControlConfigurationId in the .metadata.json file. \n Amazon Kendra currently only supports access control configuration for S3 data\n sources and documents indexed using the BatchPutDocument API.
Lists the Amazon Lookout for Vision projects in your AWS account.
\nThe ListProjects operation is eventually consistent. \n Recent calls to CreateProject and DeleteProject might\n take a while to appear in the response from ListProjects.
This operation requires permissions to perform the\n lookoutvision:ListProjects operation.
Lists the Amazon Lookout for Vision projects in your AWS account that are in the AWS Region in \n which you call ListProjects.
The ListProjects operation is eventually consistent. \n Recent calls to CreateProject and DeleteProject might\n take a while to appear in the response from ListProjects.
This operation requires permissions to perform the\n lookoutvision:ListProjects operation.
The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model\n during training.
" } + }, + "MinInferenceUnits": { + "target": "com.amazonaws.lookoutvision#InferenceUnits", + "traits": { + "smithy.api#documentation": "The minimum number of inference units used by the model. For more information,\n see StartModel\n
" + } + }, + "MaxInferenceUnits": { + "target": "com.amazonaws.lookoutvision#InferenceUnits", + "traits": { + "smithy.api#documentation": "The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model.\n For more information, see StartModel.
" + } } }, "traits": { @@ -2927,6 +2943,12 @@ "smithy.api#httpHeader": "X-Amzn-Client-Token", "smithy.api#idempotencyToken": {} } + }, + "MaxInferenceUnits": { + "target": "com.amazonaws.lookoutvision#InferenceUnits", + "traits": { + "smithy.api#documentation": "The maximum number of inference units to use for auto-scaling the model. If you don't\n specify a value, Amazon Lookout for Vision doesn't auto-scale the model.
" + } } } }, diff --git a/codegen/sdk/aws-models/macie2.json b/codegen/sdk/aws-models/macie2.json index 689b53c614e..bde5d114ac2 100644 --- a/codegen/sdk/aws-models/macie2.json +++ b/codegen/sdk/aws-models/macie2.json @@ -314,6 +314,22 @@ "smithy.api#documentation": "Provides information about an identity that performed an action on an affected resource by using temporary security credentials. The credentials were obtained using the AssumeRole operation of the Security Token Service (STS) API.
" } }, + "com.amazonaws.macie2#AvailabilityCode": { + "type": "string", + "traits": { + "smithy.api#documentation": "Specifies whether occurrences of sensitive data can be retrieved for a finding. Possible values are:
", + "smithy.api#enum": [ + { + "value": "AVAILABLE", + "name": "AVAILABLE" + }, + { + "value": "UNAVAILABLE", + "name": "UNAVAILABLE" + } + ] + } + }, "com.amazonaws.macie2#AwsAccount": { "type": "structure", "members": { @@ -1454,14 +1470,14 @@ "keywords": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.
", + "smithy.api#documentation": "An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.
", "smithy.api#jsonName": "keywords" } }, "maximumMatchDistance": { "target": "com.amazonaws.macie2#__integer", "traits": { - "smithy.api#documentation": "The maximum number of characters that can exist between text that matches the regular expression and the character sequences specified by the keywords array. Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regular expression. The distance can be 1-300 characters. The default value is 50.
", + "smithy.api#documentation": "The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. The distance can be 1-300 characters. The default value is 50.
", "smithy.api#jsonName": "maximumMatchDistance" } }, @@ -2690,7 +2706,7 @@ "lastRunTime": { "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when the job started. If the job is a recurring job, this value indicates when the most recent run started.
", + "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when the job started. If the job is a recurring job, this value indicates when the most recent run started or, if the job hasn't run yet, when the job was created.
", "smithy.api#jsonName": "lastRunTime" } }, @@ -2822,6 +2838,22 @@ } } }, + "com.amazonaws.macie2#DetectedDataDetails": { + "type": "structure", + "members": { + "value": { + "target": "com.amazonaws.macie2#__stringMin1Max128", + "traits": { + "smithy.api#documentation": "An occurrence of the specified type of sensitive data. Each occurrence can contain 1-128 characters.
", + "smithy.api#jsonName": "value", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies 1-10 occurrences of a specific type of sensitive data reported by a finding.
" + } + }, "com.amazonaws.macie2#DisableMacie": { "type": "operation", "input": { @@ -4087,14 +4119,14 @@ "keywords": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. Keywords aren't case sensitive.
", + "smithy.api#documentation": "An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. Keywords aren't case sensitive.
", "smithy.api#jsonName": "keywords" } }, "maximumMatchDistance": { "target": "com.amazonaws.macie2#__integer", "traits": { - "smithy.api#documentation": "The maximum number of characters that can exist between text that matches the regular expression and the character sequences specified by the keywords array. Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regular expression.
", + "smithy.api#documentation": "The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. Otherwise, Macie excludes the result.
", "smithy.api#jsonName": "maximumMatchDistance" } }, @@ -4773,6 +4805,219 @@ } } }, + "com.amazonaws.macie2#GetRevealConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.macie2#GetRevealConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.macie2#GetRevealConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.macie2#AccessDeniedException" + }, + { + "target": "com.amazonaws.macie2#InternalServerException" + }, + { + "target": "com.amazonaws.macie2#ThrottlingException" + }, + { + "target": "com.amazonaws.macie2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the status and configuration settings for retrieving (revealing) occurrences of sensitive data reported by findings.
", + "smithy.api#http": { + "method": "GET", + "uri": "/reveal-configuration", + "code": 200 + } + } + }, + "com.amazonaws.macie2#GetRevealConfigurationRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.macie2#GetRevealConfigurationResponse": { + "type": "structure", + "members": { + "configuration": { + "target": "com.amazonaws.macie2#RevealConfiguration", + "traits": { + "smithy.api#documentation": "The current configuration settings and the status of the configuration for the account.
", + "smithy.api#jsonName": "configuration" + } + } + } + }, + "com.amazonaws.macie2#GetSensitiveDataOccurrences": { + "type": "operation", + "input": { + "target": "com.amazonaws.macie2#GetSensitiveDataOccurrencesRequest" + }, + "output": { + "target": "com.amazonaws.macie2#GetSensitiveDataOccurrencesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.macie2#AccessDeniedException" + }, + { + "target": "com.amazonaws.macie2#InternalServerException" + }, + { + "target": "com.amazonaws.macie2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.macie2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.macie2#ThrottlingException" + }, + { + "target": "com.amazonaws.macie2#UnprocessableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves (reveals) occurrences of sensitive data reported by a finding.
", + "smithy.api#http": { + "method": "GET", + "uri": "/findings/{findingId}/reveal", + "code": 200 + }, + "smithy.waiters#waitable": { + "FindingRevealed": { + "documentation": "Wait until the sensitive data occurrences are ready.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "status", + "expected": "SUCCESS", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "status", + "expected": "ERROR", + "comparator": "stringEquals" + } + } + } + ] + } + } + } + }, + "com.amazonaws.macie2#GetSensitiveDataOccurrencesAvailability": { + "type": "operation", + "input": { + "target": "com.amazonaws.macie2#GetSensitiveDataOccurrencesAvailabilityRequest" + }, + "output": { + "target": "com.amazonaws.macie2#GetSensitiveDataOccurrencesAvailabilityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.macie2#AccessDeniedException" + }, + { + "target": "com.amazonaws.macie2#InternalServerException" + }, + { + "target": "com.amazonaws.macie2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.macie2#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Checks whether occurrences of sensitive data can be retrieved (revealed) for a finding.
", + "smithy.api#http": { + "method": "GET", + "uri": "/findings/{findingId}/reveal/availability", + "code": 200 + } + } + }, + "com.amazonaws.macie2#GetSensitiveDataOccurrencesAvailabilityRequest": { + "type": "structure", + "members": { + "findingId": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "The unique identifier for the finding.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.macie2#GetSensitiveDataOccurrencesAvailabilityResponse": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.macie2#AvailabilityCode", + "traits": { + "smithy.api#documentation": "Specifies whether occurrences of sensitive data can be retrieved for the finding. Possible values are: AVAILABLE, the sensitive data can be retrieved; and, UNAVAILABLE, the sensitive data can't be retrieved. If this value is UNAVAILABLE, the reasons array indicates why the data can't be retrieved.
", + "smithy.api#jsonName": "code" + } + }, + "reasons": { + "target": "com.amazonaws.macie2#__listOfUnavailabilityReasonCode", + "traits": { + "smithy.api#documentation": "Specifies why occurrences of sensitive data can't be retrieved for the finding. Possible values are:
INVALID_CLASSIFICATION_RESULT - Amazon Macie can't verify the location of the sensitive data to retrieve. There isn't a corresponding sensitive data discovery result for the finding. Or the sensitive data discovery result specified by the ClassificationDetails.detailedResultsLocation field of the finding isn't available, is malformed or corrupted, or uses an unsupported storage format.
OBJECT_EXCEEDS_SIZE_QUOTA - The storage size of the affected S3 object exceeds the size quota for retrieving occurrences of sensitive data.
OBJECT_UNAVAILABLE - The affected S3 object isn't available. The object might have been renamed, moved, or deleted. Or the object was changed after Amazon Macie created the finding.
UNSUPPORTED_FINDING_TYPE - The specified finding isn't a sensitive data finding.
UNSUPPORTED_OBJECT_TYPE - The affected S3 object uses a file or storage format that Macie doesn't support for retrieving occurrences of sensitive data.
This value is null if sensitive data can be retrieved for the finding.
", + "smithy.api#jsonName": "reasons" + } + } + } + }, + "com.amazonaws.macie2#GetSensitiveDataOccurrencesRequest": { + "type": "structure", + "members": { + "findingId": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "The unique identifier for the finding.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.macie2#GetSensitiveDataOccurrencesResponse": { + "type": "structure", + "members": { + "error": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "If an error occurred when Amazon Macie attempted to retrieve occurrences of sensitive data reported by the finding, a description of the error that occurred. This value is null if the status (status) of the request is PROCESSING or SUCCESS.
", + "smithy.api#jsonName": "error" + } + }, + "sensitiveDataOccurrences": { + "target": "com.amazonaws.macie2#SensitiveDataOccurrences", + "traits": { + "smithy.api#documentation": "A map that specifies 1-100 types of sensitive data reported by the finding and, for each type, 1-10 occurrences of sensitive data.
", + "smithy.api#jsonName": "sensitiveDataOccurrences" + } + }, + "status": { + "target": "com.amazonaws.macie2#RevealRequestStatus", + "traits": { + "smithy.api#documentation": "The status of the request to retrieve occurrences of sensitive data reported by the finding. Possible values are:
ERROR - An error occurred when Amazon Macie attempted to locate, retrieve, or encrypt the sensitive data. The error value indicates the nature of the error that occurred.
PROCESSING - Macie is processing the request.
SUCCESS - Macie successfully located, retrieved, and encrypted the sensitive data.
Specifies whether any one-time or recurring jobs are configured to analyze data in the bucket. Possible values are:
TRUE - The bucket is explicitly included in the bucket definition (S3BucketDefinitionForJob) for one or more jobs and at least one of those jobs has a status other than CANCELLED. Or the bucket matched the bucket criteria (S3BucketCriteriaForJob) for at least one job that previously ran.
FALSE - The bucket isn't explicitly included in the bucket definition (S3BucketDefinitionForJob) for any jobs, all the jobs that explicitly include the bucket in their bucket definitions have a status of CANCELLED, or the bucket didn't match the bucket criteria (S3BucketCriteriaForJob) for any jobs that previously ran.
UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.
Specifies whether any one-time or recurring jobs are configured to analyze data in the bucket. Possible values are:
TRUE - The bucket is explicitly included in the bucket definition (S3BucketDefinitionForJob) for one or more jobs and at least one of those jobs has a status other than CANCELLED. Or the bucket matched the bucket criteria (S3BucketCriteriaForJob) for at least one job that previously ran.
FALSE - The bucket isn't explicitly included in the bucket definition (S3BucketDefinitionForJob) for any jobs, all the jobs that explicitly include the bucket in their bucket definitions have a status of CANCELLED, or the bucket didn't match the bucket criteria (S3BucketCriteriaForJob) for any jobs that previously ran.
UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.
Specifies the location of 1-15 occurrences of sensitive data that was detected by a managed data identifier or a custom data identifier and produced a sensitive data finding.
" + "smithy.api#documentation": "Specifies the location of 1-15 occurrences of sensitive data that was detected by a managed data identifier or a custom data identifier and produced a sensitive data finding. Depending on the file or storage format of the affected S3 object, you can optionally retrieve (reveal) sample occurrences of the sensitive data that was detected.
" } }, "com.amazonaws.macie2#OrderBy": { @@ -7402,6 +7659,65 @@ "smithy.api#documentation": "Provides information about the resources that a finding applies to.
" } }, + "com.amazonaws.macie2#RevealConfiguration": { + "type": "structure", + "members": { + "kmsKeyId": { + "target": "com.amazonaws.macie2#__stringMin1Max2048", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN), ID, or alias of the KMS key to use to encrypt sensitive data that's retrieved. The key must be an existing, customer managed, symmetric encryption key that's in the same Amazon Web Services Region as the Amazon Macie account.
If this value specifies an alias, it must include the following prefix: alias/. If this value specifies a key that's owned by another Amazon Web Services account, it must specify the ARN of the key or the ARN of the key's alias.
", + "smithy.api#jsonName": "kmsKeyId" + } + }, + "status": { + "target": "com.amazonaws.macie2#RevealStatus", + "traits": { + "smithy.api#documentation": "The status of the configuration for the Amazon Macie account. In a request, valid values are: ENABLED, enable the configuration for the account; and, DISABLED, disable the configuration for the account. In a response, possible values are: ENABLED, the configuration is currently enabled for the account; and, DISABLED, the configuration is currently disabled for the account.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the configuration settings for retrieving occurrences of sensitive data reported by findings, and the status of the configuration for an Amazon Macie account. When you enable the configuration for the first time, your request must specify an AWS Key Management Service (AWS KMS) key. Otherwise, an error occurs. Macie uses the specified key to encrypt the sensitive data that you retrieve.
" + } + }, + "com.amazonaws.macie2#RevealRequestStatus": { + "type": "string", + "traits": { + "smithy.api#documentation": "The status of a request to retrieve occurrences of sensitive data reported by a finding. Possible values are:
", + "smithy.api#enum": [ + { + "value": "SUCCESS", + "name": "SUCCESS" + }, + { + "value": "PROCESSING", + "name": "PROCESSING" + }, + { + "value": "ERROR", + "name": "ERROR" + } + ] + } + }, + "com.amazonaws.macie2#RevealStatus": { + "type": "string", + "traits": { + "smithy.api#documentation": "The status of the configuration for the Amazon Macie account. In a request, valid values are:
", + "smithy.api#enum": [ + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "DISABLED", + "name": "DISABLED" + } + ] + } + }, "com.amazonaws.macie2#S3Bucket": { "type": "structure", "members": { @@ -7555,7 +7871,7 @@ "kmsKeyArn": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to use for encryption of the results. This must be the ARN of an existing, symmetric, customer managed KMS key that's in the same Amazon Web Services Region as the bucket.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the customer managed KMS key to use for encryption of the results. This must be the ARN of an existing, symmetric encryption KMS key that's in the same Amazon Web Services Region as the bucket.
", "smithy.api#jsonName": "kmsKeyArn", "smithy.api#required": {} } @@ -8134,6 +8450,18 @@ ] } }, + "com.amazonaws.macie2#SensitiveDataOccurrences": { + "type": "map", + "key": { + "target": "com.amazonaws.macie2#__string" + }, + "value": { + "target": "com.amazonaws.macie2#__listOfDetectedDataDetails" + }, + "traits": { + "smithy.api#documentation": "Specifies a type of sensitive data reported by a finding and provides occurrences of the specified type of sensitive data.
" + } + }, "com.amazonaws.macie2#ServerSideEncryption": { "type": "structure", "members": { @@ -8770,14 +9098,14 @@ "keywords": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.
", + "smithy.api#documentation": "An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.
", "smithy.api#jsonName": "keywords" } }, "maximumMatchDistance": { "target": "com.amazonaws.macie2#__integer", "traits": { - "smithy.api#documentation": "The maximum number of characters that can exist between text that matches the regular expression and the character sequences specified by the keywords array. Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regular expression. The distance can be 1-300 characters. The default value is 50.
", + "smithy.api#documentation": "The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. The distance can be 1-300 characters. The default value is 50.
", "smithy.api#jsonName": "maximumMatchDistance" } }, @@ -8863,6 +9191,34 @@ ] } }, + "com.amazonaws.macie2#UnavailabilityReasonCode": { + "type": "string", + "traits": { + "smithy.api#documentation": "Specifies why occurrences of sensitive data can't be retrieved for a finding. Possible values are:
", + "smithy.api#enum": [ + { + "value": "OBJECT_EXCEEDS_SIZE_QUOTA", + "name": "OBJECT_EXCEEDS_SIZE_QUOTA" + }, + { + "value": "UNSUPPORTED_OBJECT_TYPE", + "name": "UNSUPPORTED_OBJECT_TYPE" + }, + { + "value": "UNSUPPORTED_FINDING_TYPE", + "name": "UNSUPPORTED_FINDING_TYPE" + }, + { + "value": "INVALID_CLASSIFICATION_RESULT", + "name": "INVALID_CLASSIFICATION_RESULT" + }, + { + "value": "OBJECT_UNAVAILABLE", + "name": "OBJECT_UNAVAILABLE" + } + ] + } + }, "com.amazonaws.macie2#Unit": { "type": "string", "traits": { @@ -8874,6 +9230,24 @@ ] } }, + "com.amazonaws.macie2#UnprocessableEntityException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "The type of error that occurred and prevented Amazon Macie from retrieving occurrences of sensitive data reported by the finding. Possible values are:
INVALID_CLASSIFICATION_RESULT - Amazon Macie can't verify the location of the sensitive data to retrieve. There isn't a corresponding sensitive data discovery result for the finding. Or the sensitive data discovery result specified by the ClassificationDetails.detailedResultsLocation field of the finding isn't available, is malformed or corrupted, or uses an unsupported storage format.
OBJECT_EXCEEDS_SIZE_QUOTA - The storage size of the affected S3 object exceeds the size quota for retrieving occurrences of sensitive data.
OBJECT_UNAVAILABLE - The affected S3 object isn't available. The object might have been renamed, moved, or deleted. Or the object was changed after Amazon Macie created the finding.
UNSUPPORTED_FINDING_TYPE - The specified finding isn't a sensitive data finding..
UNSUPPORTED_OBJECT_TYPE - The affected S3 object uses a file or storage format that Amazon Macie doesn't support for retrieving occurrences of sensitive data.
Provides information about an error that occurred due to an unprocessable entity.
", + "smithy.api#error": "client", + "smithy.api#httpError": 422 + } + }, "com.amazonaws.macie2#UnprocessedAccount": { "type": "structure", "members": { @@ -9310,6 +9684,62 @@ "type": "structure", "members": {} }, + "com.amazonaws.macie2#UpdateRevealConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.macie2#UpdateRevealConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.macie2#UpdateRevealConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.macie2#AccessDeniedException" + }, + { + "target": "com.amazonaws.macie2#InternalServerException" + }, + { + "target": "com.amazonaws.macie2#ThrottlingException" + }, + { + "target": "com.amazonaws.macie2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the status and configuration settings for retrieving (revealing) occurrences of sensitive data reported by findings.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/reveal-configuration", + "code": 200 + } + } + }, + "com.amazonaws.macie2#UpdateRevealConfigurationRequest": { + "type": "structure", + "members": { + "configuration": { + "target": "com.amazonaws.macie2#RevealConfiguration", + "traits": { + "smithy.api#documentation": "The new configuration settings and the status of the configuration for the account.
", + "smithy.api#jsonName": "configuration", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.macie2#UpdateRevealConfigurationResponse": { + "type": "structure", + "members": { + "configuration": { + "target": "com.amazonaws.macie2#RevealConfiguration", + "traits": { + "smithy.api#documentation": "The new configuration settings and the status of the configuration for the account.
", + "smithy.api#jsonName": "configuration" + } + } + } + }, "com.amazonaws.macie2#UsageByAccount": { "type": "structure", "members": { @@ -9773,6 +10203,12 @@ "target": "com.amazonaws.macie2#CustomDataIdentifierSummary" } }, + "com.amazonaws.macie2#__listOfDetectedDataDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.macie2#DetectedDataDetails" + } + }, "com.amazonaws.macie2#__listOfFinding": { "type": "list", "member": { @@ -9875,6 +10311,17 @@ "target": "com.amazonaws.macie2#TagValuePair" } }, + "com.amazonaws.macie2#__listOfUnavailabilityReasonCode": { + "type": "list", + "member": { + "target": "com.amazonaws.macie2#UnavailabilityReasonCode" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, "com.amazonaws.macie2#__listOfUnprocessedAccount": { "type": "list", "member": { @@ -9917,6 +10364,24 @@ "com.amazonaws.macie2#__string": { "type": "string" }, + "com.amazonaws.macie2#__stringMin1Max128": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.macie2#__stringMin1Max2048": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, "com.amazonaws.macie2#__timestampIso8601": { "type": "timestamp", "traits": { diff --git a/codegen/sdk/aws-models/marketplace-catalog.json b/codegen/sdk/aws-models/marketplace-catalog.json index 65523ff1c1a..2608187b943 100644 --- a/codegen/sdk/aws-models/marketplace-catalog.json +++ b/codegen/sdk/aws-models/marketplace-catalog.json @@ -41,6 +41,21 @@ }, "com.amazonaws.marketplacecatalog#AWSMPSeymour": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Marketplace Catalog", + "arnNamespace": "aws-marketplace", + "cloudFormationName": "MarketplaceCatalog", + "cloudTrailEventSource": "marketplacecatalog.amazonaws.com", + "endpointPrefix": "catalog.marketplace" + }, + "aws.auth#sigv4": { + "name": "aws-marketplace" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Catalog API actions allow you to manage your entities through list, describe, and update\n capabilities. An entity can be a product or an offer on AWS Marketplace.
\n\nYou can automate your entity update process by integrating the AWS Marketplace Catalog\n API with your AWS Marketplace product build or deployment pipelines. You can also create\n your own applications on top of the Catalog API to manage your products on AWS\n Marketplace.
", + "smithy.api#title": "AWS Marketplace Catalog Service" + }, "version": "2018-09-17", "operations": [ { @@ -61,22 +76,7 @@ { "target": "com.amazonaws.marketplacecatalog#StartChangeSet" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Marketplace Catalog", - "arnNamespace": "aws-marketplace", - "cloudFormationName": "MarketplaceCatalog", - "cloudTrailEventSource": "marketplacecatalog.amazonaws.com", - "endpointPrefix": "catalog.marketplace" - }, - "aws.auth#sigv4": { - "name": "aws-marketplace" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Catalog API actions allow you to manage your entities through list, describe, and update\n capabilities. An entity can be a product or an offer on AWS Marketplace.
\n\nYou can automate your entity update process by integrating the AWS Marketplace Catalog\n API with your AWS Marketplace product build or deployment pipelines. You can also create\n your own applications on top of the Catalog API to manage your products on AWS\n Marketplace.
", - "smithy.api#title": "AWS Marketplace Catalog Service" - } + ] }, "com.amazonaws.marketplacecatalog#AccessDeniedException": { "type": "structure", @@ -584,7 +584,7 @@ "EntityArn": { "target": "com.amazonaws.marketplacecatalog#ARN", "traits": { - "smithy.api#documentation": "The ARN associated to the unique identifier for the change set referenced in this\n request.
" + "smithy.api#documentation": "The ARN associated to the unique identifier for the entity referenced in this\n request.
" } }, "LastModifiedDate": { @@ -629,7 +629,7 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "^\\\\S+[\\\\S\\\\s]*" + "smithy.api#pattern": "^\\\\S+[\\\\S\\\\s]*$" } }, "com.amazonaws.marketplacecatalog#EntitySummary": { @@ -1237,7 +1237,8 @@ "ClientRequestToken": { "target": "com.amazonaws.marketplacecatalog#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique token to identify the request to ensure idempotency.
" + "smithy.api#documentation": "A unique token to identify the request to ensure idempotency.
", + "smithy.api#idempotencyToken": {} } } } diff --git a/codegen/sdk/aws-models/medialive.json b/codegen/sdk/aws-models/medialive.json index 2c7348d7780..c96275ec0d5 100644 --- a/codegen/sdk/aws-models/medialive.json +++ b/codegen/sdk/aws-models/medialive.json @@ -14345,12 +14345,18 @@ { "target": "com.amazonaws.medialive#PurchaseOffering" }, + { + "target": "com.amazonaws.medialive#RebootInputDevice" + }, { "target": "com.amazonaws.medialive#RejectInputDeviceTransfer" }, { "target": "com.amazonaws.medialive#StartChannel" }, + { + "target": "com.amazonaws.medialive#StartInputDeviceMaintenanceWindow" + }, { "target": "com.amazonaws.medialive#StartMultiplex" }, @@ -16459,6 +16465,95 @@ "smithy.api#documentation": "Raw Settings" } }, + "com.amazonaws.medialive#RebootInputDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#RebootInputDeviceRequest" + }, + "output": { + "target": "com.amazonaws.medialive#RebootInputDeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + }, + { + "target": "com.amazonaws.medialive#UnprocessableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "Send a reboot command to the specified input device. The device will begin rebooting within a few seconds of sending the command. When the reboot is complete, the device’s connection status will change to connected.", + "smithy.api#http": { + "method": "POST", + "uri": "/prod/inputDevices/{InputDeviceId}/reboot", + "code": 200 + } + } + }, + "com.amazonaws.medialive#RebootInputDeviceForce": { + "type": "string", + "traits": { + "smithy.api#documentation": "Whether or not to force reboot the input device.", + "smithy.api#enum": [ + { + "value": "NO", + "name": "NO" + }, + { + "value": "YES", + "name": "YES" + } + ] + } + }, + "com.amazonaws.medialive#RebootInputDeviceRequest": { + "type": "structure", + "members": { + "Force": { + "target": "com.amazonaws.medialive#RebootInputDeviceForce", + "traits": { + "smithy.api#documentation": "Force a reboot of an input device. If the device is streaming, it will stop streaming and begin rebooting within a few seconds of sending the command. If the device was streaming prior to the reboot, the device will resume streaming when the reboot completes.", + "smithy.api#jsonName": "force" + } + }, + "InputDeviceId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The unique ID of the input device to reboot. For example, hd-123456789abcdef.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A request to reboot an AWS Elemental device." + } + }, + "com.amazonaws.medialive#RebootInputDeviceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Placeholder documentation for RebootInputDeviceResponse" + } + }, "com.amazonaws.medialive#Rec601Settings": { "type": "structure", "members": {}, @@ -18243,6 +18338,72 @@ "smithy.api#documentation": "Placeholder documentation for StartChannelResponse" } }, + "com.amazonaws.medialive#StartInputDeviceMaintenanceWindow": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#StartInputDeviceMaintenanceWindowRequest" + }, + "output": { + "target": "com.amazonaws.medialive#StartInputDeviceMaintenanceWindowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + }, + { + "target": "com.amazonaws.medialive#UnprocessableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "Start a maintenance window for the specified input device. Starting a maintenance window will give the device up to two hours to install software. If the device was streaming prior to the maintenance, it will resume streaming when the software is fully installed. Devices automatically install updates while they are powered on and their MediaLive channels are stopped. A maintenance window allows you to update a device without having to stop MediaLive channels that use the device. The device must remain powered on and connected to the internet for the duration of the maintenance.", + "smithy.api#http": { + "method": "POST", + "uri": "/prod/inputDevices/{InputDeviceId}/startInputDeviceMaintenanceWindow", + "code": 200 + } + } + }, + "com.amazonaws.medialive#StartInputDeviceMaintenanceWindowRequest": { + "type": "structure", + "members": { + "InputDeviceId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The unique ID of the input device to start a maintenance window for. For example, hd-123456789abcdef.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for StartInputDeviceMaintenanceWindowRequest" + } + }, + "com.amazonaws.medialive#StartInputDeviceMaintenanceWindowResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Placeholder documentation for StartInputDeviceMaintenanceWindowResponse" + } + }, "com.amazonaws.medialive#StartMultiplex": { "type": "operation", "input": { diff --git a/codegen/sdk/aws-models/network-firewall.json b/codegen/sdk/aws-models/network-firewall.json index c9a228b398b..45939e0a656 100644 --- a/codegen/sdk/aws-models/network-firewall.json +++ b/codegen/sdk/aws-models/network-firewall.json @@ -340,6 +340,56 @@ "com.amazonaws.networkfirewall#Boolean": { "type": "boolean" }, + "com.amazonaws.networkfirewall#CIDRCount": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 1000000 + } + } + }, + "com.amazonaws.networkfirewall#CIDRSummary": { + "type": "structure", + "members": { + "AvailableCIDRCount": { + "target": "com.amazonaws.networkfirewall#CIDRCount", + "traits": { + "smithy.api#documentation": "The number of CIDR blocks available for use by the IP set references in a firewall.
" + } + }, + "UtilizedCIDRCount": { + "target": "com.amazonaws.networkfirewall#CIDRCount", + "traits": { + "smithy.api#documentation": "The number of CIDR blocks used by the IP set references in a firewall.
" + } + }, + "IPSetReferences": { + "target": "com.amazonaws.networkfirewall#IPSetMetadataMap", + "traits": { + "smithy.api#documentation": "The list of the IP set references used by a firewall.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summarizes the CIDR blocks used by the IP set references in a firewall. Network Firewall calculates the number of CIDRs by taking an aggregated count of all CIDRs used by the IP sets you are referencing.
" + } + }, + "com.amazonaws.networkfirewall#CapacityUsageSummary": { + "type": "structure", + "members": { + "CIDRs": { + "target": "com.amazonaws.networkfirewall#CIDRSummary", + "traits": { + "smithy.api#documentation": "Describes the capacity usage of the CIDR blocks used by the IP set references in a firewall.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The capacity usage summary of the resources used by the ReferenceSets in a firewall.
" + } + }, "com.amazonaws.networkfirewall#CollectionMember_String": { "type": "string" }, @@ -354,6 +404,10 @@ { "value": "IN_SYNC", "name": "IN_SYNC" + }, + { + "value": "CAPACITY_CONSTRAINED", + "name": "CAPACITY_CONSTRAINED" } ] } @@ -1824,6 +1878,12 @@ "traits": { "smithy.api#documentation": "The subnets that you've configured for use by the Network Firewall firewall. This contains\n one array element per Availability Zone where you've configured a subnet. These objects\n provide details of the information that is summarized in the\n ConfigurationSyncStateSummary and Status, broken down by zone\n and configuration object.
Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall calclulates the capacity usage by taking an aggregated count of all of the resources used by all of the reference sets in a firewall.
" + } } }, "traits": { @@ -1961,6 +2021,65 @@ "smithy.api#documentation": "A list of IP addresses and address ranges, in CIDR notation. This is part of a RuleVariables.
" } }, + "com.amazonaws.networkfirewall#IPSetArn": { + "type": "string" + }, + "com.amazonaws.networkfirewall#IPSetMetadata": { + "type": "structure", + "members": { + "ResolvedCIDRCount": { + "target": "com.amazonaws.networkfirewall#CIDRCount", + "traits": { + "smithy.api#documentation": "Describes the total number of CIDR blocks currently in use by the IP set references in a firewall. To determine how many CIDR blocks are available for you to use in a firewall, you can call AvailableCIDRCount.
General information about the IP set.
" + } + }, + "com.amazonaws.networkfirewall#IPSetMetadataMap": { + "type": "map", + "key": { + "target": "com.amazonaws.networkfirewall#IPSetArn" + }, + "value": { + "target": "com.amazonaws.networkfirewall#IPSetMetadata" + } + }, + "com.amazonaws.networkfirewall#IPSetReference": { + "type": "structure", + "members": { + "ReferenceArn": { + "target": "com.amazonaws.networkfirewall#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource that you are referencing in your rule group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configures one or more IP set references for a Suricata-compatible rule group. This is used in CreateRuleGroup or UpdateRuleGroup. An IP set reference is a rule variable that references a resource that you create and manage in another Amazon Web Services service, such as an Amazon VPC prefix list. Network Firewall IP set references enable you to dynamically update the contents of your rules. When you create, update, or delete the IP set you are referencing in your rule, Network Firewall automatically updates the rule's content with the changes. For more information about IP set references in Network Firewall, see Using IP set references in the Network Firewall Developer Guide.
\n\n Network Firewall currently supports only Amazon VPC prefix lists as IP set references.\n
" + } + }, + "com.amazonaws.networkfirewall#IPSetReferenceMap": { + "type": "map", + "key": { + "target": "com.amazonaws.networkfirewall#IPSetReferenceName" + }, + "value": { + "target": "com.amazonaws.networkfirewall#IPSetReference" + } + }, + "com.amazonaws.networkfirewall#IPSetReferenceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9_]*$" + } + }, "com.amazonaws.networkfirewall#IPSets": { "type": "map", "key": { @@ -2699,6 +2818,10 @@ { "value": "IN_SYNC", "name": "IN_SYNC" + }, + { + "value": "CAPACITY_CONSTRAINED", + "name": "CAPACITY_CONSTRAINED" } ] } @@ -2874,6 +2997,20 @@ "type": "structure", "members": {} }, + "com.amazonaws.networkfirewall#ReferenceSets": { + "type": "structure", + "members": { + "IPSetReferences": { + "target": "com.amazonaws.networkfirewall#IPSetReferenceMap", + "traits": { + "smithy.api#documentation": "The list of IP set references.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains a set of IP set references.
" + } + }, "com.amazonaws.networkfirewall#ResourceArn": { "type": "string", "traits": { @@ -3010,6 +3147,12 @@ "smithy.api#documentation": "Settings that are available for use in the rules in the rule group. You can only use\n these for stateful rule groups.
" } }, + "ReferenceSets": { + "target": "com.amazonaws.networkfirewall#ReferenceSets", + "traits": { + "smithy.api#documentation": "The list of a rule group's reference sets.
" + } + }, "RulesSource": { "target": "com.amazonaws.networkfirewall#RulesSource", "traits": { diff --git a/codegen/sdk/aws-models/polly.json b/codegen/sdk/aws-models/polly.json index e72e13f92a2..b78d214f610 100644 --- a/codegen/sdk/aws-models/polly.json +++ b/codegen/sdk/aws-models/polly.json @@ -1975,6 +1975,10 @@ { "value": "Pedro", "name": "Pedro" + }, + { + "value": "Kajal", + "name": "Kajal" } ] } diff --git a/codegen/sdk/aws-models/rds.json b/codegen/sdk/aws-models/rds.json index 54e215b89ac..9f4cdc72b50 100644 --- a/codegen/sdk/aws-models/rds.json +++ b/codegen/sdk/aws-models/rds.json @@ -99,6 +99,29 @@ "target": "com.amazonaws.rds#String" } }, + "com.amazonaws.rds#ActivityStreamPolicyStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "locked", + "name": "locked" + }, + { + "value": "unlocked", + "name": "unlocked" + }, + { + "value": "locking-policy", + "name": "locking_policy" + }, + { + "value": "unlocking-policy", + "name": "unlocking_policy" + } + ] + } + }, "com.amazonaws.rds#ActivityStreamStatus": { "type": "string", "traits": { @@ -612,6 +635,9 @@ { "target": "com.amazonaws.rds#ListTagsForResource" }, + { + "target": "com.amazonaws.rds#ModifyActivityStream" + }, { "target": "com.amazonaws.rds#ModifyCertificates" }, @@ -839,6 +865,21 @@ } } }, + "com.amazonaws.rds#AuditPolicyState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "locked", + "name": "LOCKED_POLICY" + }, + { + "value": "unlocked", + "name": "UNLOCKED_POLICY" + } + ] + } + }, "com.amazonaws.rds#AuthScheme": { "type": "string", "traits": { @@ -1083,7 +1124,7 @@ } ], "traits": { - "smithy.api#documentation": "Backtracks a DB cluster to a specific time, without creating a new DB cluster.
\nFor more information on backtracking, see \n \n Backtracking an Aurora DB Cluster in the \n Amazon Aurora User Guide.
\nThis action only applies to Aurora MySQL DB clusters.
\nBacktracks a DB cluster to a specific time, without creating a new DB cluster.
\nFor more information on backtracking, see \n \n Backtracking an Aurora DB Cluster in the \n Amazon Aurora User Guide.
\nThis action applies only to Aurora MySQL DB clusters.
\nCopies a snapshot of a DB cluster.
\nTo copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier\n must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.
You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot action \n is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, \n you must provide the following values:
\n KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to \n encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.
\n PreSignedUrl - A URL that contains a Signature Version 4 signed request for the \n CopyDBClusterSnapshot action to be called in the source Amazon Web Services Region where the DB cluster snapshot is copied from. \n The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the \n source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied.
The pre-signed URL request must contain the following parameter values:
\n\n KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB \n cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot \n action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.
\n DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.
\n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster \n snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, \n if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier\n looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.
\nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.
\n TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.
\n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. \n This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified\n by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in \"copying\" status.
For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see \n \n Copying a Snapshot in the Amazon Aurora User Guide.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Copies a snapshot of a DB cluster.
\nTo copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier\n must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.
You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case,\n the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the\n destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy\n an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the\n following values:
\n KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to \n encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.
\n TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.
\n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot\n identifier for the encrypted DB cluster snapshot to be copied. This identifier\n must be in the ARN format for the source Amazon Web Services Region and is the same value as\n the SourceDBClusterSnapshotIdentifier in the presigned URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified\n by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in \"copying\" status.
For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see \n \n Copying a Snapshot in the Amazon Aurora User Guide.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" } }, "com.amazonaws.rds#CopyDBClusterSnapshotMessage": { @@ -1561,7 +1602,7 @@ "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the \n source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. \n Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.
The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be\n executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. \n The pre-signed URL request must contain the following parameter values:
\n KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB \n cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot \n action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.
\n DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.
\n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster \n snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, \n if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier\n looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see \n\n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.
\nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.
When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region\n to another, the URL that contains a Signature Version 4 signed request for the\n CopyDBClusterSnapshot API operation in the Amazon Web Services Region that contains\n the source DB cluster snapshot to copy. Use the PreSignedUrl parameter when\n copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify\n PreSignedUrl when copying an encrypted DB cluster snapshot in the same\n Amazon Web Services Region.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.
\nThe presigned URL must be a valid request for the\n CopyDBClusterSnapshot API operation that can run in the source\n Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request\n must contain the following parameter values:
\n KmsKeyId - The KMS key identifier for the KMS key\n to use to encrypt the copy of the DB cluster snapshot in the destination\n Amazon Web Services Region. This is the same identifier for both the\n CopyDBClusterSnapshot operation that is called in the\n destination Amazon Web Services Region, and the operation contained in the presigned\n URL.
\n DestinationRegion - The name of the Amazon Web Services Region \n that the DB cluster snapshot is to be created in.
\n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster \n snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, \n if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier\n looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.
\nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.
Copies the specified DB snapshot. The source DB snapshot must be in the available state.
You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region\n where you call the CopyDBSnapshot action is the destination Amazon Web Services Region for the\n DB snapshot copy.
This command doesn't apply to RDS Custom.
\nFor more information about copying snapshots, see \n Copying a DB Snapshot in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Copies the specified DB snapshot. The source DB snapshot must be in the available state.
You can copy a snapshot from one Amazon Web Services Region to another. In that case, the\n Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination\n Amazon Web Services Region for the DB snapshot copy.
This command doesn't apply to RDS Custom.
\nFor more information about copying snapshots, see \n Copying a DB Snapshot in the Amazon RDS User Guide.
" } }, "com.amazonaws.rds#CopyDBSnapshotMessage": { @@ -1687,7 +1728,7 @@ "SourceDBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The identifier for the source DB snapshot.
\nIf the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB\n snapshot identifier. For example, you might specify\n rds:mysql-instance1-snapshot-20130805.
If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB\n snapshot ARN. For example, you might specify\n arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.
If you are copying from a shared manual DB snapshot, \n this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.
\nIf you are copying an encrypted snapshot\n this parameter must be in the ARN format for the source Amazon Web Services Region, \n and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.
Constraints:
\nMust specify a valid system snapshot in the \"available\" state.
\nExample: rds:mydb-2012-04-02-00-01\n
Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805\n
The identifier for the source DB snapshot.
\nIf the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB\n snapshot identifier. For example, you might specify\n rds:mysql-instance1-snapshot-20130805.
If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB\n snapshot ARN. For example, you might specify\n arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.
If you are copying from a shared manual DB snapshot, \n this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.
\nIf you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region.
\nConstraints:
\nMust specify a valid system snapshot in the \"available\" state.
\nExample: rds:mydb-2012-04-02-00-01\n
Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805\n
The URL that contains a Signature Version 4 signed request for the\n CopyDBSnapshot API action in the source Amazon Web Services Region that contains the\n source DB snapshot to copy.
You must specify this parameter when you copy an encrypted DB snapshot from another\n Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are \n copying an encrypted DB snapshot in the same Amazon Web Services Region.
The presigned URL must be a valid request for the CopyDBSnapshot API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted DB snapshot to be copied. \n The presigned URL request must contain the following parameter values:
\n DestinationRegion - The Amazon Web Services Region that the encrypted DB snapshot is copied to. \n This Amazon Web Services Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL.
For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web Services Region\n to the us-east-1 Amazon Web Services Region, then you call the CopyDBSnapshot action in\n the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the\n CopyDBSnapshot action in the us-west-2 Amazon Web Services Region. For this\n example, the DestinationRegion in the presigned URL must be set to\n the us-east-1 Amazon Web Services Region.
\n KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. \n This is the same identifier for both the CopyDBSnapshot action that is called in the destination Amazon Web Services Region, \n and the action contained in the presigned URL.
\n SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. \n For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBSnapshotIdentifier looks like\n the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.
\nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.
When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, \n the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API \n operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.
\nYou must specify this parameter when you copy an encrypted DB snapshot from another\n Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are \n copying an encrypted DB snapshot in the same Amazon Web Services Region.
The presigned URL must be a valid request for the\n CopyDBClusterSnapshot API operation that can run in the source\n Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request\n must contain the following parameter values:
\n DestinationRegion - The Amazon Web Services Region that the encrypted DB\n snapshot is copied to. This Amazon Web Services Region is the same one where the\n CopyDBSnapshot operation is called that contains this presigned\n URL.
For example, if you copy an encrypted DB snapshot from the us-west-2\n Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the\n CopyDBSnapshot operation in the us-east-1 Amazon Web Services Region and\n provide a presigned URL that contains a call to the CopyDBSnapshot\n operation in the us-west-2 Amazon Web Services Region. For this example, the\n DestinationRegion in the presigned URL must be set to the\n us-east-1 Amazon Web Services Region.
\n KmsKeyId - The KMS key identifier for the KMS key to use to\n encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the\n same identifier for both the CopyDBSnapshot operation that is\n called in the destination Amazon Web Services Region, and the operation contained in the\n presigned URL.
\n SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. \n For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBSnapshotIdentifier looks like\n the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.
\nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.
Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
\nYou can use the ReplicationSourceIdentifier parameter to create an Amazon\n Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or\n PostgreSQL DB instance. For cross-Region replication where the DB cluster identified by\n ReplicationSourceIdentifier is encrypted, also specify the\n PreSignedUrl parameter.
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
\nYou can use the ReplicationSourceIdentifier parameter to create an Amazon\n Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or\n PostgreSQL DB instance.
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" } }, "com.amazonaws.rds#CreateDBClusterEndpoint": { @@ -1982,7 +2023,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
\nThis action only applies to Aurora DB clusters.
\nCreates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
\nThis action applies only to Aurora DB clusters.
\nA URL that contains a Signature Version 4 signed request for \n the CreateDBCluster action to be called in the source Amazon Web Services Region where the DB cluster is replicated from. \n Specify PreSignedUrl only when you are performing cross-Region replication from an encrypted DB cluster.
The pre-signed URL must be a valid request for the CreateDBCluster API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster to be copied.
The pre-signed URL request must contain the following parameter values:
\n\n KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of \n the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster \n action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.
\n DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will\n be created in.
\n ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an \n encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like\n Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.
\nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.
Valid for: Aurora DB clusters only
" + "smithy.api#documentation": "When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another,\n an URL that contains a Signature Version 4 signed request for the\n CreateDBCluster operation to be called in the source Amazon Web Services Region where\n the DB cluster is replicated from. Specify PreSignedUrl only when you are\n performing cross-Region replication from an encrypted DB cluster.
The presigned URL must be a valid request for the CreateDBCluster API\n operation that can run in the source Amazon Web Services Region that contains the encrypted DB\n cluster to copy.
The presigned URL request must contain the following parameter values:
\n\n KmsKeyId - The KMS key identifier for the KMS key to use to\n encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should\n refer to the same KMS key for both the CreateDBCluster operation\n that is called in the destination Amazon Web Services Region, and the operation contained in\n the presigned URL.
\n DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will\n be created in.
\n ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an \n encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like\n Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.
\nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.
Valid for: Aurora DB clusters only
" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide..
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.
\nFor more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters only
" } }, "BacktrackWindow": { @@ -2181,7 +2222,7 @@ "EngineMode": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The DB engine mode of the DB cluster, either provisioned, serverless, \n parallelquery, global, or multimaster.
The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, \n and version 2.09 and higher 2.x versions.
The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, \n and global engine mode isn't required for any 2.x versions.
The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.
For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery \n and the multimaster engine modes currently aren't supported.
Limitations and requirements apply to some DB engine modes. For more information, see the \n following sections in the Amazon Aurora User Guide:
\nValid for: Aurora DB clusters only
" + "smithy.api#documentation": "The DB engine mode of the DB cluster, either provisioned, serverless, \n parallelquery, global, or multimaster.
The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, \n and version 2.09 and higher 2.x versions.
The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, \n and global engine mode isn't required for any 2.x versions.
The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.
The serverless engine mode only applies for Aurora Serverless v1 DB clusters.
For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery \n and the multimaster engine modes currently aren't supported.
Limitations and requirements apply to some DB engine modes. For more information, see the \n following sections in the Amazon Aurora User Guide:
\nValid for: Aurora DB clusters only
" } }, "ScalingConfiguration": { @@ -2295,7 +2336,7 @@ "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
\nValid for: Multi-AZ DB clusters only
" } }, "ServerlessV2ScalingConfiguration": { @@ -2323,7 +2364,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new DB cluster parameter group.
\nParameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
\nA DB cluster parameter group is initially created with the default parameters for the\n database engine used by instances in the DB cluster. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to\n associate it with your DB cluster using ModifyDBCluster.
When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB\n instances in the DB cluster without failover for the new DB cluster parameter group and \n associated settings to take effect.
\nWhen you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB\n cluster without failover for the new DB cluster parameter group and associated settings to take effect.
\nAfter you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster\n that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters action to verify \n that your DB cluster parameter group has been created or modified.
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Creates a new DB cluster parameter group.
\nParameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
\nA DB cluster parameter group is initially created with the default parameters for the\n database engine used by instances in the DB cluster. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to\n associate it with your DB cluster using ModifyDBCluster.
When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB\n instances in the DB cluster without failover for the new DB cluster parameter group and \n associated settings to take effect.
\nWhen you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB\n cluster without failover for the new DB cluster parameter group and associated settings to take effect.
\nAfter you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as\n the default parameter group. This allows Amazon RDS to fully complete the create\n action before the DB cluster parameter group is used as the default for a new DB\n cluster. This is especially important for parameters that are critical when creating\n the default database for a DB cluster, such as the character set for the default\n database defined by the character_set_database parameter. You can use\n the Parameter Groups option of the Amazon RDS console or the\n DescribeDBClusterParameters operation to verify that your DB\n cluster parameter group has been created or modified.
For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" } }, "com.amazonaws.rds#CreateDBClusterParameterGroupMessage": { @@ -2513,7 +2554,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new DB instance.
" + "smithy.api#documentation": "Creates a new DB instance.
\nThe new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. \n For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance \n to the cluster.
\nFor more information about creating an RDS DB instance, see \n Creating an Amazon RDS DB instance in the Amazon RDS User Guide.
\nFor more information about creating a DB instance in an Aurora DB cluster, see \n \n Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.
" } }, "com.amazonaws.rds#CreateDBInstanceMessage": { @@ -2541,7 +2582,7 @@ "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The compute and memory capacity of the DB instance, for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.
", + "smithy.api#documentation": "The compute and memory capacity of the DB instance, for example db.m5.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes, and availability for your engine, see\n DB instance \n classes in the Amazon RDS User Guide or \n Aurora \n DB instance classes in the Amazon Aurora User Guide.
", "smithy.api#required": {} } }, @@ -2567,7 +2608,7 @@ "DBSecurityGroups": { "target": "com.amazonaws.rds#DBSecurityGroupNameList", "traits": { - "smithy.api#documentation": "A list of DB security groups to associate with this DB instance.
\nDefault: The default DB security group for the database engine.
" + "smithy.api#documentation": "A list of DB security groups to associate with this DB instance.
\nThis setting applies to the legacy EC2-Classic platform, which is no longer used to create \n new DB instances. Use the VpcSecurityGroupIds setting instead.
The number of days for which automated backups are retained. Setting this parameter to a positive number enables \n backups. Setting this parameter to 0 disables automated backups.
\n\n Amazon Aurora\n
\nNot applicable. The retention period for automated backups is managed by the DB cluster.
\nDefault: 1
\nConstraints:
\nMust be a value from 0 to 35
\nCan't be set to 0 if the DB instance is a source to read replicas
\nCan't be set to 0 or 35 for an RDS Custom for Oracle DB instance
\nThe number of days for which automated backups are retained. Setting this parameter to a positive number enables \n backups. Setting this parameter to 0 disables automated backups.
\n\n Amazon Aurora\n
\nNot applicable. The retention period for automated backups is managed by the DB cluster.
\nDefault: 1
\nConstraints:
\nMust be a value from 0 to 35
\nCan't be set to 0 if the DB instance is a source to read replicas
\nCan't be set to 0 for an RDS Custom for Oracle DB instance
\nA value that indicates whether the DB instance is a Multi-AZ deployment. You can't set \n the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set \n the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. DB instance Availability Zones (AZs) are managed by the DB cluster.
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The version number of the database engine to use.
\nFor a list of valid engine versions, use the DescribeDBEngineVersions action.
The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.
\n\n Amazon Aurora\n
\nNot applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.
\n\n Amazon RDS Custom for Oracle\n
\nA custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV \n name has the following format: 19.customized_string\n . An example identifier is \n 19.my_cev1. For more information, see \n Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.
\n Amazon RDS Custom for SQL Server\n
\nSee RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.
\n\n MariaDB\n
\nFor information, see MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.
\n\n Microsoft SQL Server\n
\nFor information, see Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.
\n\n MySQL\n
\nFor information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.
\n\n Oracle\n
\nFor information, see Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.
\n\n PostgreSQL\n
\nFor information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.
" + "smithy.api#documentation": "The version number of the database engine to use.
\nFor a list of valid engine versions, use the DescribeDBEngineVersions\n operation.
The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.
\n\n Amazon Aurora\n
\nNot applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.
\n\n Amazon RDS Custom for Oracle\n
\nA custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV \n name has the following format: 19.customized_string\n . An example identifier is \n 19.my_cev1. For more information, see \n Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.
\n Amazon RDS Custom for SQL Server\n
\nSee RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.
\n\n MariaDB\n
\nFor information, see MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.
\n\n Microsoft SQL Server\n
\nFor information, see Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.
\n\n MySQL\n
\nFor information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.
\n\n Oracle\n
\nFor information, see Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.
\n\n PostgreSQL\n
\nFor information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.
" } }, "AutoMinorVersionUpgrade": { @@ -2639,19 +2680,19 @@ "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "License model information for this DB instance.
\nValid values: license-included | bring-your-own-license | general-public-license\n
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "License model information for this DB instance.
\nValid values: license-included | bring-your-own-license | general-public-license\n
This setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable.
" } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.\n For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 \n of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 \n of the storage amount for the DB instance.
" + "smithy.api#documentation": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.\n For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 \n of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 \n of the storage amount for the DB instance.
\n\n Amazon Aurora\n
\nNot applicable. Storage is managed by the DB cluster.
" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "A value that indicates that the DB instance should be associated with the specified option group.
\nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group. Also, that option group can't be removed from a DB instance after it is \n associated with a DB instance.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that indicates that the DB instance should be associated with the specified option group.
\nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group. Also, that option group can't be removed from a DB instance after it is \n associated with a DB instance.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable.
" } }, "CharacterSetName": { @@ -2687,13 +2728,13 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type to be associated with the DB instance.
\nValid values: standard | gp2 | io1\n
If you specify io1, you must also include a value for the\n Iops parameter.
Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
Specifies the storage type to be associated with the DB instance.
\nValid values: standard | gp2 | io1\n
If you specify io1, you must also include a value for the\n Iops parameter.
Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
\n Amazon Aurora\n
\nNot applicable. Storage is managed by the DB cluster.
" } }, "TdeCredentialArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The ARN from the key store with which to associate the instance for TDE encryption.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The ARN from the key store with which to associate the instance for TDE encryption.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable.
" } }, "TdeCredentialPassword": { @@ -2717,7 +2758,7 @@ "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. The domain is managed by the DB cluster.
" } }, "CopyTagsToSnapshot": { @@ -2741,7 +2782,7 @@ "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. The domain is managed by the DB cluster.
" } }, "PromotionTier": { @@ -2759,7 +2800,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\nThis setting doesn't apply to RDS Custom or Amazon Aurora. In Aurora, mapping Amazon Web Services IAM accounts \n to database accounts is managed by the DB cluster.
\nFor more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.
\nFor more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
" } }, "EnablePerformanceInsights": { @@ -2777,7 +2818,7 @@ "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
\nThis setting doesn't apply to RDS Custom.
" } }, "EnableCloudwatchLogsExports": { @@ -2789,7 +2830,7 @@ "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable.
" } }, "DeletionProtection": { @@ -2801,7 +2842,7 @@ "MaxAllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. Storage is managed by the DB cluster.
" } }, "EnableCustomerOwnedIp": { @@ -2904,7 +2945,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new DB instance that acts as a read replica for an existing source DB\n instance. You can create a read replica for a DB instance running MySQL, MariaDB,\n Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read\n Replicas in the Amazon RDS User Guide.
\nAmazon Aurora doesn't support this action. Call the CreateDBInstance\n action to create a DB instance for an Aurora DB cluster.
All read replica DB instances are created with backups disabled. All other DB\n instance attributes (including DB security groups and DB parameter groups) are inherited\n from the source DB instance, except as specified.
\nYour source DB instance must have backup retention enabled.
\nCreates a new DB instance that acts as a read replica for an existing source DB\n instance. You can create a read replica for a DB instance running MySQL, MariaDB,\n Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read\n Replicas in the Amazon RDS User Guide.
\nAmazon Aurora doesn't support this operation. Call the CreateDBInstance\n operation to create a DB instance for an Aurora DB cluster.
All read replica DB instances are created with backups disabled. All other DB\n instance attributes (including DB security groups and DB parameter groups) are inherited\n from the source DB instance, except as specified.
\nYour source DB instance must have backup retention enabled.
\nThe name of the DB parameter group to associate with this DB instance.
\nIf you do not specify a value for DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of source DB instance for a same Region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross-Region read replica.
Specifying a parameter group for this operation is only supported for Oracle DB instances. It \n isn't supported for RDS Custom.
\nConstraints:
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nThe name of the DB parameter group to associate with this DB instance.
\nIf you do not specify a value for DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of source DB instance for a same Region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross-Region read replica.
Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. \n It isn't supported for RDS Custom.
\nConstraints:
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nThe URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action \n in the source Amazon Web Services Region that contains the source DB instance.
You must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted source DB instance. \n The presigned URL request must contain the following parameter values:
\n DestinationRegion - The Amazon Web Services Region that the encrypted read\n replica is created in. This Amazon Web Services Region is the same one where the\n CreateDBInstanceReadReplica action is called that contains this presigned URL.
For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region,\n from a source DB instance in the us-east-2 Amazon Web Services Region, \n then you call the CreateDBInstanceReadReplica action in\n the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the\n CreateDBInstanceReadReplica action in the us-west-2 Amazon Web Services Region. For this\n example, the DestinationRegion in the presigned URL must be set to\n the us-east-1 Amazon Web Services Region.
\n KmsKeyId - The Amazon Web Services KMS key identifier for the key to use to\n encrypt the read replica in the destination Amazon Web Services Region. This is the same\n identifier for both the CreateDBInstanceReadReplica action that is\n called in the destination Amazon Web Services Region, and the action contained in the presigned\n URL.
\n SourceDBInstanceIdentifier - The DB instance identifier for\n the encrypted DB instance to be replicated. This identifier must be in the\n Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you\n are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services\n Region, then your SourceDBInstanceIdentifier looks like the\n following example:\n arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.
To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.
\nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can be executed in the source Amazon Web Services Region.
\n SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS\n doesn't support cross-Region read replicas.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or\n from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4\n signed request for the CreateDBInstanceReadReplica API operation in the\n source Amazon Web Services Region that contains the source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions and \n China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.
\nYou must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.
The presigned URL must be a valid request for the\n CreateDBInstanceReadReplica API operation that can run in the\n source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL\n request must contain the following parameter values:
\n DestinationRegion - The Amazon Web Services Region that the encrypted read\n replica is created in. This Amazon Web Services Region is the same one where the\n CreateDBInstanceReadReplica operation is called that contains\n this presigned URL.
For example, if you create an encrypted DB instance in the us-west-1\n Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you\n call the CreateDBInstanceReadReplica operation in the us-east-1\n Amazon Web Services Region and provide a presigned URL that contains a call to the\n CreateDBInstanceReadReplica operation in the us-west-2\n Amazon Web Services Region. For this example, the DestinationRegion in the\n presigned URL must be set to the us-east-1 Amazon Web Services Region.
\n KmsKeyId - The KMS key identifier for the key to use to\n encrypt the read replica in the destination Amazon Web Services Region. This is the same\n identifier for both the CreateDBInstanceReadReplica operation that\n is called in the destination Amazon Web Services Region, and the operation contained in the\n presigned URL.
\n SourceDBInstanceIdentifier - The DB instance identifier for\n the encrypted DB instance to be replicated. This identifier must be in the\n Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you\n are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services\n Region, then your SourceDBInstanceIdentifier looks like the\n following example:\n arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.
To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.
\nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.
\n SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server \n doesn't support cross-Region read replicas.
This setting doesn't apply to RDS Custom.
" } }, "EnableIAMDatabaseAuthentication": { @@ -3050,7 +3091,7 @@ "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
\n \nThis setting doesn't apply to RDS Custom.
" } }, "EnableCloudwatchLogsExports": { @@ -3311,7 +3352,7 @@ "EngineFamily": { "target": "com.amazonaws.rds#EngineFamily", "traits": { - "smithy.api#documentation": "The kinds of databases that the proxy can connect to. \n This value determines which database network protocol the proxy recognizes when it interprets\n network traffic to and from the database. \n The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.
", + "smithy.api#documentation": "The kinds of databases that the proxy can connect to. \n This value determines which database network protocol the proxy recognizes when it interprets\n network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL. \n For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL.
Creates an RDS event notification subscription. This action requires a topic Amazon\n Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API.\n To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the\n topic. The ARN is displayed in the SNS console.
\nYou can specify the type of source (SourceType) that you want to be\n notified of and provide a list of RDS sources (SourceIds) that triggers the\n events. You can also provide a list of event categories (EventCategories)\n for events that you want to be notified of. For example, you can specify\n SourceType = db-instance, SourceIds =\n mydbinstance1, mydbinstance2 and\n EventCategories = Availability,\n Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance\n and SourceIds = myDBInstance1, you are notified of all the db-instance events for\n the specified source. If you specify a SourceType but do not specify SourceIds,\n you receive notice of the events for that source type for all your RDS sources. If you\n don't specify either the SourceType or the SourceIds, you are notified of events\n generated from all RDS sources belonging to your customer account.
RDS event notification is only available for unencrypted SNS topics. If you specify an \n encrypted SNS topic, event notifications aren't sent for the topic.
\nCreates an RDS event notification subscription. This operation requires a topic Amazon\n Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API.\n To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the\n topic. The ARN is displayed in the SNS console.
\nYou can specify the type of source (SourceType) that you want to be\n notified of and provide a list of RDS sources (SourceIds) that triggers the\n events. You can also provide a list of event categories (EventCategories)\n for events that you want to be notified of. For example, you can specify\n SourceType = db-instance, SourceIds =\n mydbinstance1, mydbinstance2 and\n EventCategories = Availability,\n Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance\n and SourceIds = myDBInstance1, you are notified of all the db-instance events for\n the specified source. If you specify a SourceType but do not specify SourceIds,\n you receive notice of the events for that source type for all your RDS sources. If you\n don't specify either the SourceType or the SourceIds, you are notified of events\n generated from all RDS sources belonging to your customer account.
RDS event notification is only available for unencrypted SNS topics. If you specify an \n encrypted SNS topic, event notifications aren't sent for the topic.
\nCreates an Aurora global database\n spread across multiple Amazon Web Services Regions. The global database\n contains a single primary cluster with read-write capability,\n and a read-only secondary cluster that receives\n data from the primary cluster through high-speed replication\n performed by the Aurora storage subsystem.
\nYou can create a global database that is initially empty, and then\n add a primary cluster and a secondary cluster to it.\n Or you can specify an existing Aurora cluster during the create operation,\n and this cluster becomes the primary cluster of the global database.
\nThis action only applies to Aurora DB clusters.
\nCreates an Aurora global database\n spread across multiple Amazon Web Services Regions. The global database\n contains a single primary cluster with read-write capability,\n and a read-only secondary cluster that receives\n data from the primary cluster through high-speed replication\n performed by the Aurora storage subsystem.
\nYou can create a global database that is initially empty, and then\n add a primary cluster and a secondary cluster to it.\n Or you can specify an existing Aurora cluster during the create operation,\n and this cluster becomes the primary cluster of the global database.
\nThis action applies only to Aurora DB clusters.
\nThe name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon\n Aurora will not create a database in the global database cluster you are creating.
" + "smithy.api#documentation": "The name for your database of up to 64 alphanumeric characters. If you do not provide\n a name, Amazon Aurora will not create a database in the global database cluster you are\n creating.
" } }, "StorageEncrypted": { @@ -4325,7 +4366,7 @@ "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" } }, "ServerlessV2ScalingConfiguration": { @@ -5733,7 +5774,7 @@ "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
" + "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nThe network type of the DB instance.
\nValid values:
\n\n IPV4\n
\n DUAL\n
The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).
For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide and \n \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n
" } + }, + "ActivityStreamPolicyStatus": { + "target": "com.amazonaws.rds#ActivityStreamPolicyStatus", + "traits": { + "smithy.api#documentation": "The status of the policy state of the activity stream.
" + } } }, "traits": { @@ -6520,7 +6567,7 @@ "EngineFamily": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.
" + "smithy.api#documentation": "The kinds of databases that the proxy can connect to. This value determines which database network protocol \n the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, \n RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases.
The ID of the DB instance to retrieve the list of DB snapshots for. \n This parameter can't be used in conjunction with DBSnapshotIdentifier.\n This parameter isn't case-sensitive.
Constraints:
\nIf supplied, must match the identifier of an existing DBInstance.
\nThe ID of the DB instance to retrieve the list of DB snapshots for. \n This parameter isn't case-sensitive.
\nConstraints:
\nIf supplied, must match the identifier of an existing DBInstance.
\nA specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier. \n This value is stored as a lowercase string.
Constraints:
\nIf supplied, must match the identifier of an existing DBSnapshot.
\nIf this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
A specific DB snapshot identifier to describe.\n This value is stored as a lowercase string.
\nConstraints:
\nIf supplied, must match the identifier of an existing DBSnapshot.
\nIf this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. \n Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be \n obtained by providing the name as a parameter.
\nBy default, RDS returns events that were generated in the past hour.
\nReturns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. \n Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be \n obtained by providing the name as a parameter.
\nFor more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora\n events in the Amazon Aurora User Guide.
\nBy default, RDS returns events that were generated in the past hour.
\nThe maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 10000.
" } }, "Marker": { @@ -11771,7 +11818,7 @@ } }, "traits": { - "smithy.api#documentation": "This data type is used as a response element in the DescribeEvents action.
This data type is used as a response element in the DescribeEvents action.
" } }, "com.amazonaws.rds#EventCategoriesList": { @@ -11800,7 +11847,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains the results of a successful invocation of the DescribeEventCategories operation.
Contains the results of a successful invocation of the DescribeEventCategories\n operation.
" } }, "com.amazonaws.rds#EventCategoriesMapList": { @@ -12150,7 +12197,7 @@ } ], "traits": { - "smithy.api#documentation": "Forces a failover for a DB cluster.
\nFor an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).
\nFor a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).
\nAn Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists,\n when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readbable standby \n DB instance when the primary DB instance fails.
\nTo simulate a failure of a primary instance for testing, you can force a failover. \n Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing \n connections that use those endpoint addresses when the failover is complete.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Forces a failover for a DB cluster.
\nFor an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).
\nFor a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).
\nAn Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists,\n when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby \n DB instance when the primary DB instance fails.
\nTo simulate a failure of a primary instance for testing, you can force a failover. \n Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing \n connections that use those endpoint addresses when the failover is complete.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
" } }, "com.amazonaws.rds#FailoverDBClusterMessage": { @@ -13262,6 +13309,87 @@ } } }, + "com.amazonaws.rds#ModifyActivityStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyActivityStreamRequest" + }, + "output": { + "target": "com.amazonaws.rds#ModifyActivityStreamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only,\n whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy,\n and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the\n Amazon RDS User Guide.
\nThis operation is supported for RDS for Oracle only.
" + } + }, + "com.amazonaws.rds#ModifyActivityStreamRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the RDS for Oracle DB instance,\n for example, arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db.
The audit policy state. When a policy is unlocked, it is read/write. When it is locked, it is\n read-only. You can edit your audit policy only when the activity stream is unlocked or stopped.
" + } + } + } + }, + "com.amazonaws.rds#ModifyActivityStreamResponse": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.
" + } + }, + "KinesisStreamName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon Kinesis data stream to be used for the database activity stream.
" + } + }, + "Status": { + "target": "com.amazonaws.rds#ActivityStreamStatus", + "traits": { + "smithy.api#documentation": "The status of the modification to the database activity stream.
" + } + }, + "Mode": { + "target": "com.amazonaws.rds#ActivityStreamMode", + "traits": { + "smithy.api#documentation": "The mode of the database activity stream.
" + } + }, + "EngineNativeAuditFieldsIncluded": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "Indicates whether engine-native audit fields are included in the database activity stream.
" + } + }, + "PolicyStatus": { + "target": "com.amazonaws.rds#ActivityStreamPolicyStatus", + "traits": { + "smithy.api#documentation": "The status of the modification to the policy state of the database activity stream.
" + } + } + } + }, "com.amazonaws.rds#ModifyCertificates": { "type": "operation", "input": { @@ -13722,7 +13850,7 @@ "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
\nValid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
\nValid for: Multi-AZ DB clusters only
" } }, "ServerlessV2ScalingConfiguration": { @@ -13750,7 +13878,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the parameters of a DB cluster parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, \n and ApplyMethod. A maximum of 20\n parameters can be modified in a single request.
After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters action to verify \n that your DB cluster parameter group has been created or modified.
If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora\n applies the update immediately. The cluster restart might interrupt your workload. In that case,\n your application must reopen any connections and retry any transactions that were active\n when the parameter changes took effect.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "Modifies the parameters of a DB cluster parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, \n and ApplyMethod. A maximum of 20\n parameters can be modified in a single request.
After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters operation to verify \n that your DB cluster parameter group has been created or modified.
If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora\n applies the update immediately. The cluster restart might interrupt your workload. In that case,\n your application must reopen any connections and retry any transactions that were active\n when the parameter changes took effect.
\nFor more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.
\nFor more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n
" } }, "com.amazonaws.rds#ModifyDBClusterParameterGroupMessage": { @@ -13803,7 +13931,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
\nTo share a manual DB cluster snapshot with other Amazon Web Services accounts, specify\n restore as the AttributeName and use the\n ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are\n authorized to restore the manual DB cluster snapshot. Use the value all to\n make the manual DB cluster snapshot public, which means that it can be copied or\n restored by all Amazon Web Services accounts.
Don't add the all value for any manual DB cluster snapshots\n that contain private information that you don't want available to all Amazon Web Services\n accounts.
If a manual DB cluster snapshot is encrypted, it can be shared, but only by\n specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd\n parameter. You can't use all as a value for that parameter in this\n case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster\n snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API action. The accounts are\n returned as values for the restore attribute.
Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
\nTo share a manual DB cluster snapshot with other Amazon Web Services accounts, specify\n restore as the AttributeName and use the\n ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are\n authorized to restore the manual DB cluster snapshot. Use the value all to\n make the manual DB cluster snapshot public, which means that it can be copied or\n restored by all Amazon Web Services accounts.
Don't add the all value for any manual DB cluster snapshots\n that contain private information that you don't want available to all Amazon Web Services\n accounts.
If a manual DB cluster snapshot is encrypted, it can be shared, but only by\n specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd\n parameter. You can't use all as a value for that parameter in this\n case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster\n snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are\n returned as values for the restore attribute.
The name of the DB cluster snapshot attribute to modify.
\nTo manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, \n set this value to restore.
To view the list of attributes available to modify, use the\n DescribeDBClusterSnapshotAttributes API action.
\nThe name of the DB cluster snapshot attribute to modify.
\nTo manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, \n set this value to restore.
To view the list of attributes available to modify, use the\n DescribeDBClusterSnapshotAttributes API operation.
\nThe new compute and memory capacity of the DB instance, for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.
\nIf you modify the DB instance class, an outage occurs during the change.\n The change is applied during the next maintenance window,\n unless ApplyImmediately is enabled for this request.
This setting doesn't apply to RDS Custom for Oracle.
\nDefault: Uses existing setting
" + "smithy.api#documentation": "The new compute and memory capacity of the DB instance, for example db.m5.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes, and availability for your engine, see\n DB instance \n classes in the Amazon RDS User Guide or \n Aurora \n DB instance classes in the Amazon Aurora User Guide.
\nIf you modify the DB instance class, an outage occurs during the change.\n The change is applied during the next maintenance window,\n unless ApplyImmediately is enabled for this request.
This setting doesn't apply to RDS Custom for Oracle.
\nDefault: Uses existing setting
" } }, "DBSubnetGroupName": { @@ -13971,7 +14099,7 @@ "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The new password for the master user. The password can include any printable ASCII \n character except \"/\", \"\"\", or \"@\".
\nChanging this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.
This setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. The password for the master user is managed by the DB cluster. For\n more information, see ModifyDBCluster.
Default: Uses existing setting
\n\n MariaDB\n
\nConstraints: Must contain from 8 to 41 characters.
\n\n Microsoft SQL Server\n
\nConstraints: Must contain from 8 to 128 characters.
\n\n MySQL\n
\nConstraints: Must contain from 8 to 41 characters.
\n\n Oracle\n
\nConstraints: Must contain from 8 to 30 characters.
\n\n PostgreSQL\n
\nConstraints: Must contain from 8 to 128 characters.
\nAmazon RDS API actions never return the password, \n so this action provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.
\nThe new password for the master user. The password can include any printable ASCII \n character except \"/\", \"\"\", or \"@\".
\nChanging this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.
This setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. The password for the master user is managed by the DB cluster. For\n more information, see ModifyDBCluster.
Default: Uses existing setting
\n\n MariaDB\n
\nConstraints: Must contain from 8 to 41 characters.
\n\n Microsoft SQL Server\n
\nConstraints: Must contain from 8 to 128 characters.
\n\n MySQL\n
\nConstraints: Must contain from 8 to 41 characters.
\n\n Oracle\n
\nConstraints: Must contain from 8 to 30 characters.
\n\n PostgreSQL\n
\nConstraints: Must contain from 8 to 128 characters.
\nAmazon RDS API operations never return the password, \n so this action provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.
\nThe number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
\nEnabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
\nThese changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled\n for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously\n applied as soon as possible.
\n Amazon Aurora\n
\nNot applicable. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
\nConstraints:
\nIt must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to \n read replicas. It can't be set to 0 or 35 for an RDS Custom for Oracle DB instance.
\nIt can be specified for a MySQL read replica only if the source is running MySQL 5.6 or\n later.
\nIt can be specified for a PostgreSQL read replica only if the source is running PostgreSQL\n 9.3.5.
\nThe number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
\nEnabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
\nThese changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled\n for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously\n applied as soon as possible.
\n Amazon Aurora\n
\nNot applicable. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
\nConstraints:
\nIt must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to \n read replicas. It can't be set to 0 for an RDS Custom for Oracle DB instance.
\nIt can be specified for a MySQL read replica only if the source is running MySQL 5.6 or\n later.
\nIt can be specified for a PostgreSQL read replica only if the source is running PostgreSQL\n 9.3.5.
\nA value that indicates whether to enable Performance Insights for the DB instance.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide..
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that indicates whether to enable Performance Insights for the DB instance.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "PerformanceInsightsKMSKeyId": { @@ -14139,7 +14267,7 @@ "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
\nThis setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
\nThis setting doesn't apply to RDS Custom.
" } }, "CloudwatchLogsExportConfiguration": { @@ -14447,14 +14575,14 @@ "TargetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the new target group to assign to the proxy.
", + "smithy.api#documentation": "The name of the target group to modify.
", "smithy.api#required": {} } }, "DBProxyName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the new proxy to which to assign the target group.
", + "smithy.api#documentation": "The name of the proxy.
", "smithy.api#required": {} } }, @@ -14520,7 +14648,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.
\nTo share a manual DB snapshot with other Amazon Web Services accounts, specify restore\n as the AttributeName and use the ValuesToAdd parameter to add\n a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot.\n Uses the value all to make the manual DB snapshot public, which means it\n can be copied or restored by all Amazon Web Services accounts.
Don't add the all value for any manual DB snapshots that\n contain private information that you don't want available to all Amazon Web Services\n accounts.
If the manual DB snapshot is encrypted, it can be shared, but only by specifying a\n list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You\n can't use all as a value for that parameter in this case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or\n whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action. The accounts are returned as\n values for the restore attribute.
Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.
\nTo share a manual DB snapshot with other Amazon Web Services accounts, specify restore\n as the AttributeName and use the ValuesToAdd parameter to add\n a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot.\n Uses the value all to make the manual DB snapshot public, which means it\n can be copied or restored by all Amazon Web Services accounts.
Don't add the all value for any manual DB snapshots that\n contain private information that you don't want available to all Amazon Web Services\n accounts.
If the manual DB snapshot is encrypted, it can be shared, but only by specifying a\n list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You\n can't use all as a value for that parameter in this case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or\n whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as\n values for the restore attribute.
The name of the DB snapshot attribute to modify.
\nTo manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, \n set this value to restore.
To view the list of attributes available to modify, use the\n DescribeDBSnapshotAttributes API action.
\nThe name of the DB snapshot attribute to modify.
\nTo manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, \n set this value to restore.
To view the list of attributes available to modify, use the\n DescribeDBSnapshotAttributes API operation.
\nYou might need to reboot your DB instance, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB parameter group associated with the DB instance, \n you must reboot the instance for the changes to take effect.
\nRebooting a DB instance restarts the database engine service. \n Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
\nFor more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.\n
\nThis command doesn't apply to RDS Custom.
" + "smithy.api#documentation": "You might need to reboot your DB instance, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB parameter group associated with the DB instance, \n you must reboot the instance for the changes to take effect.
\nRebooting a DB instance restarts the database engine service. \n Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
\nFor more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.\n
\nThis command doesn't apply to RDS Custom.
\nIf your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.
The name of the database engine to be used for this DB cluster.
\nValid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), and aurora-postgresql\n
The name of the database engine to be used for this DB cluster.
\nValid Values: aurora (for MySQL 5.6-compatible Aurora) and aurora-mysql \n (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
The version number of the database engine to use.
\nTo list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for aurora-postgresql, use the following command:
\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
\n Aurora MySQL\n
\nExample: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5, 8.0.mysql_aurora.3.01.0\n
\n Aurora PostgreSQL\n
\nExample: 9.6.3, 10.7\n
The version number of the database engine to use.
\nTo list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
\n Aurora MySQL\n
\nExample: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.mysql_aurora.2.07.1,\n 8.0.mysql_aurora.3.02.0\n
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.\n The values in the list depend on the DB engine being used.
\n\n RDS for MySQL\n
\nPossible values are error, general, and slowquery.
\n RDS for PostgreSQL\n
\nPossible values are postgresql and upgrade.
\n Aurora MySQL\n
\nPossible values are audit, error, general, and slowquery.
\n Aurora PostgreSQL\n
\nPossible value is postgresql.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide..
\nFor more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.\n The values in the list depend on the DB engine being used.
\n\n RDS for MySQL\n
\nPossible values are error, general, and slowquery.
\n RDS for PostgreSQL\n
\nPossible values are postgresql and upgrade.
\n Aurora MySQL\n
\nPossible values are audit, error, general, and slowquery.
\n Aurora PostgreSQL\n
\nPossible value is postgresql.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nFor more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "EngineMode": { @@ -17878,7 +18006,7 @@ "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used.
\n\n RDS for MySQL\n
\nPossible values are error, general, and slowquery.
\n RDS for PostgreSQL\n
\nPossible values are postgresql and upgrade.
\n Aurora MySQL\n
\nPossible values are audit, error, general, and slowquery.
\n Aurora PostgreSQL\n
\nPossible value is postgresql.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide..
\nFor more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used.
\n\n RDS for MySQL\n
\nPossible values are error, general, and slowquery.
\n RDS for PostgreSQL\n
\nPossible values are postgresql and upgrade.
\n Aurora MySQL\n
\nPossible values are audit, error, general, and slowquery.
\n Aurora PostgreSQL\n
\nPossible value is postgresql.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nFor more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "DBClusterParameterGroupName": { @@ -18544,7 +18672,7 @@ "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable Performance Insights for the DB instance.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide..
" + "smithy.api#documentation": "A value that indicates whether to enable Performance Insights for the DB instance.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.
" } }, "PerformanceInsightsKMSKeyId": { @@ -18556,7 +18684,7 @@ "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
" + "smithy.api#documentation": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
\n7
\n\n month * 31, where month is a number of months from 1-23
\n731
\nFor example, the following values are valid:
\n93 (3 months * 31)
\n341 (11 months * 31)
\n589 (19 months * 31)
\n731
\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
" } }, "EnableCloudwatchLogsExports": { @@ -19115,7 +19243,7 @@ "MinCapacity": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum capacity for the Aurora DB cluster in serverless DB engine\n mode.
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
A URL that contains a Signature Version 4 signed request for the StartDBInstanceAutomatedBackupsReplication action to be \n called in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the\n StartDBInstanceAutomatedBackupsReplication API action that can be executed in the Amazon Web Services Region that contains\n the source DB instance.
" + "smithy.api#documentation": "In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request \n for the StartDBInstanceAutomatedBackupsReplication operation to call \n in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the\n StartDBInstanceAutomatedBackupsReplication API operation that can run in \n the Amazon Web Services Region that contains the source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.
\nTo learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.
\nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.
Stops automated backup replication for a DB instance.
\nThis command doesn't apply to RDS Custom.
\nFor more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "Stops automated backup replication for a DB instance.
\nThis command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.
\nFor more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n
" } }, "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationMessage": { @@ -20560,7 +20688,7 @@ "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The status of the VPC security group.
" + "smithy.api#documentation": "The membership status of the VPC security group.
\nCurrently, the only valid status is active.
\n Specifies locations in the frames where Amazon Rekognition checks for objects or people. You can specify up to 10 regions of interest. This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.\n
" + "smithy.api#documentation": "\n Specifies locations in the frames where Amazon Rekognition checks for objects or people. You can specify up to 10 regions of interest, and each region has either a polygon or a bounding box. This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.\n
" } }, "DataSharingPreference": { @@ -6507,6 +6507,12 @@ "traits": { "smithy.api#documentation": "The identifer for the AWS Key Management Service key (AWS KMS key) that was used to encrypt the model during training.
" } + }, + "MaxInferenceUnits": { + "target": "com.amazonaws.rekognition#InferenceUnits", + "traits": { + "smithy.api#documentation": "The maximum number of inference units Amazon Rekognition Custom Labels uses to auto-scale the model.\n For more information, see StartProjectVersion.
" + } } }, "traits": { @@ -6914,7 +6920,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies a location within the frame that Rekognition checks for objects of interest such as text, labels, or faces. It uses a BoundingBox\n or object or Polygon to set a region of the screen.
A word, face, or label is included in the region if it is more than half in that region. If there is more than\n one region, the word, face, or label is compared with all regions of the screen. Any object of interest that is more than half in a region\n is kept in the results.
" + "smithy.api#documentation": "Specifies a location within the frame that Rekognition checks for objects of interest such as text, labels, or faces. It uses a BoundingBox\n or Polygon to set a region of the screen.
A word, face, or label is included in the region if it is more than half in that region. If there is more than\n one region, the word, face, or label is compared with all regions of the screen. Any object of interest that is more than half in a region\n is kept in the results.
" } }, "com.amazonaws.rekognition#RegionsOfInterest": { @@ -8290,7 +8296,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts the running of the version of a model. Starting a model takes a while\n to complete. To check the current state of the model, use DescribeProjectVersions.
\nOnce the model is running, you can detect custom labels in new images by calling \n DetectCustomLabels.
\nYou are charged for the amount of time that the model is running. To stop a running\n model, call StopProjectVersion.
\nThis operation requires permissions to perform the \n rekognition:StartProjectVersion action.
Starts the running of the version of a model. Starting a model takes a while\n to complete. To check the current state of the model, use DescribeProjectVersions.
\nOnce the model is running, you can detect custom labels in new images by calling \n DetectCustomLabels.
\nYou are charged for the amount of time that the model is running. To stop a running\n model, call StopProjectVersion.
\nFor more information, see Running a trained Amazon Rekognition Custom Labels model in the Amazon Rekognition Custom Labels Guide.
\n \nThis operation requires permissions to perform the \n rekognition:StartProjectVersion action.
The minimum number of inference units to use. A single\n inference unit represents 1 hour of processing and can support up to 5 Transaction Pers Second (TPS).\n Use a higher number to increase the TPS throughput of your model. You are charged for the number\n of inference units that you use.\n
", + "smithy.api#documentation": "The minimum number of inference units to use. A single\n inference unit represents 1 hour of processing.
\n \nFor information about the number \n of transactions per second (TPS) that an inference unit can support, see \n Running a trained Amazon Rekognition Custom Labels model in the \n Amazon Rekognition Custom Labels Guide.\n
\nUse a higher number to increase the TPS throughput of your model. You are charged for the number\n of inference units that you use.\n
", "smithy.api#required": {} } + }, + "MaxInferenceUnits": { + "target": "com.amazonaws.rekognition#InferenceUnits", + "traits": { + "smithy.api#documentation": "The maximum number of inference units to use for auto-scaling the model. If you don't\n specify a value, Amazon Rekognition Custom Labels doesn't auto-scale the model.
" + } } } }, diff --git a/codegen/sdk/aws-models/securityhub.json b/codegen/sdk/aws-models/securityhub.json index cf68e56188a..3873fb968cd 100644 --- a/codegen/sdk/aws-models/securityhub.json +++ b/codegen/sdk/aws-models/securityhub.json @@ -14814,7 +14814,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes the action that AWS WAF should take on a web request when it matches the criteria defined in the rule.\n
" + "smithy.api#documentation": "Describes the action that WAF should take on a web request when it matches the criteria defined in the rule.\n
" } }, "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesDetails": { @@ -14951,7 +14951,7 @@ "Action": { "target": "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListActionDetails", "traits": { - "smithy.api#documentation": "The action that AWS WAF takes when a web request matches all conditions in the rule, such as allow, \n block, or count the request.\n
" + "smithy.api#documentation": "The action that WAF takes when a web request matches all conditions in the rule, such as allow, \n block, or count the request.\n
" } }, "OverrideAction": { @@ -15567,14 +15567,14 @@ "ErrorCode": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "The code associated with the error.
", + "smithy.api#documentation": "The code associated with the error. Possible values are:
\n\n ConcurrentUpdateError - Another process or request attempted to update the finding while this request was being processed
\n DuplicatedFindingIdentifier - The request included two or more findings with the same FindingIdentifier\n
\n FindingNotFound - The FindingIdentifier included in the request did not match an existing finding
\n FindingSizeExceeded - The finding size was greater than the permissible value of 240 KB
\n InternalFailure - An internal service failure occurred when updating the finding
\n InvalidInput - The finding update contained an invalid value that did not satisfy the Amazon Web Services Security Finding Format syntax
The message associated with the error.
", + "smithy.api#documentation": "The message associated with the error. Possible values are:
\n\n Concurrent finding updates detected\n
\n Finding Identifier is duplicated\n
\n Finding Not Found\n
\n Finding size exceeded 240 KB\n
\n Internal service failure\n
\n Invalid Input\n
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you\n can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store\n parameters, and patch baselines. Tags enable you to categorize your resources in different ways,\n for example, by purpose, owner, or environment. Each tag consists of a key and an optional value,\n both of which you define. For example, you could define a set of tags for your account's managed\n nodes that helps you track each node's owner and stack level. For example:
\n\n Key=Owner,Value=DbAdmin\n
\n Key=Owner,Value=SysAdmin\n
\n Key=Owner,Value=Dev\n
\n Key=Stack,Value=Production\n
\n Key=Stack,Value=Pre-Production\n
\n Key=Stack,Value=Test\n
Most resources can have a maximum of 50 tags. Automations can have a maximum of 5\n tags.
\nWe recommend that you devise a set of tag keys that meets your needs for each resource type.\n Using a consistent set of tag keys makes it easier for you to manage your resources. You can\n search and filter the resources based on the tags you add. Tags don't have any semantic meaning\n to and are interpreted strictly as a string of characters.
\nFor more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tagging your Amazon EC2\n resources in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Adds or overwrites one or more tags for the specified resource. Tags\n are metadata that you can assign to your automations, documents, managed nodes, maintenance\n windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your\n resources in different ways, for example, by purpose, owner, or environment. Each tag consists of\n a key and an optional value, both of which you define. For example, you could define a set of\n tags for your account's managed nodes that helps you track each node's owner and stack level. For\n example:
\n\n Key=Owner,Value=DbAdmin\n
\n Key=Owner,Value=SysAdmin\n
\n Key=Owner,Value=Dev\n
\n Key=Stack,Value=Production\n
\n Key=Stack,Value=Pre-Production\n
\n Key=Stack,Value=Test\n
Most resources can have a maximum of 50 tags. Automations can have a maximum of 5\n tags.
\nWe recommend that you devise a set of tag keys that meets your needs for each resource type.\n Using a consistent set of tag keys makes it easier for you to manage your resources. You can\n search and filter the resources based on the tags you add. Tags don't have any semantic meaning\n to and are interpreted strictly as a string of characters.
\nFor more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tagging your Amazon EC2\n resources in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ssm#AddTagsToResourceRequest": { @@ -305,7 +305,7 @@ "name": "ssm" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Web Services Systems Manager is a collection of capabilities that helps you automate management tasks such as\n collecting system inventory, applying operating system (OS) patches, automating the creation of\n Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale.\n Systems Manager lets you remotely and securely manage the configuration of your managed nodes. A\n managed node is any Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises\n server or virtual machine (VM) that has been configured for Systems Manager.
\nWith support for IoT Greengrass core devices, the phrase managed\n instance has been changed to managed node in most of the Systems Manager\n documentation. The Systems Manager console, API calls, error messages, and SSM documents still use the\n term instance.
\nThis reference is intended to be used with the Amazon Web Services Systems Manager User Guide.
\nTo get started, verify prerequisites and configure managed nodes. For more information, see\n Setting up\n Amazon Web Services Systems Manager in the Amazon Web Services Systems Manager User Guide.
\n\n Related resources\n
\nFor information about how to use a Query API, see Making API requests.
\nFor information about other API operations you can perform on EC2 instances, see the\n Amazon EC2 API Reference.
\nFor information about AppConfig, a capability of Systems Manager, see the AppConfig User Guide and the AppConfig API\n Reference.
\nFor information about Incident Manager, a capability of Systems Manager, see the Incident Manager User Guide\n and the Incident Manager API\n Reference.
\nAmazon Web Services Systems Manager is a collection of capabilities to help you manage your applications and\n infrastructure running in the Amazon Web Services Cloud;. Systems Manager simplifies application and resource management,\n shortens the time to detect and resolve operational problems, and helps you manage your Amazon Web Services\n resources securely at scale.
\nThis reference is intended to be used with the Amazon Web Services Systems Manager User Guide.
\nTo get started, verify prerequisites. For more information, see Setting up\n Amazon Web Services Systems Manager.
\n\n Related resources\n
\nFor information about how to use a Query API, see Making API requests.
\nFor information about other API operations you can perform on EC2 instances, see the\n Amazon EC2 API Reference.
\nFor information about AppConfig, a capability of Systems Manager, see the AppConfig User Guide and the AppConfig API\n Reference.
\nFor information about Incident Manager, a capability of Systems Manager, see the Incident Manager User Guide\n and the Incident Manager API\n Reference.
\nIf this time is reached and the command hasn't already started running, it won't run.\n Calculated based on the ExpiresAfter user input provided as part of the\n SendCommand API operation.
If a command expires, it changes status to DeliveryTimedOut for all invocations\n that have the status InProgress, Pending, or Delayed.\n ExpiresAfter is calculated based on the total timeout for the overall command. For\n more information, see Understanding command timeout values in the\n Amazon Web Services Systems Manager User Guide.
A detailed status of the command execution. StatusDetails includes more\n information than Status because it includes states resulting from error and\n concurrency control parameters. StatusDetails can show different results than\n Status. For more information about these statuses, see Understanding command\n statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the\n following values:
Pending: The command hasn't been sent to any managed nodes.
\nIn Progress: The command has been sent to at least one managed node but hasn't reached a\n final state on all managed nodes.
\nSuccess: The command successfully ran on all invocations. This is a terminal state.
\nDelivery Timed Out: The value of MaxErrors or more command invocations shows a status of\n Delivery Timed Out. This is a terminal state.
\nExecution Timed Out: The value of MaxErrors or more command invocations shows a status of\n Execution Timed Out. This is a terminal state.
\nFailed: The value of MaxErrors or more command invocations shows a status of Failed. This\n is a terminal state.
\nIncomplete: The command was attempted on all managed nodes and one or more invocations\n doesn't have a value of Success but not enough invocations failed for the status to be Failed.\n This is a terminal state.
\nCancelled: The command was terminated before it was completed. This is a terminal\n state.
\nRate Exceeded: The number of managed nodes targeted by the command exceeded the account\n limit for pending invocations. The system has canceled the command before running it on any\n managed node. This is a terminal state.
\nA detailed status of the command execution. StatusDetails includes more\n information than Status because it includes states resulting from error and\n concurrency control parameters. StatusDetails can show different results than\n Status. For more information about these statuses, see Understanding command\n statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the\n following values:
Pending: The command hasn't been sent to any managed nodes.
\nIn Progress: The command has been sent to at least one managed node but hasn't reached a\n final state on all managed nodes.
\nSuccess: The command successfully ran on all invocations. This is a terminal state.
\nDelivery Timed Out: The value of MaxErrors or more command invocations shows a status of\n Delivery Timed Out. This is a terminal state.
\nExecution Timed Out: The value of MaxErrors or more command invocations shows a status of\n Execution Timed Out. This is a terminal state.
\nFailed: The value of MaxErrors or more command invocations shows a status of Failed. This\n is a terminal state.
\nIncomplete: The command was attempted on all managed nodes and one or more invocations\n doesn't have a value of Success but not enough invocations failed for the status to be Failed.\n This is a terminal state.
\nCancelled: The command was terminated before it was completed. This is a terminal\n state.
\nRate Exceeded: The number of managed nodes targeted by the command exceeded the account\n limit for pending invocations. The system has canceled the command before running it on any\n managed node. This is a terminal state.
\nDelayed: The system attempted to send the command to the managed node but wasn't\n successful. The system retries again.
\nA detailed status of the command execution for each invocation (each managed node targeted\n by the command). StatusDetails includes more information than Status because it includes states\n resulting from error and concurrency control parameters. StatusDetails can show different results\n than Status. For more information about these statuses, see Understanding command\n statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the\n following values:
\nPending: The command hasn't been sent to the managed node.
\nIn Progress: The command has been sent to the managed node but hasn't reached a terminal\n state.
\nSuccess: The execution of the command or plugin was successfully completed. This is a\n terminal state.
\nDelivery Timed Out: The command wasn't delivered to the managed node before the delivery\n timeout expired. Delivery timeouts don't count against the parent command's\n MaxErrors limit, but they do contribute to whether the parent command status is\n Success or Incomplete. This is a terminal state.
Execution Timed Out: Command execution started on the managed node, but the execution\n wasn't complete before the execution timeout expired. Execution timeouts count against the\n MaxErrors limit of the parent command. This is a terminal state.
Failed: The command wasn't successful on the managed node. For a plugin, this indicates\n that the result code wasn't zero. For a command invocation, this indicates that the result code\n for one or more plugins wasn't zero. Invocation failures count against the\n MaxErrors limit of the parent command. This is a terminal state.
Cancelled: The command was terminated before it was completed. This is a terminal\n state.
\nUndeliverable: The command can't be delivered to the managed node. The managed node might\n not exist or might not be responding. Undeliverable invocations don't count against the parent\n command's MaxErrors limit and don't contribute to whether the parent command status is Success\n or Incomplete. This is a terminal state.
\nTerminated: The parent command exceeded its MaxErrors limit and subsequent command\n invocations were canceled by the system. This is a terminal state.
\nA detailed status of the command execution for each invocation (each managed node targeted\n by the command). StatusDetails includes more information than Status because it includes states\n resulting from error and concurrency control parameters. StatusDetails can show different results\n than Status. For more information about these statuses, see Understanding command\n statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the\n following values:
\nPending: The command hasn't been sent to the managed node.
\nIn Progress: The command has been sent to the managed node but hasn't reached a terminal\n state.
\nSuccess: The execution of the command or plugin was successfully completed. This is a\n terminal state.
\nDelivery Timed Out: The command wasn't delivered to the managed node before the delivery\n timeout expired. Delivery timeouts don't count against the parent command's\n MaxErrors limit, but they do contribute to whether the parent command status is\n Success or Incomplete. This is a terminal state.
Execution Timed Out: Command execution started on the managed node, but the execution\n wasn't complete before the execution timeout expired. Execution timeouts count against the\n MaxErrors limit of the parent command. This is a terminal state.
Failed: The command wasn't successful on the managed node. For a plugin, this indicates\n that the result code wasn't zero. For a command invocation, this indicates that the result code\n for one or more plugins wasn't zero. Invocation failures count against the\n MaxErrors limit of the parent command. This is a terminal state.
Cancelled: The command was terminated before it was completed. This is a terminal\n state.
\nUndeliverable: The command can't be delivered to the managed node. The managed node might\n not exist or might not be responding. Undeliverable invocations don't count against the parent\n command's MaxErrors limit and don't contribute to whether the parent command status is Success\n or Incomplete. This is a terminal state.
\nTerminated: The parent command exceeded its MaxErrors limit and subsequent command\n invocations were canceled by the system. This is a terminal state.
\nDelayed: The system attempted to send the command to the managed node but wasn't\n successful. The system retries again.
\nAn optional field specifying the version of the artifact you are creating with the document.\n For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and\n can't be changed.
" + "smithy.api#documentation": "An optional field specifying the version of the artifact you are creating with the document.\n For example, Release12.1. This value is unique across all versions of a document,\n and can't be changed.
The ID of the service setting to get. The setting ID can be one of the following.
\n\n /ssm/automation/customer-script-log-destination\n
\n /ssm/automation/customer-script-log-group-name\n
\n /ssm/documents/console/public-sharing-permission\n
\n /ssm/parameter-store/default-parameter-tier\n
\n /ssm/parameter-store/high-throughput-enabled\n
\n /ssm/managed-instance/activation-tier\n
The ID of the service setting to get. The setting ID can be one of the following.
\n\n /ssm/automation/customer-script-log-destination\n
\n /ssm/automation/customer-script-log-group-name\n
\n /ssm/documents/console/public-sharing-permission\n
\n /ssm/managed-instance/activation-tier\n
\n /ssm/opsinsights/opscenter\n
\n /ssm/parameter-store/default-parameter-tier\n
\n /ssm/parameter-store/high-throughput-enabled\n
Registers a compliance type and other compliance details on a designated resource. This\n operation lets you register custom compliance details with a resource. This call overwrites\n existing compliance information on the resource, so you must provide a full list of compliance\n items each time that you send the request.
\nComplianceType can be one of the following:
\nExecutionId: The execution ID when the patch, association, or custom compliance item was\n applied.
\nExecutionType: Specify patch, association, or Custom:string.
ExecutionTime. The time the patch, association, or custom compliance item was applied to\n the managed node.
\nId: The patch, association, or custom compliance ID.
\nTitle: A title.
\nStatus: The status of the compliance item. For example, approved for patches,\n or Failed for associations.
Severity: A patch severity. For example, critical.
DocumentName: An SSM document name. For example, AWS-RunPatchBaseline.
DocumentVersion: An SSM document version number. For example, 4.
\nClassification: A patch classification. For example, security updates.
PatchBaselineId: A patch baseline ID.
\nPatchSeverity: A patch severity. For example, Critical.
PatchState: A patch state. For example, InstancesWithFailedPatches.
PatchGroup: The name of a patch group.
\nInstalledTime: The time the association, patch, or custom compliance item was applied to\n the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
\nRegisters a compliance type and other compliance details on a designated resource. This\n operation lets you register custom compliance details with a resource. This call overwrites\n existing compliance information on the resource, so you must provide a full list of compliance\n items each time that you send the request.
\nComplianceType can be one of the following:
\nExecutionId: The execution ID when the patch, association, or custom compliance item was\n applied.
\nExecutionType: Specify patch, association, or Custom:string.
ExecutionTime. The time the patch, association, or custom compliance item was applied to\n the managed node.
\nId: The patch, association, or custom compliance ID.
\nTitle: A title.
\nStatus: The status of the compliance item. For example, approved for patches,\n or Failed for associations.
Severity: A patch severity. For example, Critical.
DocumentName: An SSM document name. For example, AWS-RunPatchBaseline.
DocumentVersion: An SSM document version number. For example, 4.
\nClassification: A patch classification. For example, security updates.
PatchBaselineId: A patch baseline ID.
\nPatchSeverity: A patch severity. For example, Critical.
PatchState: A patch state. For example, InstancesWithFailedPatches.
PatchGroup: The name of a patch group.
\nInstalledTime: The time the association, patch, or custom compliance item was applied to\n the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
\nThe Amazon Resource Name (ARN) of the service setting to reset. The setting ID can be one of\n the following.
\n\n /ssm/automation/customer-script-log-destination\n
\n /ssm/automation/customer-script-log-group-name\n
\n /ssm/documents/console/public-sharing-permission\n
\n /ssm/parameter-store/default-parameter-tier\n
\n /ssm/parameter-store/high-throughput-enabled\n
\n /ssm/managed-instance/activation-tier\n
The Amazon Resource Name (ARN) of the service setting to reset. The setting ID can be one of\n the following.
\n\n /ssm/automation/customer-script-log-destination\n
\n /ssm/automation/customer-script-log-group-name\n
\n /ssm/documents/console/public-sharing-permission\n
\n /ssm/managed-instance/activation-tier\n
\n /ssm/opsinsights/opscenter\n
\n /ssm/parameter-store/default-parameter-tier\n
\n /ssm/parameter-store/high-throughput-enabled\n
The total number of resources or compliance items that have a severity level of critical.\n Critical severity is determined by the organization that published the compliance items.
" + "smithy.api#documentation": "The total number of resources or compliance items that have a severity level of\n Critical. Critical severity is determined by the organization that published the\n compliance items.
The name of the SSM document to define the parameters and plugin settings for the session.\n For example, SSM-SessionManagerRunShell. You can call the GetDocument API to verify the document exists before attempting to start a session.\n If no document name is provided, a shell to the managed node is launched by default.
The name of the SSM document you want to use to define the type of session, input\n parameters, or preferences for the session. For example, SSM-SessionManagerRunShell.\n You can call the GetDocument API to verify the document exists before\n attempting to start a session. If no document name is provided, a shell to the managed node is\n launched by default. For more information, see Start a\n session in the Amazon Web Services Systems Manager User Guide.
The Amazon Resource Name (ARN) of the service setting to reset. For example,\n arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled.\n The setting ID can be one of the following.
\n /ssm/automation/customer-script-log-destination\n
\n /ssm/automation/customer-script-log-group-name\n
\n /ssm/documents/console/public-sharing-permission\n
\n /ssm/parameter-store/default-parameter-tier\n
\n /ssm/parameter-store/high-throughput-enabled\n
\n /ssm/managed-instance/activation-tier\n
The Amazon Resource Name (ARN) of the service setting to reset. For example,\n arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled.\n The setting ID can be one of the following.
\n /ssm/automation/customer-script-log-destination\n
\n /ssm/automation/customer-script-log-group-name\n
\n /ssm/documents/console/public-sharing-permission\n
\n /ssm/managed-instance/activation-tier\n
\n /ssm/opsinsights/opscenter\n
\n /ssm/parameter-store/default-parameter-tier\n
\n /ssm/parameter-store/high-throughput-enabled\n
The new value to specify for the service setting. The following list specifies the available\n values for each setting.
\n\n /ssm/parameter-store/default-parameter-tier: Standard,\n Advanced, Intelligent-Tiering\n
\n /ssm/parameter-store/high-throughput-enabled: true or\n false\n
\n /ssm/managed-instance/activation-tier: true or\n false\n
\n /ssm/automation/customer-script-log-destination: CloudWatch\n
\n /ssm/automation/customer-script-log-group-name: the name of an Amazon CloudWatch Logs log group
\n /ssm/documents/console/public-sharing-permission: Enable or\n Disable\n
\n /ssm/managed-instance/activation-tier: standard or\n advanced\n
The new value to specify for the service setting. The following list specifies the available\n values for each setting.
\n\n /ssm/automation/customer-script-log-destination: CloudWatch\n
\n /ssm/automation/customer-script-log-group-name: the name of an Amazon CloudWatch Logs log group
\n /ssm/documents/console/public-sharing-permission: Enable or\n Disable\n
\n /ssm/managed-instance/activation-tier: standard or\n advanced\n
\n /ssm/opsinsights/opscenter: Enabled or Disabled\n
\n /ssm/parameter-store/default-parameter-tier: Standard,\n Advanced, Intelligent-Tiering\n
\n /ssm/parameter-store/high-throughput-enabled: true or\n false\n
The Amazon S3 location of the text file that contains your custom medical \n vocabulary. The URI must be located in the same Amazon Web Services Region as the resource \n you're calling.
\nHere's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt\n
The Amazon S3 location of the text file that contains your custom medical \n vocabulary. The URI must be located in the same Amazon Web Services Region as the resource \n you're calling.
\nHere's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt\n
A unique identifier for the AS2 process.
" + } + }, + "PartnerProfileId": { + "target": "com.amazonaws.transfer#ProfileId", + "traits": { + "smithy.api#documentation": "A unique identifier for the partner for the connector.
" + } + }, + "MessageSubject": { + "target": "com.amazonaws.transfer#MessageSubject", + "traits": { + "smithy.api#documentation": "A short description to help identify the connector.
" + } + }, + "Compression": { + "target": "com.amazonaws.transfer#CompressionEnum", + "traits": { + "smithy.api#documentation": "Specifies whether the AS2 file is compressed.
" + } + }, + "EncryptionAlgorithm": { + "target": "com.amazonaws.transfer#EncryptionAlg", + "traits": { + "smithy.api#documentation": "The algorithm that is used to encrypt the file.
" + } + }, + "SigningAlgorithm": { + "target": "com.amazonaws.transfer#SigningAlg", + "traits": { + "smithy.api#documentation": "The algorithm that is used to sign the AS2 transfers for this partner profile.
" + } + }, + "MdnSigningAlgorithm": { + "target": "com.amazonaws.transfer#MdnSigningAlg", + "traits": { + "smithy.api#documentation": "The signing algorithm for the MDN response.
" + } + }, + "MdnResponse": { + "target": "com.amazonaws.transfer#MdnResponse", + "traits": { + "smithy.api#documentation": "Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether\n the partner response for transfers is synchronous or asynchronous. Specify either of the following values:
\n\n SYNC: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).
\n NONE: Specifies that no MDN response is required.
Contains the details for a connector object. The connector object is used for AS2 outbound\n processes, to connect the Transfer Family customer with the trading partner.
" + } + }, + "com.amazonaws.transfer#As2Id": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\p{Print}\\s]*$" + } + }, + "com.amazonaws.transfer#As2Transport": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HTTP", + "name": "HTTP" + } + ] + } + }, + "com.amazonaws.transfer#As2Transports": { + "type": "list", + "member": { + "target": "com.amazonaws.transfer#As2Transport" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, "com.amazonaws.transfer#CallbackToken": { "type": "string", "traits": { @@ -75,6 +189,19 @@ "smithy.api#pattern": "^\\w+$" } }, + "com.amazonaws.transfer#CertDate": { + "type": "timestamp" + }, + "com.amazonaws.transfer#CertSerial": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 48 + }, + "smithy.api#pattern": "^[\\p{XDigit}{2}:?]*$" + } + }, "com.amazonaws.transfer#Certificate": { "type": "string", "traits": { @@ -84,6 +211,108 @@ } } }, + "com.amazonaws.transfer#CertificateBodyType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16384 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.transfer#CertificateChainType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2097152 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.transfer#CertificateId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 22, + "max": 22 + }, + "smithy.api#pattern": "^cert-([0-9a-f]{17})$" + } + }, + "com.amazonaws.transfer#CertificateIds": { + "type": "list", + "member": { + "target": "com.amazonaws.transfer#CertificateId" + } + }, + "com.amazonaws.transfer#CertificateStatusType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "PENDING_ROTATION", + "name": "PENDING_ROTATION" + }, + { + "value": "INACTIVE", + "name": "INACTIVE" + } + ] + } + }, + "com.amazonaws.transfer#CertificateType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CERTIFICATE", + "name": "CERTIFICATE" + }, + { + "value": "CERTIFICATE_WITH_PRIVATE_KEY", + "name": "CERTIFICATE_WITH_PRIVATE_KEY" + } + ] + } + }, + "com.amazonaws.transfer#CertificateUsageType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SIGNING", + "name": "SIGNING" + }, + { + "value": "ENCRYPTION", + "name": "ENCRYPTION" + } + ] + } + }, + "com.amazonaws.transfer#CompressionEnum": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ZLIB", + "name": "ZLIB" + }, + { + "value": "DISABLED", + "name": "DISABLED" + } + ] + } + }, "com.amazonaws.transfer#ConflictException": { "type": "structure", "members": { @@ -100,6 +329,16 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.transfer#ConnectorId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 19, + "max": 19 + }, + "smithy.api#pattern": "^c-([0-9a-f]{17})$" + } + }, "com.amazonaws.transfer#CopyStepDetails": { "type": "structure", "members": { @@ -158,7 +397,7 @@ } ], "traits": { - "smithy.api#documentation": "Used by administrators to choose which groups in the directory should have access to\n upload and download files over the enabled protocols using Amazon Web Services Transfer Family. For example, a\n Microsoft Active Directory might contain 50,000 users, but only a small fraction might need\n the ability to transfer files to the server. An administrator can use\n CreateAccess to limit the access to the correct set of users who need this\n ability.
Used by administrators to choose which groups in the directory should have access to\n upload and download files over the enabled protocols using Transfer Family. For example, a\n Microsoft Active Directory might contain 50,000 users, but only a small fraction might need\n the ability to transfer files to the server. An administrator can use\n CreateAccess to limit the access to the correct set of users who need this\n ability.
The type of landing directory (folder) you want your users' home directory to be when they log into the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.\n If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon\n S3 or EFS paths visible to your users.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer \n protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.
The following is an Entry and Target pair example.
\n [ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the\n HomeDirectory parameter value.
The following is an Entry and Target pair example for chroot.
\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) \n role provides access to paths in Target. This value\n can be set only when HomeDirectoryType is set to\n LOGICAL.
The following is an Entry and Target pair example.
\n [ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the\n HomeDirectory parameter value.
The following is an Entry and Target pair example for chroot.
\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
This only applies when the domain of ServerId is S3. EFS does not use session policies.
For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead\n of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass\n it in the Policy argument.
For an example of a session policy, see Example\n session policy.
\nFor more information, see AssumeRole in the Amazon Web Services Security Token Service API\n Reference.
\nA session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies.
For session policies, Transfer Family stores the policy as a JSON blob, instead\n of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass\n it in the Policy argument.
For an example of a session policy, see Example\n session policy.
\nFor more information, see AssumeRole in the Security Token Service API\n Reference.
\nSpecifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS\n file system. The policies attached to this role determine the level of access that you want to provide your users when transferring\n files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the\n server to access your resources when servicing your users' transfer requests.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 \n bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users \n when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust \n relationship that allows the server to access your resources when servicing your users' transfer requests.
", "smithy.api#required": {} } }, @@ -208,7 +447,7 @@ "ExternalId": { "target": "com.amazonaws.transfer#ExternalId", "traits": { - "smithy.api#documentation": "A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.
\n\n\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n
In that command, replace YourGroupName with the name of your Active Directory group.
\n\nThe regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-
", + "smithy.api#documentation": "A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.
\n\n\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n
In that command, replace YourGroupName with the name of your Active Directory group.
\n\nThe regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-
", "smithy.api#required": {} } } @@ -227,24 +466,21 @@ "ExternalId": { "target": "com.amazonaws.transfer#ExternalId", "traits": { - "smithy.api#documentation": "The external ID of the group whose users have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Amazon Web Services Transfer Family.
", + "smithy.api#documentation": "The external ID of the group whose users have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Transfer Family.
", "smithy.api#required": {} } } } }, - "com.amazonaws.transfer#CreateServer": { + "com.amazonaws.transfer#CreateAgreement": { "type": "operation", "input": { - "target": "com.amazonaws.transfer#CreateServerRequest" + "target": "com.amazonaws.transfer#CreateAgreementRequest" }, "output": { - "target": "com.amazonaws.transfer#CreateServerResponse" + "target": "com.amazonaws.transfer#CreateAgreementResponse" }, "errors": [ - { - "target": "com.amazonaws.transfer#AccessDeniedException" - }, { "target": "com.amazonaws.transfer#InternalServiceError" }, @@ -259,129 +495,89 @@ }, { "target": "com.amazonaws.transfer#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.transfer#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "Instantiates an auto-scaling virtual server based on the selected file transfer protocol\n in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work\n with users, use the service-generated ServerId property that is assigned to the\n newly created server.
Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership,\n between an Transfer Family server and an AS2 process. The agreement defines the file and message\n transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family\n combines a server, local profile, partner profile, certificate, and other\n attributes.
\nThe partner is identified with the PartnerProfileId, and the AS2 process is identified with the LocalProfileId.
The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager (ACM) certificate. Required\n when Protocols is set to FTPS.
To request a new public certificate, see Request a public certificate\n in the Amazon Web Services Certificate Manager User Guide.
\n\nTo import an existing certificate into ACM, see Importing certificates into ACM\n in the Amazon Web Services Certificate Manager User Guide.
\n\nTo request a private certificate to use FTPS through private IP addresses, see Request a\n private certificate in the Amazon Web Services Certificate Manager User\n Guide.
\n\nCertificates with the following cryptographic algorithms and key sizes are\n supported:
\n\n2048-bit RSA (RSA_2048)
\n4096-bit RSA (RSA_4096)
\nElliptic Prime Curve 256 bit (EC_prime256v1)
\nElliptic Prime Curve 384 bit (EC_secp384r1)
\nElliptic Prime Curve 521 bit (EC_secp521r1)
\nThe certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP\n address specified and information about the issuer.
\nThe domain of the storage system that is used for file transfers. There are two domains\n available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The\n default value is S3.
\n\nAfter the server is created, the domain cannot be changed.
\nThe virtual private cloud (VPC) endpoint settings that are configured for your server.\n When you host your endpoint within your VPC, you can make it accessible only to resources\n within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over\n the internet. Your VPC's default security groups are automatically assigned to your\n endpoint.
" + "smithy.api#documentation": "A name or short description to identify the agreement.
" } }, - "EndpointType": { - "target": "com.amazonaws.transfer#EndpointType", + "ServerId": { + "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC)\n or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and \n resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.
\n After May 19, 2021, you won't be able to create a server using\n EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't already\n done so before May 19, 2021. If you have already created servers with\n EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021,\n you will not be affected. After this date, use\n EndpointType=VPC.
For more information, see\n https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
\nIt is recommended that you use VPC as the EndpointType. With\n this endpoint type, you have the option to directly associate up to three Elastic IPv4\n addresses (BYO IP included) with your server's endpoint and use VPC security groups to\n restrict traffic by the client's public IP address. This is not possible with\n EndpointType set to VPC_ENDPOINT.
A system-assigned unique identifier for a server instance. This is the specific server\n that the agreement uses.
", + "smithy.api#required": {} } }, - "HostKey": { - "target": "com.amazonaws.transfer#HostKey", + "LocalProfileId": { + "target": "com.amazonaws.transfer#ProfileId", "traits": { - "smithy.api#documentation": "The RSA, ECDSA, or ED25519 private key to use for your server.
\n \nUse the following command to generate an RSA 2048 bit key with no passphrase:
\n\n ssh-keygen -t rsa -b 2048 -N \"\" -m PEM -f my-new-server-key.
Use a minimum value of 2048 for the -b option: you can create a stronger key using 3072 or 4096.
Use the following command to generate an ECDSA 256 bit key with no passphrase:
\n\n ssh-keygen -t ecdsa -b 256 -N \"\" -m PEM -f my-new-server-key.
Valid values for the -b option for ECDSA are 256, 384, and 521.
Use the following command to generate an ED25519 key with no passphrase:
\n\n ssh-keygen -t ed25519 -N \"\" -f my-new-server-key.
For all of these commands, you can replace my-new-server-key with a string of your choice.
\n\nIf you aren't planning to migrate existing users from an existing SFTP-enabled\n server to a new server, don't update the host key. Accidentally changing a\n server's host key can be disruptive.
\nFor more information, see Change the host key for your SFTP-enabled server in the Amazon Web Services Transfer\n Family User Guide.
" + "smithy.api#documentation": "A unique identifier for the AS2 local profile.
", + "smithy.api#required": {} } }, - "IdentityProviderDetails": { - "target": "com.amazonaws.transfer#IdentityProviderDetails", + "PartnerProfileId": { + "target": "com.amazonaws.transfer#ProfileId", "traits": { - "smithy.api#documentation": "Required when IdentityProviderType is set to\n AWS_DIRECTORY_SERVICE or API_GATEWAY. Accepts an array containing\n all of the information required to use a directory in AWS_DIRECTORY_SERVICE or\n invoke a customer-supplied authentication API, including the API Gateway URL. Not required\n when IdentityProviderType is set to SERVICE_MANAGED.
A unique identifier for the partner profile used in the agreement.
", + "smithy.api#required": {} } }, - "IdentityProviderType": { - "target": "com.amazonaws.transfer#IdentityProviderType", + "BaseDirectory": { + "target": "com.amazonaws.transfer#HomeDirectory", "traits": { - "smithy.api#documentation": "Specifies the mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to\n Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to\n provide a Directory ID using the IdentityProviderDetails parameter.
Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the IdentityProviderDetails parameter.
Use the AWS_LAMBDA value to directly use a Lambda function as your identity provider. If you choose this value,\n you must specify the ARN for the lambda function in the Function parameter for the IdentityProviderDetails data type.
The landing directory (folder) for files transferred by using the AS2 protocol.
\nA BaseDirectory example is\n /DOC-EXAMPLE-BUCKET/home/mydirectory\n .
Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in\n your CloudWatch logs.
" - } - }, - "PostAuthenticationLoginBanner": { - "target": "com.amazonaws.transfer#PostAuthenticationLoginBanner", - "traits": { - "smithy.api#documentation": "Specify a string to display when users connect to a server. This string is displayed after the user authenticates.
\nThe SFTP protocol does not support post-authentication display banners.
\nSpecify a string to display when users connect to a server. This string is displayed before the user authenticates.\n For example, the following banner displays details about using the system.
\n\n This system is for the use of authorized users only. Individuals using this computer system without authority,\n or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by\n system personnel.\n
Specifies the file transfer protocol or protocols over which your file transfer protocol\n client can connect to your server's endpoint. The available protocols are:
\n\n\n SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over\n SSH
\n FTPS (File Transfer Protocol Secure): File transfer with TLS\n encryption
\n FTP (File Transfer Protocol): Unencrypted file transfer
If you select FTPS, you must choose a certificate stored in Amazon Web Services Certificate\n Manager (ACM) which is used to identify your server when clients connect to it over\n FTPS.
If Protocol includes either FTP or FTPS, then the\n EndpointType must be VPC and the\n IdentityProviderType must be AWS_DIRECTORY_SERVICE or API_GATEWAY.
If Protocol includes FTP, then\n AddressAllocationIds cannot be associated.
If Protocol is set only to SFTP, the EndpointType\n can be set to PUBLIC and the IdentityProviderType can be set to\n SERVICE_MANAGED.
The protocol settings that are configured for your server.
\n\n Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols).\n Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.\n
Use the SetStatOption to ignore the error that is generated when the client attempts to use SETSTAT on a file you are uploading to an S3 bucket.\n Set the value to ENABLE_NO_OP to have the Transfer Family server ignore the SETSTAT command, and upload files without needing to make any changes to your SFTP client.\n Note that with SetStatOption set to ENABLE_NO_OP, Transfer generates a log entry to CloudWatch Logs, so you can determine when the client\n is making a SETSTAT call.
Use the TlsSessionResumptionMode parameter to determine whether or not your Transfer server\n resumes recent, negotiated sessions through a unique session ID.
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the \n HomeDirectory of your users' Amazon S3 buckets.
Specifies the name of the security policy that is attached to the server.
" + "smithy.api#documentation": "The status of the agreement. The agreement can be either ACTIVE or\n INACTIVE.
Key-value pairs that can be used to group and search for servers.
" - } - }, - "WorkflowDetails": { - "target": "com.amazonaws.transfer#WorkflowDetails", - "traits": { - "smithy.api#documentation": "Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
" + "smithy.api#documentation": "Key-value pairs that can be used to group and search for agreements.
" } } } }, - "com.amazonaws.transfer#CreateServerResponse": { + "com.amazonaws.transfer#CreateAgreementResponse": { "type": "structure", "members": { - "ServerId": { - "target": "com.amazonaws.transfer#ServerId", + "AgreementId": { + "target": "com.amazonaws.transfer#AgreementId", "traits": { - "smithy.api#documentation": "The service-assigned ID of the server that is created.
", + "smithy.api#documentation": "The unique identifier for the agreement. Use this ID for deleting, or updating an\n agreement, as well as in any other API calls that require that you specify the agreement\n ID.
", "smithy.api#required": {} } } } }, - "com.amazonaws.transfer#CreateUser": { + "com.amazonaws.transfer#CreateConnector": { "type": "operation", "input": { - "target": "com.amazonaws.transfer#CreateUserRequest" + "target": "com.amazonaws.transfer#CreateConnectorRequest" }, "output": { - "target": "com.amazonaws.transfer#CreateUserResponse" + "target": "com.amazonaws.transfer#CreateConnectorResponse" }, "errors": [ { @@ -401,34 +597,324 @@ } ], "traits": { - "smithy.api#documentation": "Creates a user and associates them with an existing file transfer protocol-enabled server.\n You can only create and associate users with servers that have the\n IdentityProviderType set to SERVICE_MANAGED. Using parameters for\n CreateUser, you can specify the user name, set the home directory, store the\n user's public key, and assign the user's Amazon Web Services Identity and Access Management (IAM)\n role. You can also optionally add a session policy, and assign metadata with tags that can\n be used to group and search for users.
Creates the connector, which captures the parameters for an outbound connection for the\n AS2 protocol. The connector is required for sending files from a\n customer's non Amazon Web Services server.
" } }, - "com.amazonaws.transfer#CreateUserRequest": { + "com.amazonaws.transfer#CreateConnectorRequest": { "type": "structure", "members": { - "HomeDirectory": { - "target": "com.amazonaws.transfer#HomeDirectory", + "Url": { + "target": "com.amazonaws.transfer#Url", "traits": { - "smithy.api#documentation": "The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory example is /bucket_name/home/mydirectory.
The URL of the partner's AS2 endpoint.
", + "smithy.api#required": {} } }, - "HomeDirectoryType": { - "target": "com.amazonaws.transfer#HomeDirectoryType", + "As2Config": { + "target": "com.amazonaws.transfer#As2ConnectorConfig", "traits": { - "smithy.api#documentation": "The type of landing directory (folder) you want your users' home directory to be when they log into the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.\n If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon\n S3 or EFS paths visible to your users.
A structure that contains the parameters for a connector object.
", + "smithy.api#required": {} } }, - "HomeDirectoryMappings": { - "target": "com.amazonaws.transfer#HomeDirectoryMappings", + "AccessRole": { + "target": "com.amazonaws.transfer#Role", + "traits": { + "smithy.api#documentation": "With AS2, you can send files by calling StartFileTransfer and specifying the\n file paths in the request parameter, SendFilePaths. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt, parent\n directory is /bucket/dir/) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer.
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn\n on CloudWatch logging for Amazon S3 events. When set, you can view connector\n activity in your CloudWatch logs.
" + } + }, + "Tags": { + "target": "com.amazonaws.transfer#Tags", + "traits": { + "smithy.api#documentation": "Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
" + } + } + } + }, + "com.amazonaws.transfer#CreateConnectorResponse": { + "type": "structure", + "members": { + "ConnectorId": { + "target": "com.amazonaws.transfer#ConnectorId", + "traits": { + "smithy.api#documentation": "The unique identifier for the connector, returned after the API call succeeds.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transfer#CreateProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#CreateProfileRequest" + }, + "output": { + "target": "com.amazonaws.transfer#CreateProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Creates the profile for the AS2 process. The agreement is between the partner and the AS2\n process.
" + } + }, + "com.amazonaws.transfer#CreateProfileRequest": { + "type": "structure", + "members": { + "As2Id": { + "target": "com.amazonaws.transfer#As2Id", + "traits": { + "smithy.api#documentation": "The As2Id is the AS2-name, as defined in the defined in\n the RFC 4130. For inbound transfers, this is the AS2-From header for the AS2 messages\n sent from the partner. For outbound connectors, this is the AS2-To header for the\n AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.
Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. \n If not supplied in the request, the command lists all types of profiles.
An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
" + } + }, + "Tags": { + "target": "com.amazonaws.transfer#Tags", + "traits": { + "smithy.api#documentation": "Key-value pairs that can be used to group and search for AS2 profiles.
" + } + } + } + }, + "com.amazonaws.transfer#CreateProfileResponse": { + "type": "structure", + "members": { + "ProfileId": { + "target": "com.amazonaws.transfer#ProfileId", + "traits": { + "smithy.api#documentation": "The unique identifier for the AS2 profile, returned after the API call succeeds.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transfer#CreateServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#CreateServerRequest" + }, + "output": { + "target": "com.amazonaws.transfer#CreateServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#AccessDeniedException" + }, + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ResourceExistsException" + }, + { + "target": "com.amazonaws.transfer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.transfer#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Instantiates an auto-scaling virtual server based on the selected file transfer protocol\n in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work\n with users, use the service-generated ServerId property that is assigned to the\n newly created server.
The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate. Required\n when Protocols is set to FTPS.
To request a new public certificate, see Request a public certificate\n in the Certificate Manager User Guide.
\n\nTo import an existing certificate into ACM, see Importing certificates into ACM\n in the Certificate Manager User Guide.
\n\nTo request a private certificate to use FTPS through private IP addresses, see Request a\n private certificate in the Certificate Manager User\n Guide.
\n\nCertificates with the following cryptographic algorithms and key sizes are\n supported:
\n\n2048-bit RSA (RSA_2048)
\n4096-bit RSA (RSA_4096)
\nElliptic Prime Curve 256 bit (EC_prime256v1)
\nElliptic Prime Curve 384 bit (EC_secp384r1)
\nElliptic Prime Curve 521 bit (EC_secp521r1)
\nThe certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP\n address specified and information about the issuer.
\nThe domain of the storage system that is used for file transfers. There are two domains\n available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The\n default value is S3.
\n\nAfter the server is created, the domain cannot be changed.
\nThe virtual private cloud (VPC) endpoint settings that are configured for your server.\n When you host your endpoint within your VPC, you can make your endpoint accessible only to resources\n within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over\n the internet. Your VPC's default security groups are automatically assigned to your\n endpoint.
" + } + }, + "EndpointType": { + "target": "com.amazonaws.transfer#EndpointType", + "traits": { + "smithy.api#documentation": "The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC)\n or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and \n resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.
\n After May 19, 2021, you won't be able to create a server using\n EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't already\n done so before May 19, 2021. If you have already created servers with\n EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021,\n you will not be affected. After this date, use\n EndpointType=VPC.
For more information, see\n https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
\nIt is recommended that you use VPC as the EndpointType. With\n this endpoint type, you have the option to directly associate up to three Elastic IPv4\n addresses (BYO IP included) with your server's endpoint and use VPC security groups to\n restrict traffic by the client's public IP address. This is not possible with\n EndpointType set to VPC_ENDPOINT.
The RSA, ECDSA, or ED25519 private key to use for your server.
\n \nUse the following command to generate an RSA 2048 bit key with no passphrase:
\n\n ssh-keygen -t rsa -b 2048 -N \"\" -m PEM -f my-new-server-key.
Use a minimum value of 2048 for the -b option. You can create a stronger key by using 3072 or 4096.
Use the following command to generate an ECDSA 256 bit key with no passphrase:
\n\n ssh-keygen -t ecdsa -b 256 -N \"\" -m PEM -f my-new-server-key.
Valid values for the -b option for ECDSA are 256, 384, and 521.
Use the following command to generate an ED25519 key with no passphrase:
\n\n ssh-keygen -t ed25519 -N \"\" -f my-new-server-key.
For all of these commands, you can replace my-new-server-key with a string of your choice.
\n\nIf you aren't planning to migrate existing users from an existing SFTP-enabled\n server to a new server, don't update the host key. Accidentally changing a\n server's host key can be disruptive.
\nFor more information, see Change the host key for your SFTP-enabled server in the Transfer Family User Guide.
" + } + }, + "IdentityProviderDetails": { + "target": "com.amazonaws.transfer#IdentityProviderDetails", + "traits": { + "smithy.api#documentation": "Required when IdentityProviderType is set to\n AWS_DIRECTORY_SERVICE or API_GATEWAY. Accepts an array containing\n all of the information required to use a directory in AWS_DIRECTORY_SERVICE or\n invoke a customer-supplied authentication API, including the API Gateway URL. Not required\n when IdentityProviderType is set to SERVICE_MANAGED.
The mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to\n Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to\n provide a Directory ID by using the IdentityProviderDetails parameter.
Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call\n for authentication by using the IdentityProviderDetails parameter.
Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. \n If you choose this value, you must specify the ARN for the Lambda function in the Function parameter \n or the IdentityProviderDetails data type.
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in\n your CloudWatch logs.
" + } + }, + "PostAuthenticationLoginBanner": { + "target": "com.amazonaws.transfer#PostAuthenticationLoginBanner", + "traits": { + "smithy.api#documentation": "Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.
\nThe SFTP protocol does not support post-authentication display banners.
\nSpecifies a string to display when users connect to a server. This string is displayed before the user authenticates.\n For example, the following banner displays details about using the system:
\n \n\n This system is for the use of authorized users only. Individuals using this computer system without authority,\n or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by\n system personnel.\n
Specifies the file transfer protocol or protocols over which your file transfer protocol\n client can connect to your server's endpoint. The available protocols are:
\n\n\n SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over\n SSH
\n FTPS (File Transfer Protocol Secure): File transfer with TLS\n encryption
\n FTP (File Transfer Protocol): Unencrypted file transfer
\n AS2 (Applicability Statement 2): used for transporting structured business-to-business data
If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM) \n which is used to identify your server when clients connect to it over\n FTPS.
If Protocol includes either FTP or FTPS, then the\n EndpointType must be VPC and the\n IdentityProviderType must be AWS_DIRECTORY_SERVICE or API_GATEWAY.
If Protocol includes FTP, then\n AddressAllocationIds cannot be associated.
If Protocol is set only to SFTP, the EndpointType\n can be set to PUBLIC and the IdentityProviderType can be set to\n SERVICE_MANAGED.
If Protocol includes AS2, then the\n EndpointType must be VPC, and domain must be Amazon S3.
The protocol settings that are configured for your server.
\n\n To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp parameter.\n Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.\n
To ignore the error that is generated when the client attempts to use the SETSTAT command on a file that you are \n uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer Family server ignore the \n SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to \n ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family \n generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT \n call.
To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the \n TlsSessionResumptionMode parameter.
\n As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
Specifies the name of the security policy that is attached to the server.
" + } + }, + "Tags": { + "target": "com.amazonaws.transfer#Tags", + "traits": { + "smithy.api#documentation": "Key-value pairs that can be used to group and search for servers.
" + } + }, + "WorkflowDetails": { + "target": "com.amazonaws.transfer#WorkflowDetails", + "traits": { + "smithy.api#documentation": "Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
" + } + } + } + }, + "com.amazonaws.transfer#CreateServerResponse": { + "type": "structure", + "members": { + "ServerId": { + "target": "com.amazonaws.transfer#ServerId", + "traits": { + "smithy.api#documentation": "The service-assigned ID of the server that is created.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transfer#CreateUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#CreateUserRequest" + }, + "output": { + "target": "com.amazonaws.transfer#CreateUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ResourceExistsException" + }, + { + "target": "com.amazonaws.transfer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a user and associates them with an existing file transfer protocol-enabled server.\n You can only create and associate users with servers that have the\n IdentityProviderType set to SERVICE_MANAGED. Using parameters for\n CreateUser, you can specify the user name, set the home directory, store the\n user's public key, and assign the user's Identity and Access Management (IAM)\n role. You can also optionally add a session policy, and assign metadata with tags that can\n be used to group and search for users.
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.
The following is an Entry and Target pair example.
\n [ { \"Entry\": \"/directory1\", \"Target\":\n \"/bucket_name/home/mydirectory\" } ]\n
In most cases, you can use this value instead of the session policy to lock your user\n down to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the HomeDirectory\n parameter value.
The following is an Entry and Target pair example for chroot.
\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory example is /bucket_name/home/mydirectory.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer \n protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) \n role provides access to paths in Target. This value\n can be set only when HomeDirectoryType is set to\n LOGICAL.
The following is an Entry and Target pair example.
\n [ { \"Entry\": \"/directory1\", \"Target\":\n \"/bucket_name/home/mydirectory\" } ]\n
In most cases, you can use this value instead of the session policy to lock your user\n down to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the HomeDirectory\n parameter value.
The following is an Entry and Target pair example for chroot.
\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
This only applies when the domain of ServerId is S3. EFS does not use session policies.
For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead\n of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass\n it in the Policy argument.
For an example of a session policy, see Example session\n policy.
\n\n \n\nFor more information, see AssumeRole in the Amazon Web Services\n Security Token Service API Reference.
\nA session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies.
For session policies, Transfer Family stores the policy as a JSON blob, instead\n of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass\n it in the Policy argument.
For an example of a session policy, see Example session\n policy.
\n\n \n\nFor more information, see AssumeRole in the Amazon Web Services\n Security Token Service API Reference.
\nSpecifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS\n file system. The policies attached to this role determine the level of access that you want to provide your users when transferring\n files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the\n server to access your resources when servicing your users' transfer requests.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 \n bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users \n when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust \n relationship that allows the server to access your resources when servicing your users' transfer requests.
", "smithy.api#required": {} } }, @@ -535,7 +1021,7 @@ "Steps": { "target": "com.amazonaws.transfer#WorkflowSteps", "traits": { - "smithy.api#documentation": "Specifies the details for the steps that are in the specified workflow.
\n\n The TYPE specifies which of the following actions is being taken for this step.\n
\n COPY: copy the file to another location
\n\n CUSTOM: custom step with a lambda target
\n\n DELETE: delete the file
\n\n TAG: add a tag to the file
\n\n Currently, copying and tagging are supported only on S3.\n
\n\n For file location, you specify either the S3 bucket and key, or the EFS filesystem ID and path.\n
", + "smithy.api#documentation": "Specifies the details for the steps that are in the specified workflow.
\n\n The TYPE specifies which of the following actions is being taken for this step.\n
\n COPY: Copy the file to another location.
\n\n CUSTOM: Perform a custom step with an Lambda function target.
\n\n DELETE: Delete the file.
\n\n TAG: Add a tag to the file.
\n\n Currently, copying and tagging are supported only on S3.\n
\nFor file location, you specify either the S3 bucket and key, or the EFS file system ID\n and path.
", "smithy.api#required": {} } }, @@ -674,24 +1160,183 @@ "ExternalId": { "target": "com.amazonaws.transfer#ExternalId", "traits": { - "smithy.api#documentation": "A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.
\n\n\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n
In that command, replace YourGroupName with the name of your Active Directory group.
\n\nThe regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-
", + "smithy.api#documentation": "A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.
\n\n\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n
In that command, replace YourGroupName with the name of your Active Directory group.
\n\nThe regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-
", "smithy.api#required": {} } } } }, - "com.amazonaws.transfer#DeleteServer": { + "com.amazonaws.transfer#DeleteAgreement": { "type": "operation", "input": { - "target": "com.amazonaws.transfer#DeleteServerRequest" + "target": "com.amazonaws.transfer#DeleteAgreementRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ - { - "target": "com.amazonaws.transfer#AccessDeniedException" - }, + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Delete the agreement that's specified in the provided AgreementId.
A unique identifier for the agreement. This identifier is returned when you create an agreement.
", + "smithy.api#required": {} + } + }, + "ServerId": { + "target": "com.amazonaws.transfer#ServerId", + "traits": { + "smithy.api#documentation": "The server ID associated with the agreement that you are deleting.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transfer#DeleteCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#DeleteCertificateRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the certificate that's specified in the CertificateId\n parameter.
The ID of the certificate object that you are deleting.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transfer#DeleteConnector": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#DeleteConnectorRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the agreement that's specified in the provided ConnectorId.
The unique identifier for the connector.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transfer#DeleteProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#DeleteProfileRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the profile that's specified in the ProfileId parameter.
The ID of the profile that you are deleting.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transfer#DeleteServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#DeleteServerRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#AccessDeniedException" + }, { "target": "com.amazonaws.transfer#InternalServiceError" }, @@ -905,7 +1550,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the access that is assigned to the specific file transfer protocol-enabled\n server, as identified by its ServerId property and its\n ExternalID.
The response from this call returns the properties of the access that is associated with\n the ServerId value that was specified.
Describes the access that is assigned to the specific file transfer protocol-enabled\n server, as identified by its ServerId property and its\n ExternalId.
The response from this call returns the properties of the access that is associated with\n the ServerId value that was specified.
A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.
\n\n\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n
In that command, replace YourGroupName with the name of your Active Directory group.
\n\nThe regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-
", + "smithy.api#documentation": "A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.
\n\n\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n
In that command, replace YourGroupName with the name of your Active Directory group.
\n\nThe regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-
", "smithy.api#required": {} } } @@ -946,13 +1591,13 @@ } } }, - "com.amazonaws.transfer#DescribeExecution": { + "com.amazonaws.transfer#DescribeAgreement": { "type": "operation", "input": { - "target": "com.amazonaws.transfer#DescribeExecutionRequest" + "target": "com.amazonaws.transfer#DescribeAgreementRequest" }, "output": { - "target": "com.amazonaws.transfer#DescribeExecutionResponse" + "target": "com.amazonaws.transfer#DescribeAgreementResponse" }, "errors": [ { @@ -969,54 +1614,47 @@ } ], "traits": { - "smithy.api#documentation": "You can use DescribeExecution to check the details of the execution of the specified workflow.
Describes the agreement that's identified by the AgreementId.
A unique identifier for the execution of a workflow.
", + "smithy.api#documentation": "A unique identifier for the agreement. This identifier is returned when you create an agreement.
", "smithy.api#required": {} } }, - "WorkflowId": { - "target": "com.amazonaws.transfer#WorkflowId", + "ServerId": { + "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "A unique identifier for the workflow.
", + "smithy.api#documentation": "The server ID that's associated with the agreement.
", "smithy.api#required": {} } } } }, - "com.amazonaws.transfer#DescribeExecutionResponse": { + "com.amazonaws.transfer#DescribeAgreementResponse": { "type": "structure", "members": { - "WorkflowId": { - "target": "com.amazonaws.transfer#WorkflowId", - "traits": { - "smithy.api#documentation": "A unique identifier for the workflow.
", - "smithy.api#required": {} - } - }, - "Execution": { - "target": "com.amazonaws.transfer#DescribedExecution", + "Agreement": { + "target": "com.amazonaws.transfer#DescribedAgreement", "traits": { - "smithy.api#documentation": "The structure that contains the details of the workflow' execution.
", + "smithy.api#documentation": "The details for the specified agreement, returned as a DescribedAgreement\n object.
Describes the security policy that is attached to your file transfer protocol-enabled\n server. The response contains a description of the security policy's properties. For more\n information about security policies, see Working with security\n policies.
" + "smithy.api#documentation": "Describes the certificate that's identified by the CertificateId.
Specifies the name of the security policy that is attached to the server.
", + "smithy.api#documentation": "An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
", "smithy.api#required": {} } } } }, - "com.amazonaws.transfer#DescribeSecurityPolicyResponse": { + "com.amazonaws.transfer#DescribeCertificateResponse": { "type": "structure", "members": { - "SecurityPolicy": { - "target": "com.amazonaws.transfer#DescribedSecurityPolicy", + "Certificate": { + "target": "com.amazonaws.transfer#DescribedCertificate", "traits": { - "smithy.api#documentation": "An array containing the properties of the security policy.
", + "smithy.api#documentation": "The details for the specified certificate, returned as an object.
", "smithy.api#required": {} } } } }, - "com.amazonaws.transfer#DescribeServer": { + "com.amazonaws.transfer#DescribeConnector": { "type": "operation", "input": { - "target": "com.amazonaws.transfer#DescribeServerRequest" + "target": "com.amazonaws.transfer#DescribeConnectorRequest" }, "output": { - "target": "com.amazonaws.transfer#DescribeServerResponse" + "target": "com.amazonaws.transfer#DescribeConnectorResponse" }, "errors": [ { @@ -1083,92 +1721,40 @@ } ], "traits": { - "smithy.api#documentation": "Describes a file transfer protocol-enabled server that you specify by passing the\n ServerId parameter.
The response contains a description of a server's properties. When you set\n EndpointType to VPC, the response will contain the\n EndpointDetails.
Describes the connector that's identified by the ConnectorId.\n
A system-assigned unique identifier for a server.
", + "smithy.api#documentation": "The unique identifier for the connector.
", "smithy.api#required": {} } } } }, - "com.amazonaws.transfer#DescribeServerResponse": { + "com.amazonaws.transfer#DescribeConnectorResponse": { "type": "structure", "members": { - "Server": { - "target": "com.amazonaws.transfer#DescribedServer", + "Connector": { + "target": "com.amazonaws.transfer#DescribedConnector", "traits": { - "smithy.api#documentation": "An array containing the properties of a server with the ServerID you\n specified.
The structure that contains the details of the connector.
", "smithy.api#required": {} } } } }, - "com.amazonaws.transfer#DescribeUser": { + "com.amazonaws.transfer#DescribeExecution": { "type": "operation", "input": { - "target": "com.amazonaws.transfer#DescribeUserRequest" + "target": "com.amazonaws.transfer#DescribeExecutionRequest" }, "output": { - "target": "com.amazonaws.transfer#DescribeUserResponse" + "target": "com.amazonaws.transfer#DescribeExecutionResponse" }, "errors": [ { @@ -1185,23 +1771,289 @@ } ], "traits": { - "smithy.api#documentation": "Describes the user assigned to the specific file transfer protocol-enabled server, as\n identified by its ServerId property.
The response from this call returns the properties of the user associated with the\n ServerId value that was specified.
You can use DescribeExecution to check the details of the execution of the specified workflow.
A system-assigned unique identifier for a server that has this user assigned.
", + "smithy.api#documentation": "A unique identifier for the execution of a workflow.
", "smithy.api#required": {} } }, - "UserName": { - "target": "com.amazonaws.transfer#UserName", + "WorkflowId": { + "target": "com.amazonaws.transfer#WorkflowId", "traits": { - "smithy.api#documentation": "The name of the user assigned to one or more servers. User names are part of the sign-in\n credentials to use the Amazon Web Services Transfer Family service and perform file transfer tasks.
", + "smithy.api#documentation": "A unique identifier for the workflow.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transfer#DescribeExecutionResponse": { + "type": "structure", + "members": { + "WorkflowId": { + "target": "com.amazonaws.transfer#WorkflowId", + "traits": { + "smithy.api#documentation": "A unique identifier for the workflow.
", + "smithy.api#required": {} + } + }, + "Execution": { + "target": "com.amazonaws.transfer#DescribedExecution", + "traits": { + "smithy.api#documentation": "The structure that contains the details of the workflow' execution.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transfer#DescribeProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#DescribeProfileRequest" + }, + "output": { + "target": "com.amazonaws.transfer#DescribeProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the details of the profile that's specified by the ProfileId.
The identifier of the profile that you want described.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transfer#DescribeProfileResponse": { + "type": "structure", + "members": { + "Profile": { + "target": "com.amazonaws.transfer#DescribedProfile", + "traits": { + "smithy.api#documentation": "The details of the specified profile, returned as an object.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transfer#DescribeSecurityPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#DescribeSecurityPolicyRequest" + }, + "output": { + "target": "com.amazonaws.transfer#DescribeSecurityPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the security policy that is attached to your file transfer protocol-enabled\n server. The response contains a description of the security policy's properties. For more\n information about security policies, see Working with security\n policies.
" + } + }, + "com.amazonaws.transfer#DescribeSecurityPolicyRequest": { + "type": "structure", + "members": { + "SecurityPolicyName": { + "target": "com.amazonaws.transfer#SecurityPolicyName", + "traits": { + "smithy.api#documentation": "Specifies the name of the security policy that is attached to the server.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transfer#DescribeSecurityPolicyResponse": { + "type": "structure", + "members": { + "SecurityPolicy": { + "target": "com.amazonaws.transfer#DescribedSecurityPolicy", + "traits": { + "smithy.api#documentation": "An array containing the properties of the security policy.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transfer#DescribeServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#DescribeServerRequest" + }, + "output": { + "target": "com.amazonaws.transfer#DescribeServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Describes a file transfer protocol-enabled server that you specify by passing the\n ServerId parameter.
The response contains a description of a server's properties. When you set\n EndpointType to VPC, the response will contain the\n EndpointDetails.
A system-assigned unique identifier for a server.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transfer#DescribeServerResponse": { + "type": "structure", + "members": { + "Server": { + "target": "com.amazonaws.transfer#DescribedServer", + "traits": { + "smithy.api#documentation": "An array containing the properties of a server with the ServerID you\n specified.
Describes the user assigned to the specific file transfer protocol-enabled server, as\n identified by its ServerId property.
The response from this call returns the properties of the user associated with the\n ServerId value that was specified.
A system-assigned unique identifier for a server that has this user assigned.
", + "smithy.api#required": {} + } + }, + "UserName": { + "target": "com.amazonaws.transfer#UserName", + "traits": { + "smithy.api#documentation": "The name of the user assigned to one or more servers. User names are part of the sign-in\n credentials to use the Transfer Family service and perform file transfer tasks.
", "smithy.api#required": {} } } @@ -1288,19 +2140,19 @@ "HomeDirectoryMappings": { "target": "com.amazonaws.transfer#HomeDirectoryMappings", "traits": { - "smithy.api#documentation": "Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.
In most cases, you can use this value instead of the session policy to lock down the\n associated access to the designated home directory (\"chroot\"). To do this, you\n can set Entry to '/' and set Target to the\n HomeDirectory parameter value.
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) \n role provides access to paths in Target. This value\n can be set only when HomeDirectoryType is set to\n LOGICAL.
In most cases, you can use this value instead of the session policy to lock down the\n associated access to the designated home directory (\"chroot\"). To do this, you\n can set Entry to '/' and set Target to the\n HomeDirectory parameter value.
The type of landing directory (folder) you want your users' home directory to be when they log into the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.\n If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon\n S3 or EFS paths visible to your users.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer \n protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS\n file system. The policies attached to this role determine the level of access that you want to provide your users when transferring\n files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the\n server to access your resources when servicing your users' transfer requests.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 \n bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users \n when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust \n relationship that allows the server to access your resources when servicing your users' transfer requests.
" } }, "ExternalId": { "target": "com.amazonaws.transfer#ExternalId", "traits": { - "smithy.api#documentation": "A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.
\n\n\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n
In that command, replace YourGroupName with the name of your Active Directory group.
\n\nThe regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-
" + "smithy.api#documentation": "A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.
\n\n\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n
In that command, replace YourGroupName with the name of your Active Directory group.
\n\nThe regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-
" } } }, @@ -1323,10 +2175,223 @@ "smithy.api#documentation": "Describes the properties of the access that was specified.
" } }, - "com.amazonaws.transfer#DescribedExecution": { + "com.amazonaws.transfer#DescribedAgreement": { "type": "structure", "members": { - "ExecutionId": { + "Arn": { + "target": "com.amazonaws.transfer#Arn", + "traits": { + "smithy.api#documentation": "The unique Amazon Resource Name (ARN) for the agreement.
", + "smithy.api#required": {} + } + }, + "AgreementId": { + "target": "com.amazonaws.transfer#AgreementId", + "traits": { + "smithy.api#documentation": "A unique identifier for the agreement. This identifier is returned when you create an agreement.
" + } + }, + "Description": { + "target": "com.amazonaws.transfer#Description", + "traits": { + "smithy.api#documentation": "The name or short description that's used to identify the agreement.
" + } + }, + "Status": { + "target": "com.amazonaws.transfer#AgreementStatusType", + "traits": { + "smithy.api#documentation": "The current status of the agreement, either ACTIVE or\n INACTIVE.
A system-assigned unique identifier for a server instance. This identifier indicates the\n specific server that the agreement uses.
" + } + }, + "LocalProfileId": { + "target": "com.amazonaws.transfer#ProfileId", + "traits": { + "smithy.api#documentation": "A unique identifier for the AS2 process.
" + } + }, + "PartnerProfileId": { + "target": "com.amazonaws.transfer#ProfileId", + "traits": { + "smithy.api#documentation": "A unique identifier for the partner in the agreement.
" + } + }, + "BaseDirectory": { + "target": "com.amazonaws.transfer#HomeDirectory", + "traits": { + "smithy.api#documentation": "The landing directory (folder) for files that are transferred by using the AS2\n protocol.
" + } + }, + "AccessRole": { + "target": "com.amazonaws.transfer#Role", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the \n HomeDirectory of your users' Amazon S3 buckets.
Key-value pairs that can be used to group and search for agreements.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the properties of an agreement.
" + } + }, + "com.amazonaws.transfer#DescribedCertificate": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.transfer#Arn", + "traits": { + "smithy.api#documentation": "The unique Amazon Resource Name (ARN) for the certificate.
", + "smithy.api#required": {} + } + }, + "CertificateId": { + "target": "com.amazonaws.transfer#CertificateId", + "traits": { + "smithy.api#documentation": "An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
" + } + }, + "Usage": { + "target": "com.amazonaws.transfer#CertificateUsageType", + "traits": { + "smithy.api#documentation": "Specifies whether this certificate is used for signing or encryption.
" + } + }, + "Status": { + "target": "com.amazonaws.transfer#CertificateStatusType", + "traits": { + "smithy.api#documentation": "The certificate can be either ACTIVE, PENDING_ROTATION, or\n INACTIVE. PENDING_ROTATION means that this certificate will\n replace the current certificate when it expires.
The file name for the certificate.
" + } + }, + "CertificateChain": { + "target": "com.amazonaws.transfer#CertificateChainType", + "traits": { + "smithy.api#documentation": "The list of certificates that make up the chain for the certificate.
" + } + }, + "ActiveDate": { + "target": "com.amazonaws.transfer#CertDate", + "traits": { + "smithy.api#documentation": "An optional date that specifies when the certificate becomes active.
" + } + }, + "InactiveDate": { + "target": "com.amazonaws.transfer#CertDate", + "traits": { + "smithy.api#documentation": "An optional date that specifies when the certificate becomes inactive.
" + } + }, + "Serial": { + "target": "com.amazonaws.transfer#CertSerial", + "traits": { + "smithy.api#documentation": "The serial number for the certificate.
" + } + }, + "NotBeforeDate": { + "target": "com.amazonaws.transfer#CertDate", + "traits": { + "smithy.api#documentation": "The earliest date that the certificate is valid.
" + } + }, + "NotAfterDate": { + "target": "com.amazonaws.transfer#CertDate", + "traits": { + "smithy.api#documentation": "The final date that the certificate is\n valid.
" + } + }, + "Type": { + "target": "com.amazonaws.transfer#CertificateType", + "traits": { + "smithy.api#documentation": "If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.
The name or description that's used to identity the certificate.
" + } + }, + "Tags": { + "target": "com.amazonaws.transfer#Tags", + "traits": { + "smithy.api#documentation": "Key-value pairs that can be used to group and search for certificates.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the properties of a certificate.
" + } + }, + "com.amazonaws.transfer#DescribedConnector": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.transfer#Arn", + "traits": { + "smithy.api#documentation": "The unique Amazon Resource Name (ARN) for the connector.
", + "smithy.api#required": {} + } + }, + "ConnectorId": { + "target": "com.amazonaws.transfer#ConnectorId", + "traits": { + "smithy.api#documentation": "The unique identifier for the connector.
" + } + }, + "Url": { + "target": "com.amazonaws.transfer#Url", + "traits": { + "smithy.api#documentation": "The URL of the partner's AS2 endpoint.
" + } + }, + "As2Config": { + "target": "com.amazonaws.transfer#As2ConnectorConfig", + "traits": { + "smithy.api#documentation": "A structure that contains the parameters for a connector object.
" + } + }, + "AccessRole": { + "target": "com.amazonaws.transfer#Role", + "traits": { + "smithy.api#documentation": "With AS2, you can send files by calling StartFileTransfer and specifying the\n file paths in the request parameter, SendFilePaths. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt, parent\n directory is /bucket/dir/) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer.
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn\n on CloudWatch logging for Amazon S3 events. When set, you can view connector\n activity in your CloudWatch logs.
" + } + }, + "Tags": { + "target": "com.amazonaws.transfer#Tags", + "traits": { + "smithy.api#documentation": "Key-value pairs that can be used to group and search for connectors.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the parameters for the connector, as identified by the\n ConnectorId.
A unique identifier for the execution of a workflow.
" @@ -1341,7 +2406,7 @@ "ServiceMetadata": { "target": "com.amazonaws.transfer#ServiceMetadata", "traits": { - "smithy.api#documentation": "A container object for the session details associated with a workflow.
" + "smithy.api#documentation": "A container object for the session details that are associated with a workflow.
" } }, "ExecutionRole": { @@ -1376,6 +2441,51 @@ "smithy.api#documentation": "The details for an execution object.
" } }, + "com.amazonaws.transfer#DescribedProfile": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.transfer#Arn", + "traits": { + "smithy.api#documentation": "The unique Amazon Resource Name (ARN) for the profile.
", + "smithy.api#required": {} + } + }, + "ProfileId": { + "target": "com.amazonaws.transfer#ProfileId", + "traits": { + "smithy.api#documentation": "A unique identifier for the local or partner AS2 profile.
" + } + }, + "ProfileType": { + "target": "com.amazonaws.transfer#ProfileType", + "traits": { + "smithy.api#documentation": "Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. \n If not supplied in the request, the command lists all types of profiles.
The unique identifier for the AS2 process.
" + } + }, + "CertificateIds": { + "target": "com.amazonaws.transfer#CertificateIds", + "traits": { + "smithy.api#documentation": "An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
" + } + }, + "Tags": { + "target": "com.amazonaws.transfer#Tags", + "traits": { + "smithy.api#documentation": "Key-value pairs that can be used to group and search for profiles.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details for a local or partner AS2 profile.\n profile.
" + } + }, "com.amazonaws.transfer#DescribedSecurityPolicy": { "type": "structure", "members": { @@ -1452,7 +2562,7 @@ "EndpointDetails": { "target": "com.amazonaws.transfer#EndpointDetails", "traits": { - "smithy.api#documentation": "The virtual private cloud (VPC) endpoint settings that are configured for your server.\n When you host your endpoint within your VPC, you can make it accessible only to resources\n within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over\n the internet. Your VPC's default security groups are automatically assigned to your\n endpoint.
" + "smithy.api#documentation": "The virtual private cloud (VPC) endpoint settings that are configured for your server.\n When you host your endpoint within your VPC, you can make your endpoint accessible only to resources\n within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over\n the internet. Your VPC's default security groups are automatically assigned to your\n endpoint.
" } }, "EndpointType": { @@ -1476,25 +2586,25 @@ "IdentityProviderType": { "target": "com.amazonaws.transfer#IdentityProviderType", "traits": { - "smithy.api#documentation": "Specifies the mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to\n Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to\n provide a Directory ID using the IdentityProviderDetails parameter.
Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the IdentityProviderDetails parameter.
Use the AWS_LAMBDA value to directly use a Lambda function as your identity provider. If you choose this value,\n you must specify the ARN for the lambda function in the Function parameter for the IdentityProviderDetails data type.
The mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to\n Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to\n provide a Directory ID by using the IdentityProviderDetails parameter.
Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call\n for authentication by using the IdentityProviderDetails parameter.
Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. \n If you choose this value, you must specify the ARN for the Lambda function in the Function parameter \n or the IdentityProviderDetails data type.
Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in\n your CloudWatch logs.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in\n your CloudWatch logs.
" } }, "PostAuthenticationLoginBanner": { "target": "com.amazonaws.transfer#PostAuthenticationLoginBanner", "traits": { - "smithy.api#documentation": "Specify a string to display when users connect to a server. This string is displayed after the user authenticates.
\nThe SFTP protocol does not support post-authentication display banners.
\nSpecifies a string to display when users connect to a server. This string is displayed after the user authenticates.
\nThe SFTP protocol does not support post-authentication display banners.
\nSpecify a string to display when users connect to a server. This string is displayed before the user authenticates.\n For example, the following banner displays details about using the system.
\n\n This system is for the use of authorized users only. Individuals using this computer system without authority,\n or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by\n system personnel.\n
Specifies a string to display when users connect to a server. This string is displayed before the user authenticates.\n For example, the following banner displays details about using the system:
\n \n\n This system is for the use of authorized users only. Individuals using this computer system without authority,\n or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by\n system personnel.\n
Specifies the condition of a server for the server that was described. A value of\n ONLINE indicates that the server can accept jobs and transfer files. A\n State value of OFFLINE means that the server cannot perform file\n transfer operations.
The states of STARTING and STOPPING indicate that the server is\n in an intermediate state, either not fully able to respond, or not fully offline. The values\n of START_FAILED or STOP_FAILED can indicate an error\n condition.
The condition of the server that was described. A value of\n ONLINE indicates that the server can accept jobs and transfer files. A\n State value of OFFLINE means that the server cannot perform file\n transfer operations.
The states of STARTING and STOPPING indicate that the server is\n in an intermediate state, either not fully able to respond, or not fully offline. The values\n of START_FAILED or STOP_FAILED can indicate an error\n condition.
Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
" + "smithy.api#documentation": "Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
" } } }, @@ -1563,19 +2673,19 @@ "HomeDirectoryMappings": { "target": "com.amazonaws.transfer#HomeDirectoryMappings", "traits": { - "smithy.api#documentation": "Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.
In most cases, you can use this value instead of the session policy to lock your user\n down to the designated home directory (\"chroot\"). To do this, you can set\n Entry to '/' and set Target to the HomeDirectory\n parameter value.
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) \n role provides access to paths in Target. This value\n can be set only when HomeDirectoryType is set to\n LOGICAL.
In most cases, you can use this value instead of the session policy to lock your user\n down to the designated home directory (\"chroot\"). To do this, you can set\n Entry to '/' and set Target to the HomeDirectory\n parameter value.
The type of landing directory (folder) you want your users' home directory to be when they log into the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.\n If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon\n S3 or EFS paths visible to your users.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer \n protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS\n file system. The policies attached to this role determine the level of access that you want to provide your users when transferring\n files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the\n server to access your resources when servicing your users' transfer requests.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 \n bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users \n when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust \n relationship that allows the server to access your resources when servicing your users' transfer requests.
" } }, "SshPublicKeys": { @@ -1658,6 +2768,16 @@ "smithy.api#documentation": "Describes the properties of the specified workflow
" } }, + "com.amazonaws.transfer#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[\\p{Graph}]+$" + } + }, "com.amazonaws.transfer#DirectoryId": { "type": "string", "traits": { @@ -1723,6 +2843,25 @@ "smithy.api#pattern": "^[^\\x00]+$" } }, + "com.amazonaws.transfer#EncryptionAlg": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AES128_CBC", + "name": "AES128_CBC" + }, + { + "value": "AES192_CBC", + "name": "AES192_CBC" + }, + { + "value": "AES256_CBC", + "name": "AES256_CBC" + } + ] + } + }, "com.amazonaws.transfer#EndpointDetails": { "type": "structure", "members": { @@ -1903,7 +3042,7 @@ "StepType": { "target": "com.amazonaws.transfer#WorkflowStepType", "traits": { - "smithy.api#documentation": "One of the available step types.
\n\n COPY: copy the file to another location
\n\n CUSTOM: custom step with a lambda target
\n\n DELETE: delete the file
\n\n TAG: add a tag to the file
\nOne of the available step types.
\n\n COPY: Copy the file to another location.
\n\n CUSTOM: Perform a custom step with an Lambda function target.
\n\n DELETE: Delete the file.
\n\n TAG: Add a tag to the file.
\nSpecifies the details for an error, if it occurred during execution of the specified workfow step.
" + "smithy.api#documentation": "Specifies the details for an error, if it occurred during execution of the specified\n workflow step.
" } } }, @@ -1951,7 +3090,7 @@ "S3FileLocation": { "target": "com.amazonaws.transfer#S3FileLocation", "traits": { - "smithy.api#documentation": "Specifies the S3 details for the file being used, such as bucket, Etag, and so forth.
" + "smithy.api#documentation": "Specifies the S3 details for the file being used, such as bucket, ETag, and so\n forth.
" } }, "EfsFileLocation": { @@ -1965,6 +3104,28 @@ "smithy.api#documentation": "Specifies the Amazon S3 or EFS file details to be used in the step.
" } }, + "com.amazonaws.transfer#FilePath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^(.)+$" + } + }, + "com.amazonaws.transfer#FilePaths": { + "type": "list", + "member": { + "target": "com.amazonaws.transfer#FilePath" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.transfer#Fips": { "type": "boolean", "traits": { @@ -2071,7 +3232,7 @@ "DirectoryId": { "target": "com.amazonaws.transfer#DirectoryId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Web Services Directory Service directory that you want to stop sharing.
" + "smithy.api#documentation": "The identifier of the Directory Service directory that you want to stop sharing.
" } }, "Function": { @@ -2109,6 +3270,99 @@ ] } }, + "com.amazonaws.transfer#ImportCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#ImportCertificateRequest" + }, + "output": { + "target": "com.amazonaws.transfer#ImportCertificateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Imports the signing and encryption certificates that you need to create local (AS2)\n profiles and partner\n profiles.
" + } + }, + "com.amazonaws.transfer#ImportCertificateRequest": { + "type": "structure", + "members": { + "Usage": { + "target": "com.amazonaws.transfer#CertificateUsageType", + "traits": { + "smithy.api#documentation": "Specifies whether this certificate is used for signing or encryption.
", + "smithy.api#required": {} + } + }, + "Certificate": { + "target": "com.amazonaws.transfer#CertificateBodyType", + "traits": { + "smithy.api#documentation": "The file that contains the certificate to import.
", + "smithy.api#required": {} + } + }, + "CertificateChain": { + "target": "com.amazonaws.transfer#CertificateChainType", + "traits": { + "smithy.api#documentation": "An optional list of certificates that make up the chain for the certificate that's being\n imported.
" + } + }, + "PrivateKey": { + "target": "com.amazonaws.transfer#PrivateKeyType", + "traits": { + "smithy.api#documentation": "The file that contains the private key for the certificate that's being imported.
" + } + }, + "ActiveDate": { + "target": "com.amazonaws.transfer#CertDate", + "traits": { + "smithy.api#documentation": "An optional date that specifies when the certificate becomes active.
" + } + }, + "InactiveDate": { + "target": "com.amazonaws.transfer#CertDate", + "traits": { + "smithy.api#documentation": "An optional date that specifies when the certificate becomes inactive.
" + } + }, + "Description": { + "target": "com.amazonaws.transfer#Description", + "traits": { + "smithy.api#documentation": "A short description that helps identify the certificate.
" + } + }, + "Tags": { + "target": "com.amazonaws.transfer#Tags", + "traits": { + "smithy.api#documentation": "Key-value pairs that can be used to group and search for certificates.
" + } + } + } + }, + "com.amazonaws.transfer#ImportCertificateResponse": { + "type": "structure", + "members": { + "CertificateId": { + "target": "com.amazonaws.transfer#CertificateId", + "traits": { + "smithy.api#documentation": "An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.transfer#ImportSshPublicKey": { "type": "operation", "input": { @@ -2191,86 +3445,387 @@ "smithy.api#required": {} } } - }, + }, + "traits": { + "smithy.api#documentation": "Identifies the user, the server they belong to, and the identifier of the SSH public key\n associated with that user. A user can have more than one key on each server that they are\n associated with.
" + } + }, + "com.amazonaws.transfer#InputFileLocation": { + "type": "structure", + "members": { + "S3FileLocation": { + "target": "com.amazonaws.transfer#S3InputFileLocation", + "traits": { + "smithy.api#documentation": "Specifies the details for the S3 file being copied.
" + } + }, + "EfsFileLocation": { + "target": "com.amazonaws.transfer#EfsFileLocation", + "traits": { + "smithy.api#documentation": "Reserved for future use.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps.
" + } + }, + "com.amazonaws.transfer#InternalServiceError": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.transfer#Message", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, + "com.amazonaws.transfer#InvalidNextTokenException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.transfer#Message", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The NextToken parameter that was passed is invalid.
This exception is thrown when the client submits a malformed request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.transfer#ListAccesses": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#ListAccessesRequest" + }, + "output": { + "target": "com.amazonaws.transfer#ListAccessesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the details for all the accesses you have on your server.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Accesses", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.transfer#ListAccessesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.transfer#MaxResults", + "traits": { + "smithy.api#documentation": "Specifies the maximum number of access SIDs to return.
" + } + }, + "NextToken": { + "target": "com.amazonaws.transfer#NextToken", + "traits": { + "smithy.api#documentation": "When you can get additional results from the ListAccesses call, a\n NextToken parameter is returned in the output. You can then pass in a\n subsequent command to the NextToken parameter to continue listing additional\n accesses.
A system-assigned unique identifier for a server that has users assigned to it.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transfer#ListAccessesResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.transfer#NextToken", + "traits": { + "smithy.api#documentation": "When you can get additional results from the ListAccesses call, a\n NextToken parameter is returned in the output. You can then pass in a\n subsequent command to the NextToken parameter to continue listing additional\n accesses.
A system-assigned unique identifier for a server that has users assigned to it.
", + "smithy.api#required": {} + } + }, + "Accesses": { + "target": "com.amazonaws.transfer#ListedAccesses", + "traits": { + "smithy.api#documentation": "Returns the accesses and their properties for the ServerId value that you\n specify.
Returns a list of the agreements for the server that's identified by the\n ServerId that you supply. If you want to limit the results to a certain number,\n supply a value for the MaxResults parameter. If you ran the command previously\n and received a value for NextToken, you can supply that value to continue listing\n agreements from where you left off.
The maximum number of agreements to return.
" + } + }, + "NextToken": { + "target": "com.amazonaws.transfer#NextToken", + "traits": { + "smithy.api#documentation": "When you can get additional results from the ListAgreements call, a\n NextToken parameter is returned in the output. You can then pass in a\n subsequent command to the NextToken parameter to continue listing additional\n agreements.
The identifier of the server for which you want a list of agreements.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transfer#ListAgreementsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.transfer#NextToken", + "traits": { + "smithy.api#documentation": "Returns a token that you can use to call ListAgreements again and receive\n additional results, if there are any.
Returns an array, where each item contains the details of an agreement.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transfer#ListCertificates": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#ListCertificatesRequest" + }, + "output": { + "target": "com.amazonaws.transfer#ListCertificatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + } + ], "traits": { - "smithy.api#documentation": "Identifies the user, the server they belong to, and the identifier of the SSH public key\n associated with that user. A user can have more than one key on each server that they are\n associated with.
" + "smithy.api#documentation": "Returns a list of the current certificates that have been imported into Transfer Family. If you want to\n limit the results to a certain number, supply a value for the MaxResults\n parameter. If you ran the command previously and received a value for the\n NextToken parameter, you can supply that value to continue listing certificates\n from where you left off.
Specifies the details for the S3 file being copied.
" + "smithy.api#documentation": "The maximum number of certificates to return.
" } }, - "EfsFileLocation": { - "target": "com.amazonaws.transfer#EfsFileLocation", + "NextToken": { + "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "Reserved for future use.
" + "smithy.api#documentation": "When you can get additional results from the ListCertificates call, a\n NextToken parameter is returned in the output. You can then pass in a\n subsequent command to the NextToken parameter to continue listing additional\n certificates.
Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps.
" } }, - "com.amazonaws.transfer#InternalServiceError": { + "com.amazonaws.transfer#ListCertificatesResponse": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.transfer#Message", + "NextToken": { + "target": "com.amazonaws.transfer#NextToken", + "traits": { + "smithy.api#documentation": "Returns the next token, which you can use to list the next certificate.
" + } + }, + "Certificates": { + "target": "com.amazonaws.transfer#ListedCertificates", "traits": { + "smithy.api#documentation": "Returns an array of the certificates that are specified in the\n ListCertificates call.
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
", - "smithy.api#error": "server", - "smithy.api#httpError": 503 + "smithy.api#documentation": "Lists the connectors for the specified Region.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Connectors", + "pageSize": "MaxResults" + } } }, - "com.amazonaws.transfer#InvalidNextTokenException": { + "com.amazonaws.transfer#ListConnectorsRequest": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.transfer#Message", + "MaxResults": { + "target": "com.amazonaws.transfer#MaxResults", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "The maximum number of connectors to return.
" + } + }, + "NextToken": { + "target": "com.amazonaws.transfer#NextToken", + "traits": { + "smithy.api#documentation": "When you can get additional results from the ListConnectors call, a\n NextToken parameter is returned in the output. You can then pass in a\n subsequent command to the NextToken parameter to continue listing additional\n connectors.
The NextToken parameter that was passed is invalid.
Returns a token that you can use to call ListConnectors again and receive\n additional results, if there are any.
Returns an array, where each item contains the details of a connector.
", "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "This exception is thrown when the client submits a malformed request.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 } }, - "com.amazonaws.transfer#ListAccesses": { + "com.amazonaws.transfer#ListExecutions": { "type": "operation", "input": { - "target": "com.amazonaws.transfer#ListAccessesRequest" + "target": "com.amazonaws.transfer#ListExecutionsRequest" }, "output": { - "target": "com.amazonaws.transfer#ListAccessesResponse" + "target": "com.amazonaws.transfer#ListExecutionsResponse" }, "errors": [ { @@ -2290,71 +3845,71 @@ } ], "traits": { - "smithy.api#documentation": "Lists the details for all the accesses you have on your server.
", + "smithy.api#documentation": "Lists all executions for the specified workflow.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "Accesses", + "items": "Executions", "pageSize": "MaxResults" } } }, - "com.amazonaws.transfer#ListAccessesRequest": { + "com.amazonaws.transfer#ListExecutionsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.transfer#MaxResults", "traits": { - "smithy.api#documentation": "Specifies the maximum number of access SIDs to return.
" + "smithy.api#documentation": "Specifies the maximum number of executions to return.
" } }, "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "When you can get additional results from the ListAccesses call, a\n NextToken parameter is returned in the output. You can then pass in a\n subsequent command to the NextToken parameter to continue listing additional\n accesses.
\n ListExecutions returns the NextToken parameter in the output.\n You can then pass the NextToken parameter in a subsequent command to\n continue listing additional executions.
\n This is useful for pagination, for instance.\n If you have 100 executions for a workflow, you might only want to list first 10. If so, call the API by specifying the max-results:\n
\n aws transfer list-executions --max-results 10\n
\n This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution.\n You can now call the API again, supplying the NextToken value you received:\n
\n aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult\n
\n This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details\n for all 100 executions have been returned.\n
" } }, - "ServerId": { - "target": "com.amazonaws.transfer#ServerId", + "WorkflowId": { + "target": "com.amazonaws.transfer#WorkflowId", "traits": { - "smithy.api#documentation": "A system-assigned unique identifier for a server that has users assigned to it.
", + "smithy.api#documentation": "A unique identifier for the workflow.
", "smithy.api#required": {} } } } }, - "com.amazonaws.transfer#ListAccessesResponse": { + "com.amazonaws.transfer#ListExecutionsResponse": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "When you can get additional results from the ListAccesses call, a\n NextToken parameter is returned in the output. You can then pass in a\n subsequent command to the NextToken parameter to continue listing additional\n accesses.
\n ListExecutions returns the NextToken parameter in the output.\n You can then pass the NextToken parameter in a subsequent command to\n continue listing additional executions.
A system-assigned unique identifier for a server that has users assigned to it.
", + "smithy.api#documentation": "A unique identifier for the workflow.
", "smithy.api#required": {} } }, - "Accesses": { - "target": "com.amazonaws.transfer#ListedAccesses", + "Executions": { + "target": "com.amazonaws.transfer#ListedExecutions", "traits": { - "smithy.api#documentation": "Returns the accesses and their properties for the ServerId value that you\n specify.
Returns the details for each execution.
\n\n NextToken: returned from a call to several APIs,\n you can use pass it to a subsequent command to continue listing additional executions.
\n\n StartTime: timestamp indicating when the execution began.
\n\n Executions: details of the execution, including the execution ID, initial file location,\n and Service metadata.
\n\n Status: one of the following values:\n IN_PROGRESS, COMPLETED, EXCEPTION, HANDLING_EXEPTION.\n
Lists all executions for the specified workflow.
", + "smithy.api#documentation": "Returns a list of the profiles for your system. If you want to limit the results to a\n certain number, supply a value for the MaxResults parameter. If you ran the\n command previously and received a value for NextToken, you can supply that value\n to continue listing profiles from where you left off.
Specifies the aximum number of executions to return.
" + "smithy.api#documentation": "The maximum number of profiles to return.
" } }, "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "\n ListExecutions returns the NextToken parameter in the output.\n You can then pass the NextToken parameter in a subsequent command to\n continue listing additional executions.
\n This is useful for pagination, for instance.\n If you have 100 executions for a workflow, you might only want to list first 10. If so, callthe API by specifing the max-results:\n
\n aws transfer list-executions --max-results 10\n
\n This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution.\n You can now call the API again, suppling the NextToken value you received:\n
\n aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult\n
\n This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details\n for all 100 executions have been returned.\n
" + "smithy.api#documentation": "When there are additional results that were not returned, a NextToken\n parameter is returned. You can use that value for a subsequent call to\n ListProfiles to continue listing results.
A unique identifier for the workflow.
", - "smithy.api#required": {} + "smithy.api#documentation": "Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. \n If not supplied in the request, the command lists all types of profiles.
\n ListExecutions returns the NextToken parameter in the output.\n You can then pass the NextToken parameter in a subsequent command to\n continue listing additional executions.
A unique identifier for the workflow.
", - "smithy.api#required": {} + "smithy.api#documentation": "Returns a token that you can use to call ListProfiles again and receive\n additional results, if there are any.
Returns the details for each execution.
\n\n NextToken: returned from a call to several APIs,\n you can use pass it to a subsequent command to continue listing additional executions.
\n\n StartTime: timestamp indicating when the execution began.
\n\n Executions: details of the execution, including the execution ID, initial file location,\n and Service metadata.
\n\n Status: one of the following values:\n IN_PROGRESS, COMPLETED, EXCEPTION, HANDLING_EXEPTION.\n
Returns an array, where each item contains the details of a profile.
", "smithy.api#required": {} } } @@ -2744,94 +4291,244 @@ { "target": "com.amazonaws.transfer#InvalidNextTokenException" }, - { - "target": "com.amazonaws.transfer#InvalidRequestException" + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all of your workflows.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Workflows", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.transfer#ListWorkflowsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.transfer#MaxResults", + "traits": { + "smithy.api#documentation": "Specifies the maximum number of workflows to return.
" + } + }, + "NextToken": { + "target": "com.amazonaws.transfer#NextToken", + "traits": { + "smithy.api#documentation": "\n ListWorkflows returns the NextToken parameter in the output.\n You can then pass the NextToken parameter in a subsequent command to\n continue listing additional workflows.
\n ListWorkflows returns the NextToken parameter in the output.\n You can then pass the NextToken parameter in a subsequent command to\n continue listing additional workflows.
Returns the Arn, WorkflowId, and Description for each workflow.
The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory example is /bucket_name/home/mydirectory.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer \n protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 \n bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users \n when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust \n relationship that allows the server to access your resources when servicing your users' transfer requests.
" + } + }, + "ExternalId": { + "target": "com.amazonaws.transfer#ExternalId", + "traits": { + "smithy.api#documentation": "A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.
\n\n\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n
In that command, replace YourGroupName with the name of your Active Directory group.
\n\nThe regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-
" + } + } + }, + "traits": { + "smithy.api#documentation": "Lists the properties for one or more specified associated accesses.
" + } + }, + "com.amazonaws.transfer#ListedAccesses": { + "type": "list", + "member": { + "target": "com.amazonaws.transfer#ListedAccess" + } + }, + "com.amazonaws.transfer#ListedAgreement": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.transfer#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the specified agreement.
" + } + }, + "AgreementId": { + "target": "com.amazonaws.transfer#AgreementId", + "traits": { + "smithy.api#documentation": "A unique identifier for the agreement. This identifier is returned when you create an agreement.
" + } + }, + "Description": { + "target": "com.amazonaws.transfer#Description", + "traits": { + "smithy.api#documentation": "The current description for the agreement. You can change it by calling the\n UpdateAgreement operation and providing a new description.
The agreement can be either ACTIVE or INACTIVE.
The unique identifier for the agreement.
" + } }, - { - "target": "com.amazonaws.transfer#ServiceUnavailableException" + "LocalProfileId": { + "target": "com.amazonaws.transfer#ProfileId", + "traits": { + "smithy.api#documentation": "A unique identifier for the AS2 process.
" + } + }, + "PartnerProfileId": { + "target": "com.amazonaws.transfer#ProfileId", + "traits": { + "smithy.api#documentation": "A unique identifier for the partner process.
" + } } - ], + }, "traits": { - "smithy.api#documentation": "Lists all of your workflows.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Workflows", - "pageSize": "MaxResults" - } + "smithy.api#documentation": "Describes the properties of an agreement.
" } }, - "com.amazonaws.transfer#ListWorkflowsRequest": { + "com.amazonaws.transfer#ListedAgreements": { + "type": "list", + "member": { + "target": "com.amazonaws.transfer#ListedAgreement" + } + }, + "com.amazonaws.transfer#ListedCertificate": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.transfer#MaxResults", + "Arn": { + "target": "com.amazonaws.transfer#Arn", "traits": { - "smithy.api#documentation": "Specifies the maximum number of workflows to return.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the specified certificate.
" } }, - "NextToken": { - "target": "com.amazonaws.transfer#NextToken", + "CertificateId": { + "target": "com.amazonaws.transfer#CertificateId", "traits": { - "smithy.api#documentation": "\n ListWorkflows returns the NextToken parameter in the output.\n You can then pass the NextToken parameter in a subsequent command to\n continue listing additional workflows.
An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
" } - } - } - }, - "com.amazonaws.transfer#ListWorkflowsResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.transfer#NextToken", + }, + "Usage": { + "target": "com.amazonaws.transfer#CertificateUsageType", "traits": { - "smithy.api#documentation": "\n ListWorkflows returns the NextToken parameter in the output.\n You can then pass the NextToken parameter in a subsequent command to\n continue listing additional workflows.
Specifies whether this certificate is used for signing or encryption.
" } }, - "Workflows": { - "target": "com.amazonaws.transfer#ListedWorkflows", + "Status": { + "target": "com.amazonaws.transfer#CertificateStatusType", "traits": { - "smithy.api#documentation": "Returns the Arn, WorkflowId, and Description for each workflow.
The certificate can be either ACTIVE, PENDING_ROTATION, or\n INACTIVE. PENDING_ROTATION means that this certificate will\n replace the current certificate when it expires.
An optional date that specifies when the certificate becomes active.
" + } + }, + "InactiveDate": { + "target": "com.amazonaws.transfer#CertDate", + "traits": { + "smithy.api#documentation": "An optional date that specifies when the certificate becomes inactive.
" + } + }, + "Type": { + "target": "com.amazonaws.transfer#CertificateType", + "traits": { + "smithy.api#documentation": "The type for the certificate. If a private key has been specified for the certificate, its\n type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is\n CERTIFICATE.
The name or short description that's used to identify the certificate.
" } } + }, + "traits": { + "smithy.api#documentation": "Describes the properties of a certificate.
" } }, - "com.amazonaws.transfer#ListedAccess": { + "com.amazonaws.transfer#ListedCertificates": { + "type": "list", + "member": { + "target": "com.amazonaws.transfer#ListedCertificate" + } + }, + "com.amazonaws.transfer#ListedConnector": { "type": "structure", "members": { - "HomeDirectory": { - "target": "com.amazonaws.transfer#HomeDirectory", - "traits": { - "smithy.api#documentation": "The landing directory (folder) for a user when they log in to the server using the client.
\nA HomeDirectory example is /bucket_name/home/mydirectory.
The type of landing directory (folder) you want your users' home directory to be when they log into the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.\n If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon\n S3 or EFS paths visible to your users.
The Amazon Resource Name (ARN) of the specified connector.
" } }, - "Role": { - "target": "com.amazonaws.transfer#Role", + "ConnectorId": { + "target": "com.amazonaws.transfer#ConnectorId", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS\n file system. The policies attached to this role determine the level of access that you want to provide your users when transferring\n files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the\n server to access your resources when servicing your users' transfer requests.
" + "smithy.api#documentation": "The unique identifier for the connector.
" } }, - "ExternalId": { - "target": "com.amazonaws.transfer#ExternalId", + "Url": { + "target": "com.amazonaws.transfer#Url", "traits": { - "smithy.api#documentation": "A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.
\n\n\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n
In that command, replace YourGroupName with the name of your Active Directory group.
\n\nThe regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-
" + "smithy.api#documentation": "The URL of the partner's AS2 endpoint.
" } } }, "traits": { - "smithy.api#documentation": "Lists the properties for one or more specified associated accesses.
" + "smithy.api#documentation": "Returns details of the connector that is specified.
" } }, - "com.amazonaws.transfer#ListedAccesses": { + "com.amazonaws.transfer#ListedConnectors": { "type": "list", "member": { - "target": "com.amazonaws.transfer#ListedAccess" + "target": "com.amazonaws.transfer#ListedConnector" } }, "com.amazonaws.transfer#ListedExecution": { @@ -2852,7 +4549,7 @@ "ServiceMetadata": { "target": "com.amazonaws.transfer#ServiceMetadata", "traits": { - "smithy.api#documentation": "A container object for the session details associated with a workflow.
" + "smithy.api#documentation": "A container object for the session details that are associated with a workflow.
" } }, "Status": { @@ -2872,6 +4569,44 @@ "target": "com.amazonaws.transfer#ListedExecution" } }, + "com.amazonaws.transfer#ListedProfile": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.transfer#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the specified profile.
" + } + }, + "ProfileId": { + "target": "com.amazonaws.transfer#ProfileId", + "traits": { + "smithy.api#documentation": "A unique identifier for the local or partner AS2 profile.
" + } + }, + "As2Id": { + "target": "com.amazonaws.transfer#As2Id", + "traits": { + "smithy.api#documentation": "The unique identifier for the AS2 process.
" + } + }, + "ProfileType": { + "target": "com.amazonaws.transfer#ProfileType", + "traits": { + "smithy.api#documentation": "Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. \n If not supplied in the request, the command lists all types of profiles.
Returns the properties of the profile that was specified.
" + } + }, + "com.amazonaws.transfer#ListedProfiles": { + "type": "list", + "member": { + "target": "com.amazonaws.transfer#ListedProfile" + } + }, "com.amazonaws.transfer#ListedServer": { "type": "structure", "members": { @@ -2891,7 +4626,7 @@ "IdentityProviderType": { "target": "com.amazonaws.transfer#IdentityProviderType", "traits": { - "smithy.api#documentation": "Specifies the mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to\n Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to\n provide a Directory ID using the IdentityProviderDetails parameter.
Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the IdentityProviderDetails parameter.
Use the AWS_LAMBDA value to directly use a Lambda function as your identity provider. If you choose this value,\n you must specify the ARN for the lambda function in the Function parameter for the IdentityProviderDetails data type.
The mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to\n Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to\n provide a Directory ID by using the IdentityProviderDetails parameter.
Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call\n for authentication by using the IdentityProviderDetails parameter.
Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. \n If you choose this value, you must specify the ARN for the Lambda function in the Function parameter \n or the IdentityProviderDetails data type.
Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in\n your CloudWatch logs.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in\n your CloudWatch logs.
" } }, "ServerId": { @@ -2915,7 +4650,7 @@ "State": { "target": "com.amazonaws.transfer#State", "traits": { - "smithy.api#documentation": "Specifies the condition of a server for the server that was described. A value of\n ONLINE indicates that the server can accept jobs and transfer files. A\n State value of OFFLINE means that the server cannot perform file\n transfer operations.
The states of STARTING and STOPPING indicate that the server is\n in an intermediate state, either not fully able to respond, or not fully offline. The values\n of START_FAILED or STOP_FAILED can indicate an error\n condition.
The condition of the server that was described. A value of\n ONLINE indicates that the server can accept jobs and transfer files. A\n State value of OFFLINE means that the server cannot perform file\n transfer operations.
The states of STARTING and STOPPING indicate that the server is\n in an intermediate state, either not fully able to respond, or not fully offline. The values\n of START_FAILED or STOP_FAILED can indicate an error\n condition.
The type of landing directory (folder) you want your users' home directory to be when they log into the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.\n If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon\n S3 or EFS paths visible to your users.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer \n protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS\n file system. The policies attached to this role determine the level of access that you want to provide your users when transferring\n files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the\n server to access your resources when servicing your users' transfer requests.
\nThe IAM role that controls your users' access to your Amazon S3 bucket for servers with Domain=S3, or your EFS file system for servers with Domain=EFS. \n
The policies attached to this role determine the level of access you want to provide your users when \n transferring files into and out of your S3 buckets or EFS file systems.
\n\nThe Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 \n bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users \n when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust \n relationship that allows the server to access your resources when servicing your users' transfer requests.
\nThe IAM role that controls your users' access to your Amazon S3 bucket for servers with Domain=S3, or your EFS file system for servers with Domain=EFS. \n
The policies attached to this role determine the level of access you want to provide your users when \n transferring files into and out of your S3 buckets or EFS file systems.
\n\nSpecifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in\n your CloudWatch logs.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in\n your CloudWatch logs.
" } }, "LogGroupName": { "target": "com.amazonaws.transfer#LogGroupName", "traits": { - "smithy.api#documentation": "The name of the CloudWatch logging group for the Amazon Web Services Transfer server to which this workflow belongs.
" + "smithy.api#documentation": "The name of the CloudWatch logging group for the Transfer Family server to which this workflow belongs.
" } } }, @@ -3078,9 +4813,65 @@ } } }, + "com.amazonaws.transfer#MdnResponse": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SYNC", + "name": "SYNC" + }, + { + "value": "NONE", + "name": "NONE" + } + ] + } + }, + "com.amazonaws.transfer#MdnSigningAlg": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SHA256", + "name": "SHA256" + }, + { + "value": "SHA384", + "name": "SHA384" + }, + { + "value": "SHA512", + "name": "SHA512" + }, + { + "value": "SHA1", + "name": "SHA1" + }, + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "DEFAULT", + "name": "DEFAULT" + } + ] + } + }, "com.amazonaws.transfer#Message": { "type": "string" }, + "com.amazonaws.transfer#MessageSubject": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\p{Print}\\p{Blank}]+$" + } + }, "com.amazonaws.transfer#NextToken": { "type": "string", "traits": { @@ -3203,6 +4994,42 @@ "smithy.api#pattern": "^[\\x09-\\x0D\\x20-\\x7E]*$" } }, + "com.amazonaws.transfer#PrivateKeyType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16384 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.transfer#ProfileId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 19, + "max": 19 + }, + "smithy.api#pattern": "^p-([0-9a-f]{17})$" + } + }, + "com.amazonaws.transfer#ProfileType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LOCAL", + "name": "LOCAL" + }, + { + "value": "PARTNER", + "name": "PARTNER" + } + ] + } + }, "com.amazonaws.transfer#Protocol": { "type": "string", "traits": { @@ -3218,6 +5045,10 @@ { "value": "FTPS", "name": "FTPS" + }, + { + "value": "AS2", + "name": "AS2" } ] } @@ -3242,6 +5073,12 @@ "traits": { "smithy.api#documentation": "Use the SetStatOption to ignore the error that is generated when the client attempts to use SETSTAT on a file you are uploading to an S3 bucket.
Some SFTP file transfer clients can attempt to change the attributes of remote files, including timestamp and permissions, using commands, such as SETSTAT when uploading the file.\n However, these commands are not compatible with object storage systems, such as Amazon S3. Due to this incompatibility, file uploads from these clients can result in errors even when \n the file is otherwise successfully uploaded.
Set the value to ENABLE_NO_OP to have the Transfer Family server ignore the SETSTAT command, and upload files without needing to make any changes to your SFTP client.\n While the SetStatOption \n ENABLE_NO_OP setting ignores the error, it does generate a log entry in Amazon CloudWatch Logs, so you can determine when the client is making a SETSTAT call.
If you want to preserve the original timestamp for your file, and modify other file attributes using SETSTAT, you can use Amazon EFS as backend storage with Transfer Family.
Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
" + } } }, "traits": { @@ -3256,7 +5093,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 3 + "max": 4 } } }, @@ -3370,7 +5207,7 @@ "Key": { "target": "com.amazonaws.transfer#S3Key", "traits": { - "smithy.api#documentation": "The name assigned to the file when it was created in S3. You use the object key to retrieve the object.
" + "smithy.api#documentation": "The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.
" } }, "VersionId": { @@ -3387,7 +5224,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the details for the file location for the file being used in the workflow. Only applicable if you are using S3 storage.
" + "smithy.api#documentation": "Specifies the details for the file location for the file that's being used in the workflow. Only applicable if you are using S3 storage.
" } }, "com.amazonaws.transfer#S3InputFileLocation": { @@ -3402,7 +5239,7 @@ "Key": { "target": "com.amazonaws.transfer#S3Key", "traits": { - "smithy.api#documentation": "The name assigned to the file when it was created in S3. You use the object key to retrieve the object.
" + "smithy.api#documentation": "The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.
" } } }, @@ -3637,7 +5474,7 @@ } }, "traits": { - "smithy.api#documentation": "A container object for the session details associated with a workflow.
" + "smithy.api#documentation": "A container object for the session details that are associated with a workflow.
" } }, "com.amazonaws.transfer#ServiceUnavailableException": { @@ -3682,6 +5519,33 @@ ] } }, + "com.amazonaws.transfer#SigningAlg": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SHA256", + "name": "SHA256" + }, + { + "value": "SHA384", + "name": "SHA384" + }, + { + "value": "SHA512", + "name": "SHA512" + }, + { + "value": "SHA1", + "name": "SHA1" + }, + { + "value": "NONE", + "name": "NONE" + } + ] + } + }, "com.amazonaws.transfer#SourceFileLocation": { "type": "string", "traits": { @@ -3768,6 +5632,66 @@ } } }, + "com.amazonaws.transfer#StartFileTransfer": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#StartFileTransferRequest" + }, + "output": { + "target": "com.amazonaws.transfer#StartFileTransferResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.transfer#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Begins an outbound file transfer. You specify the ConnectorId and the file\n paths for where to send the files.
The unique identifier for the connector.
", + "smithy.api#required": {} + } + }, + "SendFilePaths": { + "target": "com.amazonaws.transfer#FilePaths", + "traits": { + "smithy.api#documentation": "An array of strings. Each string represents the absolute path for one outbound file transfer. For example,\n \n DOC-EXAMPLE-BUCKET/myfile.txt\n .
Returns the unique identifier for this file transfer.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.transfer#StartServer": { "type": "operation", "input": { @@ -3879,7 +5803,7 @@ } ], "traits": { - "smithy.api#documentation": "Changes the state of a file transfer protocol-enabled server from ONLINE to\n OFFLINE. An OFFLINE server cannot accept and process file transfer\n jobs. Information tied to your server, such as server and user properties, are not affected by\n stopping your server.
Stopping the server will not reduce or impact your file transfer protocol endpoint\n billing; you must delete the server to stop being billed.
\nThe state of STOPPING indicates that the server is in an intermediate state,\n either not fully able to respond, or not fully offline. The values of STOP_FAILED\n can indicate an error condition.
No response is returned from this call.
" + "smithy.api#documentation": "Changes the state of a file transfer protocol-enabled server from ONLINE to\n OFFLINE. An OFFLINE server cannot accept and process file transfer\n jobs. Information tied to your server, such as server and user properties, are not affected by\n stopping your server.
Stopping the server does not reduce or impact your file transfer protocol endpoint\n billing; you must delete the server to stop being billed.
\nThe state of STOPPING indicates that the server is in an intermediate state,\n either not fully able to respond, or not fully offline. The values of STOP_FAILED\n can indicate an error condition.
No response is returned from this call.
" } }, "com.amazonaws.transfer#StopServerRequest": { @@ -4167,6 +6091,16 @@ ] } }, + "com.amazonaws.transfer#TransferId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[0-9a-zA-Z./-]+$" + } + }, "com.amazonaws.transfer#TransferService": { "type": "service", "traits": { @@ -4181,13 +6115,22 @@ "name": "transfer" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Web Services Transfer Family is a fully managed service that enables the transfer of files over the\n File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH)\n File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon\n S3). Amazon Web Services helps you seamlessly migrate your file transfer workflows to Amazon Web Services Transfer Family by\n integrating with existing authentication systems, and providing DNS routing with Amazon Route\n 53 so nothing changes for your customers and partners, or their applications. With your data\n in Amazon S3, you can use it with Amazon Web Services services for processing, analytics, machine learning,\n and archiving. Getting started with Amazon Web Services Transfer Family is easy since there is no\n infrastructure to buy and set up.
", + "smithy.api#documentation": "Transfer Family is a fully managed service that enables the transfer of files over the File\n Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File\n Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3).\n Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating\n with existing authentication systems, and providing DNS routing with Amazon Route 53 so\n nothing changes for your customers and partners, or their applications. With your data in\n Amazon S3, you can use it with Amazon Web Services for processing, analytics, machine learning, and\n archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and\n set up.
", "smithy.api#title": "AWS Transfer Family" }, "version": "2018-11-05", "operations": [ { - "target": "com.amazonaws.transfer#CreateAccess" + "target": "com.amazonaws.transfer#CreateAccess" + }, + { + "target": "com.amazonaws.transfer#CreateAgreement" + }, + { + "target": "com.amazonaws.transfer#CreateConnector" + }, + { + "target": "com.amazonaws.transfer#CreateProfile" }, { "target": "com.amazonaws.transfer#CreateServer" @@ -4201,6 +6144,18 @@ { "target": "com.amazonaws.transfer#DeleteAccess" }, + { + "target": "com.amazonaws.transfer#DeleteAgreement" + }, + { + "target": "com.amazonaws.transfer#DeleteCertificate" + }, + { + "target": "com.amazonaws.transfer#DeleteConnector" + }, + { + "target": "com.amazonaws.transfer#DeleteProfile" + }, { "target": "com.amazonaws.transfer#DeleteServer" }, @@ -4216,9 +6171,21 @@ { "target": "com.amazonaws.transfer#DescribeAccess" }, + { + "target": "com.amazonaws.transfer#DescribeAgreement" + }, + { + "target": "com.amazonaws.transfer#DescribeCertificate" + }, + { + "target": "com.amazonaws.transfer#DescribeConnector" + }, { "target": "com.amazonaws.transfer#DescribeExecution" }, + { + "target": "com.amazonaws.transfer#DescribeProfile" + }, { "target": "com.amazonaws.transfer#DescribeSecurityPolicy" }, @@ -4231,15 +6198,30 @@ { "target": "com.amazonaws.transfer#DescribeWorkflow" }, + { + "target": "com.amazonaws.transfer#ImportCertificate" + }, { "target": "com.amazonaws.transfer#ImportSshPublicKey" }, { "target": "com.amazonaws.transfer#ListAccesses" }, + { + "target": "com.amazonaws.transfer#ListAgreements" + }, + { + "target": "com.amazonaws.transfer#ListCertificates" + }, + { + "target": "com.amazonaws.transfer#ListConnectors" + }, { "target": "com.amazonaws.transfer#ListExecutions" }, + { + "target": "com.amazonaws.transfer#ListProfiles" + }, { "target": "com.amazonaws.transfer#ListSecurityPolicies" }, @@ -4258,6 +6240,9 @@ { "target": "com.amazonaws.transfer#SendWorkflowStepState" }, + { + "target": "com.amazonaws.transfer#StartFileTransfer" + }, { "target": "com.amazonaws.transfer#StartServer" }, @@ -4276,6 +6261,18 @@ { "target": "com.amazonaws.transfer#UpdateAccess" }, + { + "target": "com.amazonaws.transfer#UpdateAgreement" + }, + { + "target": "com.amazonaws.transfer#UpdateCertificate" + }, + { + "target": "com.amazonaws.transfer#UpdateConnector" + }, + { + "target": "com.amazonaws.transfer#UpdateProfile" + }, { "target": "com.amazonaws.transfer#UpdateServer" }, @@ -4370,19 +6367,19 @@ "HomeDirectoryType": { "target": "com.amazonaws.transfer#HomeDirectoryType", "traits": { - "smithy.api#documentation": "The type of landing directory (folder) you want your users' home directory to be when they log into the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.\n If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon\n S3 or EFS paths visible to your users.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer \n protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.
The following is an Entry and Target pair example.
\n [ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the\n HomeDirectory parameter value.
The following is an Entry and Target pair example for chroot.
\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) \n role provides access to paths in Target. This value\n can be set only when HomeDirectoryType is set to\n LOGICAL.
The following is an Entry and Target pair example.
\n [ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the\n HomeDirectory parameter value.
The following is an Entry and Target pair example for chroot.
\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
This only applies when the domain of ServerId is S3. EFS does not use session policies.
For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead\n of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass\n it in the Policy argument.
For an example of a session policy, see Example\n session policy.
\nFor more information, see AssumeRole in the Amazon Web ServicesSecurity Token Service API\n Reference.
\nA session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies.
For session policies, Transfer Family stores the policy as a JSON blob, instead\n of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass\n it in the Policy argument.
For an example of a session policy, see Example\n session policy.
\nFor more information, see AssumeRole in the Amazon Web ServicesSecurity Token Service API\n Reference.
\nSpecifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS\n file system. The policies attached to this role determine the level of access that you want to provide your users when transferring\n files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the\n server to access your resources when servicing your users' transfer requests.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 \n bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users \n when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust \n relationship that allows the server to access your resources when servicing your users' transfer requests.
" } }, "ServerId": { @@ -4404,7 +6401,7 @@ "ExternalId": { "target": "com.amazonaws.transfer#ExternalId", "traits": { - "smithy.api#documentation": "A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.
\n\n\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n
In that command, replace YourGroupName with the name of your Active Directory group.
\n\nThe regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-
", + "smithy.api#documentation": "A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.
\n\n\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n
In that command, replace YourGroupName with the name of your Active Directory group.
\n\nThe regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-
", "smithy.api#required": {} } } @@ -4429,6 +6426,303 @@ } } }, + "com.amazonaws.transfer#UpdateAgreement": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#UpdateAgreementRequest" + }, + "output": { + "target": "com.amazonaws.transfer#UpdateAgreementResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ResourceExistsException" + }, + { + "target": "com.amazonaws.transfer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Updates some of the parameters for an existing agreement. Provide the\n AgreementId and the ServerId for the agreement that you want to\n update, along with the new values for the parameters to update.
A unique identifier for the agreement. This identifier is returned when you create an agreement.
", + "smithy.api#required": {} + } + }, + "ServerId": { + "target": "com.amazonaws.transfer#ServerId", + "traits": { + "smithy.api#documentation": "A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.transfer#Description", + "traits": { + "smithy.api#documentation": "To replace the existing description, provide a short description for the agreement.
" + } + }, + "Status": { + "target": "com.amazonaws.transfer#AgreementStatusType", + "traits": { + "smithy.api#documentation": "You can update the status for the agreement, either activating an inactive agreement or\n the reverse.
" + } + }, + "LocalProfileId": { + "target": "com.amazonaws.transfer#ProfileId", + "traits": { + "smithy.api#documentation": "To change the local profile identifier, provide a new value\n here.
" + } + }, + "PartnerProfileId": { + "target": "com.amazonaws.transfer#ProfileId", + "traits": { + "smithy.api#documentation": "To change the partner profile identifier, provide a new value here.
" + } + }, + "BaseDirectory": { + "target": "com.amazonaws.transfer#HomeDirectory", + "traits": { + "smithy.api#documentation": "To change the landing directory (folder) for files that are transferred, provide the\n bucket folder that you want to use; for example,\n /DOC-EXAMPLE-BUCKET/home/mydirectory\n .
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the \n HomeDirectory of your users' Amazon S3 buckets.
A unique identifier for the agreement. This identifier is returned when you create an agreement.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transfer#UpdateCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#UpdateCertificateRequest" + }, + "output": { + "target": "com.amazonaws.transfer#UpdateCertificateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the active and inactive dates for a certificate.
" + } + }, + "com.amazonaws.transfer#UpdateCertificateRequest": { + "type": "structure", + "members": { + "CertificateId": { + "target": "com.amazonaws.transfer#CertificateId", + "traits": { + "smithy.api#documentation": "The identifier of the certificate object that you are updating.
", + "smithy.api#required": {} + } + }, + "ActiveDate": { + "target": "com.amazonaws.transfer#CertDate", + "traits": { + "smithy.api#documentation": "An optional date that specifies when the certificate becomes active.
" + } + }, + "InactiveDate": { + "target": "com.amazonaws.transfer#CertDate", + "traits": { + "smithy.api#documentation": "An optional date that specifies when the certificate becomes inactive.
" + } + }, + "Description": { + "target": "com.amazonaws.transfer#Description", + "traits": { + "smithy.api#documentation": "A short description to help identify the certificate.
" + } + } + } + }, + "com.amazonaws.transfer#UpdateCertificateResponse": { + "type": "structure", + "members": { + "CertificateId": { + "target": "com.amazonaws.transfer#CertificateId", + "traits": { + "smithy.api#documentation": "Returns the identifier of the certificate object that you are updating.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transfer#UpdateConnector": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#UpdateConnectorRequest" + }, + "output": { + "target": "com.amazonaws.transfer#UpdateConnectorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ResourceExistsException" + }, + { + "target": "com.amazonaws.transfer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Updates some of the parameters for an existing connector. Provide the\n ConnectorId for the connector that you want to update, along with the new\n values for the parameters to update.
The unique identifier for the connector.
", + "smithy.api#required": {} + } + }, + "Url": { + "target": "com.amazonaws.transfer#Url", + "traits": { + "smithy.api#documentation": "The URL of the partner's AS2 endpoint.
" + } + }, + "As2Config": { + "target": "com.amazonaws.transfer#As2ConnectorConfig", + "traits": { + "smithy.api#documentation": "A structure that contains the parameters for a connector object.
" + } + }, + "AccessRole": { + "target": "com.amazonaws.transfer#Role", + "traits": { + "smithy.api#documentation": "With AS2, you can send files by calling StartFileTransfer and specifying the\n file paths in the request parameter, SendFilePaths. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt, parent\n directory is /bucket/dir/) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer.
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn\n on CloudWatch logging for Amazon S3 events. When set, you can view connector\n activity in your CloudWatch logs.
" + } + } + } + }, + "com.amazonaws.transfer#UpdateConnectorResponse": { + "type": "structure", + "members": { + "ConnectorId": { + "target": "com.amazonaws.transfer#ConnectorId", + "traits": { + "smithy.api#documentation": "Returns the identifier of the connector object that you are updating.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transfer#UpdateProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#UpdateProfileRequest" + }, + "output": { + "target": "com.amazonaws.transfer#UpdateProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Updates some of the parameters for an existing profile. Provide the ProfileId\n for the profile that you want to update, along with the new values for the parameters to\n update.
The identifier of the profile object that you are updating.
", + "smithy.api#required": {} + } + }, + "CertificateIds": { + "target": "com.amazonaws.transfer#CertificateIds", + "traits": { + "smithy.api#documentation": "An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
" + } + } + } + }, + "com.amazonaws.transfer#UpdateProfileResponse": { + "type": "structure", + "members": { + "ProfileId": { + "target": "com.amazonaws.transfer#ProfileId", + "traits": { + "smithy.api#documentation": "Returns the identifier for the profile that's being updated.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.transfer#UpdateServer": { "type": "operation", "input": { @@ -4479,13 +6773,13 @@ "ProtocolDetails": { "target": "com.amazonaws.transfer#ProtocolDetails", "traits": { - "smithy.api#documentation": "The protocol settings that are configured for your server.
\n\n Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols).\n Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.\n
Use the SetStatOption to ignore the error that is generated when the client attempts to use SETSTAT on a file you are uploading to an S3 bucket.\n Set the value to ENABLE_NO_OP to have the Transfer Family server ignore the SETSTAT command, and upload files without needing to make any changes to your SFTP client.\n Note that with SetStatOption set to ENABLE_NO_OP, Transfer generates a log entry to CloudWatch Logs, so you can determine when the client\n is making a SETSTAT call.
Use the TlsSessionResumptionMode parameter to determine whether or not your Transfer server\n resumes recent, negotiated sessions through a unique session ID.
The protocol settings that are configured for your server.
\n\n To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp parameter.\n Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.\n
To ignore the error that is generated when the client attempts to use the SETSTAT command on a file that you are \n uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer Family server ignore the \n SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to \n ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family \n generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT \n call.
To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the \n TlsSessionResumptionMode parameter.
\n As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
The virtual private cloud (VPC) endpoint settings that are configured for your server.\n When you host your endpoint within your VPC, you can make it accessible only to resources\n within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over\n the internet. Your VPC's default security groups are automatically assigned to your\n endpoint.
" + "smithy.api#documentation": "The virtual private cloud (VPC) endpoint settings that are configured for your server.\n When you host your endpoint within your VPC, you can make your endpoint accessible only to resources\n within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over\n the internet. Your VPC's default security groups are automatically assigned to your\n endpoint.
" } }, "EndpointType": { @@ -4497,7 +6791,7 @@ "HostKey": { "target": "com.amazonaws.transfer#HostKey", "traits": { - "smithy.api#documentation": "The RSA, ECDSA, or ED25519 private key to use for your server.
\n \nUse the following command to generate an RSA 2048 bit key with no passphrase:
\n\n ssh-keygen -t rsa -b 2048 -N \"\" -m PEM -f my-new-server-key.
Use a minimum value of 2048 for the -b option: you can create a stronger key using 3072 or 4096.
Use the following command to generate an ECDSA 256 bit key with no passphrase:
\n\n ssh-keygen -t ecdsa -b 256 -N \"\" -m PEM -f my-new-server-key.
Valid values for the -b option for ECDSA are 256, 384, and 521.
Use the following command to generate an ED25519 key with no passphrase:
\n\n ssh-keygen -t ed25519 -N \"\" -f my-new-server-key.
For all of these commands, you can replace my-new-server-key with a string of your choice.
\n\nIf you aren't planning to migrate existing users from an existing SFTP-enabled\n server to a new server, don't update the host key. Accidentally changing a\n server's host key can be disruptive.
\nFor more information, see Change the host key for your SFTP-enabled server in the Amazon Web Services Transfer\n Family User Guide.
" + "smithy.api#documentation": "The RSA, ECDSA, or ED25519 private key to use for your server.
\n \nUse the following command to generate an RSA 2048 bit key with no passphrase:
\n\n ssh-keygen -t rsa -b 2048 -N \"\" -m PEM -f my-new-server-key.
Use a minimum value of 2048 for the -b option. You can create a stronger key by using 3072 or 4096.
Use the following command to generate an ECDSA 256 bit key with no passphrase:
\n\n ssh-keygen -t ecdsa -b 256 -N \"\" -m PEM -f my-new-server-key.
Valid values for the -b option for ECDSA are 256, 384, and 521.
Use the following command to generate an ED25519 key with no passphrase:
\n\n ssh-keygen -t ed25519 -N \"\" -f my-new-server-key.
For all of these commands, you can replace my-new-server-key with a string of your choice.
\n\nIf you aren't planning to migrate existing users from an existing SFTP-enabled\n server to a new server, don't update the host key. Accidentally changing a\n server's host key can be disruptive.
\nFor more information, see Change the host key for your SFTP-enabled server in the Transfer Family User Guide.
" } }, "IdentityProviderDetails": { @@ -4509,19 +6803,19 @@ "LoggingRole": { "target": "com.amazonaws.transfer#NullableRole", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in\n your CloudWatch logs.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in\n your CloudWatch logs.
" } }, "PostAuthenticationLoginBanner": { "target": "com.amazonaws.transfer#PostAuthenticationLoginBanner", "traits": { - "smithy.api#documentation": "Specify a string to display when users connect to a server. This string is displayed after the user authenticates.
\nThe SFTP protocol does not support post-authentication display banners.
\nSpecifies a string to display when users connect to a server. This string is displayed after the user authenticates.
\nThe SFTP protocol does not support post-authentication display banners.
\nSpecify a string to display when users connect to a server. This string is displayed before the user authenticates.\n For example, the following banner displays details about using the system.
\n\n This system is for the use of authorized users only. Individuals using this computer system without authority,\n or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by\n system personnel.\n
Specifies a string to display when users connect to a server. This string is displayed before the user authenticates.\n For example, the following banner displays details about using the system:
\n \n\n This system is for the use of authorized users only. Individuals using this computer system without authority,\n or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by\n system personnel.\n
Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
\nTo remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.
\n aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{\"OnUpload\":[]}'\n
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
\nTo remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.
\n aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{\"OnUpload\":[]}'\n
The type of landing directory (folder) you want your users' home directory to be when they log into the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.\n If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon\n S3 or EFS paths visible to your users.
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer \n protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.
The following is an Entry and Target pair example.
\n [ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to '/' and set Target to the HomeDirectory\n parameter value.
The following is an Entry and Target pair example for chroot.
\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) \n role provides access to paths in Target. This value\n can be set only when HomeDirectoryType is set to\n LOGICAL.
The following is an Entry and Target pair example.
\n [ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to '/' and set Target to the HomeDirectory\n parameter value.
The following is an Entry and Target pair example for chroot.
\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n
A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
This only applies when the domain of ServerId is S3. EFS does not use session policies.
For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead\n of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass\n it in the Policy argument.
For an example of a session policy, see Creating a session\n policy.
\n\n \n\nFor more information, see AssumeRole in the Amazon Web Services\n Security Token Service API Reference.
\nA session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies.
For session policies, Transfer Family stores the policy as a JSON blob, instead\n of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass\n it in the Policy argument.
For an example of a session policy, see Creating a session\n policy.
\n\n \n\nFor more information, see AssumeRole in the Amazon Web Services\n Security Token Service API Reference.
\nSpecifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS\n file system. The policies attached to this role determine the level of access that you want to provide your users when transferring\n files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the\n server to access your resources when servicing your users' transfer requests.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 \n bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users \n when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust \n relationship that allows the server to access your resources when servicing your users' transfer requests.
" } }, "ServerId": { @@ -4774,7 +7068,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
" + "smithy.api#documentation": "Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
" } }, "com.amazonaws.transfer#WorkflowDetails": { @@ -4808,7 +7102,7 @@ "Type": { "target": "com.amazonaws.transfer#WorkflowStepType", "traits": { - "smithy.api#documentation": "\n Currently, the following step types are supported.\n
\n\n COPY: copy the file to another location
\n\n CUSTOM: custom step with a lambda target
\n\n DELETE: delete the file
\n\n TAG: add a tag to the file
\n\n Currently, the following step types are supported.\n
\n\n COPY: Copy the file to another location.
\n\n CUSTOM: Perform a custom step with an Lambda function target.
\n\n DELETE: Delete the file.
\n\n TAG: Add a tag to the file.
\nCreates a new WorkSpace image from an existing WorkSpace.
" + } + }, + "com.amazonaws.workspaces#CreateWorkspaceImageRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.workspaces#WorkspaceImageName", + "traits": { + "smithy.api#documentation": "The name of the new WorkSpace image.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.workspaces#WorkspaceImageDescription", + "traits": { + "smithy.api#documentation": "The description of the new WorkSpace image.
", + "smithy.api#required": {} + } + }, + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "The identifier of the source WorkSpace
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.workspaces#TagList", + "traits": { + "smithy.api#documentation": "The tags that you want to add to the new WorkSpace image. \n To add tags when you're creating the image, you must create an IAM policy that grants \n your IAM user permission to use workspaces:CreateTags.
The identifier of the new WorkSpace image.
" + } + }, + "Name": { + "target": "com.amazonaws.workspaces#WorkspaceImageName", + "traits": { + "smithy.api#documentation": "The name of the image.
" + } + }, + "Description": { + "target": "com.amazonaws.workspaces#WorkspaceImageDescription", + "traits": { + "smithy.api#documentation": "The description of the image.
" + } + }, + "OperatingSystem": { + "target": "com.amazonaws.workspaces#OperatingSystem", + "traits": { + "smithy.api#documentation": "The operating system that the image is running.
" + } + }, + "State": { + "target": "com.amazonaws.workspaces#WorkspaceImageState", + "traits": { + "smithy.api#documentation": "The availability status of the image.
" + } + }, + "RequiredTenancy": { + "target": "com.amazonaws.workspaces#WorkspaceImageRequiredTenancy", + "traits": { + "smithy.api#documentation": "Specifies whether the image is running on dedicated hardware. \n When Bring Your Own License (BYOL) is enabled, this value is set \n to DEDICATED. For more information, see \n \n Bring Your Own Windows Desktop Images.\n
" + } + }, + "Created": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "The date when the image was created.
" + } + }, + "OwnerAccountId": { + "target": "com.amazonaws.workspaces#AwsAccount", + "traits": { + "smithy.api#documentation": "The identifier of the AWS account that owns the image.
" + } + } + } + }, "com.amazonaws.workspaces#CreateWorkspaces": { "type": "operation", "input": { @@ -1440,7 +1560,7 @@ "LogoUrl": { "target": "com.amazonaws.workspaces#ClientUrl", "traits": { - "smithy.api#documentation": "The logo URL. The only image \n format accepted is a binary data object that is converted from a .png file.
The logo. The only image format accepted is a binary data object that is converted from a .png file.
The login message. Specified as a key value pair, in which the key is a locale and the\n value is the localized message for that locale. The only key supported is\n en_US.
The login message. Specified as a key value pair, in which the key is a locale and the\n value is the localized message for that locale. The only key supported is\n en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, \n i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.
The logo. The only image \n format accepted is a binary data object that is converted from a .png file.
The logo. The only image format accepted is a binary data object that is converted from a .png file.
The login message. Specified as a key value pair, in which the key is a locale and the\n value is the localized message for that locale. The only key supported is\n en_US.
The login message. Specified as a key value pair, in which the key is a locale and the\n value is the localized message for that locale. The only key supported is\n en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, \n i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.
The logo. This is the\n standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal\n to one point. The only image format accepted is a binary data object that is converted from \n a .png file.
The logo. This is the standard-resolution display that has a 1:1 pixel density \n (or @1x), where one pixel is equal\n to one point. The only image format accepted is a binary data object that is converted from \n a .png file.
The login message. Specified as a key value pair, in which the key is a locale and the\n value is the localized message for that locale. The only key supported is\n en_US.
The login message. Specified as a key value pair, in which the key is a locale and the\n value is the localized message for that locale. The only key supported is\n en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, \n i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.
The login message. Specified as a key value pair, in which the key is a locale and the\n value is the localized message for that locale. The only key supported is\n en_US.
The login message. Specified as a key value pair, in which the key is a locale and the\n value is the localized message for that locale. The only key supported is\n en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, \n i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.