The ARN of the resource that was analyzed.
" }, + "resourceOwnerAccount":{ + "shape":"String", + "documentation":"The AWS account ID that owns the resource.
" + }, "resourceType":{ "shape":"ResourceType", "documentation":"The type of the resource that was analyzed.
" @@ -416,6 +421,7 @@ "type":"structure", "required":[ "resourceArn", + "resourceOwnerAccount", "resourceType" ], "members":{ @@ -423,6 +429,10 @@ "shape":"ResourceArn", "documentation":"The ARN of the analyzed resource.
" }, + "resourceOwnerAccount":{ + "shape":"String", + "documentation":"The AWS account ID that owns the resource.
" + }, "resourceType":{ "shape":"ResourceType", "documentation":"The type of resource that was analyzed.
" @@ -438,12 +448,22 @@ "type":"string", "pattern":"^[^:]*:[^:]*:[^:]*:[^:]*:[^:]*:analyzer/.{1,255}$" }, + "AnalyzerStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "CREATING", + "DISABLED", + "FAILED" + ] + }, "AnalyzerSummary":{ "type":"structure", "required":[ "arn", "createdAt", "name", + "status", "type" ], "members":{ @@ -467,6 +487,14 @@ "shape":"Name", "documentation":"The name of the analyzer.
" }, + "status":{ + "shape":"AnalyzerStatus", + "documentation":"The status of the analyzer. An Active analyzer successfully monitors supported resources and generates new findings. The analyzer is Disabled when a user action, such as removing trusted access for IAM Access Analyzer from AWS Organizations, causes the analyzer to stop generating new findings. The status is Creating when the analyzer creation is in progress and Failed when the analyzer creation has failed.
The statusReason provides more details about the current status of the analyzer. For example, if the creation for the analyzer fails, a Failed status is displayed. For an analyzer with organization as the type, this failure can be due to an issue with creating the service-linked roles required in the member accounts of the AWS organization.
The tags added to the analyzer.
" @@ -702,6 +730,7 @@ "condition", "createdAt", "id", + "resourceOwnerAccount", "resourceType", "status", "updatedAt" @@ -743,6 +772,10 @@ "shape":"String", "documentation":"The resource that an external principal has access to.
" }, + "resourceOwnerAccount":{ + "shape":"String", + "documentation":"The AWS account ID that owns the resource.
" + }, "resourceType":{ "shape":"ResourceType", "documentation":"The type of the resource reported in the finding.
" @@ -785,6 +818,7 @@ "condition", "createdAt", "id", + "resourceOwnerAccount", "resourceType", "status", "updatedAt" @@ -826,6 +860,10 @@ "shape":"String", "documentation":"The resource that the external principal has access to.
" }, + "resourceOwnerAccount":{ + "shape":"String", + "documentation":"The AWS account ID that owns the resource.
" + }, "resourceType":{ "shape":"ResourceType", "documentation":"The type of the resource that the external principal has access to.
" @@ -1206,6 +1244,15 @@ "key":{"shape":"String"}, "value":{"shape":"String"} }, + "ReasonCode":{ + "type":"string", + "enum":[ + "AWS_SERVICE_ACCESS_DISABLED", + "DELEGATED_ADMINISTRATOR_DEREGISTERED", + "ORGANIZATION_DELETED", + "SERVICE_LINKED_ROLE_CREATION_FAILED" + ] + }, "ResourceArn":{ "type":"string", "pattern":"arn:[^:]*:[^:]*:[^:]*:[^:]*:.*$" @@ -1307,6 +1354,17 @@ }, "documentation":"Starts a scan of the policies applied to the specified resource.
" }, + "StatusReason":{ + "type":"structure", + "required":["code"], + "members":{ + "code":{ + "shape":"ReasonCode", + "documentation":"The reason code for the current status of the analyzer.
" + } + }, + "documentation":"Provides more details about the current status of the analyzer. For example, if the creation for the analyzer fails, a Failed status is displayed. For an analyzer with organization as the type, this failure can be due to an issue with creating the service-linked roles required in the member accounts of the AWS organization.
The ARN of the CloudWatch Logs log group to receive access logs.
" + "documentation":"The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-.
Access log settings, including the access log format and access log destination ARN.
" @@ -2364,7 +2364,7 @@ }, "generateDistinctId":{ "shape":"Boolean", - "documentation":"Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.
Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
The name of the API's stage that you want to use for this mapping. Specify '(none)' if you do not want callers to explicitly specify the stage name after any base path name.
" + "documentation":"The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name.
" } }, "documentation":"Requests API Gateway to create a new BasePathMapping resource.
" @@ -2877,7 +2877,7 @@ }, "targetArns":{ "shape":"ListOfString", - "documentation":"[Required] The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.
" + "documentation":"[Required] The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.
" }, "tags":{ "shape":"MapOfStringToString", @@ -4693,7 +4693,7 @@ "members":{ "resourceArn":{ "shape":"String", - "documentation":"[Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.
", + "documentation":"[Required] The ARN of a resource that can be tagged.
", "location":"uri", "locationName":"resource_arn" }, @@ -5321,7 +5321,7 @@ }, "loggingLevel":{ "shape":"String", - "documentation":"Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO.
Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.
[Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.
", + "documentation":"[Required] The ARN of a resource that can be tagged.
", "location":"uri", "locationName":"resource_arn" }, @@ -6408,7 +6408,7 @@ "members":{ "resourceArn":{ "shape":"String", - "documentation":"[Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.
", + "documentation":"[Required] The ARN of a resource that can be tagged.
", "location":"uri", "locationName":"resource_arn" }, @@ -7090,7 +7090,7 @@ }, "targetArns":{ "shape":"ListOfString", - "documentation":"The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.
" + "documentation":"The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.
" }, "status":{ "shape":"VpcLinkStatus", @@ -7105,7 +7105,7 @@ "documentation":"The collection of tags. Each tag element is associated with a given resource.
" } }, - "documentation":"A API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a VpcLink resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the VpcLink. The private integration has an integration type of HTTP or HTTP_PROXY and has a connection type of VPC_LINK. The integration uses the connectionId property to identify the VpcLink used.
An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a VpcLink resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the VpcLink. The private integration has an integration type of HTTP or HTTP_PROXY and has a connection type of VPC_LINK. The integration uses the connectionId property to identify the VpcLink used.
Deletes a VPC link.
" }, + "ExportApi" : { + "name" : "ExportApi", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/exports/{specification}", + "responseCode" : 200 + }, + "input" : { + "shape" : "ExportApiRequest" + }, + "output" : { + "shape" : "ExportApiResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + } ] + }, "GetApi" : { "name" : "GetApi", "http" : { @@ -2735,7 +2760,7 @@ "IntegrationUri" : { "shape" : "UriWithLengthBetween1And2048", "locationName" : "integrationUri", - "documentation" : "For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
" + "documentation" : "For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
" }, "PassthroughBehavior" : { "shape" : "PassthroughBehavior", @@ -2763,9 +2788,9 @@ "documentation" : "The template selection expression for the integration.
" }, "TimeoutInMillis" : { - "shape" : "IntegerWithLengthBetween50And29000", + "shape" : "IntegerWithLengthBetween50And30000", "locationName" : "timeoutInMillis", - "documentation" : "Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
" + "documentation" : "Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
" }, "TlsConfig" : { "shape" : "TlsConfigInput", @@ -2823,7 +2848,7 @@ "IntegrationUri" : { "shape" : "UriWithLengthBetween1And2048", "locationName" : "integrationUri", - "documentation" : "For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
" + "documentation" : "For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
" }, "PassthroughBehavior" : { "shape" : "PassthroughBehavior", @@ -2851,9 +2876,9 @@ "documentation" : "The template selection expression for the integration.
" }, "TimeoutInMillis" : { - "shape" : "IntegerWithLengthBetween50And29000", + "shape" : "IntegerWithLengthBetween50And30000", "locationName" : "timeoutInMillis", - "documentation" : "Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
" + "documentation" : "Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
" }, "TlsConfig" : { "shape" : "TlsConfigInput", @@ -2920,7 +2945,7 @@ "IntegrationUri" : { "shape" : "UriWithLengthBetween1And2048", "locationName" : "integrationUri", - "documentation" : "For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
" + "documentation" : "For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
" }, "PassthroughBehavior" : { "shape" : "PassthroughBehavior", @@ -2948,9 +2973,9 @@ "documentation" : "The template selection expression for the integration. Supported only for WebSocket APIs.
" }, "TimeoutInMillis" : { - "shape" : "IntegerWithLengthBetween50And29000", + "shape" : "IntegerWithLengthBetween50And30000", "locationName" : "timeoutInMillis", - "documentation" : "Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
" + "documentation" : "Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
" }, "TlsConfig" : { "shape" : "TlsConfig", @@ -4215,6 +4240,63 @@ "documentation" : "Represents an endpoint type.
", "enum" : [ "REGIONAL", "EDGE" ] }, + "ExportApiRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ExportVersion" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "exportVersion", + "documentation" : "The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.
" + }, + "IncludeExtensions" : { + "shape" : "__boolean", + "location" : "querystring", + "locationName" : "includeExtensions", + "documentation" : "Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.
" + }, + "OutputType" : { + "shape" : "__string", + "enum" : ["YAML", "JSON"], + "location" : "querystring", + "locationName" : "outputType", + "documentation" : "The output type of the exported definition file. Valid values are JSON and YAML.
" + }, + "Specification" : { + "shape" : "__string", + "enum" : ["OAS30"], + "location" : "uri", + "locationName" : "specification", + "documentation" : "The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.
" + }, + "StageName" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "stageName", + "documentation" : "The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.
" + } + }, + "required" : [ "Specification", "OutputType", "ApiId" ] + }, + "ExportApiResponse" : { + "type" : "structure", + "members" : { + "body":{ + "shape":"ExportedApi" + } + }, + "payload":"body" + }, + "ExportedApi":{ + "type":"blob", + "documentation" : "Represents an exported definition of an API in a particular output format, for example, YAML. The API is serialized to the requested specification, for example, OpenAPI 3.0.
" + }, "GetApiMappingRequest" : { "type" : "structure", "members" : { @@ -4758,7 +4840,7 @@ "IntegrationUri" : { "shape" : "UriWithLengthBetween1And2048", "locationName" : "integrationUri", - "documentation" : "For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
" + "documentation" : "For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
" }, "PassthroughBehavior" : { "shape" : "PassthroughBehavior", @@ -4786,9 +4868,9 @@ "documentation" : "The template selection expression for the integration. Supported only for WebSocket APIs.
" }, "TimeoutInMillis" : { - "shape" : "IntegerWithLengthBetween50And29000", + "shape" : "IntegerWithLengthBetween50And30000", "locationName" : "timeoutInMillis", - "documentation" : "Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
" + "documentation" : "Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
" }, "TlsConfig" : { "shape" : "TlsConfig", @@ -5558,7 +5640,7 @@ "shape" : "__string", "location" : "querystring", "locationName" : "basepath", - "documentation" : "Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs.
" + "documentation" : "Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs.
" }, "Body" : { "shape" : "__string", @@ -5569,7 +5651,7 @@ "shape" : "__boolean", "location" : "querystring", "locationName" : "failOnWarnings", - "documentation" : "Specifies whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.
" + "documentation" : "Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
" } }, "documentation" : "", @@ -5656,11 +5738,11 @@ "min" : 0, "max" : 3600 }, - "IntegerWithLengthBetween50And29000" : { + "IntegerWithLengthBetween50And30000" : { "type" : "integer", - "documentation" : "An integer with a value between [50-29000].
", + "documentation" : "An integer with a value between [50-30000].
", "min" : 50, - "max" : 29000 + "max" : 30000 }, "IntegerWithLengthBetweenMinus1And86400" : { "type" : "integer", @@ -5724,7 +5806,7 @@ "IntegrationUri" : { "shape" : "UriWithLengthBetween1And2048", "locationName" : "integrationUri", - "documentation" : "For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
" + "documentation" : "For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
" }, "PassthroughBehavior" : { "shape" : "PassthroughBehavior", @@ -5752,9 +5834,9 @@ "documentation" : "The template selection expression for the integration. Supported only for WebSocket APIs.
" }, "TimeoutInMillis" : { - "shape" : "IntegerWithLengthBetween50And29000", + "shape" : "IntegerWithLengthBetween50And30000", "locationName" : "timeoutInMillis", - "documentation" : "Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
" + "documentation" : "Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
" }, "TlsConfig" : { "shape" : "TlsConfig", @@ -6003,7 +6085,7 @@ "shape" : "__string", "location" : "querystring", "locationName" : "basepath", - "documentation" : "Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs.
" + "documentation" : "Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs.
" }, "Body" : { "shape" : "__string", @@ -6014,7 +6096,7 @@ "shape" : "__boolean", "location" : "querystring", "locationName" : "failOnWarnings", - "documentation" : "Specifies whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.
" + "documentation" : "Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
" } }, "documentation" : "", @@ -7176,7 +7258,7 @@ "IntegrationUri" : { "shape" : "UriWithLengthBetween1And2048", "locationName" : "integrationUri", - "documentation" : "For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
" + "documentation" : "For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
" }, "PassthroughBehavior" : { "shape" : "PassthroughBehavior", @@ -7204,9 +7286,9 @@ "documentation" : "The template selection expression for the integration.
" }, "TimeoutInMillis" : { - "shape" : "IntegerWithLengthBetween50And29000", + "shape" : "IntegerWithLengthBetween50And30000", "locationName" : "timeoutInMillis", - "documentation" : "Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
" + "documentation" : "Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
" }, "TlsConfig" : { "shape" : "TlsConfigInput", @@ -7269,7 +7351,7 @@ "IntegrationUri" : { "shape" : "UriWithLengthBetween1And2048", "locationName" : "integrationUri", - "documentation" : "For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
" + "documentation" : "For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
" }, "PassthroughBehavior" : { "shape" : "PassthroughBehavior", @@ -7297,9 +7379,9 @@ "documentation" : "The template selection expression for the integration.
" }, "TimeoutInMillis" : { - "shape" : "IntegerWithLengthBetween50And29000", + "shape" : "IntegerWithLengthBetween50And30000", "locationName" : "timeoutInMillis", - "documentation" : "Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
" + "documentation" : "Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
" }, "TlsConfig" : { "shape" : "TlsConfigInput", @@ -7366,7 +7448,7 @@ "IntegrationUri" : { "shape" : "UriWithLengthBetween1And2048", "locationName" : "integrationUri", - "documentation" : "For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
" + "documentation" : "For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
" }, "PassthroughBehavior" : { "shape" : "PassthroughBehavior", @@ -7394,9 +7476,9 @@ "documentation" : "The template selection expression for the integration. Supported only for WebSocket APIs.
" }, "TimeoutInMillis" : { - "shape" : "IntegerWithLengthBetween50And29000", + "shape" : "IntegerWithLengthBetween50And30000", "locationName" : "timeoutInMillis", - "documentation" : "Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
" + "documentation" : "Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
" }, "TlsConfig" : { "shape" : "TlsConfig", diff --git a/botocore/data/appconfig/2019-10-09/service-2.json b/botocore/data/appconfig/2019-10-09/service-2.json index c11ba4b0..e4353582 100644 --- a/botocore/data/appconfig/2019-10-09/service-2.json +++ b/botocore/data/appconfig/2019-10-09/service-2.json @@ -889,6 +889,10 @@ "shape":"DeploymentState", "documentation":"The state of the deployment.
" }, + "EventLog":{ + "shape":"DeploymentEvents", + "documentation":"A list containing all events related to a deployment. The most recent events are displayed first.
" + }, "PercentageComplete":{ "shape":"Percentage", "documentation":"The percentage of targets for which the deployment is available.
" @@ -903,6 +907,43 @@ } } }, + "DeploymentEvent":{ + "type":"structure", + "members":{ + "EventType":{ + "shape":"DeploymentEventType", + "documentation":"The type of deployment event. Deployment event types include the start, stop, or completion of a deployment; a percentage update; the start or stop of a bake period; the start or completion of a rollback.
" + }, + "TriggeredBy":{ + "shape":"TriggeredBy", + "documentation":"The entity that triggered the deployment event. Events can be triggered by a user, AWS AppConfig, an Amazon CloudWatch alarm, or an internal error.
" + }, + "Description":{ + "shape":"Description", + "documentation":"A description of the deployment event. Descriptions include, but are not limited to, the user account or the CloudWatch alarm ARN that initiated a rollback, the percentage of hosts that received the deployment, or in the case of an internal error, a recommendation to attempt a new deployment.
" + }, + "OccurredAt":{ + "shape":"Iso8601DateTime", + "documentation":"The date and time the event occurred.
" + } + }, + "documentation":"An object that describes a deployment event.
" + }, + "DeploymentEventType":{ + "type":"string", + "enum":[ + "PERCENTAGE_UPDATED", + "ROLLBACK_STARTED", + "ROLLBACK_COMPLETED", + "BAKE_TIME_STARTED", + "DEPLOYMENT_STARTED", + "DEPLOYMENT_COMPLETED" + ] + }, + "DeploymentEvents":{ + "type":"list", + "member":{"shape":"DeploymentEvent"} + }, "DeploymentList":{ "type":"list", "member":{"shape":"DeploymentSummary"} @@ -1594,6 +1635,15 @@ "type":"string", "max":256 }, + "TriggeredBy":{ + "type":"string", + "enum":[ + "USER", + "APPCONFIG", + "CLOUDWATCH_ALARM", + "INTERNAL_ERROR" + ] + }, "UntagResourceRequest":{ "type":"structure", "required":[ diff --git a/botocore/data/application-autoscaling/2016-02-06/service-2.json b/botocore/data/application-autoscaling/2016-02-06/service-2.json index 21a638e7..d2de37bf 100644 --- a/botocore/data/application-autoscaling/2016-02-06/service-2.json +++ b/botocore/data/application-autoscaling/2016-02-06/service-2.json @@ -27,7 +27,7 @@ {"shape":"ConcurrentUpdateException"}, {"shape":"InternalServiceException"} ], - "documentation":"Deletes the specified scaling policy for an Application Auto Scaling scalable target.
Deleting a step scaling policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action.
For more information, see Delete a Step Scaling Policy and Delete a Target Tracking Scaling Policy in the Application Auto Scaling User Guide.
To create a scaling policy or update an existing one, see PutScalingPolicy.
" + "documentation":"Deletes the specified scaling policy for an Application Auto Scaling scalable target.
Deleting a step scaling policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action.
For more information, see Delete a Step Scaling Policy and Delete a Target Tracking Scaling Policy in the Application Auto Scaling User Guide.
" }, "DeleteScheduledAction":{ "name":"DeleteScheduledAction", @@ -59,7 +59,7 @@ {"shape":"ConcurrentUpdateException"}, {"shape":"InternalServiceException"} ], - "documentation":"Deregisters an Application Auto Scaling scalable target.
Deregistering a scalable target deletes the scaling policies that are associated with it.
To create a scalable target or update an existing one, see RegisterScalableTarget.
" + "documentation":"Deregisters an Application Auto Scaling scalable target when you have finished using it. To see which resources have been registered, use DescribeScalableTargets.
Deregistering a scalable target deletes the scaling policies and the scheduled actions that are associated with it.
Gets information about the scalable targets in the specified namespace.
You can filter the results using ResourceIds and ScalableDimension.
To create a scalable target or update an existing one, see RegisterScalableTarget. If you are no longer using a scalable target, you can deregister it using DeregisterScalableTarget.
" + "documentation":"Gets information about the scalable targets in the specified namespace.
You can filter the results using ResourceIds and ScalableDimension.
Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.
You can filter the results using ResourceId and ScalableDimension.
Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the scaling policies for a service namespace, see DescribeScalingPolicies. To create a scaling policy or update an existing one, see PutScalingPolicy.
" + "documentation":"Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.
You can filter the results using ResourceId and ScalableDimension.
Describes the Application Auto Scaling scaling policies for the specified service namespace.
You can filter the results using ResourceId, ScalableDimension, and PolicyNames.
To create a scaling policy or update an existing one, see PutScalingPolicy. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy.
" + "documentation":"Describes the Application Auto Scaling scaling policies for the specified service namespace.
You can filter the results using ResourceId, ScalableDimension, and PolicyNames.
For more information, see Target Tracking Scaling Policies and Step Scaling Policies in the Application Auto Scaling User Guide.
" }, "DescribeScheduledActions":{ "name":"DescribeScheduledActions", @@ -124,7 +124,7 @@ {"shape":"ConcurrentUpdateException"}, {"shape":"InternalServiceException"} ], - "documentation":"Describes the Application Auto Scaling scheduled actions for the specified service namespace.
You can filter the results using the ResourceId, ScalableDimension, and ScheduledActionNames parameters.
To create a scheduled action or update an existing one, see PutScheduledAction. If you are no longer using a scheduled action, you can delete it using DeleteScheduledAction.
" + "documentation":"Describes the Application Auto Scaling scheduled actions for the specified service namespace.
You can filter the results using the ResourceId, ScalableDimension, and ScheduledActionNames parameters.
For more information, see Scheduled Scaling in the Application Auto Scaling User Guide.
" }, "PutScalingPolicy":{ "name":"PutScalingPolicy", @@ -142,7 +142,7 @@ {"shape":"FailedResourceAccessException"}, {"shape":"InternalServiceException"} ], - "documentation":"Creates or updates a policy for an Application Auto Scaling scalable target.
Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as a scalable target using RegisterScalableTarget.
To update a policy, specify its policy name and the parameters that you want to change. Any parameters that you don't specify are not changed by this update request.
You can view the scaling policies for a service namespace using DescribeScalingPolicies. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy.
Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale out and scale in. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30.
Learn more about how to work with scaling policies in the Application Auto Scaling User Guide.
" + "documentation":"Creates or updates a scaling policy for an Application Auto Scaling scalable target.
Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as a scalable target.
Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale out and scale in. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30.
For more information, see Target Tracking Scaling Policies and Step Scaling Policies in the Application Auto Scaling User Guide.
If a scalable target is deregistered, the scalable target is no longer available to execute scaling policies. Any scaling policies that were specified for the scalable target are deleted.
Creates or updates a scheduled action for an Application Auto Scaling scalable target.
Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you have registered the resource as a scalable target using RegisterScalableTarget.
To update an action, specify its name and the parameters that you want to change. If you don't specify start and end times, the old values are deleted. Any other parameters that you don't specify are not changed by this update request.
You can view the scheduled actions using DescribeScheduledActions. If you are no longer using a scheduled action, you can delete it using DeleteScheduledAction.
Learn more about how to work with scheduled actions in the Application Auto Scaling User Guide.
" + "documentation":"Creates or updates a scheduled action for an Application Auto Scaling scalable target.
Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you have registered the resource as a scalable target.
When start and end times are specified with a recurring schedule using a cron expression or rates, they form the boundaries of when the recurring action starts and stops.
To update a scheduled action, specify the parameters that you want to change. If you don't specify start and end times, the old values are deleted.
For more information, see Scheduled Scaling in the Application Auto Scaling User Guide.
If a scalable target is deregistered, the scalable target is no longer available to run scheduled actions. Any scheduled actions that were specified for the scalable target are deleted.
Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out and scale in. Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace.
When you register a new scalable target, you must specify values for minimum and maximum capacity. Application Auto Scaling will not scale capacity to values that are outside of this range.
To update a scalable target, specify the parameter that you want to change as well as the following parameters that identify the scalable target: resource ID, scalable dimension, and namespace. Any parameters that you don't specify are not changed by this update request.
After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets. You can also view the scaling policies for a service namespace by using DescribeScalableTargets.
If you no longer need a scalable target, you can deregister it by using DeregisterScalableTarget.
" + "documentation":"Registers or updates a scalable target.
A scalable target is a resource that Application Auto Scaling can scale out and scale in. Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace.
When you register a new scalable target, you must specify values for minimum and maximum capacity. Application Auto Scaling scaling policies will not scale capacity to values that are outside of this range.
After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets. You can also view the scaling policies for a service namespace by using DescribeScalableTargets. If you no longer need a scalable target, you can deregister it by using DeregisterScalableTarget.
To update a scalable target, specify the parameters that you want to change. Include the parameters that identify the scalable target: resource ID, scalable dimension, and namespace. Any parameters that you don't specify are not changed by this update request.
" } }, "shapes":{ @@ -247,7 +247,7 @@ "documentation":"The unit of the metric.
" } }, - "documentation":"Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Application Auto Scaling.
To create your customized metric specification:
Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish Custom Metrics in the Amazon CloudWatch User Guide.
Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases.
For more information about CloudWatch, see Amazon CloudWatch Concepts.
" + "documentation":"Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Application Auto Scaling.
For information about the available metrics for a service, see AWS Services That Publish CloudWatch Metrics in the Amazon CloudWatch User Guide.
To create your customized metric specification:
Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish Custom Metrics in the Amazon CloudWatch User Guide.
Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases, and increase when capacity decreases.
For more information about CloudWatch, see Amazon CloudWatch Concepts.
" }, "DeleteScalingPolicyRequest":{ "type":"structure", @@ -264,15 +264,15 @@ }, "ServiceNamespace":{ "shape":"ServiceNamespace", - "documentation":"The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet request or ECS service.
The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:
app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
Represents a predefined metric for a target tracking scaling policy to use with Application Auto Scaling.
" + "documentation":"Represents a predefined metric for a target tracking scaling policy to use with Application Auto Scaling.
Only the AWS services that you're using send metrics to Amazon CloudWatch. To determine whether a desired metric already exists by looking up its namespace and dimension using the CloudWatch metrics dashboard in the console, follow the procedure in Building Dashboards with CloudWatch in the Application Auto Scaling User Guide.
" }, "PutScalingPolicyRequest":{ "type":"structure", @@ -656,19 +658,19 @@ }, "ServiceNamespace":{ "shape":"ServiceNamespace", - "documentation":"The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
The policy type. This parameter is required if you are creating a scaling policy.
The following policy types are supported:
TargetTrackingScaling—Not supported for Amazon EMR
StepScaling—Not supported for DynamoDB, Amazon Comprehend, or AWS Lambda
For more information, see Target Tracking Scaling Policies and Step Scaling Policies in the Application Auto Scaling User Guide.
" + "documentation":"The policy type. This parameter is required if you are creating a scaling policy.
The following policy types are supported:
TargetTrackingScaling—Not supported for Amazon EMR
StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, or Amazon Keyspaces for Apache Cassandra.
For more information, see Target Tracking Scaling Policies and Step Scaling Policies in the Application Auto Scaling User Guide.
" }, "StepScalingPolicyConfiguration":{ "shape":"StepScalingPolicyConfiguration", @@ -705,35 +707,35 @@ "members":{ "ServiceNamespace":{ "shape":"ServiceNamespace", - "documentation":"The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
The schedule for this action. The following formats are supported:
At expressions - \"at(yyyy-mm-ddThh:mm:ss)\"
Rate expressions - \"rate(value unit)\"
Cron expressions - \"cron(fields)\"
At expressions are useful for one-time schedules. Specify the time, in UTC.
For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.
For more information about cron expressions, see Cron Expressions in the Amazon CloudWatch Events User Guide.
" + "documentation":"The schedule for this action. The following formats are supported:
At expressions - \"at(yyyy-mm-ddThh:mm:ss)\"
Rate expressions - \"rate(value unit)\"
Cron expressions - \"cron(fields)\"
At expressions are useful for one-time schedules. Specify the time in UTC.
For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.
For more information about cron expressions, see Cron Expressions in the Amazon CloudWatch Events User Guide.
For examples of using these expressions, see Scheduled Scaling in the Application Auto Scaling User Guide.
" }, "ScheduledActionName":{ "shape":"ScheduledActionName", - "documentation":"The name of the scheduled action.
" + "documentation":"The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target.
" }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
The date and time for the scheduled action to start.
" + "documentation":"The date and time for this scheduled action to start.
" }, "EndTime":{ "shape":"TimestampType", - "documentation":"The date and time for the scheduled action to end.
" + "documentation":"The date and time for the recurring schedule to end.
" }, "ScalableTargetAction":{ "shape":"ScalableTargetAction", - "documentation":"The new minimum and maximum capacity. You can set both values or just one. During the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
" + "documentation":"The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
" } } }, @@ -752,27 +754,27 @@ "members":{ "ServiceNamespace":{ "shape":"ServiceNamespace", - "documentation":"The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
The identifier of the resource that is associated with the scalable target. This string consists of the resource type and unique identifier.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
The identifier of the resource that is associated with the scalable target. This string consists of the resource type and unique identifier.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
The minimum value to scale to in response to a scale-in event. MinCapacity is required to register a scalable target.
The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand.
This parameter is required if you are registering a scalable target. For Lambda provisioned concurrency, the minimum value allowed is 0. For all other resources, the minimum value allowed is 1.
" }, "MaxCapacity":{ "shape":"ResourceCapacity", - "documentation":"The maximum value to scale to in response to a scale-out event. MaxCapacity is required to register a scalable target.
The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand.
This parameter is required if you are registering a scalable target.
" }, "RoleARN":{ "shape":"ResourceIdMaxLen1600", - "documentation":"Application Auto Scaling creates a service-linked role that grants it permissions to modify the scalable target on your behalf. For more information, see Service-Linked Roles for Application Auto Scaling.
For Amazon EMR, this parameter is required, and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
" + "documentation":"This parameter is required for services that do not support service-linked roles (such as Amazon EMR), and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
If the service supports service-linked roles, Application Auto Scaling uses a service-linked role, which it creates if it does not yet exist. For more information, see Application Auto Scaling IAM Roles.
" }, "SuspendedState":{ "shape":"SuspendedState", @@ -820,7 +822,9 @@ "sagemaker:variant:DesiredInstanceCount", "custom-resource:ResourceType:Property", "comprehend:document-classifier-endpoint:DesiredInferenceUnits", - "lambda:function:ProvisionedConcurrency" + "lambda:function:ProvisionedConcurrency", + "cassandra:table:ReadCapacityUnits", + "cassandra:table:WriteCapacityUnits" ] }, "ScalableTarget":{ @@ -837,15 +841,15 @@ "members":{ "ServiceNamespace":{ "shape":"ServiceNamespace", - "documentation":"The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
The namespace of the AWS service that provides the resource, or a custom-resource.
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
The minimum capacity.
" + "documentation":"The minimum capacity.
For Lambda provisioned concurrency, the minimum value allowed is 0. For all other resources, the minimum value allowed is 1.
" }, "MaxCapacity":{ "shape":"ResourceCapacity", @@ -908,15 +912,15 @@ }, "ServiceNamespace":{ "shape":"ServiceNamespace", - "documentation":"The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
The namespace of the AWS service that provides the resource, or a custom-resource.
The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
The namespace of the AWS service that provides the resource, or a custom-resource.
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
The namespace of the AWS service that provides the resource, or a custom-resource.
The schedule for this action. The following formats are supported:
At expressions - \"at(yyyy-mm-ddThh:mm:ss)\"
Rate expressions - \"rate(value unit)\"
Cron expressions - \"cron(fields)\"
At expressions are useful for one-time schedules. Specify the time, in UTC.
For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.
For more information about cron expressions, see Cron Expressions in the Amazon CloudWatch Events User Guide.
" + "documentation":"The schedule for this action. The following formats are supported:
At expressions - \"at(yyyy-mm-ddThh:mm:ss)\"
Rate expressions - \"rate(value unit)\"
Cron expressions - \"cron(fields)\"
At expressions are useful for one-time schedules. Specify the time in UTC.
For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.
For more information about cron expressions, see Cron Expressions in the Amazon CloudWatch Events User Guide.
For examples of using these expressions, see Scheduled Scaling in the Application Auto Scaling User Guide.
" }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
The new minimum and maximum capacity. You can set both values or just one. During the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
" + "documentation":"The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
" }, "CreationTime":{ "shape":"TimestampType", @@ -1097,7 +1101,8 @@ "sagemaker", "custom-resource", "comprehend", - "lambda" + "lambda", + "cassandra" ] }, "StepAdjustment":{ @@ -1114,10 +1119,10 @@ }, "ScalingAdjustment":{ "shape":"ScalingAdjustment", - "documentation":"The amount by which to scale, based on the specified adjustment type. A positive value adds to the current scalable dimension while a negative number removes from the current scalable dimension.
" + "documentation":"The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
" } }, - "documentation":"Represents a step adjustment for a StepScalingPolicyConfiguration. Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm.
For the following examples, suppose that you have an alarm with a breach threshold of 50:
To trigger the adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.
To trigger the adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.
There are a few rules for the step adjustments for your step policy:
The ranges of your step adjustments can't overlap or have a gap.
At most one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.
At most one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.
The upper and lower bound can't be null in the same step adjustment.
Represents a step adjustment for a StepScalingPolicyConfiguration. Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm.
For the following examples, suppose that you have an alarm with a breach threshold of 50:
To trigger the adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.
To trigger the adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.
There are a few rules for the step adjustments for your step policy:
The ranges of your step adjustments can't overlap or have a gap.
At most one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.
At most one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.
The upper and lower bound can't be null in the same step adjustment.
Specifies whether the ScalingAdjustment value in a StepAdjustment is an absolute number or a percentage of the current capacity.
Specifies whether the ScalingAdjustment value in a StepAdjustment is an absolute number or a percentage of the current capacity.
AdjustmentType is required if you are adding a new step scaling policy configuration.
A set of adjustments that enable you to scale based on the size of the alarm breach.
" + "documentation":"A set of adjustments that enable you to scale based on the size of the alarm breach.
At least one step adjustment is required if you are adding a new step scaling policy configuration.
" }, "MinAdjustmentMagnitude":{ "shape":"MinAdjustmentMagnitude", - "documentation":"The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is PercentChangeInCapacity, the scaling policy changes the scalable dimension of the scalable target by this amount.
For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.
The minimum value to scale by when scaling by percentages. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.
Valid only if the adjustment type is PercentChangeInCapacity.
The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.
For scale-out policies, while the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a cooldown period of 5 minutes starts. During the cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale-out event are considered part of that capacity and only 1 additional task is added to the desired count.
For scale-in policies, the cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.
" + "documentation":"The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.
For scale-out policies, while the cooldown period is in effect, the capacity that has been added by the previous scale-out action that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a cooldown period of 5 minutes starts. During the cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale-out action are considered part of that capacity and only 1 additional task is added to the desired count.
For scale-in policies, the cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.
Application Auto Scaling provides a default value of 300 for the following scalable targets:
ECS services
Spot Fleet requests
EMR clusters
AppStream 2.0 fleets
Aurora DB clusters
Amazon SageMaker endpoint variants
Custom resources
For all other scalable targets, the default value is 0:
DynamoDB tables
DynamoDB global secondary indexes
Amazon Comprehend document classification endpoints
Lambda provisioned concurrency
Amazon Keyspaces tables
The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.
While the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.
" + "documentation":"The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.
While the cooldown period is in effect, the capacity that has been added by the previous scale-out action that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.
Application Auto Scaling provides a default value of 300 for the following scalable targets:
ECS services
Spot Fleet requests
EMR clusters
AppStream 2.0 fleets
Aurora DB clusters
Amazon SageMaker endpoint variants
Custom resources
For all other scalable targets, the default value is 0:
DynamoDB tables
DynamoDB global secondary indexes
Amazon Comprehend document classification endpoints
Lambda provisioned concurrency
Amazon Keyspaces tables
The amount of time, in seconds, after a scale-in activity completes before another scale in activity can start.
The cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.
" + "documentation":"The amount of time, in seconds, after a scale-in activity completes before another scale in activity can start.
The cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.
Application Auto Scaling provides a default value of 300 for the following scalable targets:
ECS services
Spot Fleet requests
EMR clusters
AppStream 2.0 fleets
Aurora DB clusters
Amazon SageMaker endpoint variants
Custom resources
For all other scalable targets, the default value is 0:
DynamoDB tables
DynamoDB global secondary indexes
Amazon Comprehend document classification endpoints
Lambda provisioned concurrency
Amazon Keyspaces tables
Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource. The default value is false.
Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false.
Represents a target tracking scaling policy configuration to use with Application Auto Scaling.
" @@ -1212,5 +1217,5 @@ "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" } }, - "documentation":"With Application Auto Scaling, you can configure automatic scaling for the following resources:
Amazon ECS services
Amazon EC2 Spot Fleet requests
Amazon EMR clusters
Amazon AppStream 2.0 fleets
Amazon DynamoDB tables and global secondary indexes throughput capacity
Amazon Aurora Replicas
Amazon SageMaker endpoint variants
Custom resources provided by your own applications or services
Amazon Comprehend document classification endpoints
AWS Lambda function provisioned concurrency
API Summary
The Application Auto Scaling service API includes three key sets of actions:
Register and manage scalable targets - Register AWS or custom resources as scalable targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and retrieve information on existing scalable targets.
Configure and manage automatic scaling - Define scaling policies to dynamically scale your resources in response to CloudWatch alarms, schedule one-time or recurring scaling actions, and retrieve your recent scaling activity history.
Suspend and resume scaling - Temporarily suspend and later resume automatic scaling by calling the RegisterScalableTarget action for any Application Auto Scaling scalable target. You can suspend and resume, individually or in combination, scale-out activities triggered by a scaling policy, scale-in activities triggered by a scaling policy, and scheduled scaling.
To learn more about Application Auto Scaling, including information about granting IAM users required permissions for Application Auto Scaling actions, see the Application Auto Scaling User Guide.
" + "documentation":"With Application Auto Scaling, you can configure automatic scaling for the following resources:
Amazon ECS services
Amazon EC2 Spot Fleet requests
Amazon EMR clusters
Amazon AppStream 2.0 fleets
Amazon DynamoDB tables and global secondary indexes throughput capacity
Amazon Aurora Replicas
Amazon SageMaker endpoint variants
Custom resources provided by your own applications or services
Amazon Comprehend document classification endpoints
AWS Lambda function provisioned concurrency
Amazon Keyspaces for Apache Cassandra tables
API Summary
The Application Auto Scaling service API includes three key sets of actions:
Register and manage scalable targets - Register AWS or custom resources as scalable targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and retrieve information on existing scalable targets.
Configure and manage automatic scaling - Define scaling policies to dynamically scale your resources in response to CloudWatch alarms, schedule one-time or recurring scaling actions, and retrieve your recent scaling activity history.
Suspend and resume scaling - Temporarily suspend and later resume automatic scaling by calling the RegisterScalableTarget API action for any Application Auto Scaling scalable target. You can suspend and resume (individually or in combination) scale-out activities that are triggered by a scaling policy, scale-in activities that are triggered by a scaling policy, and scheduled scaling.
To learn more about Application Auto Scaling, including information about granting IAM users required permissions for Application Auto Scaling actions, see the Application Auto Scaling User Guide.
" } diff --git a/botocore/data/application-insights/2018-11-25/service-2.json b/botocore/data/application-insights/2018-11-25/service-2.json index fd3f072a..1c847097 100644 --- a/botocore/data/application-insights/2018-11-25/service-2.json +++ b/botocore/data/application-insights/2018-11-25/service-2.json @@ -477,6 +477,10 @@ "shape":"OpsCenterEnabled", "documentation":"Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.
" }, + "CWEMonitorEnabled":{ + "shape":"CWEMonitorEnabled", + "documentation":" Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.
The issues on the user side that block Application Insights from successfully monitoring an application. Example remarks include:
“Configuring application, detected 1 Errors, 3 Warnings”
“Configuring application, detected 1 Unconfigured Components”
The request is not understood by the server.
", "exception":true }, + "CWEMonitorEnabled":{"type":"boolean"}, + "CloudWatchEventDetailType":{"type":"string"}, + "CloudWatchEventId":{"type":"string"}, + "CloudWatchEventSource":{ + "type":"string", + "enum":[ + "EC2", + "CODE_DEPLOY", + "HEALTH" + ] + }, + "CodeDeployApplication":{"type":"string"}, + "CodeDeployDeploymentGroup":{"type":"string"}, + "CodeDeployDeploymentId":{"type":"string"}, + "CodeDeployInstanceGroupId":{"type":"string"}, + "CodeDeployState":{"type":"string"}, "ComponentConfiguration":{ "type":"string", "max":10000, @@ -568,6 +588,10 @@ "shape":"OpsCenterEnabled", "documentation":" When set to true, creates opsItems for any problems detected on an application.
Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.
The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.
" @@ -926,6 +950,7 @@ } } }, + "Ec2State":{"type":"string"}, "EndTime":{"type":"timestamp"}, "ErrorMsg":{"type":"string"}, "ExceptionMessage":{"type":"string"}, @@ -947,6 +972,11 @@ "NOT_USEFUL" ] }, + "HealthEventArn":{"type":"string"}, + "HealthEventDescription":{"type":"string"}, + "HealthEventTypeCategory":{"type":"string"}, + "HealthEventTypeCode":{"type":"string"}, + "HealthService":{"type":"string"}, "Insights":{"type":"string"}, "InternalServerException":{ "type":"structure", @@ -1309,6 +1339,90 @@ "Value":{ "shape":"Value", "documentation":"The value of the source observation metric.
" + }, + "CloudWatchEventId":{ + "shape":"CloudWatchEventId", + "documentation":"The ID of the CloudWatch Event-based observation related to the detected problem.
" + }, + "CloudWatchEventSource":{ + "shape":"CloudWatchEventSource", + "documentation":"The source of the CloudWatch Event.
" + }, + "CloudWatchEventDetailType":{ + "shape":"CloudWatchEventDetailType", + "documentation":" The detail type of the CloudWatch Event-based observation, for example, EC2 Instance State-change Notification.
The Amazon Resource Name (ARN) of the AWS Health Event-based observation.
" + }, + "HealthService":{ + "shape":"HealthService", + "documentation":"The service to which the AWS Health Event belongs, such as EC2.
" + }, + "HealthEventTypeCode":{ + "shape":"HealthEventTypeCode", + "documentation":" The type of the AWS Health event, for example, AWS_EC2_POWER_CONNECTIVITY_ISSUE.
The category of the AWS Health event, such as issue.
The description of the AWS Health event provided by the service, such as Amazon EC2.
" + }, + "CodeDeployDeploymentId":{ + "shape":"CodeDeployDeploymentId", + "documentation":"The deployment ID of the CodeDeploy-based observation related to the detected problem.
" + }, + "CodeDeployDeploymentGroup":{ + "shape":"CodeDeployDeploymentGroup", + "documentation":"The deployment group to which the CodeDeploy deployment belongs.
" + }, + "CodeDeployState":{ + "shape":"CodeDeployState", + "documentation":" The status of the CodeDeploy deployment, for example SUCCESS or FAILURE.
The CodeDeploy application to which the deployment belongs.
" + }, + "CodeDeployInstanceGroupId":{ + "shape":"CodeDeployInstanceGroupId", + "documentation":"The instance group to which the CodeDeploy instance belongs.
" + }, + "Ec2State":{ + "shape":"Ec2State", + "documentation":" The state of the instance, such as STOPPING or TERMINATING.
The X-Ray request fault percentage for this node.
" + }, + "XRayThrottlePercent":{ + "shape":"XRayThrottlePercent", + "documentation":"The X-Ray request throttle percentage for this node.
" + }, + "XRayErrorPercent":{ + "shape":"XRayErrorPercent", + "documentation":"The X-Ray request error percentage for this node.
" + }, + "XRayRequestCount":{ + "shape":"XRayRequestCount", + "documentation":"The X-Ray request count for this node.
" + }, + "XRayRequestAverageLatency":{ + "shape":"XRayRequestAverageLatency", + "documentation":"The X-Ray node request average latency for this node.
" + }, + "XRayNodeName":{ + "shape":"XRayNodeName", + "documentation":"The name of the X-Ray node.
" + }, + "XRayNodeType":{ + "shape":"XRayNodeType", + "documentation":"The type of the X-Ray node.
" } }, "documentation":"Describes an anomaly or error with the application.
" @@ -1579,6 +1693,10 @@ "shape":"OpsCenterEnabled", "documentation":" When set to true, creates opsItems for any problems detected on an application.
Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.
The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.
" @@ -1713,7 +1831,14 @@ "documentation":"The parameter is not valid.
", "exception":true }, - "Value":{"type":"double"} + "Value":{"type":"double"}, + "XRayErrorPercent":{"type":"integer"}, + "XRayFaultPercent":{"type":"integer"}, + "XRayNodeName":{"type":"string"}, + "XRayNodeType":{"type":"string"}, + "XRayRequestAverageLatency":{"type":"long"}, + "XRayRequestCount":{"type":"integer"}, + "XRayThrottlePercent":{"type":"integer"} }, "documentation":"Amazon CloudWatch Application Insights for .NET and SQL Server is a service that helps you detect common problems with your .NET and SQL Server-based applications. It enables you to pinpoint the source of issues in your applications (built with technologies such as Microsoft IIS, .NET, and Microsoft SQL Server), by providing key insights into detected problems.
After you onboard your application, CloudWatch Application Insights for .NET and SQL Server identifies, recommends, and sets up metrics and logs. It continuously analyzes and correlates your metrics and logs for unusual behavior to surface actionable problems with your application. For example, if your application is slow and unresponsive and leading to HTTP 500 errors in your Application Load Balancer (ALB), Application Insights informs you that a memory pressure problem with your SQL Server database is occurring. It bases this analysis on impactful metrics and log errors.
" } diff --git a/botocore/data/appsync/2017-07-25/examples-1.json b/botocore/data/appsync/2017-07-25/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/appsync/2017-07-25/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/athena/2017-05-18/examples-1.json b/botocore/data/athena/2017-05-18/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/athena/2017-05-18/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/athena/2017-05-18/service-2.json b/botocore/data/athena/2017-05-18/service-2.json index 0875ec92..35988536 100644 --- a/botocore/data/athena/2017-05-18/service-2.json +++ b/botocore/data/athena/2017-05-18/service-2.json @@ -167,7 +167,7 @@ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], - "documentation":"Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the workgroup.
For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
" + "documentation":"Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the workgroup. If a workgroup is not specified, lists the saved queries for the primary workgroup.
For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
" }, "ListQueryExecutions":{ "name":"ListQueryExecutions", @@ -181,7 +181,7 @@ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], - "documentation":"Provides a list of available query execution IDs for the queries in the specified workgroup. Requires you to have access to the workgroup in which the queries ran.
For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
" + "documentation":"Provides a list of available query execution IDs for the queries in the specified workgroup. If a workgroup is not specified, returns a list of query execution IDs for the primary workgroup. Requires you to have access to the workgroup in which the queries ran.
For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", @@ -694,7 +694,7 @@ }, "WorkGroup":{ "shape":"WorkGroupName", - "documentation":"The name of the workgroup from which the named queries are being returned.
" + "documentation":"The name of the workgroup from which the named queries are returned. If a workgroup is not specified, the saved queries for the primary workgroup are returned.
" } } }, @@ -724,7 +724,7 @@ }, "WorkGroup":{ "shape":"WorkGroupName", - "documentation":"The name of the workgroup from which queries are being returned.
" + "documentation":"The name of the workgroup from which queries are returned. If a workgroup is not specified, a list of available query execution IDs for the queries in the primary workgroup is returned.
" } } }, @@ -908,7 +908,7 @@ }, "Statistics":{ "shape":"QueryExecutionStatistics", - "documentation":"The amount of data scanned during the query execution and the amount of time that it took to execute, and the type of statement that was run.
" + "documentation":"Query execution statistics, such as the amount of data scanned, the amount of time that the query took to process, and the type of statement that was run.
" }, "WorkGroup":{ "shape":"WorkGroupName", @@ -987,7 +987,7 @@ "members":{ "State":{ "shape":"QueryExecutionState", - "documentation":"The state of query execution. QUEUED state is listed but is not used by Athena and is reserved for future use. RUNNING indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. SUCCEEDED indicates that the query completed without errors. FAILED indicates that the query experienced an error and did not complete processing. CANCELLED indicates that a user input interrupted query execution.
The state of query execution. QUEUED indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. RUNNING indicates that the query is in execution phase. SUCCEEDED indicates that the query completed without errors. FAILED indicates that the query experienced an error and did not complete processing. CANCELLED indicates that a user input interrupted query execution.
Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
Creates a new Cost Category with the requested name and rules.
" + "documentation":"Creates a new Cost Category with the requested name and rules.
" }, "DeleteCostCategoryDefinition":{ "name":"DeleteCostCategoryDefinition", @@ -40,7 +40,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"} ], - "documentation":"Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.
" + "documentation":"Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.
" }, "DescribeCostCategoryDefinition":{ "name":"DescribeCostCategoryDefinition", @@ -54,7 +54,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"} ], - "documentation":"Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
Returns the name, ARN, rules, definition, and effective dates of a Cost Category that's defined in the account.
You have the option to use EffectiveOn to return a Cost Category that is active on a specific date. If there is no EffectiveOn specified, you’ll see a Cost Category that is effective on the current date. If Cost Category is still effective, EffectiveEnd is omitted in the response.
Returns the name, ARN, rules, definition, and effective dates of a Cost Category that's defined in the account.
You have the option to use EffectiveOn to return a Cost Category that is active on a specific date. If there is no EffectiveOn specified, you’ll see a Cost Category that is effective on the current date. If Cost Category is still effective, EffectiveEnd is omitted in the response.
Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Master accounts in an organization in AWS Organizations have access to all member accounts.
Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Master accounts in an organization in AWS Organizations have access to all member accounts.
Retrieves cost and usage metrics with resources for your account. You can specify which cost and usage-related metric, such as BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Master accounts in an organization in AWS Organizations have access to all member accounts. This API is currently available for the Amazon Elastic Compute Cloud – Compute service only.
This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information on how to access the Settings page, see Controlling Access for Cost Explorer in the AWS Billing and Cost Management User Guide.
Retrieves cost and usage metrics with resources for your account. You can specify which cost and usage-related metric, such as BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Master accounts in an organization in AWS Organizations have access to all member accounts. This API is currently available for the Amazon Elastic Compute Cloud – Compute service only.
This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information on how to access the Settings page, see Controlling Access for Cost Explorer in the AWS Billing and Cost Management User Guide.
Retrieves the reservation coverage for your account. This enables you to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's master account can see the coverage of the associated member accounts. For any time period, you can filter data about reservation usage by the following dimensions:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
SERVICE
TAG
TENANCY
To determine valid values for a dimension, use the GetDimensionValues operation.
Retrieves the reservation coverage for your account. This enables you to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's master account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data about reservation usage by the following dimensions:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
SERVICE
TAG
TENANCY
To determine valid values for a dimension, use the GetDimensionValues operation.
Retrieves the Savings Plans covered for your account. This enables you to see how much of your cost is covered by a Savings Plan. An organization’s master account can see the coverage of the associated member accounts. For any time period, you can filter data for Savings Plans usage with the following dimensions:
LINKED_ACCOUNT
REGION
SERVICE
INSTANCE_FAMILY
To determine valid values for a dimension, use the GetDimensionValues operation.
Retrieves the Savings Plans covered for your account. This enables you to see how much of your cost is covered by a Savings Plan. An organization’s master account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data for Savings Plans usage with the following dimensions:
LINKED_ACCOUNT
REGION
SERVICE
INSTANCE_FAMILY
To determine valid values for a dimension, use the GetDimensionValues operation.
Retrieves your request parameters, Savings Plan Recommendations Summary and Details.
" + "documentation":"Retrieves your request parameters, Savings Plan Recommendations Summary and Details.
" }, "GetSavingsPlansUtilization":{ "name":"GetSavingsPlansUtilization", @@ -281,7 +281,7 @@ "errors":[ {"shape":"LimitExceededException"} ], - "documentation":"Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
Returns the name, ARN and effective dates of all Cost Categories defined in the account. You have the option to use EffectiveOn to return a list of Cost Categories that were active on a specific date. If there is no EffectiveOn specified, you’ll see Cost Categories that are effective on the current date. If Cost Category is still effective, EffectiveEnd is omitted in the response.
Returns the name, ARN, NumberOfRules and effective dates of all Cost Categories defined in the account. You have the option to use EffectiveOn to return a list of Cost Categories that were active on a specific date. If there is no EffectiveOn specified, you’ll see Cost Categories that are effective on the current date. If Cost Category is still effective, EffectiveEnd is omitted in the response. ListCostCategoryDefinitions supports pagination. The request can have a MaxResults range up to 100.
Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
Updates an existing Cost Category. Changes made to the Cost Category rules will be used to categorize the current month’s expenses and future expenses. This won’t change categorization for the previous months.
" + "documentation":"Updates an existing Cost Category. Changes made to the Cost Category rules will be used to categorize the current month’s expenses and future expenses. This won’t change categorization for the previous months.
" } }, "shapes":{ @@ -367,7 +367,12 @@ "documentation":"Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.
" } }, - "documentation":"Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
The structure of Cost Categories. This includes detailed metadata and the set of rules for the CostCategory object.
The structure of Cost Categories. This includes detailed metadata and the set of rules for the CostCategory object.
The unique identifier for your Cost Category Reference.
" + "documentation":"The unique identifier for your Cost Category.
" }, "Name":{"shape":"CostCategoryName"}, "EffectiveStart":{ @@ -391,9 +396,13 @@ "EffectiveEnd":{ "shape":"ZonedDateTime", "documentation":"The Cost Category's effective end date.
" + }, + "NumberOfRules":{ + "shape":"NonNegativeInteger", + "documentation":"The number of rules associated with a specific Cost Category.
" } }, - "documentation":"Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
A reference to a Cost Category containing only enough information to identify the Cost Category.
You can use this information to retrieve the full Cost Category information using DescribeCostCategory.
A reference to a Cost Category containing only enough information to identify the Cost Category.
You can use this information to retrieve the full Cost Category information using DescribeCostCategory.
An Expression object used to categorize costs. This supports dimensions, Tags, and nested expressions. Currently the only dimensions supported is LINKED_ACCOUNT.
Root level OR is not supported. We recommend you create a separate rule instead.
An Expression object used to categorize costs. This supports dimensions, Tags, and nested expressions. Currently the only dimensions supported are LINKED_ACCOUNT, SERVICE_CODE, RECORD_TYPE, and LINKED_ACCOUNT_NAME.
Root level OR is not supported. We recommend that you create a separate rule instead.
RECORD_TYPE is a dimension used for Cost Explorer APIs, and is also supported for Cost Category expressions. This dimension uses different terms, depending on whether you're using the console or API/JSON editor. For a detailed comparison, see Term Comparisons in the AWS Billing and Cost Management User Guide.
Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.
" + "documentation":"Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.
" }, "CostCategoryRuleVersion":{ "type":"string", @@ -441,7 +450,7 @@ "documentation":"The specific value of the Cost Category.
" } }, - "documentation":"Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
The values that are available for Cost Categories.
" + "documentation":"The Cost Categories values used for filtering the costs.
" }, "Coverage":{ "type":"structure", @@ -484,10 +493,10 @@ "members":{ "OnDemandCost":{ "shape":"OnDemandCost", - "documentation":"How much an On-Demand instance cost.
" + "documentation":"How much an On-Demand Instance costs.
" } }, - "documentation":"How much it cost to run an instance.
" + "documentation":"How much it costs to run an instance.
" }, "CoverageHours":{ "type":"structure", @@ -551,7 +560,7 @@ "RuleVersion":{"shape":"CostCategoryRuleVersion"}, "Rules":{ "shape":"CostCategoryRulesList", - "documentation":" CreateCostCategoryDefinition supports dimensions, Tags, and nested expressions. Currently the only dimensions supported is LINKED_ACCOUNT.
Root level OR is not supported. We recommend you create a separate rule instead.
Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.
" + "documentation":"The Cost Category rules used to categorize costs. For more information, see CostCategoryRule.
" } } }, @@ -689,10 +698,12 @@ "AZ", "INSTANCE_TYPE", "LINKED_ACCOUNT", + "LINKED_ACCOUNT_NAME", "OPERATION", "PURCHASE_TYPE", "REGION", "SERVICE", + "SERVICE_CODE", "USAGE_TYPE", "USAGE_TYPE_GROUP", "RECORD_TYPE", @@ -724,7 +735,11 @@ }, "Values":{ "shape":"Values", - "documentation":"The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.
Valid values for the SERVICE dimension are Amazon Elastic Compute Cloud - Compute, Amazon Elasticsearch Service, Amazon ElastiCache, Amazon Redshift, and Amazon Relational Database Service.
The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.
The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.
The metadata that you can use to filter and group your results. You can use GetDimensionValues to find specific values.
Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
The specific CostCategory used for Expression.
The filter based on CostCategory values.
Use Expression to filter by cost or by usage. There are two patterns:
Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for REGION==us-east-1 OR REGION==us-west-1. The Expression for that looks like this:
{ \"Dimensions\": { \"Key\": \"REGION\", \"Values\": [ \"us-east-1\", “us-west-1” ] } }
The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
Compound dimension values with logical operations - You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. This allows you to filter on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer). The Expression for that looks like this:
{ \"And\": [ {\"Or\": [ {\"Dimensions\": { \"Key\": \"REGION\", \"Values\": [ \"us-east-1\", \"us-west-1\" ] }}, {\"Tags\": { \"Key\": \"TagName\", \"Values\": [\"Value1\"] } } ]}, {\"Not\": {\"Dimensions\": { \"Key\": \"USAGE_TYPE\", \"Values\": [\"DataTransfer\"] }}} ] }
Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error.
{ \"And\": [ ... ], \"DimensionValues\": { \"Dimension\": \"USAGE_TYPE\", \"Values\": [ \"DataTransfer\" ] } }
For GetRightsizingRecommendation action, a combination of OR and NOT is not supported. OR is not supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE.
Filters AWS costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.
Filters AWS costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.
Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the \"blended\" annotation appear on some line items in my bill?.
Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.
If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.
Metrics is required for GetCostAndUsage requests.
Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the \"blended\" annotation appear on some line items in my bill?.
Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.
If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.
Metrics is required for GetCostAndUsage requests.
Filters Amazon Web Services costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.
The GetCostAndUsageWithResources operation requires that you either group by or filter by a ResourceId.
Filters Amazon Web Services costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.
The GetCostAndUsageWithResources operation requires that you either group by or filter by a ResourceId.
Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the \"blended\" annotation appear on some line items in my bill?.
Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.
If you return the UsageQuantity metric, the service aggregates all usage numbers without taking the units into account. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.
Metrics is required for GetCostAndUsageWithResources requests.
Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the \"blended\" annotation appear on some line items in my bill?.
Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.
If you return the UsageQuantity metric, the service aggregates all usage numbers without taking the units into account. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.
Metrics is required for GetCostAndUsageWithResources requests.
Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the \"blended\" annotation appear on some line items in my bill?.
Valid values for a GetCostForecast call are the following:
AMORTIZED_COST
BLENDED_COST
NET_AMORTIZED_COST
NET_UNBLENDED_COST
UNBLENDED_COST
Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the \"blended\" annotation appear on some line items in my bill?.
Valid values for a GetCostForecast call are the following:
AMORTIZED_COST
BLENDED_COST
NET_AMORTIZED_COST
NET_UNBLENDED_COST
UNBLENDED_COST
Filters utilization data by dimensions. You can filter by the following dimensions:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
SERVICE
TAG
TENANCY
GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.
If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.
Filters utilization data by dimensions. You can filter by the following dimensions:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
SERVICE
TAG
TENANCY
GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.
If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.
Cost category is also supported.
" }, "Metrics":{ "shape":"MetricNames", @@ -1231,7 +1251,7 @@ }, "AccountScope":{ "shape":"AccountScope", - "documentation":"The account scope that you want recommendations for. PAYER means that AWS includes the master account and any member accounts when it calculates its recommendations. LINKED means that AWS includes only member accounts when it calculates its recommendations.
Valid values are PAYER and LINKED.
The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the payer account and linked accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual linked accounts only.
Filters utilization data by dimensions. You can filter by the following dimensions:
AZ
CACHE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
SERVICE
SCOPE
TENANCY
GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.
Filters utilization data by dimensions. You can filter by the following dimensions:
AZ
CACHE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
SERVICE
SCOPE
TENANCY
GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.
Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or niether.
" + }, "Service":{ "shape":"GenericString", "documentation":"The specific service that you want recommendations for. The only valid value for GetRightsizingRecommendation is \"AmazonEC2\".
The token to retrieve the next set of results.
" + }, + "Configuration":{ + "shape":"RightsizingRecommendationConfiguration", + "documentation":"Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or niether.
" } } }, @@ -1378,7 +1406,7 @@ }, "Filter":{ "shape":"Expression", - "documentation":"Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:
LINKED_ACCOUNT
REGION
SERVICE
INSTANCE_FAMILY
GetSavingsPlansCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.
Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:
LINKED_ACCOUNT
REGION
SERVICE
INSTANCE_FAMILY
GetSavingsPlansCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.
Cost category is also supported.
" }, "Metrics":{ "shape":"MetricNames", @@ -1430,6 +1458,10 @@ "shape":"PaymentOption", "documentation":"The payment option used to generate these recommendations.
" }, + "AccountScope":{ + "shape":"AccountScope", + "documentation":"The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the payer account and linked accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual linked accounts only.
The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
" @@ -1441,6 +1473,10 @@ "LookbackPeriodInDays":{ "shape":"LookbackPeriodInDays", "documentation":"The lookback period used to generate the recommendation.
" + }, + "Filter":{ + "shape":"Expression", + "documentation":"You can filter your recommendations by Account ID with the LINKED_ACCOUNT dimension. To filter your recommendations by Account ID, specify Key as LINKED_ACCOUNT and Value as the comma-separated Acount ID(s) for which you want to see Savings Plans purchase recommendations.
For GetSavingsPlansPurchaseRecommendation, the Filter does not include CostCategories or Tags. It only includes Dimensions. With Dimensions, Key must be LINKED_ACCOUNT and Value can be a single Account ID or multiple comma-separated Account IDs for which you want to see Savings Plans Purchase Recommendations. AND and OR operators are not supported.
Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:
LINKED_ACCOUNT
SAVINGS_PLAN_ARN
REGION
PAYMENT_OPTION
INSTANCE_TYPE_FAMILY
GetSavingsPlansUtilizationDetails uses the same Expression object as the other operations, but only AND is supported among each dimension.
Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:
LINKED_ACCOUNT
SAVINGS_PLAN_ARN
REGION
PAYMENT_OPTION
INSTANCE_TYPE_FAMILY
GetSavingsPlansUtilizationDetails uses the same Expression object as the other operations, but only AND is supported among each dimension.
Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:
LINKED_ACCOUNT
SAVINGS_PLAN_ARN
SAVINGS_PLANS_TYPE
REGION
PAYMENT_OPTION
INSTANCE_TYPE_FAMILY
GetSavingsPlansUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension.
Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:
LINKED_ACCOUNT
SAVINGS_PLAN_ARN
SAVINGS_PLANS_TYPE
REGION
PAYMENT_OPTION
INSTANCE_TYPE_FAMILY
GetSavingsPlansUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension.
Represents a group when you specify a group by criteria or in the response to a query with a specific grouping.
" }, - "GroupDefinitionKey":{"type":"string"}, + "GroupDefinitionKey":{ + "type":"string", + "max":1024, + "min":0, + "pattern":"[\\S\\s]*" + }, "GroupDefinitionType":{ "type":"string", "enum":[ @@ -1738,7 +1779,12 @@ }, "NextToken":{ "shape":"NextPageToken", - "documentation":"The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
You can use this information to retrieve the full Cost Category information using DescribeCostCategory.
The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
" + }, + "MaxResults":{ + "shape":"CostCategoryMaxResults", + "documentation":"The number of entries a paginated response contains.
", + "box":true } } }, @@ -1763,6 +1809,21 @@ "SIXTY_DAYS" ] }, + "MatchOption":{ + "type":"string", + "enum":[ + "EQUALS", + "STARTS_WITH", + "ENDS_WITH", + "CONTAINS", + "CASE_SENSITIVE", + "CASE_INSENSITIVE" + ] + }, + "MatchOptions":{ + "type":"list", + "member":{"shape":"MatchOption"} + }, "MaxResults":{ "type":"integer", "min":1 @@ -1780,7 +1841,12 @@ ] }, "MetricAmount":{"type":"string"}, - "MetricName":{"type":"string"}, + "MetricName":{ + "type":"string", + "max":1024, + "min":0, + "pattern":"[\\S\\s]*" + }, "MetricNames":{ "type":"list", "member":{"shape":"MetricName"} @@ -1816,7 +1882,12 @@ "documentation":"Details on the modification recommendation.
" }, "NetRISavings":{"type":"string"}, - "NextPageToken":{"type":"string"}, + "NextPageToken":{ + "type":"string", + "max":8192, + "min":0, + "pattern":"[\\S\\s]*" + }, "NonNegativeInteger":{ "type":"integer", "min":0 @@ -1893,6 +1964,13 @@ }, "documentation":"Details about the Amazon RDS instances that AWS recommends that you purchase.
" }, + "RecommendationTarget":{ + "type":"string", + "enum":[ + "SAME_INSTANCE_FAMILY", + "CROSS_INSTANCE_FAMILY" + ] + }, "RedshiftInstanceDetails":{ "type":"structure", "members":{ @@ -2138,10 +2216,10 @@ }, "GenerationTimestamp":{ "shape":"GenericString", - "documentation":"The time stamp for when AWS made this recommendation.
" + "documentation":"The timestamp for when AWS made this recommendation.
" } }, - "documentation":"Information about this specific recommendation, such as the time stamp for when AWS made a specific recommendation.
" + "documentation":"Information about this specific recommendation, such as the timestamp for when AWS made a specific recommendation.
" }, "ReservationPurchaseRecommendationSummary":{ "type":"structure", @@ -2273,6 +2351,24 @@ }, "documentation":"Recommendations to rightsize resources.
" }, + "RightsizingRecommendationConfiguration":{ + "type":"structure", + "required":[ + "RecommendationTarget", + "BenefitsConsidered" + ], + "members":{ + "RecommendationTarget":{ + "shape":"RecommendationTarget", + "documentation":" The option to see recommendations within the same instance family, or recommendations for instances across other families. The default value is SAME_INSTANCE_FAMILY.
The option to consider RI or Savings Plans discount benefits in your savings calculation. The default value is TRUE.
Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or niether.
" + }, "RightsizingRecommendationList":{ "type":"list", "member":{"shape":"RightsizingRecommendation"} @@ -2375,7 +2471,7 @@ }, "CoveragePercentage":{ "shape":"GenericString", - "documentation":"The percentage of your existing Savings Planscovered usage, divided by all of your eligible Savings Plans usage in an account(or set of accounts).
" + "documentation":"The percentage of your existing Savings Plans covered usage, divided by all of your eligible Savings Plans usage in an account(or set of accounts).
" } }, "documentation":"Specific coverage percentage, On-Demand costs, and spend covered by Savings Plans, and total Savings Plans costs for an account.
" @@ -2405,6 +2501,10 @@ "SavingsPlansPurchaseRecommendation":{ "type":"structure", "members":{ + "AccountScope":{ + "shape":"AccountScope", + "documentation":"The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the payer account and linked accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual linked accounts only.
The requested Savings Plans recommendation type.
" @@ -2423,7 +2523,7 @@ }, "SavingsPlansPurchaseRecommendationDetails":{ "shape":"SavingsPlansPurchaseRecommendationDetailList", - "documentation":"Details for the Savings Plans we recommend you to purchase to cover existing, Savings Plans eligible workloads.
" + "documentation":"Details for the Savings Plans we recommend that you purchase to cover existing Savings Plans eligible workloads.
" }, "SavingsPlansPurchaseRecommendationSummary":{ "shape":"SavingsPlansPurchaseRecommendationSummary", @@ -2682,7 +2782,12 @@ "type":"list", "member":{"shape":"SavingsPlansUtilizationByTime"} }, - "SearchString":{"type":"string"}, + "SearchString":{ + "type":"string", + "max":1024, + "min":0, + "pattern":"[\\S\\s]*" + }, "ServiceQuotaExceededException":{ "type":"structure", "members":{ @@ -2708,7 +2813,12 @@ "EC2_INSTANCE_SP" ] }, - "TagKey":{"type":"string"}, + "TagKey":{ + "type":"string", + "max":1024, + "min":0, + "pattern":"[\\S\\s]*" + }, "TagList":{ "type":"list", "member":{"shape":"Entity"} @@ -2723,6 +2833,10 @@ "Values":{ "shape":"Values", "documentation":"The specific value of the tag.
" + }, + "MatchOptions":{ + "shape":"MatchOptions", + "documentation":"The match options that you can use to filter your results. MatchOptions is only applicable for only applicable for actions related to Cost Category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.
The values that are available for a tag.
" @@ -2817,7 +2931,7 @@ "RuleVersion":{"shape":"CostCategoryRuleVersion"}, "Rules":{ "shape":"CostCategoryRulesList", - "documentation":" UpdateCostCategoryDefinition supports dimensions, Tags, and nested expressions. Currently the only dimensions supported is LINKED_ACCOUNT.
Root level OR is not supported. We recommend you create a separate rule instead.
Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.
" + "documentation":"The Expression object used to categorize costs. For more information, see CostCategoryRule .
The Cost Explorer API enables you to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data, such as the number of daily write operations for Amazon DynamoDB database tables in your production environment.
Service Endpoint
The Cost Explorer API provides the following endpoint:
https://ce.us-east-1.amazonaws.com
For information about costs associated with the Cost Explorer API, see AWS Cost Management Pricing.
" + "documentation":"The Cost Explorer API enables you to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data, such as the number of daily write operations for Amazon DynamoDB database tables in your production environment.
Service Endpoint
The Cost Explorer API provides the following endpoint:
https://ce.us-east-1.amazonaws.com
For information about costs associated with the Cost Explorer API, see AWS Cost Management Pricing.
" } diff --git a/botocore/data/chime/2018-05-01/service-2.json b/botocore/data/chime/2018-05-01/service-2.json index 730d251c..d850013c 100644 --- a/botocore/data/chime/2018-05-01/service-2.json +++ b/botocore/data/chime/2018-05-01/service-2.json @@ -337,6 +337,26 @@ ], "documentation":"Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you must use the Amazon Chime Voice Connector product type.
" }, + "CreateProxySession":{ + "name":"CreateProxySession", + "http":{ + "method":"POST", + "requestUri":"/voice-connectors/{voiceConnectorId}/proxy-sessions", + "responseCode":201 + }, + "input":{"shape":"CreateProxySessionRequest"}, + "output":{"shape":"CreateProxySessionResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.
" + }, "CreateRoom":{ "name":"CreateRoom", "http":{ @@ -539,6 +559,25 @@ ], "documentation":"Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted.
Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
" }, + "DeleteProxySession":{ + "name":"DeleteProxySession", + "http":{ + "method":"DELETE", + "requestUri":"/voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}", + "responseCode":204 + }, + "input":{"shape":"DeleteProxySessionRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Deletes the specified proxy session from the specified Amazon Chime Voice Connector.
" + }, "DeleteRoom":{ "name":"DeleteRoom", "http":{ @@ -636,6 +675,25 @@ ], "documentation":"Deletes the origination settings for the specified Amazon Chime Voice Connector.
" }, + "DeleteVoiceConnectorProxy":{ + "name":"DeleteVoiceConnectorProxy", + "http":{ + "method":"DELETE", + "requestUri":"/voice-connectors/{voiceConnectorId}/programmable-numbers/proxy", + "responseCode":204 + }, + "input":{"shape":"DeleteVoiceConnectorProxyRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Deletes the proxy configuration from the specified Amazon Chime Voice Connector.
" + }, "DeleteVoiceConnectorStreamingConfiguration":{ "name":"DeleteVoiceConnectorStreamingConfiguration", "http":{ @@ -966,6 +1024,26 @@ ], "documentation":"Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
" }, + "GetProxySession":{ + "name":"GetProxySession", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}", + "responseCode":200 + }, + "input":{"shape":"GetProxySessionRequest"}, + "output":{"shape":"GetProxySessionResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Gets the specified proxy session details for the specified Amazon Chime Voice Connector.
" + }, "GetRoom":{ "name":"GetRoom", "http":{ @@ -1106,6 +1184,26 @@ ], "documentation":"Retrieves origination setting details for the specified Amazon Chime Voice Connector.
" }, + "GetVoiceConnectorProxy":{ + "name":"GetVoiceConnectorProxy", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors/{voiceConnectorId}/programmable-numbers/proxy", + "responseCode":200 + }, + "input":{"shape":"GetVoiceConnectorProxyRequest"}, + "output":{"shape":"GetVoiceConnectorProxyResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Gets the proxy configuration details for the specified Amazon Chime Voice Connector.
" + }, "GetVoiceConnectorStreamingConfiguration":{ "name":"GetVoiceConnectorStreamingConfiguration", "http":{ @@ -1205,6 +1303,26 @@ ], "documentation":"Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.
" }, + "ListAttendeeTags":{ + "name":"ListAttendeeTags", + "http":{ + "method":"GET", + "requestUri":"/meetings/{meetingId}/attendees/{attendeeId}/tags", + "responseCode":200 + }, + "input":{"shape":"ListAttendeeTagsRequest"}, + "output":{"shape":"ListAttendeeTagsResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"NotFoundException"}, + {"shape":"ThrottledClientException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Lists the tags applied to an Amazon Chime SDK attendee resource.
" + }, "ListAttendees":{ "name":"ListAttendees", "http":{ @@ -1245,6 +1363,26 @@ ], "documentation":"Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
" }, + "ListMeetingTags":{ + "name":"ListMeetingTags", + "http":{ + "method":"GET", + "requestUri":"/meetings/{meetingId}/tags", + "responseCode":200 + }, + "input":{"shape":"ListMeetingTagsRequest"}, + "output":{"shape":"ListMeetingTagsResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"NotFoundException"}, + {"shape":"ThrottledClientException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Lists the tags applied to an Amazon Chime SDK meeting resource.
" + }, "ListMeetings":{ "name":"ListMeetings", "http":{ @@ -1301,6 +1439,26 @@ ], "documentation":"Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
" }, + "ListProxySessions":{ + "name":"ListProxySessions", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors/{voiceConnectorId}/proxy-sessions", + "responseCode":200 + }, + "input":{"shape":"ListProxySessionsRequest"}, + "output":{"shape":"ListProxySessionsResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Lists the proxy sessions for the specified Amazon Chime Voice Connector.
" + }, "ListRoomMemberships":{ "name":"ListRoomMemberships", "http":{ @@ -1341,6 +1499,24 @@ ], "documentation":"Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.
" }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Lists the tags applied to an Amazon Chime SDK meeting resource.
" + }, "ListUsers":{ "name":"ListUsers", "http":{ @@ -1499,6 +1675,26 @@ ], "documentation":"Adds origination settings for the specified Amazon Chime Voice Connector.
" }, + "PutVoiceConnectorProxy":{ + "name":"PutVoiceConnectorProxy", + "http":{ + "method":"PUT", + "requestUri":"/voice-connectors/{voiceConnectorId}/programmable-numbers/proxy" + }, + "input":{"shape":"PutVoiceConnectorProxyRequest"}, + "output":{"shape":"PutVoiceConnectorProxyResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.
" + }, "PutVoiceConnectorStreamingConfiguration":{ "name":"PutVoiceConnectorStreamingConfiguration", "http":{ @@ -1639,6 +1835,120 @@ ], "documentation":"Searches phone numbers that can be ordered.
" }, + "TagAttendee":{ + "name":"TagAttendee", + "http":{ + "method":"POST", + "requestUri":"/meetings/{meetingId}/attendees/{attendeeId}/tags?operation=add", + "responseCode":204 + }, + "input":{"shape":"TagAttendeeRequest"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"NotFoundException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ThrottledClientException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Applies the specified tags to the specified Amazon Chime SDK attendee.
" + }, + "TagMeeting":{ + "name":"TagMeeting", + "http":{ + "method":"POST", + "requestUri":"/meetings/{meetingId}/tags?operation=add", + "responseCode":204 + }, + "input":{"shape":"TagMeetingRequest"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"NotFoundException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ThrottledClientException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Applies the specified tags to the specified Amazon Chime SDK meeting.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags?operation=tag-resource", + "responseCode":204 + }, + "input":{"shape":"TagResourceRequest"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Applies the specified tags to the specified Amazon Chime SDK meeting resource.
" + }, + "UntagAttendee":{ + "name":"UntagAttendee", + "http":{ + "method":"POST", + "requestUri":"/meetings/{meetingId}/attendees/{attendeeId}/tags?operation=delete", + "responseCode":204 + }, + "input":{"shape":"UntagAttendeeRequest"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"ThrottledClientException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Untags the specified tags from the specified Amazon Chime SDK attendee.
" + }, + "UntagMeeting":{ + "name":"UntagMeeting", + "http":{ + "method":"POST", + "requestUri":"/meetings/{meetingId}/tags?operation=delete", + "responseCode":204 + }, + "input":{"shape":"UntagMeetingRequest"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"ThrottledClientException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Untags the specified tags from the specified Amazon Chime SDK meeting.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/tags?operation=untag-resource", + "responseCode":204 + }, + "input":{"shape":"UntagResourceRequest"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Untags the specified tags from the specified Amazon Chime SDK meeting resource.
" + }, "UpdateAccount":{ "name":"UpdateAccount", "http":{ @@ -1756,6 +2066,26 @@ ], "documentation":"Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.
" }, + "UpdateProxySession":{ + "name":"UpdateProxySession", + "http":{ + "method":"POST", + "requestUri":"/voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}", + "responseCode":201 + }, + "input":{"shape":"UpdateProxySessionRequest"}, + "output":{"shape":"UpdateProxySessionResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"Updates the specified proxy session details, such as voice or SMS capabilities.
" + }, "UpdateRoom":{ "name":"UpdateRoom", "http":{ @@ -1978,6 +2308,10 @@ }, "documentation":"The Alexa for Business metadata associated with an Amazon Chime user, used to integrate Alexa for Business with a device.
" }, + "AreaCode":{ + "type":"string", + "pattern":"^$|^[0-9]{3,3}$" + }, "Arn":{ "type":"string", "max":1024, @@ -2120,6 +2454,18 @@ "type":"list", "member":{"shape":"Attendee"} }, + "AttendeeTagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":10, + "min":1 + }, + "AttendeeTagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":10, + "min":1 + }, "BadRequestException":{ "type":"structure", "members":{ @@ -2404,6 +2750,17 @@ "type":"list", "member":{"shape":"CallingRegion"} }, + "Capability":{ + "type":"string", + "enum":[ + "Voice", + "SMS" + ] + }, + "CapabilityList":{ + "type":"list", + "member":{"shape":"Capability"} + }, "ClientRequestToken":{ "type":"string", "max":64, @@ -2421,6 +2778,16 @@ "error":{"httpStatusCode":409}, "exception":true }, + "Country":{ + "type":"string", + "pattern":"^$|^[A-Z]{2,2}$" + }, + "CountryList":{ + "type":"list", + "member":{"shape":"Country"}, + "max":100, + "min":1 + }, "CpsLimit":{ "type":"integer", "min":1 @@ -2478,6 +2845,10 @@ "ExternalUserId":{ "shape":"ExternalUserIdType", "documentation":"The Amazon Chime SDK external user ID. Links the attendee to an identity managed by a builder application.
" + }, + "Tags":{ + "shape":"AttendeeTagList", + "documentation":"The tag key-value pairs.
" } } }, @@ -2488,6 +2859,10 @@ "ExternalUserId":{ "shape":"ExternalUserIdType", "documentation":"The Amazon Chime SDK external user ID. Links the attendee to an identity managed by a builder application.
" + }, + "Tags":{ + "shape":"AttendeeTagList", + "documentation":"The tag key-value pairs.
" } }, "documentation":"The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.
" @@ -2546,6 +2921,10 @@ "documentation":"The unique identifier for the client request. Use a different token for different meetings.
", "idempotencyToken":true }, + "ExternalMeetingId":{ + "shape":"ExternalMeetingIdType", + "documentation":"The external meeting ID.
" + }, "MeetingHostId":{ "shape":"ExternalUserIdType", "documentation":"Reserved.
" @@ -2554,6 +2933,10 @@ "shape":"String", "documentation":"The Region in which to create the meeting. Available values: ap-northeast-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2.
The tag key-value pairs.
" + }, "NotificationsConfiguration":{ "shape":"MeetingNotificationConfiguration", "documentation":"The configuration for resource targets to receive notifications when meeting and attendee events occur.
" @@ -2595,6 +2978,59 @@ } } }, + "CreateProxySessionRequest":{ + "type":"structure", + "required":[ + "ParticipantPhoneNumbers", + "Capabilities", + "VoiceConnectorId" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Amazon Chime voice connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "ParticipantPhoneNumbers":{ + "shape":"ParticipantPhoneNumberList", + "documentation":"The participant phone numbers.
" + }, + "Name":{ + "shape":"ProxySessionNameString", + "documentation":"The name of the proxy session.
" + }, + "ExpiryMinutes":{ + "shape":"PositiveInteger", + "documentation":"The number of minutes allowed for the proxy session.
" + }, + "Capabilities":{ + "shape":"CapabilityList", + "documentation":"The proxy session capabilities.
" + }, + "NumberSelectionBehavior":{ + "shape":"NumberSelectionBehavior", + "documentation":"The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
" + }, + "GeoMatchLevel":{ + "shape":"GeoMatchLevel", + "documentation":"The preference for matching the country or area code of the proxy phone number with that of the first participant.
" + }, + "GeoMatchParams":{ + "shape":"GeoMatchParams", + "documentation":"The country and area code for the proxy phone number.
" + } + } + }, + "CreateProxySessionResponse":{ + "type":"structure", + "members":{ + "ProxySession":{ + "shape":"ProxySession", + "documentation":"The proxy session details.
" + } + } + }, "CreateRoomMembershipRequest":{ "type":"structure", "required":[ @@ -2855,6 +3291,27 @@ } } }, + "DeleteProxySessionRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "ProxySessionId" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Amazon Chime voice connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "ProxySessionId":{ + "shape":"NonEmptyString128", + "documentation":"The proxy session ID.
", + "location":"uri", + "locationName":"proxySessionId" + } + } + }, "DeleteRoomMembershipRequest":{ "type":"structure", "required":[ @@ -2928,6 +3385,18 @@ } } }, + "DeleteVoiceConnectorProxyRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Amazon Chime Voice Connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, "DeleteVoiceConnectorRequest":{ "type":"structure", "required":["VoiceConnectorId"], @@ -3139,6 +3608,12 @@ }, "documentation":"The configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint or a Lambda function ARN.
" }, + "ExternalMeetingIdType":{ + "type":"string", + "max":64, + "min":2, + "sensitive":true + }, "ExternalUserIdType":{ "type":"string", "max":64, @@ -3155,6 +3630,31 @@ "error":{"httpStatusCode":403}, "exception":true }, + "GeoMatchLevel":{ + "type":"string", + "enum":[ + "Country", + "AreaCode" + ] + }, + "GeoMatchParams":{ + "type":"structure", + "required":[ + "Country", + "AreaCode" + ], + "members":{ + "Country":{ + "shape":"Country", + "documentation":"The country.
" + }, + "AreaCode":{ + "shape":"AreaCode", + "documentation":"The area code.
" + } + }, + "documentation":"The country and area code for a proxy phone number in a proxy phone session.
" + }, "GetAccountRequest":{ "type":"structure", "required":["AccountId"], @@ -3376,6 +3876,36 @@ } } }, + "GetProxySessionRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "ProxySessionId" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Amazon Chime voice connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "ProxySessionId":{ + "shape":"NonEmptyString128", + "documentation":"The proxy session ID.
", + "location":"uri", + "locationName":"proxySessionId" + } + } + }, + "GetProxySessionResponse":{ + "type":"structure", + "members":{ + "ProxySession":{ + "shape":"ProxySession", + "documentation":"The proxy session details.
" + } + } + }, "GetRoomRequest":{ "type":"structure", "required":[ @@ -3529,6 +4059,27 @@ } } }, + "GetVoiceConnectorProxyRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Amazon Chime voice connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "GetVoiceConnectorProxyResponse":{ + "type":"structure", + "members":{ + "Proxy":{ + "shape":"Proxy", + "documentation":"The proxy configuration details.
" + } + } + }, "GetVoiceConnectorRequest":{ "type":"structure", "required":["VoiceConnectorId"], @@ -3617,6 +4168,7 @@ "type":"string", "pattern":"[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}" }, + "Integer":{"type":"integer"}, "Invite":{ "type":"structure", "members":{ @@ -3748,6 +4300,36 @@ } } }, + "ListAttendeeTagsRequest":{ + "type":"structure", + "required":[ + "MeetingId", + "AttendeeId" + ], + "members":{ + "MeetingId":{ + "shape":"GuidString", + "documentation":"The Amazon Chime SDK meeting ID.
", + "location":"uri", + "locationName":"meetingId" + }, + "AttendeeId":{ + "shape":"GuidString", + "documentation":"The Amazon Chime SDK attendee ID.
", + "location":"uri", + "locationName":"attendeeId" + } + } + }, + "ListAttendeeTagsResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"A list of tag key-value pairs.
" + } + } + }, "ListAttendeesRequest":{ "type":"structure", "required":["MeetingId"], @@ -3822,6 +4404,27 @@ } } }, + "ListMeetingTagsRequest":{ + "type":"structure", + "required":["MeetingId"], + "members":{ + "MeetingId":{ + "shape":"GuidString", + "documentation":"The Amazon Chime SDK meeting ID.
", + "location":"uri", + "locationName":"meetingId" + } + } + }, + "ListMeetingTagsResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"A list of tag key-value pairs.
" + } + } + }, "ListMeetingsRequest":{ "type":"structure", "members":{ @@ -3936,6 +4539,49 @@ } } }, + "ListProxySessionsRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Amazon Chime voice connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "Status":{ + "shape":"ProxySessionStatus", + "documentation":"The proxy session status.
", + "location":"querystring", + "locationName":"status" + }, + "NextToken":{ + "shape":"NextTokenString", + "documentation":"The token to use to retrieve the next page of results.
", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"ResultMax", + "documentation":"The maximum number of results to return in a single call.
", + "location":"querystring", + "locationName":"max-results" + } + } + }, + "ListProxySessionsResponse":{ + "type":"structure", + "members":{ + "ProxySessions":{ + "shape":"ProxySessions", + "documentation":"The proxy session details.
" + }, + "NextToken":{ + "shape":"NextTokenString", + "documentation":"The token to use to retrieve the next page of results.
" + } + } + }, "ListRoomMembershipsRequest":{ "type":"structure", "required":[ @@ -4025,6 +4671,27 @@ } } }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"Arn", + "documentation":"The resource ARN.
", + "location":"querystring", + "locationName":"arn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"A list of tag-key value pairs.
" + } + } + }, "ListUsersRequest":{ "type":"structure", "required":["AccountId"], @@ -4232,6 +4899,10 @@ "shape":"GuidString", "documentation":"The Amazon Chime SDK meeting ID.
" }, + "ExternalMeetingId":{ + "shape":"ExternalMeetingIdType", + "documentation":"The external meeting ID.
" + }, "MediaPlacement":{ "shape":"MediaPlacement", "documentation":"The media placement for the meeting.
" @@ -4261,6 +4932,18 @@ }, "documentation":"The configuration for resource targets to receive notifications when Amazon Chime SDK meeting and attendee events occur.
" }, + "MeetingTagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "MeetingTagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50, + "min":1 + }, "Member":{ "type":"structure", "members":{ @@ -4336,10 +5019,20 @@ "member":{"shape":"MembershipItem"}, "max":50 }, + "NextTokenString":{ + "type":"string", + "max":65535 + }, "NonEmptyString":{ "type":"string", "pattern":".*\\S.*" }, + "NonEmptyString128":{ + "type":"string", + "max":128, + "min":1, + "pattern":".*\\S.*" + }, "NonEmptyStringList":{ "type":"list", "member":{"shape":"String"}, @@ -4356,6 +5049,13 @@ "exception":true }, "NullableBoolean":{"type":"boolean"}, + "NumberSelectionBehavior":{ + "type":"string", + "enum":[ + "PreferSticky", + "AvoidSticky" + ] + }, "OrderedPhoneNumber":{ "type":"structure", "members":{ @@ -4443,6 +5143,30 @@ "max":100, "min":1 }, + "Participant":{ + "type":"structure", + "members":{ + "PhoneNumber":{ + "shape":"E164PhoneNumber", + "documentation":"The participant's phone number.
" + }, + "ProxyPhoneNumber":{ + "shape":"E164PhoneNumber", + "documentation":"The participant's proxy phone number.
" + } + }, + "documentation":"The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session.
" + }, + "ParticipantPhoneNumberList":{ + "type":"list", + "member":{"shape":"E164PhoneNumber"}, + "max":2, + "min":2 + }, + "Participants":{ + "type":"list", + "member":{"shape":"Participant"} + }, "PhoneNumber":{ "type":"structure", "members":{ @@ -4664,11 +5388,112 @@ "max":65535, "min":0 }, + "PositiveInteger":{ + "type":"integer", + "min":1 + }, "ProfileServiceMaxResults":{ "type":"integer", "max":200, "min":1 }, + "Proxy":{ + "type":"structure", + "members":{ + "DefaultSessionExpiryMinutes":{ + "shape":"Integer", + "documentation":"The default number of minutes allowed for proxy sessions.
" + }, + "Disabled":{ + "shape":"Boolean", + "documentation":"When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.
" + }, + "FallBackPhoneNumber":{ + "shape":"E164PhoneNumber", + "documentation":"The phone number to route calls to after a proxy session expires.
" + }, + "PhoneNumberCountries":{ + "shape":"StringList", + "documentation":"The countries for proxy phone numbers to be selected from.
" + } + }, + "documentation":"The proxy configuration for an Amazon Chime Voice Connector.
" + }, + "ProxySession":{ + "type":"structure", + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Amazon Chime voice connector ID.
" + }, + "ProxySessionId":{ + "shape":"NonEmptyString128", + "documentation":"The proxy session ID.
" + }, + "Name":{ + "shape":"String128", + "documentation":"The name of the proxy session.
" + }, + "Status":{ + "shape":"ProxySessionStatus", + "documentation":"The status of the proxy session.
" + }, + "ExpiryMinutes":{ + "shape":"PositiveInteger", + "documentation":"The number of minutes allowed for the proxy session.
" + }, + "Capabilities":{ + "shape":"CapabilityList", + "documentation":"The proxy session capabilities.
" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The created timestamp, in ISO 8601 format.
" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The updated timestamp, in ISO 8601 format.
" + }, + "EndedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The ended timestamp, in ISO 8601 format.
" + }, + "Participants":{ + "shape":"Participants", + "documentation":"The proxy session participants.
" + }, + "NumberSelectionBehavior":{ + "shape":"NumberSelectionBehavior", + "documentation":"The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
" + }, + "GeoMatchLevel":{ + "shape":"GeoMatchLevel", + "documentation":"The preference for matching the country or area code of the proxy phone number with that of the first participant.
" + }, + "GeoMatchParams":{ + "shape":"GeoMatchParams", + "documentation":"The country and area code for the proxy phone number.
" + } + }, + "documentation":"The proxy session for an Amazon Chime Voice Connector.
" + }, + "ProxySessionNameString":{ + "type":"string", + "pattern":"^$|^[a-zA-Z0-9 ]{0,30}$", + "sensitive":true + }, + "ProxySessionStatus":{ + "type":"string", + "enum":[ + "Open", + "InProgress", + "Closed" + ] + }, + "ProxySessions":{ + "type":"list", + "member":{"shape":"ProxySession"} + }, "PutEventsConfigurationRequest":{ "type":"structure", "required":[ @@ -4760,6 +5585,47 @@ } } }, + "PutVoiceConnectorProxyRequest":{ + "type":"structure", + "required":[ + "DefaultSessionExpiryMinutes", + "PhoneNumberPoolCountries", + "VoiceConnectorId" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Amazon Chime voice connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "DefaultSessionExpiryMinutes":{ + "shape":"Integer", + "documentation":"The default number of minutes allowed for proxy sessions.
" + }, + "PhoneNumberPoolCountries":{ + "shape":"CountryList", + "documentation":"The countries for proxy phone numbers to be selected from.
" + }, + "FallBackPhoneNumber":{ + "shape":"E164PhoneNumber", + "documentation":"The phone number to route calls to after a proxy session expires.
" + }, + "Disabled":{ + "shape":"Boolean", + "documentation":"When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.
" + } + } + }, + "PutVoiceConnectorProxyResponse":{ + "type":"structure", + "members":{ + "Proxy":{ + "shape":"Proxy", + "documentation":"The proxy configuration details.
" + } + } + }, "PutVoiceConnectorStreamingConfigurationRequest":{ "type":"structure", "required":[ @@ -5117,10 +5983,118 @@ "documentation":"The streaming configuration associated with an Amazon Chime Voice Connector. Specifies whether media streaming is enabled for sending to Amazon Kinesis, and shows the retention period for the Amazon Kinesis data, in hours.
" }, "String":{"type":"string"}, + "String128":{ + "type":"string", + "max":128 + }, "StringList":{ "type":"list", "member":{"shape":"String"} }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"The key of the tag.
" + }, + "Value":{ + "shape":"TagValue", + "documentation":"The value of the tag.
" + } + }, + "documentation":"Describes a tag applied to a resource.
" + }, + "TagAttendeeRequest":{ + "type":"structure", + "required":[ + "MeetingId", + "AttendeeId", + "Tags" + ], + "members":{ + "MeetingId":{ + "shape":"GuidString", + "documentation":"The Amazon Chime SDK meeting ID.
", + "location":"uri", + "locationName":"meetingId" + }, + "AttendeeId":{ + "shape":"GuidString", + "documentation":"The Amazon Chime SDK attendee ID.
", + "location":"uri", + "locationName":"attendeeId" + }, + "Tags":{ + "shape":"AttendeeTagList", + "documentation":"The tag key-value pairs.
" + } + } + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "sensitive":true + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50, + "min":1 + }, + "TagMeetingRequest":{ + "type":"structure", + "required":[ + "MeetingId", + "Tags" + ], + "members":{ + "MeetingId":{ + "shape":"GuidString", + "documentation":"The Amazon Chime SDK meeting ID.
", + "location":"uri", + "locationName":"meetingId" + }, + "Tags":{ + "shape":"MeetingTagList", + "documentation":"The tag key-value pairs.
" + } + } + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "Tags" + ], + "members":{ + "ResourceARN":{ + "shape":"Arn", + "documentation":"The resource ARN.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tag key-value pairs.
" + } + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":1, + "sensitive":true + }, "TelephonySettings":{ "type":"structure", "required":[ @@ -5220,6 +6194,68 @@ "error":{"httpStatusCode":422}, "exception":true }, + "UntagAttendeeRequest":{ + "type":"structure", + "required":[ + "MeetingId", + "TagKeys", + "AttendeeId" + ], + "members":{ + "MeetingId":{ + "shape":"GuidString", + "documentation":"The Amazon Chime SDK meeting ID.
", + "location":"uri", + "locationName":"meetingId" + }, + "AttendeeId":{ + "shape":"GuidString", + "documentation":"The Amazon Chime SDK attendee ID.
", + "location":"uri", + "locationName":"attendeeId" + }, + "TagKeys":{ + "shape":"AttendeeTagKeyList", + "documentation":"The tag keys.
" + } + } + }, + "UntagMeetingRequest":{ + "type":"structure", + "required":[ + "MeetingId", + "TagKeys" + ], + "members":{ + "MeetingId":{ + "shape":"GuidString", + "documentation":"The Amazon Chime SDK meeting ID.
", + "location":"uri", + "locationName":"meetingId" + }, + "TagKeys":{ + "shape":"MeetingTagKeyList", + "documentation":"The tag keys.
" + } + } + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "TagKeys" + ], + "members":{ + "ResourceARN":{ + "shape":"Arn", + "documentation":"The resource ARN.
" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"The tag keys.
" + } + } + }, "UpdateAccountRequest":{ "type":"structure", "required":["AccountId"], @@ -5382,6 +6418,45 @@ } } }, + "UpdateProxySessionRequest":{ + "type":"structure", + "required":[ + "Capabilities", + "VoiceConnectorId", + "ProxySessionId" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString128", + "documentation":"The Amazon Chime voice connector ID.
", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "ProxySessionId":{ + "shape":"NonEmptyString128", + "documentation":"The proxy session ID.
", + "location":"uri", + "locationName":"proxySessionId" + }, + "Capabilities":{ + "shape":"CapabilityList", + "documentation":"The proxy session capabilities.
" + }, + "ExpiryMinutes":{ + "shape":"PositiveInteger", + "documentation":"The number of minutes allowed for the proxy session.
" + } + } + }, + "UpdateProxySessionResponse":{ + "type":"structure", + "members":{ + "ProxySession":{ + "shape":"ProxySession", + "documentation":"The proxy session details.
" + } + } + }, "UpdateRoomMembershipRequest":{ "type":"structure", "required":[ diff --git a/botocore/data/cloud9/2017-09-23/examples-1.json b/botocore/data/cloud9/2017-09-23/examples-1.json new file mode 100644 index 00000000..0074f498 --- /dev/null +++ b/botocore/data/cloud9/2017-09-23/examples-1.json @@ -0,0 +1,308 @@ +{ + "version": "1.0", + "examples": { + "CreateEnvironmentEC2": [ + { + "input": { + "name": "my-demo-environment", + "automaticStopTimeMinutes": 60, + "description": "This is my demonstration environment.", + "instanceType": "t2.micro", + "ownerArn": "arn:aws:iam::123456789012:user/MyDemoUser", + "subnetId": "subnet-1fab8aEX" + }, + "output": { + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "createenvironmentec2-1516821730547", + "title": "CreateEnvironmentEC2" + } + ], + "CreateEnvironmentMembership": [ + { + "input": { + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX", + "permissions": "read-write", + "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser" + }, + "output": { + "membership": { + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX", + "permissions": "read-write", + "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser", + "userId": "AIDAJ3BA6O2FMJWCWXHEX" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "createenvironmentmembership-1516822583452", + "title": "CreateEnvironmentMembership" + } + ], + "DeleteEnvironment": [ + { + "input": { + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "deleteenvironment-1516822903149", + "title": "DeleteEnvironment" + } + ], + "DeleteEnvironmentMembership": [ + { + "input": { + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX", + "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "deleteenvironmentmembership-1516822975655", + "title": "DeleteEnvironmentMembership" + } + ], + "DescribeEnvironmentMemberships": [ + { + "input": { + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX" + }, + "output": { + "memberships": [ + { + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX", + "permissions": "read-write", + "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser", + "userId": "AIDAJ3BA6O2FMJWCWXHEX" + }, + { + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX", + "permissions": "owner", + "userArn": "arn:aws:iam::123456789012:user/MyDemoUser", + "userId": "AIDAJNUEDQAQWFELJDLEX" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example gets information about all of the environment members for the specified AWS Cloud9 development environment.", + "id": "describeenvironmentmemberships1-1516823070453", + "title": "DescribeEnvironmentMemberships1" + }, + { + "input": { + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX", + "permissions": [ + "owner" + ] + }, + "output": { + "memberships": [ + { + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX", + "permissions": "owner", + "userArn": "arn:aws:iam::123456789012:user/MyDemoUser", + "userId": "AIDAJNUEDQAQWFELJDLEX" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example gets information about the owner of the specified AWS Cloud9 development environment.", + "id": "describeenvironmentmemberships2-1516823191355", + "title": "DescribeEnvironmentMemberships2" + }, + { + "input": { + "userArn": "arn:aws:iam::123456789012:user/MyDemoUser" + }, + "output": { + "memberships": [ + { + "environmentId": "10a75714bd494714929e7f5ec4125aEX", + "lastAccess": "2018-01-19T11:06:13Z", + "permissions": "owner", + "userArn": "arn:aws:iam::123456789012:user/MyDemoUser", + "userId": "AIDAJNUEDQAQWFELJDLEX" + }, + { + "environmentId": "12bfc3cd537f41cb9776f8af5525c9EX", + "lastAccess": "2018-01-19T11:39:19Z", + "permissions": "owner", + "userArn": "arn:aws:iam::123456789012:user/MyDemoUser", + "userId": "AIDAJNUEDQAQWFELJDLEX" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example gets AWS Cloud9 development environment membership information for the specified user.", + "id": "describeenvironmentmemberships3-1516823268793", + "title": "DescribeEnvironmentMemberships3" + } + ], + "DescribeEnvironmentStatus": [ + { + "input": { + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX" + }, + "output": { + "message": "Environment is ready to use", + "status": "ready" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "describeenvironmentstatus-1516823462133", + "title": "DescribeEnvironmentStatus" + } + ], + "DescribeEnvironments": [ + { + "input": { + "environmentIds": [ + "8d9967e2f0624182b74e7690ad69ebEX", + "349c86d4579e4e7298d500ff57a6b2EX" + ] + }, + "output": { + "environments": [ + { + "name": "my-demo-environment", + "type": "ec2", + "arn": "arn:aws:cloud9:us-east-2:123456789012:environment:8d9967e2f0624182b74e7690ad69ebEX", + "description": "This is my demonstration environment.", + "id": "8d9967e2f0624182b74e7690ad69ebEX", + "ownerArn": "arn:aws:iam::123456789012:user/MyDemoUser" + }, + { + "name": "another-demo-environment", + "type": "ssh", + "arn": "arn:aws:cloud9:us-east-2:123456789012:environment:349c86d4579e4e7298d500ff57a6b2EX", + "id": "349c86d4579e4e7298d500ff57a6b2EX", + "ownerArn": "arn:aws:sts::123456789012:assumed-role/AnotherDemoUser/AnotherDemoUser" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "describeenvironments-1516823568291", + "title": "DescribeEnvironments" + } + ], + "ListEnvironments": [ + { + "input": { + }, + "output": { + "environmentIds": [ + "349c86d4579e4e7298d500ff57a6b2EX", + "45a3da47af0840f2b0c0824f5ee232EX" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "listenvironments-1516823687205", + "title": "ListEnvironments" + } + ], + "UpdateEnvironment": [ + { + "input": { + "name": "my-changed-demo-environment", + "description": "This is my changed demonstration environment.", + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "updateenvironment-1516823781910", + "title": "UpdateEnvironment" + } + ], + "UpdateEnvironmentMembership": [ + { + "input": { + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX", + "permissions": "read-only", + "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser" + }, + "output": { + "membership": { + "environmentId": "8d9967e2f0624182b74e7690ad69eb31", + "permissions": "read-only", + "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser", + "userId": "AIDAJ3BA6O2FMJWCWXHEX" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "updateenvironmentmembership-1516823876645", + "title": "UpdateEnvironmentMembership" + } + ] + } +} diff --git a/botocore/data/clouddirectory/2017-01-11/examples-1.json b/botocore/data/clouddirectory/2017-01-11/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/clouddirectory/2017-01-11/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/cloudformation/2010-05-15/examples-1.json b/botocore/data/cloudformation/2010-05-15/examples-1.json index e7802626..0ea7e3b0 100644 --- a/botocore/data/cloudformation/2010-05-15/examples-1.json +++ b/botocore/data/cloudformation/2010-05-15/examples-1.json @@ -1,158 +1,5 @@ { "version": "1.0", "examples": { - "CancelUpdateStack": [ - { - "input": { - "StackName": "MyStack" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "This example cancels an update of the specified stack.", - "id": "to-cancel-a-stack-update-that-is-in-progress-1472747085196", - "title": "To cancel a stack update in progress" - } - ], - "UpdateStack": [ - { - "input": { - "NotificationARNs": [ - - ], - "Parameters": [ - { - "ParameterKey": "KeyPairName", - "ParameterValue": "ExampleKeyPair" - }, - { - "ParameterKey": "SubnetIDs", - "ParameterValue": "ExampleSubnetID1, ExampleSubnetID2" - } - ], - "ResourceTypes": [ - - ], - "StackName": "MyStack", - "Tags": [ - - ], - "TemplateURL": "https://s3.amazonaws.com/example/updated.template" - }, - "output": { - "StackId": "" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "This example updates the template and input parameters for the specified stack.", - "id": "to-update-an-aws-cloudformation-stack-1472841931621", - "title": "To update an AWS CloudFormation stack" - }, - { - "input": { - "NotificationARNs": [ - - ], - "Parameters": [ - { - "ParameterKey": "KeyPairName", - "UsePreviousValue": true - }, - { - "ParameterKey": "SubnetIDs", - "ParameterValue": "SampleSubnetID1, UpdatedSampleSubnetID2" - } - ], - "ResourceTypes": [ - - ], - "StackName": "MyStack", - "Tags": [ - - ], - "TemplateURL": "https://s3.amazonaws.com/example/updated.template" - }, - "output": { - "StackId": "" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "This example updates only the the specified parameter value for the specified stack. If you don't specify a parameter value, AWS CloudFormation uses the default value from the template.", - "id": "to-update-an-aws-cloudformation-stack-1472841931621", - "title": "To update an AWS CloudFormation stack" - }, - { - "input": { - "Capabilities": [ - - ], - "NotificationARNs": [ - "arn:aws:sns:use-east-1:123456789012:mytopic1", - "arn:aws:sns:us-east-1:123456789012:mytopic2" - ], - "Parameters": [ - - ], - "ResourceTypes": [ - - ], - "StackName": "MyStack", - "Tags": [ - - ], - "TemplateURL": "https://s3.amazonaws.com/example/updated.template", - "UsePreviousTemplate": true - }, - "output": { - "StackId": "" - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "This example adds two stack notification topics to the specified stack.", - "id": "to-update-an-aws-cloudformation-stack-1472841931621", - "title": "To update an AWS CloudFormation stack" - } - ], - "ValidateTemplate": [ - { - "input": { - "TemplateBody": "MyTemplate.json" - }, - "output": { - "Capabilities": [ - - ], - "CapabilitiesReason": "", - "Description": "AWS CloudFormation Example Template S3_Bucket: An example template that shows how to create a publicly-accessible S3 bucket. IMPORTANT: This template creates an S3 bucket. You will be billed for the AWS resources used if you create a stack from this template.", - "Parameters": [ - - ] - }, - "comments": { - "input": { - }, - "output": { - } - }, - "description": "This example validates the specified template.", - "id": "to-validate-an-aws-cloudformation-template-1472839072307", - "title": "To validate an AWS CloudFormation template" - } - ] } } diff --git a/botocore/data/cloudformation/2010-05-15/service-2.json b/botocore/data/cloudformation/2010-05-15/service-2.json index e82b51e9..368638c1 100644 --- a/botocore/data/cloudformation/2010-05-15/service-2.json +++ b/botocore/data/cloudformation/2010-05-15/service-2.json @@ -95,7 +95,7 @@ {"shape":"InvalidOperationException"}, {"shape":"LimitExceededException"} ], - "documentation":"Creates stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. You must specify at least one value for either Accounts or DeploymentTargets, and you must specify at least one value for Regions.
Creates stack instances for the specified accounts, within the specified Regions. A stack instance refers to a stack in a specific account and Region. You must specify at least one value for either Accounts or DeploymentTargets, and you must specify at least one value for Regions.
Deletes stack instances for the specified accounts, in the specified regions.
" + "documentation":"Deletes stack instances for the specified accounts, in the specified Regions.
" }, "DeleteStackSet":{ "name":"DeleteStackSet", @@ -268,7 +268,7 @@ {"shape":"StackSetNotFoundException"}, {"shape":"StackInstanceNotFoundException"} ], - "documentation":"Returns the stack instance that's associated with the specified stack set, AWS account, and region.
For a list of stack instances that are associated with a specific stack set, use ListStackInstances.
" + "documentation":"Returns the stack instance that's associated with the specified stack set, AWS account, and Region.
For a list of stack instances that are associated with a specific stack set, use ListStackInstances.
" }, "DescribeStackResource":{ "name":"DescribeStackResource", @@ -535,7 +535,7 @@ "shape":"ListExportsOutput", "resultWrapper":"ListExportsResult" }, - "documentation":"Lists all exported output values in the account and region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the Fn::ImportValue function.
For more information, see AWS CloudFormation Export Stack Output Values.
" + "documentation":"Lists all exported output values in the account and Region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the Fn::ImportValue function.
For more information, see AWS CloudFormation Export Stack Output Values.
" }, "ListImports":{ "name":"ListImports", @@ -564,7 +564,7 @@ "errors":[ {"shape":"StackSetNotFoundException"} ], - "documentation":"Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or region.
" + "documentation":"Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or Region.
" }, "ListStackResources":{ "name":"ListStackResources", @@ -721,7 +721,7 @@ "errors":[ {"shape":"CFNRegistryException"} ], - "documentation":"Registers a type with the CloudFormation service. Registering a type makes it available for use in CloudFormation templates in your AWS account, and includes:
Validating the resource schema
Determining which handlers have been specified for the resource
Making the resource type available for use in your account
For more information on how to develop types and ready them for registeration, see Creating Resource Providers in the CloudFormation CLI User Guide.
Once you have initiated a registration request using RegisterType , you can use DescribeTypeRegistration to monitor the progress of the registration request.
Registers a type with the CloudFormation service. Registering a type makes it available for use in CloudFormation templates in your AWS account, and includes:
Validating the resource schema
Determining which handlers have been specified for the resource
Making the resource type available for use in your account
For more information on how to develop types and ready them for registeration, see Creating Resource Providers in the CloudFormation CLI User Guide.
You can have a maximum of 50 resource type versions registered at a time. This maximum is per account and per region. Use DeregisterType to deregister specific resource type versions if necessary.
Once you have initiated a registration request using RegisterType , you can use DescribeTypeRegistration to monitor the progress of the registration request.
Updates the parameter values for stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region.
You can only update stack instances in regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances.
During stack set updates, any parameters overridden for a stack instance are not updated, but retain their overridden value.
You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.
Updates the parameter values for stack instances for the specified accounts, within the specified Regions. A stack instance refers to a stack in a specific account and Region.
You can only update stack instances in Regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances.
During stack set updates, any parameters overridden for a stack instance are not updated, but retain their overridden value.
You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.
Updates the stack set, and associated stack instances in the specified accounts and regions.
Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.
" + "documentation":"Updates the stack set, and associated stack instances in the specified accounts and Regions.
Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.
" }, "UpdateTerminationProtection":{ "name":"UpdateTerminationProtection", @@ -874,14 +874,14 @@ "members":{ "Status":{ "shape":"AccountGateStatus", - "documentation":"The status of the account gate function.
SUCCEEDED: The account gate function has determined that the account and region passes any requirements for a stack set operation to occur. AWS CloudFormation proceeds with the stack operation in that account and region.
FAILED: The account gate function has determined that the account and region does not meet the requirements for a stack set operation to occur. AWS CloudFormation cancels the stack set operation in that account and region, and sets the stack set operation result status for that account and region to FAILED.
SKIPPED: AWS CloudFormation has skipped calling the account gate function for this account and region, for one of the following reasons:
An account gate function has not been specified for the account and region. AWS CloudFormation proceeds with the stack set operation in this account and region.
The AWSCloudFormationStackSetExecutionRole of the stack set adminstration account lacks permissions to invoke the function. AWS CloudFormation proceeds with the stack set operation in this account and region.
Either no action is necessary, or no action is possible, on the stack. AWS CloudFormation skips the stack set operation in this account and region.
The status of the account gate function.
SUCCEEDED: The account gate function has determined that the account and Region passes any requirements for a stack set operation to occur. AWS CloudFormation proceeds with the stack operation in that account and Region.
FAILED: The account gate function has determined that the account and Region does not meet the requirements for a stack set operation to occur. AWS CloudFormation cancels the stack set operation in that account and Region, and sets the stack set operation result status for that account and Region to FAILED.
SKIPPED: AWS CloudFormation has skipped calling the account gate function for this account and Region, for one of the following reasons:
An account gate function has not been specified for the account and Region. AWS CloudFormation proceeds with the stack set operation in this account and Region.
The AWSCloudFormationStackSetExecutionRole of the stack set adminstration account lacks permissions to invoke the function. AWS CloudFormation proceeds with the stack set operation in this account and Region.
Either no action is necessary, or no action is possible, on the stack. AWS CloudFormation skips the stack set operation in this account and Region.
The reason for the account gate status assigned to this account and region for the stack set operation.
" + "documentation":"The reason for the account gate status assigned to this account and Region for the stack set operation.
" } }, - "documentation":"Structure that contains the results of the account gate function which AWS CloudFormation invokes, if present, before proceeding with a stack set operation in an account and region.
For each account and region, AWS CloudFormation lets you specify a Lamdba function that encapsulates any requirements that must be met before CloudFormation can proceed with a stack set operation in that account and region. CloudFormation invokes the function each time a stack set operation is requested for that account and region; if the function returns FAILED, CloudFormation cancels the operation in that account and region, and sets the stack set operation result status for that account and region to FAILED.
For more information, see Configuring a target account gate.
" + "documentation":"Structure that contains the results of the account gate function which AWS CloudFormation invokes, if present, before proceeding with a stack set operation in an account and Region.
For each account and Region, AWS CloudFormation lets you specify a Lamdba function that encapsulates any requirements that must be met before CloudFormation can proceed with a stack set operation in that account and Region. CloudFormation invokes the function each time a stack set operation is requested for that account and Region; if the function returns FAILED, CloudFormation cancels the operation in that account and Region, and sets the stack set operation result status for that account and Region to FAILED.
For more information, see Configuring a target account gate.
" }, "AccountGateStatus":{ "type":"string", @@ -1268,7 +1268,7 @@ "members":{ "StackName":{ "shape":"StackName", - "documentation":"The name that is associated with the stack. The name must be unique in the region in which you are creating the stack.
A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters.
The name that is associated with the stack. The name must be unique in the Region in which you are creating the stack.
A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters.
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
[Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified region(s) for.
You can specify Accounts or DeploymentTargets, but not both.
[Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.
You can specify Accounts or DeploymentTargets, but not both.
The names of one or more regions where you want to create stack instances using the specified AWS account(s).
" + "documentation":"The names of one or more Regions where you want to create stack instances using the specified AWS account(s).
" }, "ParameterOverrides":{ "shape":"Parameters", - "documentation":"A list of stack set parameters whose values you want to override in the selected stack instances.
Any overridden parameter values will be applied to all stack instances in the specified accounts and regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance operations:
To override the current value for a parameter, include the parameter and specify its value.
To leave a parameter set to its present value, you can do one of the following:
Do not include the parameter in the list.
Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)
To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.
To leave all parameters set to their present values, do not specify this property at all.
During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.
You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.
" + "documentation":"A list of stack set parameters whose values you want to override in the selected stack instances.
Any overridden parameter values will be applied to all stack instances in the specified accounts and Regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance operations:
To override the current value for a parameter, include the parameter and specify its value.
To leave a parameter set to its present value, you can do one of the following:
Do not include the parameter in the list.
Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)
To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.
To leave all parameters set to their present values, do not specify this property at all.
During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.
You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.
" }, "OperationPreferences":{ "shape":"StackSetOperationPreferences", @@ -1400,7 +1400,7 @@ "members":{ "StackSetName":{ "shape":"StackSetName", - "documentation":"The name to associate with the stack set. The name must be unique in the region where you create your stack set.
A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.
The name to associate with the stack set. The name must be unique in the Region where you create your stack set.
A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.
Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.
If you specify AutoDeployment, do not specify DeploymentTargets or Regions.
Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.
[Self-managed permissions] The names of the AWS accounts that you want to delete stack instances for.
You can specify Accounts or DeploymentTargets, but not both.
[Self-managed permissions] The names of the AWS accounts that you want to delete stack instances for.
You can specify Accounts or DeploymentTargets, but not both.
The regions where you want to delete stack set instances.
" + "documentation":"The Regions where you want to delete stack set instances.
" }, "OperationPreferences":{ "shape":"StackSetOperationPreferences", @@ -1588,10 +1588,10 @@ }, "OrganizationalUnitIds":{ "shape":"OrganizationalUnitIdList", - "documentation":"The organization root ID or organizational unit (OUs) IDs to which StackSets deploys.
" + "documentation":"The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
" } }, - "documentation":"[Service-managed permissions] The AWS Organizations accounts to which StackSets deploys.
For update operations, you can specify either Accounts or OrganizationalUnitIds. For create and delete operations, specify OrganizationalUnitIds.
[Service-managed permissions] The AWS Organizations accounts to which StackSets deploys. StackSets does not deploy stack instances to the organization master account, even if the master account is in your organization or in an OU in your organization.
For update operations, you can specify either Accounts or OrganizationalUnitIds. For create and delete operations, specify OrganizationalUnitIds.
The name of a region that's associated with this stack instance.
" + "documentation":"The name of a Region that's associated with this stack instance.
" } } }, @@ -2656,7 +2656,7 @@ }, "StackInstanceRegion":{ "shape":"Region", - "documentation":"The name of the region where you want to list stack instances.
" + "documentation":"The name of the Region where you want to list stack instances.
" } } }, @@ -2732,7 +2732,7 @@ "members":{ "Summaries":{ "shape":"StackSetOperationResultSummaries", - "documentation":"A list of StackSetOperationResultSummary structures that contain information about the specified operation results, for accounts and regions that are included in the operation.
A list of StackSetOperationResultSummary structures that contain information about the specified operation results, for accounts and Regions that are included in the operation.
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
The input for the SetStackPolicy action.
" @@ -3997,11 +3997,11 @@ }, "Region":{ "shape":"Region", - "documentation":"The name of the AWS region that the stack instance is associated with.
" + "documentation":"The name of the AWS Region that the stack instance is associated with.
" }, "Account":{ "shape":"Account", - "documentation":"[Self-managed permissions] The name of the AWS account that the stack instance is associated with.
" + "documentation":"[Self-managed permissions] The name of the AWS account that the stack instance is associated with.
[Service-managed permissions] The organization root ID or organizational unit (OU) ID that the stack instance is associated with.
Reserved for internal use. No data returned.
" }, "DriftStatus":{ "shape":"StackDriftStatus", @@ -4032,7 +4032,7 @@ "documentation":"Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance on which drift detection has not yet been performed.
An AWS CloudFormation stack, in a specific account and region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, as well as the ID of the actual stack and the stack status.
" + "documentation":"An AWS CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, as well as the ID of the actual stack and the stack status.
" }, "StackInstanceNotFoundException":{ "type":"structure", @@ -4067,11 +4067,11 @@ }, "Region":{ "shape":"Region", - "documentation":"The name of the AWS region that the stack instance is associated with.
" + "documentation":"The name of the AWS Region that the stack instance is associated with.
" }, "Account":{ "shape":"Account", - "documentation":"[Self-managed permissions] The name of the AWS account that the stack instance is associated with.
" + "documentation":"[Self-managed permissions] The name of the AWS account that the stack instance is associated with.
[Service-managed permissions] The organization root ID or organizational unit (OU) ID that the stack instance is associated with.
Reserved for internal use. No data returned.
" }, "DriftStatus":{ "shape":"StackDriftStatus", @@ -4445,10 +4445,10 @@ }, "OrganizationalUnitIds":{ "shape":"OrganizationalUnitIdList", - "documentation":"[Service-managed permissions] The organization root ID or organizational unit (OUs) IDs to which stacks in your stack set have been deployed.
Reserved for internal use. No data returned.
" } }, - "documentation":"A structure that contains information about a stack set. A stack set enables you to provision stacks into AWS accounts and across regions by using a single CloudFormation template. In the stack set, you specify the template to use, as well as any parameters and capabilities that the template requires.
" + "documentation":"A structure that contains information about a stack set. A stack set enables you to provision stacks into AWS accounts and across Regions by using a single CloudFormation template. In the stack set, you specify the template to use, as well as any parameters and capabilities that the template requires.
" }, "StackSetARN":{"type":"string"}, "StackSetDriftDetectionDetails":{ @@ -4554,7 +4554,7 @@ }, "Status":{ "shape":"StackSetOperationStatus", - "documentation":"The status of the operation.
FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each region during stack create and update operations. If the number of failed stacks within a region exceeds the failure tolerance, the status of the operation in the region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and AWS CloudFormation cancels the operation in any remaining regions.
QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations. The operation is queued to be performed. For more information, see the stack set operation status codes in the AWS CloudFormation User Guide.
RUNNING: The operation is currently being performed.
STOPPED: The user has cancelled the operation.
STOPPING: The operation is in the process of stopping, at user request.
SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
The status of the operation.
FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and AWS CloudFormation cancels the operation in any remaining Regions.
QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the AWS CloudFormation User Guide.
RUNNING: The operation is currently being performed.
STOPPED: The user has cancelled the operation.
STOPPING: The operation is in the process of stopping, at user request.
SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested regions, before actually creating the first stacks.
" + "documentation":"The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.
" }, "EndTimestamp":{ "shape":"Timestamp", - "documentation":"The time at which the stack set operation ended, across all accounts and regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or region.
" + "documentation":"The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.
" }, "DeploymentTargets":{ "shape":"DeploymentTargets", @@ -4605,15 +4605,15 @@ "members":{ "RegionOrder":{ "shape":"RegionList", - "documentation":"The order of the regions in where you want to perform the stack operation.
" + "documentation":"The order of the Regions in where you want to perform the stack operation.
" }, "FailureToleranceCount":{ "shape":"FailureToleranceCount", - "documentation":"The number of accounts, per region, for which this operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions.
Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).
The number of accounts, per Region, for which this operation can fail before AWS CloudFormation stops the operation in that Region. If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions.
Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).
The percentage of accounts, per region, for which this stack operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions.
When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number.
Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.
The percentage of accounts, per Region, for which this stack operation can fail before AWS CloudFormation stops the operation in that Region. If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions.
When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number.
Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.
[Self-managed permissions] The name of the AWS account for this operation result.
" + "documentation":"[Self-managed permissions] The name of the AWS account for this operation result.
The name of the AWS region for this operation result.
" + "documentation":"The name of the AWS Region for this operation result.
" }, "Status":{ "shape":"StackSetOperationResultStatus", - "documentation":"The result status of the stack set operation for the given account in the given region.
CANCELLED: The operation in the specified account and region has been cancelled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.
FAILED: The operation in the specified account and region failed.
If the stack set operation fails in enough accounts within a region, the failure tolerance for the stack set operation as a whole might be exceeded.
RUNNING: The operation in the specified account and region is currently in progress.
PENDING: The operation in the specified account and region has yet to start.
SUCCEEDED: The operation in the specified account and region completed successfully.
The result status of the stack set operation for the given account in the given Region.
CANCELLED: The operation in the specified account and Region has been cancelled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.
FAILED: The operation in the specified account and Region failed.
If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.
RUNNING: The operation in the specified account and Region is currently in progress.
PENDING: The operation in the specified account and Region has yet to start.
SUCCEEDED: The operation in the specified account and Region completed successfully.
[Service-managed permissions] The organization root ID or organizational unit (OU) ID for this operation result.
Reserved for internal use. No data returned.
" } }, - "documentation":"The structure that contains information about a specified operation's results for a given account in a given region.
" + "documentation":"The structure that contains information about a specified operation's results for a given account in a given Region.
" }, "StackSetOperationStatus":{ "type":"string", @@ -4698,15 +4698,15 @@ }, "Status":{ "shape":"StackSetOperationStatus", - "documentation":"The overall status of the operation.
FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each region during stack create and update operations. If the number of failed stacks within a region exceeds the failure tolerance, the status of the operation in the region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and AWS CloudFormation cancels the operation in any remaining regions.
QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations. The operation is queued to be performed. For more information, see the stack set operation status codes in the AWS CloudFormation User Guide.
RUNNING: The operation is currently being performed.
STOPPED: The user has cancelled the operation.
STOPPING: The operation is in the process of stopping, at user request.
SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
The overall status of the operation.
FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and AWS CloudFormation cancels the operation in any remaining Regions.
QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the AWS CloudFormation User Guide.
RUNNING: The operation is currently being performed.
STOPPED: The user has cancelled the operation.
STOPPING: The operation is in the process of stopping, at user request.
SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested regions, before actually creating the first stacks.
" + "documentation":"The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.
" }, "EndTimestamp":{ "shape":"Timestamp", - "documentation":"The time at which the stack set operation ended, across all accounts and regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or region.
" + "documentation":"The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.
" } }, "documentation":"The structures that contain summary information about the specified operation.
" @@ -5128,7 +5128,7 @@ }, "StackPolicyDuringUpdateURL":{ "shape":"StackPolicyDuringUpdateURL", - "documentation":"Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
" + "documentation":"Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
" }, "Parameters":{ "shape":"Parameters", @@ -5156,7 +5156,7 @@ }, "StackPolicyURL":{ "shape":"StackPolicyURL", - "documentation":"Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
" + "documentation":"Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
" }, "NotificationARNs":{ "shape":"NotificationARNs", @@ -5186,7 +5186,7 @@ }, "Accounts":{ "shape":"AccountList", - "documentation":"[Self-managed permissions] The names of one or more AWS accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.
You can specify Accounts or DeploymentTargets, but not both.
[Self-managed permissions] The names of one or more AWS accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.
You can specify Accounts or DeploymentTargets, but not both.
The names of one or more regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.
" + "documentation":"The names of one or more Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.
" }, "ParameterOverrides":{ "shape":"Parameters", - "documentation":"A list of input parameters whose values you want to update for the specified stack instances.
Any overridden parameter values will be applied to all stack instances in the specified accounts and regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance update operations:
To override the current value for a parameter, include the parameter and specify its value.
To leave a parameter set to its present value, you can do one of the following:
Do not include the parameter in the list.
Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)
To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.
To leave all parameters set to their present values, do not specify this property at all.
During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.
You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.
A list of input parameters whose values you want to update for the specified stack instances.
Any overridden parameter values will be applied to all stack instances in the specified accounts and Regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance update operations:
To override the current value for a parameter, include the parameter and specify its value.
To leave a parameter set to its present value, you can do one of the following:
Do not include the parameter in the list.
Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)
To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.
To leave all parameters set to their present values, do not specify this property at all.
During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.
You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.
[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the regions in which to update stack set instances.
To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.
If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status.
[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Regions in which to update stack set instances.
To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.
If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.
The regions in which to update associated stack instances. If you specify regions, you must also specify accounts in which to update stack set instances.
To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.
If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status.
The Regions in which to update associated stack instances. If you specify Regions, you must also specify accounts in which to update stack set instances.
To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.
If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.
Displays the tags associated with a CloudWatch resource. Alarms support tagging.
" + "documentation":"Displays the tags associated with a CloudWatch resource. Currently, alarms and Contributor Insights rules support tagging.
" }, "PutAnomalyDetector":{ "name":"PutAnomalyDetector", @@ -469,7 +469,7 @@ {"shape":"ConcurrentModificationException"}, {"shape":"InternalServiceFault"} ], - "documentation":"Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
You can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource.
" + "documentation":"Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms and Contributor Insights rules.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
You can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a CloudWatch resource.
" }, "UntagResource":{ "name":"UntagResource", @@ -594,7 +594,7 @@ "documentation":"The metric dimensions associated with the anomaly detection model.
" }, "Stat":{ - "shape":"Stat", + "shape":"AnomalyDetectorMetricStat", "documentation":"The statistic associated with the anomaly detection model.
" }, "Configuration":{ @@ -626,7 +626,15 @@ "type":"list", "member":{"shape":"Range"} }, - "AnomalyDetectorMetricTimezone":{"type":"string"}, + "AnomalyDetectorMetricStat":{ + "type":"string", + "pattern":"(SampleCount|Average|Sum|Minimum|Maximum|p(\\d{1,2}|100)(\\.\\d{0,2})?|[ou]\\d+(\\.\\d*)?)(_E|_L|_H)?" + }, + "AnomalyDetectorMetricTimezone":{ + "type":"string", + "max":50, + "pattern":".*" + }, "AnomalyDetectorStateValue":{ "type":"string", "enum":[ @@ -927,7 +935,7 @@ "documentation":"The metric dimensions associated with the anomaly detection model to delete.
" }, "Stat":{ - "shape":"Stat", + "shape":"AnomalyDetectorMetricStat", "documentation":"The statistic associated with the anomaly detection model to delete.
" } } @@ -1945,7 +1953,7 @@ "members":{ "ResourceARN":{ "shape":"AmazonResourceName", - "documentation":"The ARN of the CloudWatch resource that you want to view tags for. For more information on ARN format, see Example ARNs in the Amazon Web Services General Reference.
" + "documentation":"The ARN of the CloudWatch resource that you want to view tags for.
The ARN format of an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
The ARN format of a Contributor Insights rule is arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name
For more information on ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
" } } }, @@ -2395,7 +2403,7 @@ "documentation":"The metric dimensions to create the anomaly detection model for.
" }, "Stat":{ - "shape":"Stat", + "shape":"AnomalyDetectorMetricStat", "documentation":"The statistic to use for the metric and the anomaly detection model.
" }, "Configuration":{ @@ -2494,6 +2502,10 @@ "RuleDefinition":{ "shape":"InsightRuleDefinition", "documentation":"The definition of the rule, as a JSON object. For details on the valid syntax, see Contributor Insights Rule Syntax.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.
To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.
If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this parameter are ignored. To change the tags of an existing rule, use TagResource.
" } } }, @@ -2863,7 +2875,7 @@ "members":{ "ResourceARN":{ "shape":"AmazonResourceName", - "documentation":"The ARN of the CloudWatch alarm that you're adding tags to. The ARN format is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
The ARN of the CloudWatch resource that you're adding tags to.
The ARN format of an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
The ARN format of a Contributor Insights rule is arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name
For more information on ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
" }, "Tags":{ "shape":"TagList", @@ -2901,7 +2913,7 @@ "members":{ "ResourceARN":{ "shape":"AmazonResourceName", - "documentation":"The ARN of the CloudWatch resource that you're removing tags from. For more information on ARN format, see Example ARNs in the Amazon Web Services General Reference.
" + "documentation":"The ARN of the CloudWatch resource that you're removing tags from.
The ARN format of an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
The ARN format of a Contributor Insights rule is arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name
For more information on ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
" }, "TagKeys":{ "shape":"TagKeyList", diff --git a/botocore/data/codebuild/2016-10-06/examples-1.json b/botocore/data/codebuild/2016-10-06/examples-1.json index 0ea7e3b0..a5fb660e 100644 --- a/botocore/data/codebuild/2016-10-06/examples-1.json +++ b/botocore/data/codebuild/2016-10-06/examples-1.json @@ -1,5 +1,281 @@ { "version": "1.0", "examples": { + "BatchGetBuilds": [ + { + "input": { + "ids": [ + "codebuild-demo-project:9b0ac37f-d19e-4254-9079-f47e9a389eEX", + "codebuild-demo-project:b79a46f7-1473-4636-a23f-da9c45c208EX" + ] + }, + "output": { + "builds": [ + { + "arn": "arn:aws:codebuild:us-east-1:123456789012:build/codebuild-demo-project:9b0ac37f-d19e-4254-9079-f47e9a389eEX", + "artifacts": { + "location": "arn:aws:s3:::codebuild-123456789012-output-bucket/codebuild-demo-project" + }, + "buildComplete": true, + "buildStatus": "SUCCEEDED", + "currentPhase": "COMPLETED", + "endTime": 1479832474.764, + "environment": { + "type": "LINUX_CONTAINER", + "computeType": "BUILD_GENERAL1_SMALL", + "environmentVariables": [ + + ], + "image": "aws/codebuild/java:openjdk-8", + "privilegedMode": false + }, + "id": "codebuild-demo-project:9b0ac37f-d19e-4254-9079-f47e9a389eEX", + "initiator": "MyDemoUser", + "logs": { + "deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#logEvent:group=/aws/codebuild/codebuild-demo-project;stream=9b0ac37f-d19e-4254-9079-f47e9a389eEX", + "groupName": "/aws/codebuild/codebuild-demo-project", + "streamName": "9b0ac37f-d19e-4254-9079-f47e9a389eEX" + }, + "phases": [ + { + "durationInSeconds": 0, + "endTime": 1479832342.23, + "phaseStatus": "SUCCEEDED", + "phaseType": "SUBMITTED", + "startTime": 1479832341.854 + }, + { + "contexts": [ + + ], + "durationInSeconds": 72, + "endTime": 1479832415.064, + "phaseStatus": "SUCCEEDED", + "phaseType": "PROVISIONING", + "startTime": 1479832342.23 + }, + { + "contexts": [ + + ], + "durationInSeconds": 46, + "endTime": 1479832461.261, + "phaseStatus": "SUCCEEDED", + "phaseType": "DOWNLOAD_SOURCE", + "startTime": 1479832415.064 + }, + { + "contexts": [ + + ], + "durationInSeconds": 0, + "endTime": 1479832461.354, + "phaseStatus": "SUCCEEDED", + "phaseType": "INSTALL", + "startTime": 1479832461.261 + }, + { + "contexts": [ + + ], + "durationInSeconds": 0, + "endTime": 1479832461.448, + "phaseStatus": "SUCCEEDED", + "phaseType": "PRE_BUILD", + "startTime": 1479832461.354 + }, + { + "contexts": [ + + ], + "durationInSeconds": 9, + "endTime": 1479832471.115, + "phaseStatus": "SUCCEEDED", + "phaseType": "BUILD", + "startTime": 1479832461.448 + }, + { + "contexts": [ + + ], + "durationInSeconds": 0, + "endTime": 1479832471.224, + "phaseStatus": "SUCCEEDED", + "phaseType": "POST_BUILD", + "startTime": 1479832471.115 + }, + { + "contexts": [ + + ], + "durationInSeconds": 0, + "endTime": 1479832471.791, + "phaseStatus": "SUCCEEDED", + "phaseType": "UPLOAD_ARTIFACTS", + "startTime": 1479832471.224 + }, + { + "contexts": [ + + ], + "durationInSeconds": 2, + "endTime": 1479832474.764, + "phaseStatus": "SUCCEEDED", + "phaseType": "FINALIZING", + "startTime": 1479832471.791 + }, + { + "phaseType": "COMPLETED", + "startTime": 1479832474.764 + } + ], + "projectName": "codebuild-demo-project", + "source": { + "type": "S3", + "buildspec": "", + "location": "arn:aws:s3:::codebuild-123456789012-input-bucket/MessageUtil.zip" + }, + "startTime": 1479832341.854, + "timeoutInMinutes": 60 + }, + { + "arn": "arn:aws:codebuild:us-east-1:123456789012:build/codebuild-demo-project:b79a46f7-1473-4636-a23f-da9c45c208EX", + "artifacts": { + "location": "arn:aws:s3:::codebuild-123456789012-output-bucket/codebuild-demo-project" + }, + "buildComplete": true, + "buildStatus": "SUCCEEDED", + "currentPhase": "COMPLETED", + "endTime": 1479401214.239, + "environment": { + "type": "LINUX_CONTAINER", + "computeType": "BUILD_GENERAL1_SMALL", + "environmentVariables": [ + + ], + "image": "aws/codebuild/java:openjdk-8", + "privilegedMode": false + }, + "id": "codebuild-demo-project:b79a46f7-1473-4636-a23f-da9c45c208EX", + "initiator": "MyDemoUser", + "logs": { + "deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#logEvent:group=/aws/codebuild/codebuild-demo-project;stream=b79a46f7-1473-4636-a23f-da9c45c208EX", + "groupName": "/aws/codebuild/codebuild-demo-project", + "streamName": "b79a46f7-1473-4636-a23f-da9c45c208EX" + }, + "phases": [ + { + "durationInSeconds": 0, + "endTime": 1479401082.342, + "phaseStatus": "SUCCEEDED", + "phaseType": "SUBMITTED", + "startTime": 1479401081.869 + }, + { + "contexts": [ + + ], + "durationInSeconds": 71, + "endTime": 1479401154.129, + "phaseStatus": "SUCCEEDED", + "phaseType": "PROVISIONING", + "startTime": 1479401082.342 + }, + { + "contexts": [ + + ], + "durationInSeconds": 45, + "endTime": 1479401199.136, + "phaseStatus": "SUCCEEDED", + "phaseType": "DOWNLOAD_SOURCE", + "startTime": 1479401154.129 + }, + { + "contexts": [ + + ], + "durationInSeconds": 0, + "endTime": 1479401199.236, + "phaseStatus": "SUCCEEDED", + "phaseType": "INSTALL", + "startTime": 1479401199.136 + }, + { + "contexts": [ + + ], + "durationInSeconds": 0, + "endTime": 1479401199.345, + "phaseStatus": "SUCCEEDED", + "phaseType": "PRE_BUILD", + "startTime": 1479401199.236 + }, + { + "contexts": [ + + ], + "durationInSeconds": 9, + "endTime": 1479401208.68, + "phaseStatus": "SUCCEEDED", + "phaseType": "BUILD", + "startTime": 1479401199.345 + }, + { + "contexts": [ + + ], + "durationInSeconds": 0, + "endTime": 1479401208.783, + "phaseStatus": "SUCCEEDED", + "phaseType": "POST_BUILD", + "startTime": 1479401208.68 + }, + { + "contexts": [ + + ], + "durationInSeconds": 0, + "endTime": 1479401209.463, + "phaseStatus": "SUCCEEDED", + "phaseType": "UPLOAD_ARTIFACTS", + "startTime": 1479401208.783 + }, + { + "contexts": [ + + ], + "durationInSeconds": 4, + "endTime": 1479401214.239, + "phaseStatus": "SUCCEEDED", + "phaseType": "FINALIZING", + "startTime": 1479401209.463 + }, + { + "phaseType": "COMPLETED", + "startTime": 1479401214.239 + } + ], + "projectName": "codebuild-demo-project", + "source": { + "type": "S3", + "location": "arn:aws:s3:::codebuild-123456789012-input-bucket/MessageUtil.zip" + }, + "startTime": 1479401081.869, + "timeoutInMinutes": 60 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example gets information about builds with the specified build IDs.", + "id": "to-get-information-about-builds-1501187184588", + "title": "To get information about builds" + } + ] } } diff --git a/botocore/data/codeguru-reviewer/2019-09-19/service-2.json b/botocore/data/codeguru-reviewer/2019-09-19/service-2.json index f7c36673..d894bb0d 100644 --- a/botocore/data/codeguru-reviewer/2019-09-19/service-2.json +++ b/botocore/data/codeguru-reviewer/2019-09-19/service-2.json @@ -28,7 +28,41 @@ {"shape":"ConflictException"}, {"shape":"ThrottlingException"} ], - "documentation":"Associates an AWS CodeCommit repository with Amazon CodeGuru Reviewer. When you associate an AWS CodeCommit repository with Amazon CodeGuru Reviewer, Amazon CodeGuru Reviewer will provide recommendations for each pull request. You can view recommendations in the AWS CodeCommit repository.
You can associate a GitHub repository using the Amazon CodeGuru Reviewer console.
" + "documentation":"Associates an AWS CodeCommit repository with Amazon CodeGuru Reviewer. When you associate an AWS CodeCommit repository with Amazon CodeGuru Reviewer, Amazon CodeGuru Reviewer will provide recommendations for each pull request raised within the repository. You can view recommendations in the AWS CodeCommit repository.
You can associate a GitHub repository using the Amazon CodeGuru Reviewer console.
" + }, + "DescribeCodeReview":{ + "name":"DescribeCodeReview", + "http":{ + "method":"GET", + "requestUri":"/codereviews/{CodeReviewArn}" + }, + "input":{"shape":"DescribeCodeReviewRequest"}, + "output":{"shape":"DescribeCodeReviewResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns the metadaata associated with the code review along with its status.
" + }, + "DescribeRecommendationFeedback":{ + "name":"DescribeRecommendationFeedback", + "http":{ + "method":"GET", + "requestUri":"/feedback/{CodeReviewArn}" + }, + "input":{"shape":"DescribeRecommendationFeedbackRequest"}, + "output":{"shape":"DescribeRecommendationFeedbackResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Describes the customer feedback for a CodeGuru Reviewer recommendation.
" }, "DescribeRepositoryAssociation":{ "name":"DescribeRepositoryAssociation", @@ -65,6 +99,56 @@ ], "documentation":"Removes the association between Amazon CodeGuru Reviewer and a repository.
" }, + "ListCodeReviews":{ + "name":"ListCodeReviews", + "http":{ + "method":"GET", + "requestUri":"/codereviews" + }, + "input":{"shape":"ListCodeReviewsRequest"}, + "output":{"shape":"ListCodeReviewsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Lists all the code reviews that the customer has created in the past 90 days.
" + }, + "ListRecommendationFeedback":{ + "name":"ListRecommendationFeedback", + "http":{ + "method":"GET", + "requestUri":"/feedback/{CodeReviewArn}/RecommendationFeedback" + }, + "input":{"shape":"ListRecommendationFeedbackRequest"}, + "output":{"shape":"ListRecommendationFeedbackResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Lists the customer feedback for a CodeGuru Reviewer recommendation for all users. This API will be used from the console to extract the previously given feedback by the user to pre-populate the feedback emojis for all recommendations.
" + }, + "ListRecommendations":{ + "name":"ListRecommendations", + "http":{ + "method":"GET", + "requestUri":"/codereviews/{CodeReviewArn}/Recommendations" + }, + "input":{"shape":"ListRecommendationsRequest"}, + "output":{"shape":"ListRecommendationsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns the list of all recommendations for a completed code review.
" + }, "ListRepositoryAssociations":{ "name":"ListRepositoryAssociations", "http":{ @@ -79,6 +163,23 @@ {"shape":"ThrottlingException"} ], "documentation":"Lists repository associations. You can optionally filter on one or more of the following recommendation properties: provider types, states, names, and owners.
" + }, + "PutRecommendationFeedback":{ + "name":"PutRecommendationFeedback", + "http":{ + "method":"PUT", + "requestUri":"/feedback" + }, + "input":{"shape":"PutRecommendationFeedbackRequest"}, + "output":{"shape":"PutRecommendationFeedbackResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Stores customer feedback for a CodeGuru-Reviewer recommendation. When this API is called again with different reactions the previous feedback is overwritten.
" } }, "shapes":{ @@ -95,7 +196,7 @@ "type":"string", "max":1600, "min":1, - "pattern":"^arn:aws[^:\\s]*:codeguru-reviewer:[^:\\s]+:[\\d]{12}:[a-z]+:[\\w-]+$" + "pattern":"^arn:aws[^:\\s]*:codeguru-reviewer:[^:\\s]+:[\\d]{12}:[a-z-]+:[\\w-]+$" }, "AssociateRepositoryRequest":{ "type":"structure", @@ -107,7 +208,7 @@ }, "ClientRequestToken":{ "shape":"ClientRequestToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
If you want to add a new repository association, this parameter specifies a unique identifier for the new repository association that helps ensure idempotency.
If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.
You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given repository association is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified repository association.
Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate repository associations if there are failures and retries.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
To add a new repository association, this parameter specifies a unique identifier for the new repository association that helps ensure idempotency.
If you use the AWS CLI or one of the AWS SDKs to call this operation, you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, you must generate a ClientRequestToken yourself for new versions and include that value in the request.
You typically interact with this value if you implement your own retry logic and want to ensure that a given repository association is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified repository association.
Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate repository associations if there are failures and retries.
", "idempotencyToken":true } } @@ -143,6 +244,137 @@ }, "documentation":"Information about an AWS CodeCommit repository.
" }, + "CodeReview":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"Name", + "documentation":"The name of the code review.
" + }, + "CodeReviewArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the code review to describe.
" + }, + "RepositoryName":{ + "shape":"Name", + "documentation":"The name of the repository.
" + }, + "Owner":{ + "shape":"Owner", + "documentation":"The owner of the repository.
" + }, + "ProviderType":{ + "shape":"ProviderType", + "documentation":"The provider type of the repository association.
" + }, + "State":{ + "shape":"JobState", + "documentation":"The state of the code review.
" + }, + "StateReason":{ + "shape":"StateReason", + "documentation":"The reason for the state of the code review.
" + }, + "CreatedTimeStamp":{ + "shape":"TimeStamp", + "documentation":"The time, in milliseconds since the epoch, when the code review was created.
" + }, + "LastUpdatedTimeStamp":{ + "shape":"TimeStamp", + "documentation":"The time, in milliseconds since the epoch, when the code review was last updated.
" + }, + "Type":{ + "shape":"Type", + "documentation":"The type of code review.
" + }, + "PullRequestId":{ + "shape":"PullRequestId", + "documentation":"The pull request ID for the code review.
" + }, + "SourceCodeType":{ + "shape":"SourceCodeType", + "documentation":"The type of the source code for the code review.
" + }, + "Metrics":{ + "shape":"Metrics", + "documentation":"The statistics from the code review.
" + } + }, + "documentation":"Information about a code review.
" + }, + "CodeReviewSummaries":{ + "type":"list", + "member":{"shape":"CodeReviewSummary"} + }, + "CodeReviewSummary":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"Name", + "documentation":"The name of the code review.
" + }, + "CodeReviewArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the code review to describe.
" + }, + "RepositoryName":{ + "shape":"Name", + "documentation":"The name of the repository.
" + }, + "Owner":{ + "shape":"Owner", + "documentation":"The owner of the repository.
" + }, + "ProviderType":{ + "shape":"ProviderType", + "documentation":"The provider type of the repository association.
" + }, + "State":{ + "shape":"JobState", + "documentation":"The state of the code review.
" + }, + "CreatedTimeStamp":{ + "shape":"TimeStamp", + "documentation":"The time, in milliseconds since the epoch, when the code review was created.
" + }, + "LastUpdatedTimeStamp":{ + "shape":"TimeStamp", + "documentation":"The time, in milliseconds since the epoch, when the code review was last updated.
" + }, + "Type":{ + "shape":"Type", + "documentation":"The type of the code review.
" + }, + "PullRequestId":{ + "shape":"PullRequestId", + "documentation":"The pull request ID for the code review.
" + }, + "MetricsSummary":{ + "shape":"MetricsSummary", + "documentation":"The statistics from the code review.
" + } + }, + "documentation":"Information about the summary of the code review.
" + }, + "CommitDiffSourceCodeType":{ + "type":"structure", + "members":{ + "SourceCommit":{ + "shape":"CommitId", + "documentation":"Source Commit SHA.
" + }, + "DestinationCommit":{ + "shape":"CommitId", + "documentation":"Destination Commit SHA
" + } + }, + "documentation":"The commit diff for the pull request.
" + }, + "CommitId":{ + "type":"string", + "max":64, + "min":6 + }, "ConflictException":{ "type":"structure", "members":{ @@ -152,13 +384,70 @@ "error":{"httpStatusCode":409}, "exception":true }, + "DescribeCodeReviewRequest":{ + "type":"structure", + "required":["CodeReviewArn"], + "members":{ + "CodeReviewArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the code review to describe.
", + "location":"uri", + "locationName":"CodeReviewArn" + } + } + }, + "DescribeCodeReviewResponse":{ + "type":"structure", + "members":{ + "CodeReview":{ + "shape":"CodeReview", + "documentation":"Information about the code review.
" + } + } + }, + "DescribeRecommendationFeedbackRequest":{ + "type":"structure", + "required":[ + "CodeReviewArn", + "RecommendationId" + ], + "members":{ + "CodeReviewArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) that identifies the code review.
", + "location":"uri", + "locationName":"CodeReviewArn" + }, + "RecommendationId":{ + "shape":"RecommendationId", + "documentation":"The recommendation ID that can be used to track the provided recommendations and then to collect the feedback.
", + "location":"querystring", + "locationName":"RecommendationId" + }, + "UserId":{ + "shape":"UserId", + "documentation":"Optional parameter to describe the feedback for a given user. If this is not supplied, it defaults to the user making the request.
", + "location":"querystring", + "locationName":"UserId" + } + } + }, + "DescribeRecommendationFeedbackResponse":{ + "type":"structure", + "members":{ + "RecommendationFeedback":{ + "shape":"RecommendationFeedback", + "documentation":"The recommendation feedback given by the user.
" + } + } + }, "DescribeRepositoryAssociationRequest":{ "type":"structure", "required":["AssociationArn"], "members":{ "AssociationArn":{ "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) identifying the association.
", + "documentation":"The Amazon Resource Name (ARN) identifying the association. You can retrieve this ARN by calling ListRepositories.
List of provider types for filtering that needs to be applied before displaying the result. For example, \"providerTypes=[GitHub]\" will list code reviews from GitHub.
", + "location":"querystring", + "locationName":"ProviderTypes" + }, + "States":{ + "shape":"JobStates", + "documentation":"List of states for filtering that needs to be applied before displaying the result. For example, \"states=[Pending]\" will list code reviews in the Pending state.
", + "location":"querystring", + "locationName":"States" + }, + "RepositoryNames":{ + "shape":"RepositoryNames", + "documentation":"List of repository names for filtering that needs to be applied before displaying the result.
", + "location":"querystring", + "locationName":"RepositoryNames" + }, + "Type":{ + "shape":"Type", + "documentation":"The type of code reviews to list in the response.
", + "location":"querystring", + "locationName":"Type" + }, + "MaxResults":{ + "shape":"ListCodeReviewsMaxResults", + "documentation":"The maximum number of results that are returned per call. The default is 100.
", + "location":"querystring", + "locationName":"MaxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
", + "location":"querystring", + "locationName":"NextToken" + } + } + }, + "ListCodeReviewsResponse":{ + "type":"structure", + "members":{ + "CodeReviewSummaries":{ + "shape":"CodeReviewSummaries", + "documentation":"A list of code reviews that meet the criteria of the request.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"Pagination token.
" + } + } + }, + "ListRecommendationFeedbackRequest":{ + "type":"structure", + "required":["CodeReviewArn"], + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results that are returned per call. The default is 100.
", + "location":"querystring", + "locationName":"MaxResults" + }, + "CodeReviewArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) that identifies the code review.
", + "location":"uri", + "locationName":"CodeReviewArn" + }, + "UserIds":{ + "shape":"UserIds", + "documentation":"Filter on userIds that need to be applied before displaying the result. This can be used to query all the recommendation feedback for a code review from a given user.
", + "location":"querystring", + "locationName":"UserIds" + }, + "RecommendationIds":{ + "shape":"RecommendationIds", + "documentation":"Filter on recommendationIds that need to be applied before displaying the result. This can be used to query all the recommendation feedback for a given recommendation.
", + "location":"querystring", + "locationName":"RecommendationIds" + } + } + }, + "ListRecommendationFeedbackResponse":{ + "type":"structure", + "members":{ + "RecommendationFeedbackSummaries":{ + "shape":"RecommendationFeedbackSummaries", + "documentation":"Recommendation feedback summaries corresponding to the code reivew ARN.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
" + } + } + }, + "ListRecommendationsRequest":{ + "type":"structure", + "required":["CodeReviewArn"], + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"Pagination token.
", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results that are returned per call. The default is 100.
", + "location":"querystring", + "locationName":"MaxResults" + }, + "CodeReviewArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the code review to describe.
", + "location":"uri", + "locationName":"CodeReviewArn" + } + } + }, + "ListRecommendationsResponse":{ + "type":"structure", + "members":{ + "RecommendationSummaries":{ + "shape":"RecommendationSummaries", + "documentation":"List of recommendations for the requested code review.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"Pagination token.
" + } + } + }, "ListRepositoryAssociationsRequest":{ "type":"structure", "members":{ @@ -222,25 +679,25 @@ }, "Names":{ "shape":"Names", - "documentation":"List of names to use as a filter.
", + "documentation":"List of repository names to use as a filter.
", "location":"querystring", "locationName":"Name" }, "Owners":{ "shape":"Owners", - "documentation":"List of owners to use as a filter. For AWS CodeCommit, the owner is the AWS account id. For GitHub, it is the GitHub account name.
", + "documentation":"List of owners to use as a filter. For GitHub, this is name of the GitHub account that was used to associate the repository. For AWS CodeCommit, it is the name of the CodeCommit account that was used to associate the repository.
", "location":"querystring", "locationName":"Owner" }, "MaxResults":{ "shape":"MaxResults", - "documentation":"The maximum number of repository association results returned by ListRepositoryAssociations in paginated output. When this parameter is used, ListRepositoryAssociations only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRepositoryAssociations request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRepositoryAssociations returns up to 100 results and a nextToken value if applicable.
The maximum number of repository association results returned by ListRepositoryAssociations in paginated output. When this parameter is used, ListRepositoryAssociations only returns maxResults results in a single page with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRepositoryAssociations request with the returned nextToken value. This value can be between 1 and 25. If this parameter is not used, ListRepositoryAssociations returns up to 25 results and a nextToken value if applicable.
The nextToken value returned from a previous paginated ListRepositoryAssociations request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken value returned from a previous paginated ListRepositoryAssociations request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
Treat this token as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
Lines of code metered in the code review.
" + }, + "FindingsCount":{ + "shape":"FindingsCount", + "documentation":"Total number of recommendations found in the code review.
" + } + }, + "documentation":"Information about the statistics from the code review.
" + }, + "MetricsSummary":{ + "type":"structure", + "members":{ + "MeteredLinesOfCodeCount":{ + "shape":"MeteredLinesOfCodeCount", + "documentation":"Lines of code metered in the code review.
" + }, + "FindingsCount":{ + "shape":"FindingsCount", + "documentation":"Total number of recommendations found in the code review.
" + } + }, + "documentation":"Information about metrics summaries.
" + }, "Name":{ "type":"string", "max":100, - "min":1 + "min":1, + "pattern":"^\\S[\\w.-]*$" }, "Names":{ "type":"list", @@ -292,7 +779,8 @@ "Owner":{ "type":"string", "max":100, - "min":1 + "min":1, + "pattern":"^\\S(.*\\S)?$" }, "Owners":{ "type":"list", @@ -313,6 +801,144 @@ "max":3, "min":1 }, + "PullRequestId":{ + "type":"string", + "max":64, + "min":1 + }, + "PutRecommendationFeedbackRequest":{ + "type":"structure", + "required":[ + "CodeReviewArn", + "RecommendationId", + "Reactions" + ], + "members":{ + "CodeReviewArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) that identifies the code review.
" + }, + "RecommendationId":{ + "shape":"RecommendationId", + "documentation":"The recommendation ID that can be used to track the provided recommendations and then to collect the feedback.
" + }, + "Reactions":{ + "shape":"Reactions", + "documentation":"List for storing reactions. Reactions are utf-8 text code for emojis. If you send an empty list it clears all your feedback.
" + } + } + }, + "PutRecommendationFeedbackResponse":{ + "type":"structure", + "members":{ + } + }, + "Reaction":{ + "type":"string", + "enum":[ + "ThumbsUp", + "ThumbsDown" + ] + }, + "Reactions":{ + "type":"list", + "member":{"shape":"Reaction"}, + "max":1, + "min":0 + }, + "RecommendationFeedback":{ + "type":"structure", + "members":{ + "CodeReviewArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) that identifies the code review.
" + }, + "RecommendationId":{ + "shape":"RecommendationId", + "documentation":"The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.
" + }, + "Reactions":{ + "shape":"Reactions", + "documentation":"List for storing reactions. Reactions are utf-8 text code for emojis. You can send an empty list to clear off all your feedback.
" + }, + "UserId":{ + "shape":"UserId", + "documentation":"The user principal that made the API call.
" + }, + "CreatedTimeStamp":{ + "shape":"TimeStamp", + "documentation":"The time at which the feedback was created.
" + }, + "LastUpdatedTimeStamp":{ + "shape":"TimeStamp", + "documentation":"The time at which the feedback was last updated.
" + } + }, + "documentation":"Information about the recommendation feedback.
" + }, + "RecommendationFeedbackSummaries":{ + "type":"list", + "member":{"shape":"RecommendationFeedbackSummary"} + }, + "RecommendationFeedbackSummary":{ + "type":"structure", + "members":{ + "RecommendationId":{ + "shape":"RecommendationId", + "documentation":"The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.
" + }, + "Reactions":{ + "shape":"Reactions", + "documentation":"List for storing reactions. Reactions are utf-8 text code for emojis.
" + }, + "UserId":{ + "shape":"UserId", + "documentation":"The identifier for the user that gave the feedback.
" + } + }, + "documentation":"Information about recommendation feedback summaries.
" + }, + "RecommendationId":{ + "type":"string", + "max":64, + "min":1 + }, + "RecommendationIds":{ + "type":"list", + "member":{"shape":"RecommendationId"}, + "max":100, + "min":1 + }, + "RecommendationSummaries":{ + "type":"list", + "member":{"shape":"RecommendationSummary"} + }, + "RecommendationSummary":{ + "type":"structure", + "members":{ + "FilePath":{ + "shape":"FilePath", + "documentation":"Name of the file on which a recommendation is provided.
" + }, + "RecommendationId":{ + "shape":"RecommendationId", + "documentation":"The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.
" + }, + "StartLine":{ + "shape":"LineNumber", + "documentation":"Start line from where the recommendation is applicable in the source commit or source branch.
" + }, + "EndLine":{ + "shape":"LineNumber", + "documentation":"Last line where the recommendation is applicable in the source commit or source branch. For a single line comment the start line and end line values will be the same.
" + }, + "Description":{ + "shape":"Text", + "documentation":"A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.
" + } + }, + "documentation":"Information about recommendations.
" + }, "Repository":{ "type":"structure", "members":{ @@ -328,7 +954,7 @@ "members":{ "AssociationId":{ "shape":"AssociationId", - "documentation":"The id of the repository association.
" + "documentation":"The ID of the repository association.
" }, "AssociationArn":{ "shape":"Arn", @@ -413,16 +1039,46 @@ }, "State":{ "shape":"RepositoryAssociationState", - "documentation":"The state of the repository association.
Amazon CodeGuru Reviewer is associated with the repository.
The association is in progress.
The association failed. For more information about troubleshooting (or why it failed), see [troubleshooting topic].
Amazon CodeGuru Reviewer is in the process of disassociating with the repository.
The state of the repository association.
Amazon CodeGuru Reviewer is associated with the repository.
The association is in progress.
The association failed.
Amazon CodeGuru Reviewer is in the process of disassociating with the repository.
Information about a repository association.
" }, + "RepositoryNames":{ + "type":"list", + "member":{"shape":"Name"}, + "max":100, + "min":1 + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"The resource specified in the request was not found.
", + "error":{"httpStatusCode":404}, + "exception":true + }, + "SourceCodeType":{ + "type":"structure", + "members":{ + "CommitDiff":{ + "shape":"CommitDiffSourceCodeType", + "documentation":"The commit diff for the pull request.
" + } + }, + "documentation":"Information about the source code type.
" + }, "StateReason":{ "type":"string", "max":256, "min":0 }, + "Text":{ + "type":"string", + "max":2048, + "min":1 + }, "ThrottlingException":{ "type":"structure", "members":{ @@ -433,6 +1089,21 @@ "exception":true }, "TimeStamp":{"type":"timestamp"}, + "Type":{ + "type":"string", + "enum":["PullRequest"] + }, + "UserId":{ + "type":"string", + "max":256, + "min":1 + }, + "UserIds":{ + "type":"list", + "member":{"shape":"UserId"}, + "max":100, + "min":1 + }, "ValidationException":{ "type":"structure", "members":{ diff --git a/botocore/data/codeguruprofiler/2019-07-18/paginators-1.json b/botocore/data/codeguruprofiler/2019-07-18/paginators-1.json index ea142457..c787d76c 100644 --- a/botocore/data/codeguruprofiler/2019-07-18/paginators-1.json +++ b/botocore/data/codeguruprofiler/2019-07-18/paginators-1.json @@ -1,3 +1,10 @@ { - "pagination": {} + "pagination": { + "ListProfileTimes": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "profileTimes" + } + } } diff --git a/botocore/data/codeguruprofiler/2019-07-18/service-2.json b/botocore/data/codeguruprofiler/2019-07-18/service-2.json index f9f10049..1190d157 100644 --- a/botocore/data/codeguruprofiler/2019-07-18/service-2.json +++ b/botocore/data/codeguruprofiler/2019-07-18/service-2.json @@ -83,6 +83,22 @@ ], "documentation":"Describes a profiling group.
" }, + "GetPolicy":{ + "name":"GetPolicy", + "http":{ + "method":"GET", + "requestUri":"/profilingGroups/{profilingGroupName}/policy", + "responseCode":200 + }, + "input":{"shape":"GetPolicyRequest"}, + "output":{"shape":"GetPolicyResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Gets the profiling group policy.
" + }, "GetProfile":{ "name":"GetProfile", "http":{ @@ -149,6 +165,43 @@ ], "documentation":"" }, + "PutPermission":{ + "name":"PutPermission", + "http":{ + "method":"PUT", + "requestUri":"/profilingGroups/{profilingGroupName}/policy/{actionGroup}", + "responseCode":200 + }, + "input":{"shape":"PutPermissionRequest"}, + "output":{"shape":"PutPermissionResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Provides permission to the principals. This overwrites the existing permissions, and is not additive.
", + "idempotent":true + }, + "RemovePermission":{ + "name":"RemovePermission", + "http":{ + "method":"DELETE", + "requestUri":"/profilingGroups/{profilingGroupName}/policy/{actionGroup}", + "responseCode":200 + }, + "input":{"shape":"RemovePermissionRequest"}, + "output":{"shape":"RemovePermissionResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Removes statement for the provided action group from the policy.
" + }, "UpdateProfilingGroup":{ "name":"UpdateProfilingGroup", "http":{ @@ -170,6 +223,10 @@ } }, "shapes":{ + "ActionGroup":{ + "type":"string", + "enum":["agentPermissions"] + }, "AgentConfiguration":{ "type":"structure", "required":[ @@ -362,6 +419,37 @@ "min":1, "pattern":"^[\\w-.:/]+$" }, + "GetPolicyRequest":{ + "type":"structure", + "required":["profilingGroupName"], + "members":{ + "profilingGroupName":{ + "shape":"ProfilingGroupName", + "documentation":"The name of the profiling group.
", + "location":"uri", + "locationName":"profilingGroupName" + } + }, + "documentation":"The structure representing the getPolicyRequest.
" + }, + "GetPolicyResponse":{ + "type":"structure", + "required":[ + "policy", + "revisionId" + ], + "members":{ + "policy":{ + "shape":"String", + "documentation":"The resource-based policy attached to the ProfilingGroup.
A unique identifier for the current revision of the policy.
" + } + }, + "documentation":"The structure representing the getPolicyResponse.
" + }, "GetProfileRequest":{ "type":"structure", "required":["profilingGroupName"], @@ -630,6 +718,13 @@ }, "documentation":"The structure representing the postAgentProfileResponse.
" }, + "Principal":{"type":"string"}, + "Principals":{ + "type":"list", + "member":{"shape":"Principal"}, + "max":50, + "min":1 + }, "ProfileTime":{ "type":"structure", "members":{ @@ -707,6 +802,102 @@ }, "documentation":"Information about the profiling status.
" }, + "PutPermissionRequest":{ + "type":"structure", + "required":[ + "actionGroup", + "principals", + "profilingGroupName" + ], + "members":{ + "actionGroup":{ + "shape":"ActionGroup", + "documentation":"The list of actions that the users and roles can perform on the profiling group.
", + "location":"uri", + "locationName":"actionGroup" + }, + "principals":{ + "shape":"Principals", + "documentation":"The list of role and user ARNs or the accountId that needs access (wildcards are not allowed).
" + }, + "profilingGroupName":{ + "shape":"ProfilingGroupName", + "documentation":"The name of the profiling group.
", + "location":"uri", + "locationName":"profilingGroupName" + }, + "revisionId":{ + "shape":"RevisionId", + "documentation":"A unique identifier for the current revision of the policy. This is required, if a policy exists for the profiling group. This is not required when creating the policy for the first time.
" + } + }, + "documentation":"The structure representing the putPermissionRequest.
" + }, + "PutPermissionResponse":{ + "type":"structure", + "required":[ + "policy", + "revisionId" + ], + "members":{ + "policy":{ + "shape":"String", + "documentation":"The resource-based policy.
" + }, + "revisionId":{ + "shape":"RevisionId", + "documentation":"A unique identifier for the current revision of the policy.
" + } + }, + "documentation":"The structure representing the putPermissionResponse.
" + }, + "RemovePermissionRequest":{ + "type":"structure", + "required":[ + "actionGroup", + "profilingGroupName", + "revisionId" + ], + "members":{ + "actionGroup":{ + "shape":"ActionGroup", + "documentation":"The list of actions that the users and roles can perform on the profiling group.
", + "location":"uri", + "locationName":"actionGroup" + }, + "profilingGroupName":{ + "shape":"ProfilingGroupName", + "documentation":"The name of the profiling group.
", + "location":"uri", + "locationName":"profilingGroupName" + }, + "revisionId":{ + "shape":"RevisionId", + "documentation":"A unique identifier for the current revision of the policy.
", + "location":"querystring", + "locationName":"revisionId" + } + }, + "documentation":"The structure representing the removePermissionRequest.
" + }, + "RemovePermissionResponse":{ + "type":"structure", + "required":[ + "policy", + "revisionId" + ], + "members":{ + "policy":{ + "shape":"String", + "documentation":"The resource-based policy.
" + }, + "revisionId":{ + "shape":"RevisionId", + "documentation":"A unique identifier for the current revision of the policy.
" + } + }, + "documentation":"The structure representing the removePermissionResponse.
" + }, "ResourceNotFoundException":{ "type":"structure", "required":["message"], @@ -720,6 +911,10 @@ }, "exception":true }, + "RevisionId":{ + "type":"string", + "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" + }, "ServiceQuotaExceededException":{ "type":"structure", "required":["message"], diff --git a/botocore/data/codestar/2017-04-19/examples-1.json b/botocore/data/codestar/2017-04-19/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/codestar/2017-04-19/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/comprehend/2017-11-27/examples-1.json b/botocore/data/comprehend/2017-11-27/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/comprehend/2017-11-27/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/connect/2017-08-08/examples-1.json b/botocore/data/connect/2017-08-08/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/connect/2017-08-08/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/dax/2017-04-19/examples-1.json b/botocore/data/dax/2017-04-19/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/dax/2017-04-19/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/detective/2018-10-26/service-2.json b/botocore/data/detective/2018-10-26/service-2.json index 078c7194..67d527b7 100644 --- a/botocore/data/detective/2018-10-26/service-2.json +++ b/botocore/data/detective/2018-10-26/service-2.json @@ -25,7 +25,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], - "documentation":"Amazon Detective is currently in preview.
Accepts an invitation for the member account to contribute data to a behavior graph. This operation can only be called by an invited member account.
The request provides the ARN of behavior graph.
The member account status in the graph must be INVITED.
Accepts an invitation for the member account to contribute data to a behavior graph. This operation can only be called by an invited member account.
The request provides the ARN of behavior graph.
The member account status in the graph must be INVITED.
Amazon Detective is currently in preview.
Creates a new behavior graph for the calling account, and sets that account as the master account. This operation is called by the account that is enabling Detective.
The operation also enables Detective for the calling account in the currently selected Region. It returns the ARN of the new behavior graph.
CreateGraph triggers a process to create the corresponding data tables for the new behavior graph.
An account can only be the master account for one behavior graph within a Region. If the same account calls CreateGraph with the same master account, it always returns the same behavior graph ARN. It does not create a new behavior graph.
Creates a new behavior graph for the calling account, and sets that account as the master account. This operation is called by the account that is enabling Detective.
Before you try to enable Detective, make sure that your account has been enrolled in Amazon GuardDuty for at least 48 hours. If you do not meet this requirement, you cannot enable Detective. If you do meet the GuardDuty prerequisite, then when you make the request to enable Detective, it checks whether your data volume is within the Detective quota. If it exceeds the quota, then you cannot enable Detective.
The operation also enables Detective for the calling account in the currently selected Region. It returns the ARN of the new behavior graph.
CreateGraph triggers a process to create the corresponding data tables for the new behavior graph.
An account can only be the master account for one behavior graph within a Region. If the same account calls CreateGraph with the same master account, it always returns the same behavior graph ARN. It does not create a new behavior graph.
Amazon Detective is currently in preview.
Sends a request to invite the specified AWS accounts to be member accounts in the behavior graph. This operation can only be called by the master account for a behavior graph.
CreateMembers verifies the accounts and then sends invitations to the verified accounts.
The request provides the behavior graph ARN and the list of accounts to invite.
The response separates the requested accounts into two lists:
The accounts that CreateMembers was able to start the verification for. This list includes member accounts that are being verified, that have passed verification and are being sent an invitation, and that have failed verification.
The accounts that CreateMembers was unable to process. This list includes accounts that were already invited to be member accounts in the behavior graph.
Sends a request to invite the specified AWS accounts to be member accounts in the behavior graph. This operation can only be called by the master account for a behavior graph.
CreateMembers verifies the accounts and then sends invitations to the verified accounts.
The request provides the behavior graph ARN and the list of accounts to invite.
The response separates the requested accounts into two lists:
The accounts that CreateMembers was able to start the verification for. This list includes member accounts that are being verified, that have passed verification and are being sent an invitation, and that have failed verification.
The accounts that CreateMembers was unable to process. This list includes accounts that were already invited to be member accounts in the behavior graph.
Amazon Detective is currently in preview.
Disables the specified behavior graph and queues it to be deleted. This operation removes the graph from each member account's list of behavior graphs.
DeleteGraph can only be called by the master account for a behavior graph.
Disables the specified behavior graph and queues it to be deleted. This operation removes the graph from each member account's list of behavior graphs.
DeleteGraph can only be called by the master account for a behavior graph.
Amazon Detective is currently in preview.
Deletes one or more member accounts from the master account behavior graph. This operation can only be called by a Detective master account. That account cannot use DeleteMembers to delete their own account from the behavior graph. To disable a behavior graph, the master account uses the DeleteGraph API method.
Deletes one or more member accounts from the master account behavior graph. This operation can only be called by a Detective master account. That account cannot use DeleteMembers to delete their own account from the behavior graph. To disable a behavior graph, the master account uses the DeleteGraph API method.
Amazon Detective is currently in preview.
Removes the member account from the specified behavior graph. This operation can only be called by a member account that has the ENABLED status.
Removes the member account from the specified behavior graph. This operation can only be called by a member account that has the ENABLED status.
Amazon Detective is currently in preview.
Returns the membership details for specified member accounts for a behavior graph.
" + "documentation":"Returns the membership details for specified member accounts for a behavior graph.
" }, "ListGraphs":{ "name":"ListGraphs", @@ -128,7 +129,7 @@ {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], - "documentation":"Amazon Detective is currently in preview.
Returns the list of behavior graphs that the calling account is a master of. This operation can only be called by a master account.
Because an account can currently only be the master of one behavior graph within a Region, the results always contain a single graph.
" + "documentation":"Returns the list of behavior graphs that the calling account is a master of. This operation can only be called by a master account.
Because an account can currently only be the master of one behavior graph within a Region, the results always contain a single graph.
" }, "ListInvitations":{ "name":"ListInvitations", @@ -142,7 +143,7 @@ {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], - "documentation":"Amazon Detective is currently in preview.
Retrieves the list of open and accepted behavior graph invitations for the member account. This operation can only be called by a member account.
Open invitations are invitations that the member account has not responded to.
The results do not include behavior graphs for which the member account declined the invitation. The results also do not include behavior graphs that the member account resigned from or was removed from.
" + "documentation":"Retrieves the list of open and accepted behavior graph invitations for the member account. This operation can only be called by a member account.
Open invitations are invitations that the member account has not responded to.
The results do not include behavior graphs for which the member account declined the invitation. The results also do not include behavior graphs that the member account resigned from or was removed from.
" }, "ListMembers":{ "name":"ListMembers", @@ -157,7 +158,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], - "documentation":"Amazon Detective is currently in preview.
Retrieves the list of member accounts for a behavior graph. Does not return member accounts that were removed from the behavior graph.
" + "documentation":"Retrieves the list of member accounts for a behavior graph. Does not return member accounts that were removed from the behavior graph.
" }, "RejectInvitation":{ "name":"RejectInvitation", @@ -172,7 +173,23 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], - "documentation":"Amazon Detective is currently in preview.
Rejects an invitation to contribute the account data to a behavior graph. This operation must be called by a member account that has the INVITED status.
Rejects an invitation to contribute the account data to a behavior graph. This operation must be called by a member account that has the INVITED status.
Sends a request to enable data ingest for a member account that has a status of ACCEPTED_BUT_DISABLED.
For valid member accounts, the status is updated as follows.
If Detective enabled the member account, then the new status is ENABLED.
If Detective cannot enable the member account, the status remains ACCEPTED_BUT_DISABLED.
The AWS account root user email address for the AWS account.
" } }, - "documentation":"Amazon Detective is currently in preview.
An AWS account that is the master of or a member of a behavior graph.
" + "documentation":"An AWS account that is the master of or a member of a behavior graph.
" }, "AccountId":{ "type":"string", @@ -378,7 +395,7 @@ "documentation":"The date and time that the behavior graph was created. The value is in milliseconds since the epoch.
" } }, - "documentation":"Amazon Detective is currently in preview.
A behavior graph in Detective.
" + "documentation":"A behavior graph in Detective.
" }, "GraphArn":{ "type":"string", @@ -501,7 +518,11 @@ }, "Status":{ "shape":"MemberStatus", - "documentation":"The current membership status of the member account. The status can have one of the following values:
INVITED - Indicates that the member was sent an invitation but has not yet responded.
VERIFICATION_IN_PROGRESS - Indicates that Detective is verifying that the account identifier and email address provided for the member account match. If they do match, then Detective sends the invitation. If the email address and account identifier don't match, then the member cannot be added to the behavior graph.
VERIFICATION_FAILED - Indicates that the account and email address provided for the member account do not match, and Detective did not send an invitation to the account.
ENABLED - Indicates that the member account accepted the invitation to contribute to the behavior graph.
Member accounts that declined an invitation or that were removed from the behavior graph are not included.
" + "documentation":"The current membership status of the member account. The status can have one of the following values:
INVITED - Indicates that the member was sent an invitation but has not yet responded.
VERIFICATION_IN_PROGRESS - Indicates that Detective is verifying that the account identifier and email address provided for the member account match. If they do match, then Detective sends the invitation. If the email address and account identifier don't match, then the member cannot be added to the behavior graph.
VERIFICATION_FAILED - Indicates that the account and email address provided for the member account do not match, and Detective did not send an invitation to the account.
ENABLED - Indicates that the member account accepted the invitation to contribute to the behavior graph.
ACCEPTED_BUT_DISABLED - Indicates that the member account accepted the invitation but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.
Member accounts that declined an invitation or that were removed from the behavior graph are not included.
" + }, + "DisabledReason":{ + "shape":"MemberDisabledReason", + "documentation":"For member accounts with a status of ACCEPTED_BUT_DISABLED, the reason that the member account is not enabled.
The reason can have one of the following values:
VOLUME_TOO_HIGH - Indicates that adding the member account would cause the data volume for the behavior graph to be too high.
VOLUME_UNKNOWN - Indicates that Detective is unable to verify the data volume for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.
The date and time that the member account was last updated. The value is in milliseconds since the epoch.
" + }, + "PercentOfGraphUtilization":{ + "shape":"Percentage", + "documentation":"The member account data volume as a percentage of the maximum allowed data volume. 0 indicates 0 percent, and 100 indicates 100 percent.
Note that this is not the percentage of the behavior graph data volume.
For example, the data volume for the behavior graph is 80 GB per day. The maximum data volume is 160 GB per day. If the data volume for the member account is 40 GB per day, then PercentOfGraphUtilization is 25. It represents 25% of the maximum allowed data volume.
The date and time when the graph utilization percentage was last updated.
" } }, - "documentation":"Amazon Detective is currently in preview.
Details about a member account that was invited to contribute to a behavior graph.
" + "documentation":"Details about a member account that was invited to contribute to a behavior graph.
" }, "MemberDetailList":{ "type":"list", "member":{"shape":"MemberDetail"} }, + "MemberDisabledReason":{ + "type":"string", + "enum":[ + "VOLUME_TOO_HIGH", + "VOLUME_UNKNOWN" + ] + }, "MemberResultsLimit":{ "type":"integer", "box":true, @@ -530,7 +566,8 @@ "INVITED", "VERIFICATION_IN_PROGRESS", "VERIFICATION_FAILED", - "ENABLED" + "ENABLED", + "ACCEPTED_BUT_DISABLED" ] }, "PaginationToken":{ @@ -538,6 +575,7 @@ "max":1024, "min":1 }, + "Percentage":{"type":"double"}, "RejectInvitationRequest":{ "type":"structure", "required":["GraphArn"], @@ -562,10 +600,27 @@ "members":{ "Message":{"shape":"ErrorMessage"} }, - "documentation":"This request would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1000 member accounts.
", + "documentation":"This request cannot be completed for one of the following reasons.
The request would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1000 member accounts.
The request would cause the data rate for the behavior graph to exceed the maximum allowed.
Detective is unable to verify the data rate for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.
The ARN of the behavior graph.
" + }, + "AccountId":{ + "shape":"AccountId", + "documentation":"The account ID of the member account to try to enable.
The account must be an invited member account with a status of ACCEPTED_BUT_DISABLED.
The reason that the member account request could not be processed.
" } }, - "documentation":"Amazon Detective is currently in preview.
A member account that was included in a request but for which the request could not be processed.
" + "documentation":"A member account that was included in a request but for which the request could not be processed.
" }, "UnprocessedAccountList":{ "type":"list", @@ -596,5 +651,5 @@ "exception":true } }, - "documentation":"Amazon Detective is currently in preview. The Detective API can only be used by accounts that are admitted into the preview.
Detective uses machine learning and purpose-built visualizations to help you analyze and investigate security issues across your Amazon Web Services (AWS) workloads. Detective automatically extracts time-based events such as login attempts, API calls, and network traffic from AWS CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by Amazon GuardDuty.
The Detective API primarily supports the creation and management of behavior graphs. A behavior graph contains the extracted data from a set of member accounts, and is created and managed by a master account.
Every behavior graph is specific to a Region. You can only use the API to manage graphs that belong to the Region that is associated with the currently selected endpoint.
A Detective master account can use the Detective API to do the following:
Enable and disable Detective. Enabling Detective creates a new behavior graph.
View the list of member accounts in a behavior graph.
Add member accounts to a behavior graph.
Remove member accounts from a behavior graph.
A member account can use the Detective API to do the following:
View the list of behavior graphs that they are invited to.
Accept an invitation to contribute to a behavior graph.
Decline an invitation to contribute to a behavior graph.
Remove their account from a behavior graph.
All API actions are logged as CloudTrail events. See Logging Detective API Calls with CloudTrail.
" + "documentation":"Detective uses machine learning and purpose-built visualizations to help you analyze and investigate security issues across your Amazon Web Services (AWS) workloads. Detective automatically extracts time-based events such as login attempts, API calls, and network traffic from AWS CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by Amazon GuardDuty.
The Detective API primarily supports the creation and management of behavior graphs. A behavior graph contains the extracted data from a set of member accounts, and is created and managed by a master account.
Every behavior graph is specific to a Region. You can only use the API to manage graphs that belong to the Region that is associated with the currently selected endpoint.
A Detective master account can use the Detective API to do the following:
Enable and disable Detective. Enabling Detective creates a new behavior graph.
View the list of member accounts in a behavior graph.
Add member accounts to a behavior graph.
Remove member accounts from a behavior graph.
A member account can use the Detective API to do the following:
View the list of behavior graphs that they are invited to.
Accept an invitation to contribute to a behavior graph.
Decline an invitation to contribute to a behavior graph.
Remove their account from a behavior graph.
All API actions are logged as CloudTrail events. See Logging Detective API Calls with CloudTrail.
" } diff --git a/botocore/data/devicefarm/2015-06-23/examples-1.json b/botocore/data/devicefarm/2015-06-23/examples-1.json index 3b9063f8..4bfa22ba 100644 --- a/botocore/data/devicefarm/2015-06-23/examples-1.json +++ b/botocore/data/devicefarm/2015-06-23/examples-1.json @@ -36,7 +36,7 @@ "output": { "project": { "name": "MyProject", - "arn": "arn:aws:devicefarm:us-west-2:183774035805:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE", + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE", "created": "1472660939.152" } }, @@ -90,10 +90,10 @@ "upload": { "name": "MyAppiumPythonUpload", "type": "APPIUM_PYTHON_TEST_PACKAGE", - "arn": "arn:aws:devicefarm:us-west-2:183774035805:upload:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/b5340a65-3da7-4da6-a26e-12345EXAMPLE", + "arn": "arn:aws:devicefarm:us-west-2:123456789101:upload:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/b5340a65-3da7-4da6-a26e-12345EXAMPLE", "created": "1472661404.186", "status": "INITIALIZED", - "url": "https://prod-us-west-2-uploads.s3-us-west-2.amazonaws.com/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A183774035805%3Aproject%3A5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE/uploads/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A183774035805%3Aupload%3A5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/b5340a65-3da7-4da6-a26e-12345EXAMPLE/MyAppiumPythonUpload?AWSAccessKeyId=1234567891011EXAMPLE&Expires=1472747804&Signature=1234567891011EXAMPLE" + "url": "https://prod-us-west-2-uploads.s3-us-west-2.amazonaws.com/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789101%3Aproject%3A5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE/uploads/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789101%3Aupload%3A5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/b5340a65-3da7-4da6-a26e-12345EXAMPLE/MyAppiumPythonUpload?AWSAccessKeyId=1234567891011EXAMPLE&Expires=1472747804&Signature=1234567891011EXAMPLE" } }, "comments": { @@ -840,12 +840,12 @@ "projects": [ { "name": "My Test Project", - "arn": "arn:aws:devicefarm:us-west-2:183774035805:project:7ad300ed-8183-41a7-bf94-12345EXAMPLE", + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:7ad300ed-8183-41a7-bf94-12345EXAMPLE", "created": "1453163262.105" }, { "name": "Hello World", - "arn": "arn:aws:devicefarm:us-west-2:183774035805:project:d6b087d9-56db-4e44-b9ec-12345EXAMPLE", + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:d6b087d9-56db-4e44-b9ec-12345EXAMPLE", "created": "1470350112.439" } ] @@ -1217,12 +1217,12 @@ { "input": { "name": "NewName", - "arn": "arn:aws:devicefarm:us-west-2:183774035805:project:8f75187d-101e-4625-accc-12345EXAMPLE" + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:8f75187d-101e-4625-accc-12345EXAMPLE" }, "output": { "project": { "name": "NewName", - "arn": "arn:aws:devicefarm:us-west-2:183774035805:project:8f75187d-101e-4625-accc-12345EXAMPLE", + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:8f75187d-101e-4625-accc-12345EXAMPLE", "created": "1448400709.927" } }, diff --git a/botocore/data/dlm/2018-01-12/examples-1.json b/botocore/data/dlm/2018-01-12/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/dlm/2018-01-12/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/dlm/2018-01-12/service-2.json b/botocore/data/dlm/2018-01-12/service-2.json index 76ff6e78..d7f0c44d 100644 --- a/botocore/data/dlm/2018-01-12/service-2.json +++ b/botocore/data/dlm/2018-01-12/service-2.json @@ -211,7 +211,7 @@ "members":{ "Interval":{ "shape":"Interval", - "documentation":"The interval between snapshots. The supported values are 2, 3, 4, 6, 8, 12, and 24.
" + "documentation":"The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
" }, "IntervalUnit":{ "shape":"IntervalUnitValues", diff --git a/botocore/data/dms/2016-01-01/examples-1.json b/botocore/data/dms/2016-01-01/examples-1.json index 0ea7e3b0..295fccf2 100644 --- a/botocore/data/dms/2016-01-01/examples-1.json +++ b/botocore/data/dms/2016-01-01/examples-1.json @@ -1,5 +1,1053 @@ { "version": "1.0", "examples": { + "AddTagsToResource": [ + { + "input": { + "ResourceArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E", + "Tags": [ + { + "Key": "Acount", + "Value": "1633456" + } + ] + }, + "output": { + }, + "comments": { + "input": { + "ResourceArn": "Required. Use the ARN of the resource you want to tag.", + "Tags": "Required. Use the Key/Value pair format." + }, + "output": { + } + }, + "description": "Adds metadata tags to an AWS DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with AWS DMS resources, or used in a Condition statement in an IAM policy for AWS DMS.", + "id": "add-tags-to-resource-1481744141435", + "title": "Add tags to resource" + } + ], + "CreateEndpoint": [ + { + "input": { + "CertificateArn": "", + "DatabaseName": "testdb", + "EndpointIdentifier": "test-endpoint-1", + "EndpointType": "source", + "EngineName": "mysql", + "ExtraConnectionAttributes": "", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", + "Password": "pasword", + "Port": 3306, + "ServerName": "mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com", + "SslMode": "require", + "Tags": [ + { + "Key": "Acount", + "Value": "143327655" + } + ], + "Username": "username" + }, + "output": { + "Endpoint": { + "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM", + "EndpointIdentifier": "test-endpoint-1", + "EndpointType": "source", + "EngineName": "mysql", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", + "Port": 3306, + "ServerName": "mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com", + "Status": "active", + "Username": "username" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates an endpoint using the provided settings.", + "id": "create-endpoint-1481746254348", + "title": "Create endpoint" + } + ], + "CreateReplicationInstance": [ + { + "input": { + "AllocatedStorage": 123, + "AutoMinorVersionUpgrade": true, + "AvailabilityZone": "", + "EngineVersion": "", + "KmsKeyId": "", + "MultiAZ": true, + "PreferredMaintenanceWindow": "", + "PubliclyAccessible": true, + "ReplicationInstanceClass": "", + "ReplicationInstanceIdentifier": "", + "ReplicationSubnetGroupIdentifier": "", + "Tags": [ + { + "Key": "string", + "Value": "string" + } + ], + "VpcSecurityGroupIds": [ + + ] + }, + "output": { + "ReplicationInstance": { + "AllocatedStorage": 5, + "AutoMinorVersionUpgrade": true, + "EngineVersion": "1.5.0", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", + "PendingModifiedValues": { + }, + "PreferredMaintenanceWindow": "sun:06:00-sun:14:00", + "PubliclyAccessible": true, + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "ReplicationInstanceClass": "dms.t2.micro", + "ReplicationInstanceIdentifier": "test-rep-1", + "ReplicationInstanceStatus": "creating", + "ReplicationSubnetGroup": { + "ReplicationSubnetGroupDescription": "default", + "ReplicationSubnetGroupIdentifier": "default", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetAvailabilityZone": { + "Name": "us-east-1d" + }, + "SubnetIdentifier": "subnet-f6dd91af", + "SubnetStatus": "Active" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-east-1b" + }, + "SubnetIdentifier": "subnet-3605751d", + "SubnetStatus": "Active" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-east-1c" + }, + "SubnetIdentifier": "subnet-c2daefb5", + "SubnetStatus": "Active" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-east-1e" + }, + "SubnetIdentifier": "subnet-85e90cb8", + "SubnetStatus": "Active" + } + ], + "VpcId": "vpc-6741a603" + } + } + }, + "comments": { + "output": { + } + }, + "description": "Creates the replication instance using the specified parameters.", + "id": "create-replication-instance-1481746705295", + "title": "Create replication instance" + } + ], + "CreateReplicationSubnetGroup": [ + { + "input": { + "ReplicationSubnetGroupDescription": "US West subnet group", + "ReplicationSubnetGroupIdentifier": "us-west-2ab-vpc-215ds366", + "SubnetIds": [ + "subnet-e145356n", + "subnet-58f79200" + ], + "Tags": [ + { + "Key": "Acount", + "Value": "145235" + } + ] + }, + "output": { + "ReplicationSubnetGroup": { + } + }, + "comments": { + "output": { + } + }, + "description": "Creates a replication subnet group given a list of the subnet IDs in a VPC.", + "id": "create-replication-subnet-group-1481747297930", + "title": "Create replication subnet group" + } + ], + "CreateReplicationTask": [ + { + "input": { + "CdcStartTime": "2016-12-14T18:25:43Z", + "MigrationType": "full-load", + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "ReplicationTaskIdentifier": "task1", + "ReplicationTaskSettings": "", + "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", + "TableMappings": "file://mappingfile.json", + "Tags": [ + { + "Key": "Acount", + "Value": "24352226" + } + ], + "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E" + }, + "output": { + "ReplicationTask": { + "MigrationType": "full-load", + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM", + "ReplicationTaskCreationDate": "2016-12-14T18:25:43Z", + "ReplicationTaskIdentifier": "task1", + "ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}", + "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", + "Status": "creating", + "TableMappings": "file://mappingfile.json", + "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates a replication task using the specified parameters.", + "id": "create-replication-task-1481747646288", + "title": "Create replication task" + } + ], + "DeleteCertificate": [ + { + "input": { + "CertificateArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUSM457DE6XFJCJQ" + }, + "output": { + "Certificate": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes the specified certificate.", + "id": "delete-certificate-1481751957981", + "title": "Delete Certificate" + } + ], + "DeleteEndpoint": [ + { + "input": { + "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM" + }, + "output": { + "Endpoint": { + "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM", + "EndpointIdentifier": "test-endpoint-1", + "EndpointType": "source", + "EngineName": "mysql", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", + "Port": 3306, + "ServerName": "mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com", + "Status": "active", + "Username": "username" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes the specified endpoint. All tasks associated with the endpoint must be deleted before you can delete the endpoint.\n", + "id": "delete-endpoint-1481752425530", + "title": "Delete Endpoint" + } + ], + "DeleteReplicationInstance": [ + { + "input": { + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ" + }, + "output": { + "ReplicationInstance": { + "AllocatedStorage": 5, + "AutoMinorVersionUpgrade": true, + "EngineVersion": "1.5.0", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", + "PendingModifiedValues": { + }, + "PreferredMaintenanceWindow": "sun:06:00-sun:14:00", + "PubliclyAccessible": true, + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "ReplicationInstanceClass": "dms.t2.micro", + "ReplicationInstanceIdentifier": "test-rep-1", + "ReplicationInstanceStatus": "creating", + "ReplicationSubnetGroup": { + "ReplicationSubnetGroupDescription": "default", + "ReplicationSubnetGroupIdentifier": "default", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetAvailabilityZone": { + "Name": "us-east-1d" + }, + "SubnetIdentifier": "subnet-f6dd91af", + "SubnetStatus": "Active" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-east-1b" + }, + "SubnetIdentifier": "subnet-3605751d", + "SubnetStatus": "Active" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-east-1c" + }, + "SubnetIdentifier": "subnet-c2daefb5", + "SubnetStatus": "Active" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-east-1e" + }, + "SubnetIdentifier": "subnet-85e90cb8", + "SubnetStatus": "Active" + } + ], + "VpcId": "vpc-6741a603" + } + } + }, + "comments": { + "output": { + } + }, + "description": "Deletes the specified replication instance. You must delete any migration tasks that are associated with the replication instance before you can delete it.\n\n", + "id": "delete-replication-instance-1481752552839", + "title": "Delete Replication Instance" + } + ], + "DeleteReplicationSubnetGroup": [ + { + "input": { + "ReplicationSubnetGroupIdentifier": "us-west-2ab-vpc-215ds366" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes a replication subnet group.", + "id": "delete-replication-subnet-group-1481752728597", + "title": "Delete Replication Subnet Group" + } + ], + "DeleteReplicationTask": [ + { + "input": { + "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ" + }, + "output": { + "ReplicationTask": { + "MigrationType": "full-load", + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM", + "ReplicationTaskCreationDate": "2016-12-14T18:25:43Z", + "ReplicationTaskIdentifier": "task1", + "ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}", + "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", + "Status": "creating", + "TableMappings": "file://mappingfile.json", + "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes the specified replication task.", + "id": "delete-replication-task-1481752903506", + "title": "Delete Replication Task" + } + ], + "DescribeAccountAttributes": [ + { + "input": { + }, + "output": { + "AccountQuotas": [ + { + "AccountQuotaName": "ReplicationInstances", + "Max": 20, + "Used": 0 + }, + { + "AccountQuotaName": "AllocatedStorage", + "Max": 20, + "Used": 0 + }, + { + "AccountQuotaName": "Endpoints", + "Max": 20, + "Used": 0 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists all of the AWS DMS attributes for a customer account. The attributes include AWS DMS quotas for the account, such as the number of replication instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This operation does not take any parameters.", + "id": "describe-acount-attributes-1481753085663", + "title": "Describe acount attributes" + } + ], + "DescribeCertificates": [ + { + "input": { + "Filters": [ + { + "Name": "string", + "Values": [ + "string", + "string" + ] + } + ], + "Marker": "", + "MaxRecords": 123 + }, + "output": { + "Certificates": [ + + ], + "Marker": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Provides a description of the certificate.", + "id": "describe-certificates-1481753186244", + "title": "Describe certificates" + } + ], + "DescribeConnections": [ + { + "input": { + "Filters": [ + { + "Name": "string", + "Values": [ + "string", + "string" + ] + } + ], + "Marker": "", + "MaxRecords": 123 + }, + "output": { + "Connections": [ + { + "EndpointArn": "arn:aws:dms:us-east-arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", + "EndpointIdentifier": "testsrc1", + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "ReplicationInstanceIdentifier": "test", + "Status": "successful" + } + ], + "Marker": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.", + "id": "describe-connections-1481754477953", + "title": "Describe connections" + } + ], + "DescribeEndpointTypes": [ + { + "input": { + "Filters": [ + { + "Name": "string", + "Values": [ + "string", + "string" + ] + } + ], + "Marker": "", + "MaxRecords": 123 + }, + "output": { + "Marker": "", + "SupportedEndpointTypes": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns information about the type of endpoints available.", + "id": "describe-endpoint-types-1481754742591", + "title": "Describe endpoint types" + } + ], + "DescribeEndpoints": [ + { + "input": { + "Filters": [ + { + "Name": "string", + "Values": [ + "string", + "string" + ] + } + ], + "Marker": "", + "MaxRecords": 123 + }, + "output": { + "Endpoints": [ + + ], + "Marker": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns information about the endpoints for your account in the current region.", + "id": "describe-endpoints-1481754926060", + "title": "Describe endpoints" + } + ], + "DescribeOrderableReplicationInstances": [ + { + "input": { + "Marker": "", + "MaxRecords": 123 + }, + "output": { + "Marker": "", + "OrderableReplicationInstances": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns information about the replication instance types that can be created in the specified region.", + "id": "describe-orderable-replication-instances-1481755123669", + "title": "Describe orderable replication instances" + } + ], + "DescribeRefreshSchemasStatus": [ + { + "input": { + "EndpointArn": "" + }, + "output": { + "RefreshSchemasStatus": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns the status of the refresh-schemas operation.", + "id": "describe-refresh-schema-status-1481755303497", + "title": "Describe refresh schema status" + } + ], + "DescribeReplicationInstances": [ + { + "input": { + "Filters": [ + { + "Name": "string", + "Values": [ + "string", + "string" + ] + } + ], + "Marker": "", + "MaxRecords": 123 + }, + "output": { + "Marker": "", + "ReplicationInstances": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns the status of the refresh-schemas operation.", + "id": "describe-replication-instances-1481755443952", + "title": "Describe replication instances" + } + ], + "DescribeReplicationSubnetGroups": [ + { + "input": { + "Filters": [ + { + "Name": "string", + "Values": [ + "string", + "string" + ] + } + ], + "Marker": "", + "MaxRecords": 123 + }, + "output": { + "Marker": "", + "ReplicationSubnetGroups": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns information about the replication subnet groups.", + "id": "describe-replication-subnet-groups-1481755621284", + "title": "Describe replication subnet groups" + } + ], + "DescribeReplicationTasks": [ + { + "input": { + "Filters": [ + { + "Name": "string", + "Values": [ + "string", + "string" + ] + } + ], + "Marker": "", + "MaxRecords": 123 + }, + "output": { + "Marker": "", + "ReplicationTasks": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns information about replication tasks for your account in the current region.", + "id": "describe-replication-tasks-1481755777563", + "title": "Describe replication tasks" + } + ], + "DescribeSchemas": [ + { + "input": { + "EndpointArn": "", + "Marker": "", + "MaxRecords": 123 + }, + "output": { + "Marker": "", + "Schemas": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns information about the schema for the specified endpoint.", + "id": "describe-schemas-1481755933924", + "title": "Describe schemas" + } + ], + "DescribeTableStatistics": [ + { + "input": { + "Marker": "", + "MaxRecords": 123, + "ReplicationTaskArn": "" + }, + "output": { + "Marker": "", + "ReplicationTaskArn": "", + "TableStatistics": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.", + "id": "describe-table-statistics-1481756071890", + "title": "Describe table statistics" + } + ], + "ImportCertificate": [ + { + "input": { + "CertificateIdentifier": "", + "CertificatePem": "" + }, + "output": { + "Certificate": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Uploads the specified certificate.", + "id": "import-certificate-1481756197206", + "title": "Import certificate" + } + ], + "ListTagsForResource": [ + { + "input": { + "ResourceArn": "" + }, + "output": { + "TagList": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists all tags for an AWS DMS resource.", + "id": "list-tags-for-resource-1481761095501", + "title": "List tags for resource" + } + ], + "ModifyEndpoint": [ + { + "input": { + "CertificateArn": "", + "DatabaseName": "", + "EndpointArn": "", + "EndpointIdentifier": "", + "EndpointType": "source", + "EngineName": "", + "ExtraConnectionAttributes": "", + "Password": "", + "Port": 123, + "ServerName": "", + "SslMode": "require", + "Username": "" + }, + "output": { + "Endpoint": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Modifies the specified endpoint.", + "id": "modify-endpoint-1481761649937", + "title": "Modify endpoint" + } + ], + "ModifyReplicationInstance": [ + { + "input": { + "AllocatedStorage": 123, + "AllowMajorVersionUpgrade": true, + "ApplyImmediately": true, + "AutoMinorVersionUpgrade": true, + "EngineVersion": "1.5.0", + "MultiAZ": true, + "PreferredMaintenanceWindow": "sun:06:00-sun:14:00", + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "ReplicationInstanceClass": "dms.t2.micro", + "ReplicationInstanceIdentifier": "test-rep-1", + "VpcSecurityGroupIds": [ + + ] + }, + "output": { + "ReplicationInstance": { + "AllocatedStorage": 5, + "AutoMinorVersionUpgrade": true, + "EngineVersion": "1.5.0", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", + "PendingModifiedValues": { + }, + "PreferredMaintenanceWindow": "sun:06:00-sun:14:00", + "PubliclyAccessible": true, + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "ReplicationInstanceClass": "dms.t2.micro", + "ReplicationInstanceIdentifier": "test-rep-1", + "ReplicationInstanceStatus": "available", + "ReplicationSubnetGroup": { + "ReplicationSubnetGroupDescription": "default", + "ReplicationSubnetGroupIdentifier": "default", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetAvailabilityZone": { + "Name": "us-east-1d" + }, + "SubnetIdentifier": "subnet-f6dd91af", + "SubnetStatus": "Active" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-east-1b" + }, + "SubnetIdentifier": "subnet-3605751d", + "SubnetStatus": "Active" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-east-1c" + }, + "SubnetIdentifier": "subnet-c2daefb5", + "SubnetStatus": "Active" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-east-1e" + }, + "SubnetIdentifier": "subnet-85e90cb8", + "SubnetStatus": "Active" + } + ], + "VpcId": "vpc-6741a603" + } + } + }, + "comments": { + "output": { + } + }, + "description": "Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request. Some settings are applied during the maintenance window.", + "id": "modify-replication-instance-1481761784746", + "title": "Modify replication instance" + } + ], + "ModifyReplicationSubnetGroup": [ + { + "input": { + "ReplicationSubnetGroupDescription": "", + "ReplicationSubnetGroupIdentifier": "", + "SubnetIds": [ + + ] + }, + "output": { + "ReplicationSubnetGroup": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Modifies the settings for the specified replication subnet group.", + "id": "modify-replication-subnet-group-1481762275392", + "title": "Modify replication subnet group" + } + ], + "RefreshSchemas": [ + { + "input": { + "EndpointArn": "", + "ReplicationInstanceArn": "" + }, + "output": { + "RefreshSchemasStatus": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the describe-refresh-schemas-status operation.", + "id": "refresh-schema-1481762399111", + "title": "Refresh schema" + } + ], + "RemoveTagsFromResource": [ + { + "input": { + "ResourceArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E", + "TagKeys": [ + + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Removes metadata tags from an AWS DMS resource.", + "id": "remove-tags-from-resource-1481762571330", + "title": "Remove tags from resource" + } + ], + "StartReplicationTask": [ + { + "input": { + "CdcStartTime": "2016-12-14T13:33:20Z", + "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "StartReplicationTaskType": "start-replication" + }, + "output": { + "ReplicationTask": { + "MigrationType": "full-load", + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM", + "ReplicationTaskCreationDate": "2016-12-14T18:25:43Z", + "ReplicationTaskIdentifier": "task1", + "ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}", + "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", + "Status": "creating", + "TableMappings": "file://mappingfile.json", + "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Starts the replication task.", + "id": "start-replication-task-1481762706778", + "title": "Start replication task" + } + ], + "StopReplicationTask": [ + { + "input": { + "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E" + }, + "output": { + "ReplicationTask": { + "MigrationType": "full-load", + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM", + "ReplicationTaskCreationDate": "2016-12-14T18:25:43Z", + "ReplicationTaskIdentifier": "task1", + "ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}", + "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", + "Status": "creating", + "TableMappings": "file://mappingfile.json", + "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Stops the replication task.", + "id": "stop-replication-task-1481762924947", + "title": "Stop replication task" + } + ], + "TestConnection": [ + { + "input": { + "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM", + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ" + }, + "output": { + "Connection": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Tests the connection between the replication instance and the endpoint.", + "id": "test-conection-1481763017636", + "title": "Test conection" + } + ] } } diff --git a/botocore/data/dynamodb/2012-08-10/examples-1.json b/botocore/data/dynamodb/2012-08-10/examples-1.json index e66e704b..5b6ad0f6 100644 --- a/botocore/data/dynamodb/2012-08-10/examples-1.json +++ b/botocore/data/dynamodb/2012-08-10/examples-1.json @@ -548,13 +548,16 @@ "output": { "Attributes": { "AlbumTitle": { - "S": "Songs About Life" + "S": "Louder Than Ever" }, "Artist": { "S": "Acme Band" }, "SongTitle": { "S": "Happy Day" + }, + "Year": { + "N": "2015" } } }, diff --git a/botocore/data/ec2/2016-11-15/examples-1.json b/botocore/data/ec2/2016-11-15/examples-1.json index f6a8719f..29f88e78 100644 --- a/botocore/data/ec2/2016-11-15/examples-1.json +++ b/botocore/data/ec2/2016-11-15/examples-1.json @@ -156,6 +156,36 @@ "title": "To associate the default DHCP options set with a VPC" } ], + "AssociateIamInstanceProfile": [ + { + "input": { + "IamInstanceProfile": { + "Name": "admin-role" + }, + "InstanceId": "i-123456789abcde123" + }, + "output": { + "IamInstanceProfileAssociation": { + "AssociationId": "iip-assoc-0e7736511a163c209", + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role", + "Id": "AIPAJBLK7RKJKWDXVHIEC" + }, + "InstanceId": "i-123456789abcde123", + "State": "associating" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates an IAM instance profile named admin-role with the specified instance.", + "id": "to-associate-an-iam-instance-profile-with-an-instance-1528928429850", + "title": "To associate an IAM instance profile with an instance" + } + ], "AssociateRouteTable": [ { "input": { @@ -239,6 +269,153 @@ "title": "To attach a volume to an instance" } ], + "AuthorizeSecurityGroupEgress": [ + { + "input": { + "GroupId": "sg-1a2b3c4d", + "IpPermissions": [ + { + "FromPort": 80, + "IpProtocol": "tcp", + "IpRanges": [ + { + "CidrIp": "10.0.0.0/16" + } + ], + "ToPort": 80 + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds a rule that grants access to the specified address ranges on TCP port 80.", + "id": "to-add-a-rule-that-allows-outbound-traffic-to-a-specific-address-range-1528929309636", + "title": "To add a rule that allows outbound traffic to a specific address range" + }, + { + "input": { + "GroupId": "sg-1a2b3c4d", + "IpPermissions": [ + { + "FromPort": 80, + "IpProtocol": "tcp", + "ToPort": 80, + "UserIdGroupPairs": [ + { + "GroupId": "sg-4b51a32f" + } + ] + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds a rule that grants access to the specified security group on TCP port 80.", + "id": "to-add-a-rule-that-allows-outbound-traffic-to-a-specific-security-group-1528929760260", + "title": "To add a rule that allows outbound traffic to a specific security group" + } + ], + "AuthorizeSecurityGroupIngress": [ + { + "input": { + "GroupId": "sg-903004f8", + "IpPermissions": [ + { + "FromPort": 22, + "IpProtocol": "tcp", + "IpRanges": [ + { + "CidrIp": "203.0.113.0/24", + "Description": "SSH access from the LA office" + } + ], + "ToPort": 22 + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables inbound traffic on TCP port 22 (SSH). The rule includes a description to help you identify it later.", + "id": "to-add-a-rule-that-allows-inbound-ssh-traffic-1529011610328", + "title": "To add a rule that allows inbound SSH traffic from an IPv4 address range" + }, + { + "input": { + "GroupId": "sg-111aaa22", + "IpPermissions": [ + { + "FromPort": 80, + "IpProtocol": "tcp", + "ToPort": 80, + "UserIdGroupPairs": [ + { + "Description": "HTTP access from other instances", + "GroupId": "sg-1a2b3c4d" + } + ] + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables inbound traffic on TCP port 80 from the specified security group. The group must be in the same VPC or a peer VPC. Incoming traffic is allowed based on the private IP addresses of instances that are associated with the specified security group.", + "id": "to-add-a-rule-that-allows-inbound-http-traffic-from-another-security-group-1529012163168", + "title": "To add a rule that allows inbound HTTP traffic from another security group" + }, + { + "input": { + "GroupId": "sg-123abc12 ", + "IpPermissions": [ + { + "FromPort": 3389, + "IpProtocol": "tcp", + "Ipv6Ranges": [ + { + "CidrIpv6": "2001:db8:1234:1a00::/64", + "Description": "RDP access from the NY office" + } + ], + "ToPort": 3389 + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds an inbound rule that allows RDP traffic from the specified IPv6 address range. The rule includes a description to help you identify it later.", + "id": "to-add-a-rule-with-a-description-1529012418116", + "title": "To add a rule that allows inbound RDP traffic from an IPv6 address range" + } + ], "CancelSpotFleetRequests": [ { "input": { @@ -339,6 +516,28 @@ "title": "To confirm the product instance" } ], + "CopyImage": [ + { + "input": { + "Description": "", + "Name": "My server", + "SourceImageId": "ami-5731123e", + "SourceRegion": "us-east-1" + }, + "output": { + "ImageId": "ami-438bea42" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example copies the specified AMI from the us-east-1 region to the current region.", + "id": "to-copy-an-ami-to-another-region-1529022820832", + "title": "To copy an AMI to another region" + } + ], "CopySnapshot": [ { "input": { @@ -430,6 +629,40 @@ "title": "To create a DHCP options set" } ], + "CreateImage": [ + { + "input": { + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/sdh", + "Ebs": { + "VolumeSize": "100" + } + }, + { + "DeviceName": "/dev/sdc", + "VirtualName": "ephemeral1" + } + ], + "Description": "An AMI for my server", + "InstanceId": "i-1234567890abcdef0", + "Name": "My server", + "NoReboot": true + }, + "output": { + "ImageId": "ami-1a2b3c4d" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an AMI from the specified instance and adds an EBS volume with the device name /dev/sdh and an instance store volume with the device name /dev/sdc.", + "id": "to-create-an-ami-from-an-amazon-ebs-backed-instance-1529023150636", + "title": "To create an AMI from an Amazon EBS-backed instance" + } + ], "CreateInternetGateway": [ { "output": { @@ -470,6 +703,104 @@ "title": "To create a key pair" } ], + "CreateLaunchTemplate": [ + { + "input": { + "LaunchTemplateData": { + "ImageId": "ami-8c1be5f6", + "InstanceType": "t2.small", + "NetworkInterfaces": [ + { + "AssociatePublicIpAddress": true, + "DeviceIndex": 0, + "Ipv6AddressCount": 1, + "SubnetId": "subnet-7b16de0c" + } + ], + "TagSpecifications": [ + { + "ResourceType": "instance", + "Tags": [ + { + "Key": "Name", + "Value": "webserver" + } + ] + } + ] + }, + "LaunchTemplateName": "my-template", + "VersionDescription": "WebVersion1" + }, + "output": { + "LaunchTemplate": { + "CreateTime": "2017-11-27T09:13:24.000Z", + "CreatedBy": "arn:aws:iam::123456789012:root", + "DefaultVersionNumber": 1, + "LatestVersionNumber": 1, + "LaunchTemplateId": "lt-01238c059e3466abc", + "LaunchTemplateName": "my-template" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a launch template that specifies the subnet in which to launch the instance, assigns a public IP address and an IPv6 address to the instance, and creates a tag for the instance.", + "id": "to-create-a-launch-template-1529023655488", + "title": "To create a launch template" + } + ], + "CreateLaunchTemplateVersion": [ + { + "input": { + "LaunchTemplateData": { + "ImageId": "ami-c998b6b2" + }, + "LaunchTemplateId": "lt-0abcd290751193123", + "SourceVersion": "1", + "VersionDescription": "WebVersion2" + }, + "output": { + "LaunchTemplateVersion": { + "CreateTime": "2017-12-01T13:35:46.000Z", + "CreatedBy": "arn:aws:iam::123456789012:root", + "DefaultVersion": false, + "LaunchTemplateData": { + "ImageId": "ami-c998b6b2", + "InstanceType": "t2.micro", + "NetworkInterfaces": [ + { + "AssociatePublicIpAddress": true, + "DeviceIndex": 0, + "Ipv6Addresses": [ + { + "Ipv6Address": "2001:db8:1234:1a00::123" + } + ], + "SubnetId": "subnet-7b16de0c" + } + ] + }, + "LaunchTemplateId": "lt-0abcd290751193123", + "LaunchTemplateName": "my-template", + "VersionDescription": "WebVersion2", + "VersionNumber": 2 + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a new launch template version based on version 1 of the specified launch template and specifies a different AMI ID.", + "id": "to-create-a-launch-template-version-1529024195702", + "title": "To create a launch template version" + } + ], "CreateNatGateway": [ { "input": { @@ -697,6 +1028,27 @@ "title": "To create a route table" } ], + "CreateSecurityGroup": [ + { + "input": { + "Description": "My security group", + "GroupName": "my-security-group", + "VpcId": "vpc-1a2b3c4d" + }, + "output": { + "GroupId": "sg-903004f8" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a security group for the specified VPC.", + "id": "to-create-a-security-group-for-a-vpc-1529024532716", + "title": "To create a security group for a VPC" + } + ], "CreateSnapshot": [ { "input": { @@ -953,6 +1305,63 @@ "title": "To delete a key pair" } ], + "DeleteLaunchTemplate": [ + { + "input": { + "LaunchTemplateId": "lt-0abcd290751193123" + }, + "output": { + "LaunchTemplate": { + "CreateTime": "2017-11-23T16:46:25.000Z", + "CreatedBy": "arn:aws:iam::123456789012:root", + "DefaultVersionNumber": 2, + "LatestVersionNumber": 2, + "LaunchTemplateId": "lt-0abcd290751193123", + "LaunchTemplateName": "my-template" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified launch template.", + "id": "to-delete-a-launch-template-1529024658216", + "title": "To delete a launch template" + } + ], + "DeleteLaunchTemplateVersions": [ + { + "input": { + "LaunchTemplateId": "lt-0abcd290751193123", + "Versions": [ + "1" + ] + }, + "output": { + "SuccessfullyDeletedLaunchTemplateVersions": [ + { + "LaunchTemplateId": "lt-0abcd290751193123", + "LaunchTemplateName": "my-template", + "VersionNumber": 1 + } + ], + "UnsuccessfullyDeletedLaunchTemplateVersions": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified launch template version.", + "id": "to-delete-a-launch-template-version-1529024790864", + "title": "To delete a launch template version" + } + ], "DeleteNatGateway": [ { "input": { @@ -1073,6 +1482,24 @@ "title": "To delete a route table" } ], + "DeleteSecurityGroup": [ + { + "input": { + "GroupId": "sg-903004f8" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified security group.", + "id": "to-delete-a-security-group-1529024952972", + "title": "To delete a security group" + } + ], "DeleteSnapshot": [ { "input": { @@ -1490,6 +1917,111 @@ "title": "To describe a DHCP options set" } ], + "DescribeIamInstanceProfileAssociations": [ + { + "input": { + "AssociationIds": [ + "iip-assoc-0db249b1f25fa24b8" + ] + }, + "output": { + "IamInstanceProfileAssociations": [ + { + "AssociationId": "iip-assoc-0db249b1f25fa24b8", + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role", + "Id": "AIPAJVQN4F5WVLGCJDRGM" + }, + "InstanceId": "i-09eb09efa73ec1dee", + "State": "associated" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified IAM instance profile association.", + "id": "to-describe-an-iam-instance-profile-association-1529025123918", + "title": "To describe an IAM instance profile association" + } + ], + "DescribeImageAttribute": [ + { + "input": { + "Attribute": "launchPermission", + "ImageId": "ami-5731123e" + }, + "output": { + "ImageId": "ami-5731123e", + "LaunchPermissions": [ + { + "UserId": "123456789012" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the launch permissions for the specified AMI.", + "id": "to-describe-the-launch-permissions-for-an-ami-1529025296264", + "title": "To describe the launch permissions for an AMI" + } + ], + "DescribeImages": [ + { + "input": { + "ImageIds": [ + "ami-5731123e" + ] + }, + "output": { + "Images": [ + { + "Architecture": "x86_64", + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/sda1", + "Ebs": { + "DeleteOnTermination": true, + "SnapshotId": "snap-1234567890abcdef0", + "VolumeSize": 8, + "VolumeType": "standard" + } + } + ], + "Description": "An AMI for my server", + "Hypervisor": "xen", + "ImageId": "ami-5731123e", + "ImageLocation": "123456789012/My server", + "ImageType": "machine", + "KernelId": "aki-88aa75e1", + "Name": "My server", + "OwnerId": "123456789012", + "Public": false, + "RootDeviceName": "/dev/sda1", + "RootDeviceType": "ebs", + "State": "available", + "VirtualizationType": "paravirtual" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified AMI.", + "id": "to-describe-an-ami-1529025482866", + "title": "To describe an AMI" + } + ], "DescribeInstanceAttribute": [ { "input": { @@ -1572,6 +2104,120 @@ "title": "To describe the block device mapping for an instance" } ], + "DescribeInstanceStatus": [ + { + "input": { + "InstanceIds": [ + "i-1234567890abcdef0" + ] + }, + "output": { + "InstanceStatuses": [ + { + "AvailabilityZone": "us-east-1d", + "InstanceId": "i-1234567890abcdef0", + "InstanceState": { + "Code": 16, + "Name": "running" + }, + "InstanceStatus": { + "Details": [ + { + "Name": "reachability", + "Status": "passed" + } + ], + "Status": "ok" + }, + "SystemStatus": { + "Details": [ + { + "Name": "reachability", + "Status": "passed" + } + ], + "Status": "ok" + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the current status of the specified instance.", + "id": "to-describe-the-status-of-an-instance-1529025696830", + "title": "To describe the status of an instance" + } + ], + "DescribeInstances": [ + { + "input": { + "InstanceIds": [ + "i-1234567890abcdef0" + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified instance.", + "id": "to-describe-an-amazon-ec2-instance-1529025982172", + "title": "To describe an Amazon EC2 instance" + }, + { + "input": { + "Filters": [ + { + "Name": "instance-type", + "Values": [ + "t2.micro" + ] + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the instances with the t2.micro instance type.", + "id": "to-describe-the-instances-with-the-instance-type-t2micro-1529026147602", + "title": "To describe the instances with a specific instance type" + }, + { + "input": { + "Filters": [ + { + "Name": "tag:Purpose", + "Values": [ + "test" + ] + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the instances with the Purpose=test tag.", + "id": "to-describe-the-instances-with-a-specific-tag-1529026251928", + "title": "To describe the instances with a specific tag" + } + ], "DescribeInternetGateways": [ { "input": { @@ -1637,6 +2283,103 @@ "title": "To display a key pair" } ], + "DescribeLaunchTemplateVersions": [ + { + "input": { + "LaunchTemplateId": "068f72b72934aff71" + }, + "output": { + "LaunchTemplateVersions": [ + { + "CreateTime": "2017-11-20T13:12:32.000Z", + "CreatedBy": "arn:aws:iam::123456789102:root", + "DefaultVersion": false, + "LaunchTemplateData": { + "ImageId": "ami-6057e21a", + "InstanceType": "t2.medium", + "KeyName": "kp-us-east", + "NetworkInterfaces": [ + { + "DeviceIndex": 0, + "Groups": [ + "sg-7c227019" + ], + "SubnetId": "subnet-1a2b3c4d" + } + ] + }, + "LaunchTemplateId": "lt-068f72b72934aff71", + "LaunchTemplateName": "Webservers", + "VersionNumber": 2 + }, + { + "CreateTime": "2017-11-20T12:52:33.000Z", + "CreatedBy": "arn:aws:iam::123456789102:root", + "DefaultVersion": true, + "LaunchTemplateData": { + "ImageId": "ami-aabbcc11", + "InstanceType": "t2.medium", + "KeyName": "kp-us-east", + "NetworkInterfaces": [ + { + "AssociatePublicIpAddress": true, + "DeleteOnTermination": false, + "DeviceIndex": 0, + "Groups": [ + "sg-7c227019" + ], + "SubnetId": "subnet-7b16de0c" + } + ], + "UserData": "" + }, + "LaunchTemplateId": "lt-068f72b72934aff71", + "LaunchTemplateName": "Webservers", + "VersionNumber": 1 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the versions for the specified launch template.", + "id": "to-describe-the-versions-for-a-launch-template-1529344425048", + "title": "To describe the versions for a launch template" + } + ], + "DescribeLaunchTemplates": [ + { + "input": { + "LaunchTemplateIds": [ + "lt-01238c059e3466abc" + ] + }, + "output": { + "LaunchTemplates": [ + { + "CreateTime": "2018-01-16T04:32:57.000Z", + "CreatedBy": "arn:aws:iam::123456789012:root", + "DefaultVersionNumber": 1, + "LatestVersionNumber": 1, + "LaunchTemplateId": "lt-01238c059e3466abc", + "LaunchTemplateName": "my-template" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified launch template.", + "id": "to-describe-a-launch-template-1529344182862", + "title": "To describe a launch template" + } + ], "DescribeMovingAddresses": [ { "output": { @@ -2126,6 +2869,76 @@ "title": "To describe your Scheduled Instances" } ], + "DescribeSecurityGroupReferences": [ + { + "input": { + "GroupId": [ + "sg-903004f8" + ] + }, + "output": { + "SecurityGroupReferenceSet": [ + { + "GroupId": "sg-903004f8", + "ReferencingVpcId": "vpc-1a2b3c4d", + "VpcPeeringConnectionId": "pcx-b04deed9" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the security group references for the specified security group.", + "id": "to-describe-security-group-references-1529354312088", + "title": "To describe security group references" + } + ], + "DescribeSecurityGroups": [ + { + "input": { + "GroupIds": [ + "sg-903004f8" + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified security group.", + "id": "to-describe-a-security-group-1529354426314", + "title": "To describe a security group" + }, + { + "input": { + "Filters": [ + { + "Name": "tag:Purpose", + "Values": [ + "test" + ] + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the security groups that include the specified tag (Purpose=test).", + "id": "to-describe-a-tagged-security-group-1529354553880", + "title": "To describe a tagged security group" + } + ], "DescribeSnapshotAttribute": [ { "input": { @@ -2925,6 +3738,33 @@ "title": "To disassociate an Elastic IP addresses in EC2-Classic" } ], + "DisassociateIamInstanceProfile": [ + { + "input": { + "AssociationId": "iip-assoc-05020b59952902f5f" + }, + "output": { + "IamInstanceProfileAssociation": { + "AssociationId": "iip-assoc-05020b59952902f5f", + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role", + "Id": "AIPAI5IVIHMFFYY2DKV5Y" + }, + "InstanceId": "i-123456789abcde123", + "State": "disassociating" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example disassociates the specified IAM instance profile from an instance.", + "id": "to-disassociate-an-iam-instance-profile-1529355364478", + "title": "To disassociate an IAM instance profile" + } + ], "DisassociateRouteTable": [ { "input": { @@ -2974,6 +3814,210 @@ "title": "To enable I/O for a volume" } ], + "GetConsoleOutput": [ + { + "input": { + "InstanceId": "i-1234567890abcdef0" + }, + "output": { + "InstanceId": "i-1234567890abcdef0", + "Output": "...", + "Timestamp": "2018-05-25T21:23:53.000Z" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example gets the console output for the specified instance.", + "id": "to-get-the-console-output-1529355683194", + "title": "To get the console output" + } + ], + "GetLaunchTemplateData": [ + { + "input": { + "InstanceId": "0123d646e8048babc" + }, + "output": { + "LaunchTemplateData": { + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/xvda", + "Ebs": { + "DeleteOnTermination": true, + "Encrypted": false, + "Iops": 100, + "SnapshotId": "snap-02594938353ef77d3", + "VolumeSize": 8, + "VolumeType": "gp2" + } + } + ], + "EbsOptimized": false, + "ImageId": "ami-32cf7b4a", + "InstanceType": "t2.medium", + "KeyName": "my-key-pair", + "Monitoring": { + "Enabled": false + }, + "NetworkInterfaces": [ + { + "AssociatePublicIpAddress": false, + "DeleteOnTermination": true, + "Description": "", + "DeviceIndex": 0, + "Groups": [ + "sg-d14e1bb4" + ], + "Ipv6Addresses": [ + + ], + "NetworkInterfaceId": "eni-4338b5a9", + "PrivateIpAddress": "10.0.3.233", + "PrivateIpAddresses": [ + { + "Primary": true, + "PrivateIpAddress": "10.0.3.233" + } + ], + "SubnetId": "subnet-5264e837" + } + ], + "Placement": { + "AvailabilityZone": "us-east-2b", + "GroupName": "", + "Tenancy": "default" + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example gets the launch template data for the specified instance.", + "id": "to-get-the-launch-template-data-for-an-instance--1529356515702", + "title": "To get the launch template data for an instance " + } + ], + "ModifyImageAttribute": [ + { + "input": { + "ImageId": "ami-5731123e", + "LaunchPermission": { + "Add": [ + { + "Group": "all" + } + ] + } + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example makes the specified AMI public.", + "id": "to-make-an-ami-public-1529357395278", + "title": "To make an AMI public" + }, + { + "input": { + "ImageId": "ami-5731123e", + "LaunchPermission": { + "Add": [ + { + "UserId": "123456789012" + } + ] + } + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example grants launch permissions for the specified AMI to the specified AWS account.", + "id": "to-grant-launch-permissions-1529357727906", + "title": "To grant launch permissions" + } + ], + "ModifyInstanceAttribute": [ + { + "input": { + "InstanceId": "i-1234567890abcdef0", + "InstanceType": { + "Value": "m5.large" + } + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies the instance type of the specified stopped instance.", + "id": "to-modify-the-instance-type-1529357844378", + "title": "To modify the instance type" + }, + { + "input": { + "EnaSupport": { + "Value": true + }, + "InstanceId": "i-1234567890abcdef0" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables enhanced networking for the specified stopped instance.", + "id": "to-enable-enhanced-networking-1529358279870", + "title": "To enable enhanced networking" + } + ], + "ModifyLaunchTemplate": [ + { + "input": { + "DefaultVersion": "2", + "LaunchTemplateId": "lt-0abcd290751193123" + }, + "output": { + "LaunchTemplate": { + "CreateTime": "2017-12-01T13:35:46.000Z", + "CreatedBy": "arn:aws:iam::123456789012:root", + "DefaultVersionNumber": 2, + "LatestVersionNumber": 2, + "LaunchTemplateId": "lt-0abcd290751193123", + "LaunchTemplateName": "WebServers" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example specifies version 2 as the default version of the specified launch template.", + "id": "to-change-the-default-version-of-a-launch-template-1529358440364", + "title": "To change the default version of a launch template" + } + ], "ModifyNetworkInterfaceAttribute": [ { "input": { @@ -3274,6 +4318,26 @@ "title": "To purchase a Scheduled Instance" } ], + "RebootInstances": [ + { + "input": { + "InstanceIds": [ + "i-1234567890abcdef5" + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example reboots the specified EC2 instance.", + "id": "to-reboot-an-ec2-instance-1529358566382", + "title": "To reboot an EC2 instance" + } + ], "ReleaseAddress": [ { "input": { @@ -3604,6 +4668,44 @@ "title": "To create a one-time Spot Instance request" } ], + "ResetImageAttribute": [ + { + "input": { + "Attribute": "launchPermission", + "ImageId": "ami-5731123e" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example resets the launchPermission attribute for the specified AMI. By default, AMIs are private.", + "id": "to-reset-the-launchpermission-attribute-1529359519534", + "title": "To reset the launchPermission attribute" + } + ], + "ResetInstanceAttribute": [ + { + "input": { + "Attribute": "sourceDestCheck", + "InstanceId": "i-1234567890abcdef0" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example resets the sourceDestCheck attribute for the specified instance.", + "id": "to-reset-the-sourcedestcheck-attribute-1529359630708", + "title": "To reset the sourceDestCheck attribute" + } + ], "ResetSnapshotAttribute": [ { "input": { @@ -3643,6 +4745,51 @@ "title": "To restore an address to EC2-Classic" } ], + "RunInstances": [ + { + "input": { + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/sdh", + "Ebs": { + "VolumeSize": 100 + } + } + ], + "ImageId": "ami-abc12345", + "InstanceType": "t2.micro", + "KeyName": "my-key-pair", + "MaxCount": 1, + "MinCount": 1, + "SecurityGroupIds": [ + "sg-1a2b3c4d" + ], + "SubnetId": "subnet-6e7f829e", + "TagSpecifications": [ + { + "ResourceType": "instance", + "Tags": [ + { + "Key": "Purpose", + "Value": "test" + } + ] + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example launches an instance using the specified AMI, instance type, security group, subnet, block device mapping, and tags.", + "id": "to-launch-an-instance-1529360150806", + "title": "To launch an instance" + } + ], "RunScheduledInstances": [ { "input": { @@ -3717,6 +4864,105 @@ "title": "To launch a Scheduled Instance in EC2-Classic" } ], + "StartInstances": [ + { + "input": { + "InstanceIds": [ + "i-1234567890abcdef0" + ] + }, + "output": { + "StartingInstances": [ + { + "CurrentState": { + "Code": 0, + "Name": "pending" + }, + "InstanceId": "i-1234567890abcdef0", + "PreviousState": { + "Code": 80, + "Name": "stopped" + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example starts the specified EC2 instance.", + "id": "to-start-a-stopped-ec2-instance-1529358792730", + "title": "To start a stopped EC2 instance" + } + ], + "StopInstances": [ + { + "input": { + "InstanceIds": [ + "i-1234567890abcdef0" + ] + }, + "output": { + "StoppingInstances": [ + { + "CurrentState": { + "Code": 64, + "Name": "stopping" + }, + "InstanceId": "i-1234567890abcdef0", + "PreviousState": { + "Code": 16, + "Name": "running" + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example stops the specified EC2 instance.", + "id": "to-stop-a-running-ec2-instance-1529358905540", + "title": "To stop a running EC2 instance" + } + ], + "TerminateInstances": [ + { + "input": { + "InstanceIds": [ + "i-1234567890abcdef0" + ] + }, + "output": { + "TerminatingInstances": [ + { + "CurrentState": { + "Code": 32, + "Name": "shutting-down" + }, + "InstanceId": "i-1234567890abcdef0", + "PreviousState": { + "Code": 16, + "Name": "running" + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example terminates the specified EC2 instance.", + "id": "to-terminate-an-ec2-instance-1529359350660", + "title": "To terminate an EC2 instance" + } + ], "UnassignPrivateIpAddresses": [ { "input": { @@ -3735,6 +4981,68 @@ "id": "ec2-unassign-private-ip-addresses-1", "title": "To unassign a secondary private IP address from a network interface" } + ], + "UpdateSecurityGroupRuleDescriptionsEgress": [ + { + "input": { + "GroupId": "sg-123abc12", + "IpPermissions": [ + { + "FromPort": 80, + "IpProtocol": "tcp", + "IpRanges": [ + { + "CidrIp": "203.0.113.0/24", + "Description": "Outbound HTTP access to server 2" + } + ], + "ToPort": 80 + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example updates the description for the specified security group rule.", + "id": "to-update-an-outbound-security-group-rule-description-1529360481544", + "title": "To update an outbound security group rule description" + } + ], + "UpdateSecurityGroupRuleDescriptionsIngress": [ + { + "input": { + "GroupId": "sg-123abc12", + "IpPermissions": [ + { + "FromPort": 22, + "IpProtocol": "tcp", + "IpRanges": [ + { + "CidrIp": "203.0.113.0/16", + "Description": "SSH access from the LA office" + } + ], + "ToPort": 22 + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example updates the description for the specified security group rule.", + "id": "to-update-an-inbound-security-group-rule-description-1529360820372", + "title": "To update an inbound security group rule description" + } ] } } diff --git a/botocore/data/ec2/2016-11-15/service-2.json b/botocore/data/ec2/2016-11-15/service-2.json index 21b7803c..a4ea7f6b 100644 --- a/botocore/data/ec2/2016-11-15/service-2.json +++ b/botocore/data/ec2/2016-11-15/service-2.json @@ -662,6 +662,7 @@ "requestUri":"/" }, "input":{"shape":"CreatePlacementGroupRequest"}, + "output":{"shape":"CreatePlacementGroupResult"}, "documentation":"Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.
A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.
For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.
" }, "CreateReservedInstancesListing":{ @@ -1411,6 +1412,16 @@ "input":{"shape":"DeregisterImageRequest"}, "documentation":"Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances; however, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them.
When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI.
" }, + "DeregisterInstanceEventNotificationAttributes":{ + "name":"DeregisterInstanceEventNotificationAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterInstanceEventNotificationAttributesRequest"}, + "output":{"shape":"DeregisterInstanceEventNotificationAttributesResult"}, + "documentation":"Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region.
" + }, "DeregisterTransitGatewayMulticastGroupMembers":{ "name":"DeregisterTransitGatewayMulticastGroupMembers", "http":{ @@ -1831,6 +1842,16 @@ "output":{"shape":"DescribeInstanceCreditSpecificationsResult"}, "documentation":"Describes the credit option for CPU usage of the specified burstable performance instances. The credit options are standard and unlimited.
If you do not specify an instance ID, Amazon EC2 returns burstable performance instances with the unlimited credit option, as well as instances that were previously configured as T2, T3, and T3a with the unlimited credit option. For example, if you resize a T2 instance, while it is configured as unlimited, to an M4 instance, Amazon EC2 returns the M4 instance.
If you specify one or more instance IDs, Amazon EC2 returns the credit option (standard or unlimited) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a burstable performance instance, an error is returned.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally.
For more information, see Burstable Performance Instances in the Amazon Elastic Compute Cloud User Guide.
" }, + "DescribeInstanceEventNotificationAttributes":{ + "name":"DescribeInstanceEventNotificationAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstanceEventNotificationAttributesRequest"}, + "output":{"shape":"DescribeInstanceEventNotificationAttributesResult"}, + "documentation":"Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region.
" + }, "DescribeInstanceStatus":{ "name":"DescribeInstanceStatus", "http":{ @@ -2249,7 +2270,7 @@ }, "input":{"shape":"DescribeSpotInstanceRequestsRequest"}, "output":{"shape":"DescribeSpotInstanceRequestsResult"}, - "documentation":"Describes the specified Spot Instance requests.
You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.
We recommend that you set MaxResults to a value between 5 and 1000 to limit the number of results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining results.
Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.
" + "documentation":"Describes the specified Spot Instance requests.
You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.
We recommend that you set MaxResults to a value between 5 and 1000 to limit the number of results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining results.
Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.
" }, "DescribeSpotPriceHistory":{ "name":"DescribeSpotPriceHistory", @@ -3523,6 +3544,16 @@ "output":{"shape":"RegisterImageResult"}, "documentation":"Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide.
For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.
You can also use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using the block device mapping. For more information, see Launching a Linux Instance from a Backup in the Amazon Elastic Compute Cloud User Guide.
You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.
Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billing product code associated with an AMI to verify the subscription status for package updates. To create a new AMI for operating systems that require a billing product code, instead of registering the AMI, do the following to preserve the billing product code association:
Launch an instance from an existing AMI with that billing product code.
Customize the instance.
Create an AMI from the instance using CreateImage.
If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see Obtaining Billing Information in the Amazon Elastic Compute Cloud User Guide.
If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.
" }, + "RegisterInstanceEventNotificationAttributes":{ + "name":"RegisterInstanceEventNotificationAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterInstanceEventNotificationAttributesRequest"}, + "output":{"shape":"RegisterInstanceEventNotificationAttributesResult"}, + "documentation":"Registers a set of tag keys to include in scheduled event notifications for your resources.
To remove tags, use .
" + }, "RegisterTransitGatewayMulticastGroupMembers":{ "name":"RegisterTransitGatewayMulticastGroupMembers", "http":{ @@ -3791,7 +3822,7 @@ }, "input":{"shape":"RunInstancesRequest"}, "output":{"shape":"Reservation"}, - "documentation":"Launches the specified number of instances using an AMI for which you have permissions.
You can specify a number of options, or leave the default options. The following rules apply:
[EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request.
[EC2-Classic] If don't specify an Availability Zone, we choose one for you.
Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance Types Available Only in a VPC.
[EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet.
Not all instance types support IPv6 addresses. For more information, see Instance Types.
If you don't specify a security group ID, we use the default security group. For more information, see Security Groups.
If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.
You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.
To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.
An instance is ready for you to use when it's in the running state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging Your Amazon EC2 Resources.
Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
For troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Launches the specified number of instances using an AMI for which you have permissions.
You can specify a number of options, or leave the default options. The following rules apply:
[EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request.
[EC2-Classic] If don't specify an Availability Zone, we choose one for you.
Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance Types Available Only in a VPC.
[EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet.
Not all instance types support IPv6 addresses. For more information, see Instance Types.
If you don't specify a security group ID, we use the default security group. For more information, see Security Groups.
If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.
You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.
To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.
An instance is ready for you to use when it's in the running state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging Your Amazon EC2 Resources.
Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
For troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide.
" }, "RunScheduledInstances":{ "name":"RunScheduledInstances", @@ -8160,6 +8191,11 @@ "shape":"Boolean", "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The tags to apply to the new key pair.
", + "locationName":"TagSpecification" } } }, @@ -8581,6 +8617,20 @@ "PartitionCount":{ "shape":"Integer", "documentation":"The number of partitions. Valid only when Strategy is set to partition.
The tags to apply to the new placement group.
", + "locationName":"TagSpecification" + } + } + }, + "CreatePlacementGroupResult":{ + "type":"structure", + "members":{ + "PlacementGroup":{ + "shape":"PlacementGroup", + "locationName":"placementGroup" } } }, @@ -10260,12 +10310,15 @@ }, "DeleteKeyPairRequest":{ "type":"structure", - "required":["KeyName"], "members":{ "KeyName":{ "shape":"KeyPairName", "documentation":"The name of the key pair.
" }, + "KeyPairId":{ + "shape":"KeyPairId", + "documentation":"The ID of the key pair.
" + }, "DryRun":{ "shape":"Boolean", "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Contains the parameters for DeregisterImage.
" }, + "DeregisterInstanceEventNotificationAttributesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the tag keys to deregister.
" + } + } + }, + "DeregisterInstanceEventNotificationAttributesResult":{ + "type":"structure", + "members":{ + "InstanceTagAttribute":{ + "shape":"InstanceTagNotificationAttribute", + "documentation":"The resulting set of tag keys.
", + "locationName":"instanceTagAttribute" + } + } + }, + "DeregisterInstanceTagAttributeRequest":{ + "type":"structure", + "members":{ + "IncludeAllTagsOfInstance":{ + "shape":"Boolean", + "documentation":"Indicates whether to deregister all tag keys in the current Region. Specify false to deregister all tag keys.
Information about the tag keys to deregister.
", + "locationName":"InstanceTagKey" + } + }, + "documentation":"Information about the tag keys to deregister for the current Region. You can either specify individual tag keys or deregister all tag keys in the current Region. You must specify either IncludeAllTagsOfInstance or InstanceTagKeys in the request
The filters.
instance-id - The ID of the instance.
state - The state of the association (associating | associated | disassociating | disassociated).
The filters.
instance-id - The ID of the instance.
state - The state of the association (associating | associated | disassociating).
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the registered tag keys.
", + "locationName":"instanceTagAttribute" + } + } + }, "DescribeInstanceStatusRequest":{ "type":"structure", "members":{ @@ -13313,7 +13423,7 @@ "members":{ "Filters":{ "shape":"FilterList", - "documentation":"The filters.
fingerprint - The fingerprint of the key pair.
key-name - The name of the key pair.
The filters.
key-pair-id - The ID of the key pair.
fingerprint - The fingerprint of the key pair.
key-name - The name of the key pair.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
The filters.
group-name - The name of the placement group.
state - The state of the placement group (pending | available | deleting | deleted).
strategy - The strategy of the placement group (cluster | spread | partition).
The filters.
group-name - The name of the placement group.
state - The state of the placement group (pending | available | deleting | deleted).
strategy - The strategy of the placement group (cluster | spread | partition).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
The filters.
key - The tag key.
resource-id - The ID of the resource.
resource-type - The resource type (customer-gateway | dedicated-host | dhcp-options | elastic-ip | fleet | fpga-image | image | instance | host-reservation | internet-gateway | launch-template | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpc-endpoint | vpc-endpoint-service | vpc-peering-connection | vpn-connection | vpn-gateway).
tag:<key> - The key/value combination of the tag. For example, specify \"tag:Owner\" for the filter name and \"TeamA\" for the filter value to find resources with the tag \"Owner=TeamA\".
value - The tag value.
The filters.
key - The tag key.
resource-id - The ID of the resource.
resource-type - The resource type (customer-gateway | dedicated-host | dhcp-options | elastic-ip | fleet | fpga-image | host-reservation | image | instance | internet-gateway | key-pair | launch-template | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpc-endpoint | vpc-endpoint-service | vpc-peering-connection | vpn-connection | vpn-gateway).
tag:<key> - The key/value combination of the tag. For example, specify \"tag:Owner\" for the filter name and \"TeamA\" for the filter value to find resources with the tag \"Owner=TeamA\".
value - The tag value.
The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.
", "locationName":"publicKeyMaterial" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"The tags to apply to the imported key pair.
", + "locationName":"TagSpecification" } } }, @@ -21090,6 +21205,16 @@ "shape":"String", "documentation":"The key pair name you provided.
", "locationName":"keyName" + }, + "KeyPairId":{ + "shape":"String", + "documentation":"The ID of the resulting key pair.
", + "locationName":"keyPairId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags applied to the imported key pair.
", + "locationName":"tagSet" } } }, @@ -22506,6 +22631,29 @@ }, "documentation":"Describes the disks that are available for the instance type.
" }, + "InstanceTagKeySet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "InstanceTagNotificationAttribute":{ + "type":"structure", + "members":{ + "InstanceTagKeys":{ + "shape":"InstanceTagKeySet", + "documentation":"The registered tag keys.
", + "locationName":"instanceTagKeySet" + }, + "IncludeAllTagsOfInstance":{ + "shape":"Boolean", + "documentation":"Indicates wheter all tag keys in the current Region are registered to appear in scheduled event notifications. true indicates that all tag keys in the current Region are registered.
Describes the registered tag keys for the current Region.
" + }, "InstanceType":{ "type":"string", "enum":[ @@ -23274,6 +23422,11 @@ "shape":"String", "documentation":"The ID of the key pair.
", "locationName":"keyPairId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"Any tags applied to the key pair.
", + "locationName":"tagSet" } }, "documentation":"Describes a key pair.
" @@ -27830,12 +27983,12 @@ "members":{ "AvailabilityZone":{ "shape":"String", - "documentation":"The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported by .
", + "documentation":"The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported by CreateFleet.
", "locationName":"availabilityZone" }, "Affinity":{ "shape":"String", - "documentation":"The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
This parameter is not supported by .
", + "documentation":"The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet.
", "locationName":"affinity" }, "GroupName":{ @@ -27845,27 +27998,27 @@ }, "PartitionNumber":{ "shape":"Integer", - "documentation":"The number of the partition the instance is in. Valid only if the placement group strategy is set to partition.
This parameter is not supported by .
", + "documentation":"The number of the partition the instance is in. Valid only if the placement group strategy is set to partition.
This parameter is not supported by CreateFleet.
", "locationName":"partitionNumber" }, "HostId":{ "shape":"String", - "documentation":"The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
This parameter is not supported by .
", + "documentation":"The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet.
", "locationName":"hostId" }, "Tenancy":{ "shape":"Tenancy", - "documentation":"The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
This parameter is not supported by .
", + "documentation":"The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet.
", "locationName":"tenancy" }, "SpreadDomain":{ "shape":"String", - "documentation":"Reserved for future use.
This parameter is not supported by .
", + "documentation":"Reserved for future use.
This parameter is not supported by CreateFleet.
", "locationName":"spreadDomain" }, "HostResourceGroupArn":{ "shape":"String", - "documentation":"The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.
This parameter is not supported by .
", + "documentation":"The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.
This parameter is not supported by CreateFleet.
", "locationName":"hostResourceGroupArn" } }, @@ -28901,6 +29054,44 @@ }, "documentation":"Contains the output of RegisterImage.
" }, + "RegisterInstanceEventNotificationAttributesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the tag keys to register.
" + } + } + }, + "RegisterInstanceEventNotificationAttributesResult":{ + "type":"structure", + "members":{ + "InstanceTagAttribute":{ + "shape":"InstanceTagNotificationAttribute", + "documentation":"The resulting set of tag keys.
", + "locationName":"instanceTagAttribute" + } + } + }, + "RegisterInstanceTagAttributeRequest":{ + "type":"structure", + "members":{ + "IncludeAllTagsOfInstance":{ + "shape":"Boolean", + "documentation":"Indicates whether to register all tag keys in the current Region. Specify true to register all tag keys.
The tag keys to register.
", + "locationName":"InstanceTagKey" + } + }, + "documentation":"Information about the tag keys to register for the current Region. You can either specify individual tag keys or register all tag keys in the current Region. You must specify either IncludeAllTagsOfInstance or InstanceTagKeys in the request
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet Prerequisites in the Amazon EC2 User Guide for Linux Instances. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration.
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet Prerequisites in the Amazon EC2 User Guide for Linux Instances. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration.
The Spot Instance request type. For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop.
The Spot Instance request type. For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop.
The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice, or both to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in and
The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice, or both to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptions and SpotOptions
The default TotalTargetCapacity, which is either Spot or On-Demand.
The number of units to request. You can choose to set the target capacity as the number of instances. Or you can set the target capacity to a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in and .
The number of units to request. You can choose to set the target capacity as the number of instances. Or you can set the target capacity to a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptionsRequest and SpotOptionsRequest.
Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, see the UpdateService action.
In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.
Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they're in the RUNNING state and the container instance that they're hosted on is reported as healthy by the load balancer.
There are two service scheduler strategies available:
REPLICA - The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service Scheduler Concepts in the Amazon Elastic Container Service Developer Guide.
DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service Scheduler Concepts in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment is triggered by changing properties, such as the task definition or the desired count of a service, with an UpdateService operation. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.
If a service is using the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they're in the RUNNING state and they're reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.
If a service is using the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.
If a service is using either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used, although they're currently visible when describing your service.
When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:
Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy) with the placementStrategy parameter):
Sort the valid container instances, giving priority to instances that have the fewest number of running tasks for this service in their respective Availability Zone. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, see the UpdateService action.
In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.
Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they're in the RUNNING state and the container instance that they're hosted on is reported as healthy by the load balancer.
There are two service scheduler strategies available:
REPLICA - The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service Scheduler Concepts in the Amazon Elastic Container Service Developer Guide.
DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service Scheduler Concepts in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment is triggered by changing properties, such as the task definition or the desired count of a service, with an UpdateService operation. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.
If a service is using the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they're in the RUNNING state and they're reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.
If a service is using the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.
If a service is using either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used, although they're currently visible when describing your service.
When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:
Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy) with the placementStrategy parameter):
Sort the valid container instances, giving priority to instances that have the fewest number of running tasks for this service in their respective Availability Zone. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
Modifies the parameters of a service.
For services using the rolling update (ECS) deployment controller, the desired count, deployment configuration, network configuration, or task definition used can be updated.
For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, and health check grace period can be updated using this API. If the network configuration, platform version, or task definition need to be updated, a new AWS CodeDeploy deployment should be created. For more information, see CreateDeployment in the AWS CodeDeploy API Reference.
For services using an external deployment controller, you can update only the desired count and health check grace period using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, you should create a new task set. For more information, see CreateTaskSet.
You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.
If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.
If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest), you do not need to create a new revision of your task definition. You can update the service using the forceNewDeployment option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.
You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent and maximumPercent, to determine the deployment strategy.
If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during a deployment. For example, if desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer.
The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).
When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.
When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic:
Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy):
Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:
Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination.
Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.
Updating the task placement strategies and constraints on an Amazon ECS service remains in preview and is a Beta Service as defined by and subject to the Beta Service Participation Service Terms located at https://aws.amazon.com/service-terms (\"Beta Terms\"). These Beta Terms apply to your participation in this preview.
Modifies the parameters of a service.
For services using the rolling update (ECS) deployment controller, the desired count, deployment configuration, network configuration, task placement constraints and strategies, or task definition used can be updated.
For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, task placement constraints and strategies, and health check grace period can be updated using this API. If the network configuration, platform version, or task definition need to be updated, a new AWS CodeDeploy deployment should be created. For more information, see CreateDeployment in the AWS CodeDeploy API Reference.
For services using an external deployment controller, you can update only the desired count, task placement constraints and strategies, and health check grace period using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, you should create a new task set. For more information, see CreateTaskSet.
You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.
If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.
If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest), you do not need to create a new revision of your task definition. You can update the service using the forceNewDeployment option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.
You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent and maximumPercent, to determine the deployment strategy.
If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during a deployment. For example, if desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer.
The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).
When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.
When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic:
Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy):
Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:
Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination.
Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.
The short name or full Amazon Resource Name (ARN) of the capacity provider.
" + "documentation":"The short name of the capacity provider.
" }, "weight":{ "shape":"CapacityProviderStrategyItemWeight", @@ -1430,7 +1430,7 @@ }, "healthCheck":{ "shape":"HealthCheck", - "documentation":"The health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run.
The container health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run.
The short name or full Amazon Resource Name (ARN) of one or more capacity providers to associate with the cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
" + "documentation":"The short name of one or more capacity providers to associate with the cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
" }, "defaultCapacityProviderStrategy":{ "shape":"CapacityProviderStrategy", @@ -1783,7 +1783,7 @@ }, "schedulingStrategy":{ "shape":"SchedulingStrategy", - "documentation":"The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available:
REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service is using the CODE_DEPLOY or EXTERNAL deployment controller types.
DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.
Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.
The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available:
REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service is using the CODE_DEPLOY or EXTERNAL deployment controller types.
DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.
Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.
This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead.
The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration will be relative to the directory set for the access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS Access Points in the Amazon Elastic File System User Guide.
Whether or not to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS Access Points in the Amazon Elastic Container Service Developer Guide.
The authorization configuration details for the Amazon EFS file system.
" + }, + "EFSAuthorizationConfigIAM":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "EFSTransitEncryption":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, "EFSVolumeConfiguration":{ "type":"structure", "required":["fileSystemId"], @@ -2468,10 +2496,22 @@ }, "rootDirectory":{ "shape":"String", - "documentation":"The directory within the Amazon EFS file system to mount as the root directory inside the host.
" + "documentation":"The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying / will have the same effect as omitting this parameter.
Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting Data in Transit in the Amazon Elastic File System User Guide.
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS Mount Helper in the Amazon Elastic File System User Guide.
" + }, + "authorizationConfig":{ + "shape":"EFSAuthorizationConfig", + "documentation":"The authorization configuration details for the Amazon EFS file system.
" } }, - "documentation":"This parameter is specified when you are using an Amazon Elastic File System (Amazon EFS) file storage. Amazon EFS file systems are only supported when you are using the EC2 launch type.
EFSVolumeConfiguration remains in preview and is a Beta Service as defined by and subject to the Beta Service Participation Service Terms located at https://aws.amazon.com/service-terms (\"Beta Terms\"). These Beta Terms apply to your participation in this preview of EFSVolumeConfiguration.
This parameter is specified when you are using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS Volumes in the Amazon Elastic Container Service Developer Guide.
" }, "EnvironmentVariables":{ "type":"list", @@ -2555,7 +2595,7 @@ "documentation":"The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. The startPeriod is disabled by default.
If a health check succeeds within the startPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.
An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile).
The following are notes about container health check support:
Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent.
Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see AWS Fargate Platform Versions.
Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer.
An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile).
You can view the health status of both individual containers and a task with the DescribeTasks API operation or when viewing the task details in the console.
The following describes the possible healthStatus values for a container:
HEALTHY-The container health check has passed successfully.
UNHEALTHY-The container health check has failed.
UNKNOWN-The container health check is being evaluated or there is no container health check defined.
The following describes the possible healthStatus values for a task. The container health check status of nonessential containers do not have an effect on the health status of a task.
HEALTHY-All essential containers within the task have passed their health checks.
UNHEALTHY-One or more essential containers have failed their health check.
UNKNOWN-The essential containers within the task are still having their health checks evaluated or there are no container health checks defined.
If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it.
The following are notes about container health check support:
Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent.
Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see AWS Fargate Platform Versions.
Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer.
The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available:
REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.
DAEMON-The daemon scheduling strategy deploys exactly one task on each container instance in your cluster. When you are using this strategy, do not specify a desired number of tasks or any task placement strategies.
Fargate tasks do not support the DAEMON scheduling strategy.
The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available:
REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.
DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints.
Fargate tasks do not support the DAEMON scheduling strategy.
The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see Amazon ECS Task Role in the Amazon Elastic Container Service Developer Guide.
IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see Windows IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see Amazon ECS Task Role in the Amazon Elastic Container Service Developer Guide.
IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see Windows IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
The capacity provider strategy to update the service to use.
If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers. However, when a service is using a non-default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.
" + "documentation":"The capacity provider strategy to update the service to use.
If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that is not the default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.
A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
" }, "deploymentConfiguration":{ "shape":"DeploymentConfiguration", diff --git a/botocore/data/eks/2017-11-01/examples-1.json b/botocore/data/eks/2017-11-01/examples-1.json new file mode 100644 index 00000000..6a83da72 --- /dev/null +++ b/botocore/data/eks/2017-11-01/examples-1.json @@ -0,0 +1,114 @@ +{ + "version": "1.0", + "examples": { + "CreateCluster": [ + { + "input": { + "version": "1.10", + "name": "prod", + "clientRequestToken": "1d2129a1-3d38-460a-9756-e5b91fddb951", + "resourcesVpcConfig": { + "securityGroupIds": [ + "sg-6979fe18" + ], + "subnetIds": [ + "subnet-6782e71e", + "subnet-e7e761ac" + ] + }, + "roleArn": "arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates an Amazon EKS cluster called prod.", + "id": "to-create-a-new-cluster-1527868185648", + "title": "To create a new cluster" + } + ], + "DeleteCluster": [ + { + "input": { + "name": "devel" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example command deletes a cluster named `devel` in your default region.", + "id": "to-delete-a-cluster-1527868641252", + "title": "To delete a cluster" + } + ], + "DescribeCluster": [ + { + "input": { + "name": "devel" + }, + "output": { + "cluster": { + "version": "1.10", + "name": "devel", + "arn": "arn:aws:eks:us-west-2:012345678910:cluster/devel", + "certificateAuthority": { + "data": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUN5RENDQWJDZ0F3SUJBZ0lCQURBTkJna3Foa2lHOXcwQkFRc0ZBREFWTVJNd0VRWURWUVFERXdwcmRXSmwKY201bGRHVnpNQjRYRFRFNE1EVXpNVEl6TVRFek1Wb1hEVEk0TURVeU9ESXpNVEV6TVZvd0ZURVRNQkVHQTFVRQpBeE1LYTNWaVpYSnVaWFJsY3pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBTTZWCjVUaG4rdFcySm9Xa2hQMzRlVUZMNitaRXJOZGIvWVdrTmtDdWNGS2RaaXl2TjlMVmdvUmV2MjlFVFZlN1ZGbSsKUTJ3ZURyRXJiQyt0dVlibkFuN1ZLYmE3ay9hb1BHekZMdmVnb0t6b0M1N2NUdGVwZzRIazRlK2tIWHNaME10MApyb3NzcjhFM1ROeExETnNJTThGL1cwdjhsTGNCbWRPcjQyV2VuTjFHZXJnaDNSZ2wzR3JIazBnNTU0SjFWenJZCm9hTi8zODFUczlOTFF2QTBXb0xIcjBFRlZpTFdSZEoyZ3lXaC9ybDVyOFNDOHZaQXg1YW1BU0hVd01aTFpWRC8KTDBpOW4wRVM0MkpVdzQyQmxHOEdpd3NhTkJWV3lUTHZKclNhRXlDSHFtVVZaUTFDZkFXUjl0L3JleVVOVXM3TApWV1FqM3BFbk9RMitMSWJrc0RzQ0F3RUFBYU1qTUNFd0RnWURWUjBQQVFIL0JBUURBZ0trTUE4R0ExVWRFd0VCCi93UUZNQU1CQWY4d0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQkFNZ3RsQ1dIQ2U2YzVHMXl2YlFTS0Q4K2hUalkKSm1NSG56L2EvRGt0WG9YUjFVQzIrZUgzT1BZWmVjRVZZZHVaSlZCckNNQ2VWR0ZkeWdBYlNLc1FxWDg0S2RXbAp1MU5QaERDSmEyRHliN2pVMUV6VThTQjFGZUZ5ZFE3a0hNS1E1blpBRVFQOTY4S01hSGUrSm0yQ2x1UFJWbEJVCjF4WlhTS1gzTVZ0K1Q0SU1EV2d6c3JRSjVuQkRjdEtLcUZtM3pKdVVubHo5ZEpVckdscEltMjVJWXJDckxYUFgKWkUwRUtRNWEzMHhkVWNrTHRGQkQrOEtBdFdqSS9yZUZPNzM1YnBMdVoyOTBaNm42QlF3elRrS0p4cnhVc3QvOAppNGsxcnlsaUdWMm5SSjBUYjNORkczNHgrYWdzYTRoSTFPbU90TFM0TmgvRXJxT3lIUXNDc2hEQUtKUT0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo=" + }, + "createdAt": 1527807879.988, + "endpoint": "https://A0DCCD80A04F01705DD065655C30CC3D.yl4.us-west-2.eks.amazonaws.com", + "resourcesVpcConfig": { + "securityGroupIds": [ + "sg-6979fe18" + ], + "subnetIds": [ + "subnet-6782e71e", + "subnet-e7e761ac" + ], + "vpcId": "vpc-950809ec" + }, + "roleArn": "arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI", + "status": "ACTIVE" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example command provides a description of the specified cluster in your default region.", + "id": "to-describe-a-cluster-1527868708512", + "title": "To describe a cluster" + } + ], + "ListClusters": [ + { + "input": { + }, + "output": { + "clusters": [ + "devel", + "prod" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example command lists all of your available clusters in your default region.", + "id": "to-list-your-available-clusters-1527868801040", + "title": "To list your available clusters" + } + ] + } +} diff --git a/botocore/data/eks/2017-11-01/service-2.json b/botocore/data/eks/2017-11-01/service-2.json index 38ce3f80..5286eb5b 100644 --- a/botocore/data/eks/2017-11-01/service-2.json +++ b/botocore/data/eks/2017-11-01/service-2.json @@ -84,7 +84,7 @@ {"shape":"ServerException"}, {"shape":"ServiceUnavailableException"} ], - "documentation":"Deletes the Amazon EKS cluster control plane.
If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a Cluster in the Amazon EKS User Guide.
If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more information, see DeleteNodegroup andDeleteFargateProfile.
" + "documentation":"Deletes the Amazon EKS cluster control plane.
If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a Cluster in the Amazon EKS User Guide.
If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more information, see DeleteNodegroup and DeleteFargateProfile.
" }, "DeleteFargateProfile":{ "name":"DeleteFargateProfile", @@ -232,7 +232,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Lists the Amazon EKS node groups associated with the specified cluster in your AWS account in the specified Region.
" + "documentation":"Lists the Amazon EKS managed node groups associated with the specified cluster in your AWS account in the specified Region. Self-managed node groups are not listed.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", @@ -666,7 +666,7 @@ }, "nodeRole":{ "shape":"String", - "documentation":"The IAM role associated with your node group. The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch worker nodes and register them into a cluster, you must create an IAM role for those worker nodes to use when they are launched. For more information, see Amazon EKS Worker Node IAM Role in the Amazon EKS User Guide .
The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch worker nodes and register them into a cluster, you must create an IAM role for those worker nodes to use when they are launched. For more information, see Amazon EKS Worker Node IAM Role in the Amazon EKS User Guide .
Describes the locations in which a given accelerator type or set of types is present in a given region.
" + }, + "DescribeAcceleratorTypes":{ + "name":"DescribeAcceleratorTypes", + "http":{ + "method":"GET", + "requestUri":"/describe-accelerator-types" + }, + "input":{"shape":"DescribeAcceleratorTypesRequest"}, + "output":{"shape":"DescribeAcceleratorTypesResponse"}, + "errors":[ + {"shape":"InternalServerException"} + ], + "documentation":"Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput.
" + }, + "DescribeAccelerators":{ + "name":"DescribeAccelerators", + "http":{ + "method":"POST", + "requestUri":"/describe-accelerators" + }, + "input":{"shape":"DescribeAcceleratorsRequest"}, + "output":{"shape":"DescribeAcceleratorsResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Describes information over a provided set of accelerators belonging to an account.
" + }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ @@ -26,7 +69,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], - "documentation":"Returns all tags of an Elastic Inference Accelerator." + "documentation":"Returns all tags of an Elastic Inference Accelerator.
" }, "TagResource":{ "name":"TagResource", @@ -41,7 +84,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], - "documentation":"Adds the specified tag(s) to an Elastic Inference Accelerator." + "documentation":"Adds the specified tags to an Elastic Inference Accelerator.
" }, "UntagResource":{ "name":"UntagResource", @@ -56,35 +99,275 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], - "documentation":"Removes the specified tag(s) from an Elastic Inference Accelerator." + "documentation":"Removes the specified tags from an Elastic Inference Accelerator.
" } }, "shapes":{ + "AcceleratorHealthStatus":{ + "type":"string", + "max":256, + "min":1 + }, + "AcceleratorId":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^eia-[0-9a-f]+$" + }, + "AcceleratorIdList":{ + "type":"list", + "member":{"shape":"AcceleratorId"}, + "max":1000, + "min":0 + }, + "AcceleratorType":{ + "type":"structure", + "members":{ + "acceleratorTypeName":{ + "shape":"AcceleratorTypeName", + "documentation":"The name of the Elastic Inference Accelerator type.
" + }, + "memoryInfo":{ + "shape":"MemoryInfo", + "documentation":"The memory information of the Elastic Inference Accelerator type.
" + }, + "throughputInfo":{ + "shape":"ThroughputInfoList", + "documentation":"The throughput information of the Elastic Inference Accelerator type.
" + } + }, + "documentation":"The details of an Elastic Inference Accelerator type.
" + }, + "AcceleratorTypeList":{ + "type":"list", + "member":{"shape":"AcceleratorType"}, + "max":100, + "min":0 + }, + "AcceleratorTypeName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^\\S+$" + }, + "AcceleratorTypeNameList":{ + "type":"list", + "member":{"shape":"AcceleratorTypeName"}, + "max":100, + "min":0 + }, + "AcceleratorTypeOffering":{ + "type":"structure", + "members":{ + "acceleratorType":{ + "shape":"AcceleratorTypeName", + "documentation":"The name of the Elastic Inference Accelerator type.
" + }, + "locationType":{ + "shape":"LocationType", + "documentation":"The location type for the offering. It can assume the following values: region: defines that the offering is at the regional level. availability-zone: defines that the offering is at the availability zone level. availability-zone-id: defines that the offering is at the availability zone level, defined by the availability zone id.
" + }, + "location":{ + "shape":"Location", + "documentation":"The location for the offering. It will return either the region, availability zone or availability zone id for the offering depending on the locationType value.
" + } + }, + "documentation":"The offering for an Elastic Inference Accelerator type.
" + }, + "AcceleratorTypeOfferingList":{ + "type":"list", + "member":{"shape":"AcceleratorTypeOffering"}, + "max":100, + "min":0 + }, + "AvailabilityZone":{ + "type":"string", + "max":256, + "min":1 + }, "BadRequestException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, - "documentation":"Raised when a malformed input has been provided to the API.", + "documentation":"Raised when a malformed input has been provided to the API.
", "error":{"httpStatusCode":400}, "exception":true }, + "DescribeAcceleratorOfferingsRequest":{ + "type":"structure", + "required":["locationType"], + "members":{ + "locationType":{ + "shape":"LocationType", + "documentation":"The location type that you want to describe accelerator type offerings for. It can assume the following values: region: will return the accelerator type offering at the regional level. availability-zone: will return the accelerator type offering at the availability zone level. availability-zone-id: will return the accelerator type offering at the availability zone level returning the availability zone id.
" + }, + "acceleratorTypes":{ + "shape":"AcceleratorTypeNameList", + "documentation":"The list of accelerator types to describe.
" + } + } + }, + "DescribeAcceleratorOfferingsResponse":{ + "type":"structure", + "members":{ + "acceleratorTypeOfferings":{ + "shape":"AcceleratorTypeOfferingList", + "documentation":"The list of accelerator type offerings for a specific location.
" + } + } + }, + "DescribeAcceleratorTypesRequest":{ + "type":"structure", + "members":{ + } + }, + "DescribeAcceleratorTypesResponse":{ + "type":"structure", + "members":{ + "acceleratorTypes":{ + "shape":"AcceleratorTypeList", + "documentation":"The available accelerator types.
" + } + } + }, + "DescribeAcceleratorsRequest":{ + "type":"structure", + "members":{ + "acceleratorIds":{ + "shape":"AcceleratorIdList", + "documentation":"The IDs of the accelerators to describe.
" + }, + "filters":{ + "shape":"FilterList", + "documentation":"One or more filters. Filter names and values are case-sensitive. Valid filter names are: accelerator-types: can provide a list of accelerator type names to filter for. instance-id: can provide a list of EC2 instance ids to filter for.
" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + } + } + }, + "DescribeAcceleratorsResponse":{ + "type":"structure", + "members":{ + "acceleratorSet":{ + "shape":"ElasticInferenceAcceleratorSet", + "documentation":"The details of the Elastic Inference Accelerators.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + } + } + }, + "ElasticInferenceAccelerator":{ + "type":"structure", + "members":{ + "acceleratorHealth":{ + "shape":"ElasticInferenceAcceleratorHealth", + "documentation":"The health of the Elastic Inference Accelerator.
" + }, + "acceleratorType":{ + "shape":"AcceleratorTypeName", + "documentation":"The type of the Elastic Inference Accelerator.
" + }, + "acceleratorId":{ + "shape":"AcceleratorId", + "documentation":"The ID of the Elastic Inference Accelerator.
" + }, + "availabilityZone":{ + "shape":"AvailabilityZone", + "documentation":"The availability zone where the Elastic Inference Accelerator is present.
" + }, + "attachedResource":{ + "shape":"ResourceArn", + "documentation":"The ARN of the resource that the Elastic Inference Accelerator is attached to.
" + } + }, + "documentation":"The details of an Elastic Inference Accelerator.
" + }, + "ElasticInferenceAcceleratorHealth":{ + "type":"structure", + "members":{ + "status":{ + "shape":"AcceleratorHealthStatus", + "documentation":"The health status of the Elastic Inference Accelerator.
" + } + }, + "documentation":"The health details of an Elastic Inference Accelerator.
" + }, + "ElasticInferenceAcceleratorSet":{ + "type":"list", + "member":{"shape":"ElasticInferenceAccelerator"} + }, + "Filter":{ + "type":"structure", + "members":{ + "name":{ + "shape":"FilterName", + "documentation":"The filter name for the Elastic Inference Accelerator list. It can assume the following values: accelerator-type: the type of Elastic Inference Accelerator to filter for. instance-id: an EC2 instance id to filter for.
" + }, + "values":{ + "shape":"ValueStringList", + "documentation":"The values for the filter of the Elastic Inference Accelerator list.
" + } + }, + "documentation":"A filter expression for the Elastic Inference Accelerator list.
" + }, + "FilterList":{ + "type":"list", + "member":{"shape":"Filter"}, + "max":100, + "min":0 + }, + "FilterName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^\\S+$" + }, + "Integer":{"type":"integer"}, "InternalServerException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, - "documentation":"Raised when an unexpected error occurred during request processing.", + "documentation":"Raised when an unexpected error occurred during request processing.
", "error":{"httpStatusCode":500}, "exception":true }, + "Key":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^\\S+$" + }, + "KeyValuePair":{ + "type":"structure", + "members":{ + "key":{ + "shape":"Key", + "documentation":"The throughput value of the Elastic Inference Accelerator type. It can assume the following values: TFLOPS16bit: the throughput expressed in 16bit TeraFLOPS. TFLOPS32bit: the throughput expressed in 32bit TeraFLOPS.
" + }, + "value":{ + "shape":"Value", + "documentation":"The throughput value of the Elastic Inference Accelerator type.
" + } + }, + "documentation":"A throughput entry for an Elastic Inference Accelerator type.
" + }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"ResourceARN", - "documentation":"The ARN of the Elastic Inference Accelerator to list the tags for.", + "documentation":"The ARN of the Elastic Inference Accelerator to list the tags for.
", "location":"uri", "locationName":"resourceArn" } @@ -95,13 +378,55 @@ "members":{ "tags":{ "shape":"TagMap", - "documentation":"The tags of the Elastic Inference Accelerator." + "documentation":"The tags of the Elastic Inference Accelerator.
" } } }, + "Location":{ + "type":"string", + "max":256, + "min":1 + }, + "LocationType":{ + "type":"string", + "enum":[ + "region", + "availability-zone", + "availability-zone-id" + ], + "max":256, + "min":1 + }, + "MaxResults":{ + "type":"integer", + "max":100, + "min":0 + }, + "MemoryInfo":{ + "type":"structure", + "members":{ + "sizeInMiB":{ + "shape":"Integer", + "documentation":"The size in mebibytes of the Elastic Inference Accelerator type.
" + } + }, + "documentation":"The memory information of an Elastic Inference Accelerator type.
" + }, + "NextToken":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^[A-Za-z0-9+/]+={0,2}$" + }, "ResourceARN":{ "type":"string", "max":1011, + "min":1, + "pattern":"^arn:aws\\S*:elastic-inference:\\S+:\\d{12}:elastic-inference-accelerator/eia-[0-9a-f]+$" + }, + "ResourceArn":{ + "type":"string", + "max":1283, "min":1 }, "ResourceNotFoundException":{ @@ -109,15 +434,20 @@ "members":{ "message":{"shape":"String"} }, - "documentation":"Raised when the requested resource cannot be found.", + "documentation":"Raised when the requested resource cannot be found.
", "error":{"httpStatusCode":404}, "exception":true }, - "String":{"type":"string"}, + "String":{ + "type":"string", + "max":500000, + "pattern":"^.*$" + }, "TagKey":{ "type":"string", "max":128, - "min":1 + "min":1, + "pattern":"^\\S$" }, "TagKeyList":{ "type":"list", @@ -141,13 +471,13 @@ "members":{ "resourceArn":{ "shape":"ResourceARN", - "documentation":"The ARN of the Elastic Inference Accelerator to tag.", + "documentation":"The ARN of the Elastic Inference Accelerator to tag.
", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"TagMap", - "documentation":"The tags to add to the Elastic Inference Accelerator." + "documentation":"The tags to add to the Elastic Inference Accelerator.
" } } }, @@ -160,6 +490,12 @@ "type":"string", "max":256 }, + "ThroughputInfoList":{ + "type":"list", + "member":{"shape":"KeyValuePair"}, + "max":100, + "min":0 + }, "UntagResourceRequest":{ "type":"structure", "required":[ @@ -169,13 +505,13 @@ "members":{ "resourceArn":{ "shape":"ResourceARN", - "documentation":"The ARN of the Elastic Inference Accelerator to untag.", + "documentation":"The ARN of the Elastic Inference Accelerator to untag.
", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeyList", - "documentation":"The list of tags to remove from the Elastic Inference Accelerator.", + "documentation":"The list of tags to remove from the Elastic Inference Accelerator.
", "location":"querystring", "locationName":"tagKeys" } @@ -185,7 +521,14 @@ "type":"structure", "members":{ } + }, + "Value":{"type":"integer"}, + "ValueStringList":{ + "type":"list", + "member":{"shape":"String"}, + "max":100, + "min":0 } }, - "documentation":"Elastic Inference public APIs." + "documentation":"Elastic Inference public APIs.
" } diff --git a/botocore/data/elasticache/2015-02-02/examples-1.json b/botocore/data/elasticache/2015-02-02/examples-1.json new file mode 100644 index 00000000..f1d21bd7 --- /dev/null +++ b/botocore/data/elasticache/2015-02-02/examples-1.json @@ -0,0 +1,3149 @@ +{ + "version": "1.0", + "examples": { + "AddTagsToResource": [ + { + "input": { + "ResourceName": "arn:aws:elasticache:us-east-1:1234567890:cluster:my-mem-cluster", + "Tags": [ + { + "Key": "APIVersion", + "Value": "20150202" + }, + { + "Key": "Service", + "Value": "ElastiCache" + } + ] + }, + "output": { + "TagList": [ + { + "Key": "APIVersion", + "Value": "20150202" + }, + { + "Key": "Service", + "Value": "ElastiCache" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Adds up to 10 tags, key/value pairs, to a cluster or snapshot resource.", + "id": "addtagstoresource-1482430264385", + "title": "AddTagsToResource" + } + ], + "AuthorizeCacheSecurityGroupIngress": [ + { + "input": { + "CacheSecurityGroupName": "my-sec-grp", + "EC2SecurityGroupName": "my-ec2-sec-grp", + "EC2SecurityGroupOwnerId": "1234567890" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2. Amazon EC2 security groups are used as the authorization mechanism.", + "id": "authorizecachecachesecuritygroupingress-1483046446206", + "title": "AuthorizeCacheCacheSecurityGroupIngress" + } + ], + "CopySnapshot": [ + { + "input": { + "SourceSnapshotName": "my-snapshot", + "TargetBucket": "", + "TargetSnapshotName": "my-snapshot-copy" + }, + "output": { + "Snapshot": { + "AutoMinorVersionUpgrade": true, + "CacheClusterCreateTime": "2016-12-21T22:24:04.955Z", + "CacheClusterId": "my-redis4", + "CacheNodeType": "cache.m3.large", + "CacheParameterGroupName": "default.redis3.2", + "CacheSubnetGroupName": "default", + "Engine": "redis", + "EngineVersion": "3.2.4", + "NodeSnapshots": [ + { + "CacheNodeCreateTime": "2016-12-21T22:24:04.955Z", + "CacheNodeId": "0001", + "CacheSize": "3 MB", + "SnapshotCreateTime": "2016-12-28T07:00:52Z" + } + ], + "NumCacheNodes": 1, + "Port": 6379, + "PreferredAvailabilityZone": "us-east-1c", + "PreferredMaintenanceWindow": "tue:09:30-tue:10:30", + "SnapshotName": "my-snapshot-copy", + "SnapshotRetentionLimit": 7, + "SnapshotSource": "manual", + "SnapshotStatus": "creating", + "SnapshotWindow": "07:00-08:00", + "VpcId": "vpc-3820329f3" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Copies a snapshot to a specified name.", + "id": "copysnapshot-1482961393820", + "title": "CopySnapshot" + } + ], + "CreateCacheCluster": [ + { + "input": { + "AZMode": "cross-az", + "CacheClusterId": "my-memcached-cluster", + "CacheNodeType": "cache.r3.large", + "CacheSubnetGroupName": "default", + "Engine": "memcached", + "EngineVersion": "1.4.24", + "NumCacheNodes": 2, + "Port": 11211 + }, + "output": { + "CacheCluster": { + "AutoMinorVersionUpgrade": true, + "CacheClusterId": "my-memcached-cluster", + "CacheClusterStatus": "creating", + "CacheNodeType": "cache.r3.large", + "CacheParameterGroup": { + "CacheNodeIdsToReboot": [ + + ], + "CacheParameterGroupName": "default.memcached1.4", + "ParameterApplyStatus": "in-sync" + }, + "CacheSecurityGroups": [ + + ], + "CacheSubnetGroupName": "default", + "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", + "Engine": "memcached", + "EngineVersion": "1.4.24", + "NumCacheNodes": 2, + "PendingModifiedValues": { + }, + "PreferredAvailabilityZone": "Multiple", + "PreferredMaintenanceWindow": "wed:09:00-wed:10:00" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates a Memcached cluster with 2 nodes. ", + "id": "createcachecluster-1474994727381", + "title": "CreateCacheCluster" + }, + { + "input": { + "AutoMinorVersionUpgrade": true, + "CacheClusterId": "my-redis", + "CacheNodeType": "cache.r3.larage", + "CacheSubnetGroupName": "default", + "Engine": "redis", + "EngineVersion": "3.2.4", + "NumCacheNodes": 1, + "Port": 6379, + "PreferredAvailabilityZone": "us-east-1c", + "SnapshotRetentionLimit": 7 + }, + "output": { + "CacheCluster": { + "AutoMinorVersionUpgrade": true, + "CacheClusterId": "my-redis", + "CacheClusterStatus": "creating", + "CacheNodeType": "cache.m3.large", + "CacheParameterGroup": { + "CacheNodeIdsToReboot": [ + + ], + "CacheParameterGroupName": "default.redis3.2", + "ParameterApplyStatus": "in-sync" + }, + "CacheSecurityGroups": [ + + ], + "CacheSubnetGroupName": "default", + "ClientDownloadLandingPage": "https: //console.aws.amazon.com/elasticache/home#client-download: ", + "Engine": "redis", + "EngineVersion": "3.2.4", + "NumCacheNodes": 1, + "PendingModifiedValues": { + }, + "PreferredAvailabilityZone": "us-east-1c", + "PreferredMaintenanceWindow": "fri: 05: 30-fri: 06: 30", + "SnapshotRetentionLimit": 7, + "SnapshotWindow": "10: 00-11: 00" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates a Redis cluster with 1 node. ", + "id": "createcachecluster-1474994727381", + "title": "CreateCacheCluster" + } + ], + "CreateCacheParameterGroup": [ + { + "input": { + "CacheParameterGroupFamily": "redis2.8", + "CacheParameterGroupName": "custom-redis2-8", + "Description": "Custom Redis 2.8 parameter group." + }, + "output": { + "CacheParameterGroup": { + "CacheParameterGroupFamily": "redis2.8", + "CacheParameterGroupName": "custom-redis2-8", + "Description": "Custom Redis 2.8 parameter group." + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates the Amazon ElastiCache parameter group custom-redis2-8.", + "id": "createcacheparametergroup-1474997699362", + "title": "CreateCacheParameterGroup" + } + ], + "CreateCacheSecurityGroup": [ + { + "input": { + "CacheSecurityGroupName": "my-cache-sec-grp", + "Description": "Example ElastiCache security group." + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates an ElastiCache security group. ElastiCache security groups are only for clusters not running in an AWS VPC.", + "id": "createcachesecuritygroup-1483041506604", + "title": "CreateCacheSecurityGroup" + } + ], + "CreateCacheSubnetGroup": [ + { + "input": { + "CacheSubnetGroupDescription": "Sample subnet group", + "CacheSubnetGroupName": "my-sn-grp2", + "SubnetIds": [ + "subnet-6f28c982", + "subnet-bcd382f3", + "subnet-845b3e7c0" + ] + }, + "output": { + "CacheSubnetGroup": { + "CacheSubnetGroupDescription": "My subnet group.", + "CacheSubnetGroupName": "my-sn-grp", + "Subnets": [ + { + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + }, + "SubnetIdentifier": "subnet-6f28c982" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-east-1c" + }, + "SubnetIdentifier": "subnet-bcd382f3" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-east-1b" + }, + "SubnetIdentifier": "subnet-845b3e7c0" + } + ], + "VpcId": "vpc-91280df6" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates a new cache subnet group.", + "id": "createcachesubnet-1483042274558", + "title": "CreateCacheSubnet" + } + ], + "CreateReplicationGroup": [ + { + "input": { + "AutomaticFailoverEnabled": true, + "CacheNodeType": "cache.m3.medium", + "Engine": "redis", + "EngineVersion": "2.8.24", + "NumCacheClusters": 3, + "ReplicationGroupDescription": "A Redis replication group.", + "ReplicationGroupId": "my-redis-rg", + "SnapshotRetentionLimit": 30 + }, + "output": { + "ReplicationGroup": { + "AutomaticFailover": "enabling", + "Description": "A Redis replication group.", + "MemberClusters": [ + "my-redis-rg-001", + "my-redis-rg-002", + "my-redis-rg-003" + ], + "PendingModifiedValues": { + }, + "ReplicationGroupId": "my-redis-rg", + "SnapshottingClusterId": "my-redis-rg-002", + "Status": "creating" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates a Redis replication group with 3 nodes.", + "id": "createcachereplicationgroup-1474998730655", + "title": "CreateCacheReplicationGroup" + }, + { + "input": { + "AutoMinorVersionUpgrade": true, + "CacheNodeType": "cache.m3.medium", + "CacheParameterGroupName": "default.redis3.2.cluster.on", + "Engine": "redis", + "EngineVersion": "3.2.4", + "NodeGroupConfiguration": [ + { + "PrimaryAvailabilityZone": "us-east-1c", + "ReplicaAvailabilityZones": [ + "us-east-1b" + ], + "ReplicaCount": 1, + "Slots": "0-8999" + }, + { + "PrimaryAvailabilityZone": "us-east-1a", + "ReplicaAvailabilityZones": [ + "us-east-1a", + "us-east-1c" + ], + "ReplicaCount": 2, + "Slots": "9000-16383" + } + ], + "NumNodeGroups": 2, + "ReplicationGroupDescription": "A multi-sharded replication group", + "ReplicationGroupId": "clustered-redis-rg", + "SnapshotRetentionLimit": 8 + }, + "output": { + "ReplicationGroup": { + "AutomaticFailover": "enabled", + "Description": "Sharded replication group", + "MemberClusters": [ + "rc-rg3-0001-001", + "rc-rg3-0001-002", + "rc-rg3-0002-001", + "rc-rg3-0002-002", + "rc-rg3-0002-003" + ], + "PendingModifiedValues": { + }, + "ReplicationGroupId": "clustered-redis-rg", + "SnapshotRetentionLimit": 8, + "SnapshotWindow": "05:30-06:30", + "Status": "creating" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates a Redis (cluster mode enabled) replication group with two shards. One shard has one read replica node and the other shard has two read replicas.", + "id": "createreplicationgroup-1483657035585", + "title": "CreateReplicationGroup" + } + ], + "CreateSnapshot": [ + { + "input": { + "CacheClusterId": "onenoderedis", + "SnapshotName": "snapshot-1" + }, + "output": { + "Snapshot": { + "AutoMinorVersionUpgrade": true, + "CacheClusterCreateTime": "2017-02-03T15:43:36.278Z", + "CacheClusterId": "onenoderedis", + "CacheNodeType": "cache.m3.medium", + "CacheParameterGroupName": "default.redis3.2", + "CacheSubnetGroupName": "default", + "Engine": "redis", + "EngineVersion": "3.2.4", + "NodeSnapshots": [ + { + "CacheNodeCreateTime": "2017-02-03T15:43:36.278Z", + "CacheNodeId": "0001", + "CacheSize": "" + } + ], + "NumCacheNodes": 1, + "Port": 6379, + "PreferredAvailabilityZone": "us-west-2c", + "PreferredMaintenanceWindow": "sat:08:00-sat:09:00", + "SnapshotName": "snapshot-1", + "SnapshotRetentionLimit": 1, + "SnapshotSource": "manual", + "SnapshotStatus": "creating", + "SnapshotWindow": "00:00-01:00", + "VpcId": "vpc-73c3cd17" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates a snapshot of a non-clustered Redis cluster that has only one node.", + "id": "createsnapshot-1474999681024", + "title": "CreateSnapshot - NonClustered Redis, no read-replicas" + }, + { + "input": { + "CacheClusterId": "threenoderedis-001", + "SnapshotName": "snapshot-2" + }, + "output": { + "Snapshot": { + "AutoMinorVersionUpgrade": true, + "CacheClusterCreateTime": "2017-02-03T15:43:36.278Z", + "CacheClusterId": "threenoderedis-001", + "CacheNodeType": "cache.m3.medium", + "CacheParameterGroupName": "default.redis3.2", + "CacheSubnetGroupName": "default", + "Engine": "redis", + "EngineVersion": "3.2.4", + "NodeSnapshots": [ + { + "CacheNodeCreateTime": "2017-02-03T15:43:36.278Z", + "CacheNodeId": "0001", + "CacheSize": "" + } + ], + "NumCacheNodes": 1, + "Port": 6379, + "PreferredAvailabilityZone": "us-west-2c", + "PreferredMaintenanceWindow": "sat:08:00-sat:09:00", + "SnapshotName": "snapshot-2", + "SnapshotRetentionLimit": 1, + "SnapshotSource": "manual", + "SnapshotStatus": "creating", + "SnapshotWindow": "00:00-01:00", + "VpcId": "vpc-73c3cd17" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates a snapshot of a non-clustered Redis cluster that has only three nodes, primary and two read-replicas. CacheClusterId must be a specific node in the cluster.", + "id": "createsnapshot-1474999681024", + "title": "CreateSnapshot - NonClustered Redis, 2 read-replicas" + }, + { + "input": { + "ReplicationGroupId": "clusteredredis", + "SnapshotName": "snapshot-2x5" + }, + "output": { + "Snapshot": { + "AutoMinorVersionUpgrade": true, + "AutomaticFailover": "enabled", + "CacheNodeType": "cache.m3.medium", + "CacheParameterGroupName": "default.redis3.2.cluster.on", + "CacheSubnetGroupName": "default", + "Engine": "redis", + "EngineVersion": "3.2.4", + "NodeSnapshots": [ + { + "CacheSize": "", + "NodeGroupId": "0001" + }, + { + "CacheSize": "", + "NodeGroupId": "0002" + } + ], + "NumNodeGroups": 2, + "Port": 6379, + "PreferredMaintenanceWindow": "mon:09:30-mon:10:30", + "ReplicationGroupDescription": "Redis cluster with 2 shards.", + "ReplicationGroupId": "clusteredredis", + "SnapshotName": "snapshot-2x5", + "SnapshotRetentionLimit": 1, + "SnapshotSource": "manual", + "SnapshotStatus": "creating", + "SnapshotWindow": "12:00-13:00", + "VpcId": "vpc-73c3cd17" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates a snapshot of a clustered Redis cluster that has 2 shards, each with a primary and 4 read-replicas.", + "id": "createsnapshot-clustered-redis-1486144841758", + "title": "CreateSnapshot-clustered Redis" + } + ], + "DeleteCacheCluster": [ + { + "input": { + "CacheClusterId": "my-memcached" + }, + "output": { + "CacheCluster": { + "AutoMinorVersionUpgrade": true, + "CacheClusterCreateTime": "2016-12-22T16:05:17.314Z", + "CacheClusterId": "my-memcached", + "CacheClusterStatus": "deleting", + "CacheNodeType": "cache.r3.large", + "CacheParameterGroup": { + "CacheNodeIdsToReboot": [ + + ], + "CacheParameterGroupName": "default.memcached1.4", + "ParameterApplyStatus": "in-sync" + }, + "CacheSecurityGroups": [ + + ], + "CacheSubnetGroupName": "default", + "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", + "ConfigurationEndpoint": { + "Address": "my-memcached2.ameaqx.cfg.use1.cache.amazonaws.com", + "Port": 11211 + }, + "Engine": "memcached", + "EngineVersion": "1.4.24", + "NumCacheNodes": 2, + "PendingModifiedValues": { + }, + "PreferredAvailabilityZone": "Multiple", + "PreferredMaintenanceWindow": "tue:07:30-tue:08:30" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes an Amazon ElastiCache cluster.", + "id": "deletecachecluster-1475010605291", + "title": "DeleteCacheCluster" + } + ], + "DeleteCacheParameterGroup": [ + { + "input": { + "CacheParameterGroupName": "custom-mem1-4" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes the Amazon ElastiCache parameter group custom-mem1-4.", + "id": "deletecacheparametergroup-1475010933957", + "title": "DeleteCacheParameterGroup" + } + ], + "DeleteCacheSecurityGroup": [ + { + "input": { + "CacheSecurityGroupName": "my-sec-group" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes a cache security group.", + "id": "deletecachesecuritygroup-1483046967507", + "title": "DeleteCacheSecurityGroup" + } + ], + "DeleteCacheSubnetGroup": [ + { + "input": { + "CacheSubnetGroupName": "my-subnet-group" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes the Amazon ElastiCache subnet group my-subnet-group.", + "id": "deletecachesubnetgroup-1475011431325", + "title": "DeleteCacheSubnetGroup" + } + ], + "DeleteReplicationGroup": [ + { + "input": { + "ReplicationGroupId": "my-redis-rg", + "RetainPrimaryCluster": false + }, + "output": { + "ReplicationGroup": { + "AutomaticFailover": "disabled", + "Description": "simple redis cluster", + "PendingModifiedValues": { + }, + "ReplicationGroupId": "my-redis-rg", + "Status": "deleting" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes the Amazon ElastiCache replication group my-redis-rg.", + "id": "deletereplicationgroup-1475011641804", + "title": "DeleteReplicationGroup" + } + ], + "DeleteSnapshot": [ + { + "input": { + "SnapshotName": "snapshot-20161212" + }, + "output": { + "Snapshot": { + "AutoMinorVersionUpgrade": true, + "CacheClusterCreateTime": "2016-12-21T22:27:12.543Z", + "CacheClusterId": "my-redis5", + "CacheNodeType": "cache.m3.large", + "CacheParameterGroupName": "default.redis3.2", + "CacheSubnetGroupName": "default", + "Engine": "redis", + "EngineVersion": "3.2.4", + "NodeSnapshots": [ + { + "CacheNodeCreateTime": "2016-12-21T22:27:12.543Z", + "CacheNodeId": "0001", + "CacheSize": "3 MB", + "SnapshotCreateTime": "2016-12-21T22:30:26Z" + } + ], + "NumCacheNodes": 1, + "Port": 6379, + "PreferredAvailabilityZone": "us-east-1c", + "PreferredMaintenanceWindow": "fri:05:30-fri:06:30", + "SnapshotName": "snapshot-20161212", + "SnapshotRetentionLimit": 7, + "SnapshotSource": "manual", + "SnapshotStatus": "deleting", + "SnapshotWindow": "10:00-11:00", + "VpcId": "vpc-91280df6" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes the Redis snapshot snapshot-20160822.", + "id": "deletesnapshot-1475011945779", + "title": "DeleteSnapshot" + } + ], + "DescribeCacheClusters": [ + { + "input": { + "CacheClusterId": "my-mem-cluster" + }, + "output": { + "CacheClusters": [ + { + "AutoMinorVersionUpgrade": true, + "CacheClusterCreateTime": "2016-12-21T21:59:43.794Z", + "CacheClusterId": "my-mem-cluster", + "CacheClusterStatus": "available", + "CacheNodeType": "cache.t2.medium", + "CacheParameterGroup": { + "CacheNodeIdsToReboot": [ + + ], + "CacheParameterGroupName": "default.memcached1.4", + "ParameterApplyStatus": "in-sync" + }, + "CacheSecurityGroups": [ + + ], + "CacheSubnetGroupName": "default", + "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", + "ConfigurationEndpoint": { + "Address": "my-mem-cluster.abcdef.cfg.use1.cache.amazonaws.com", + "Port": 11211 + }, + "Engine": "memcached", + "EngineVersion": "1.4.24", + "NumCacheNodes": 2, + "PendingModifiedValues": { + }, + "PreferredAvailabilityZone": "Multiple", + "PreferredMaintenanceWindow": "wed:06:00-wed:07:00" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists the details for up to 50 cache clusters.", + "id": "describecacheclusters-1475012269754", + "title": "DescribeCacheClusters" + }, + { + "input": { + "CacheClusterId": "my-mem-cluster", + "ShowCacheNodeInfo": true + }, + "output": { + "CacheClusters": [ + { + "AutoMinorVersionUpgrade": true, + "CacheClusterCreateTime": "2016-12-21T21:59:43.794Z", + "CacheClusterId": "my-mem-cluster", + "CacheClusterStatus": "available", + "CacheNodeType": "cache.t2.medium", + "CacheNodes": [ + { + "CacheNodeCreateTime": "2016-12-21T21:59:43.794Z", + "CacheNodeId": "0001", + "CacheNodeStatus": "available", + "CustomerAvailabilityZone": "us-east-1b", + "Endpoint": { + "Address": "my-mem-cluster.ameaqx.0001.use1.cache.amazonaws.com", + "Port": 11211 + }, + "ParameterGroupStatus": "in-sync" + }, + { + "CacheNodeCreateTime": "2016-12-21T21:59:43.794Z", + "CacheNodeId": "0002", + "CacheNodeStatus": "available", + "CustomerAvailabilityZone": "us-east-1a", + "Endpoint": { + "Address": "my-mem-cluster.ameaqx.0002.use1.cache.amazonaws.com", + "Port": 11211 + }, + "ParameterGroupStatus": "in-sync" + } + ], + "CacheParameterGroup": { + "CacheNodeIdsToReboot": [ + + ], + "CacheParameterGroupName": "default.memcached1.4", + "ParameterApplyStatus": "in-sync" + }, + "CacheSecurityGroups": [ + + ], + "CacheSubnetGroupName": "default", + "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", + "ConfigurationEndpoint": { + "Address": "my-mem-cluster.ameaqx.cfg.use1.cache.amazonaws.com", + "Port": 11211 + }, + "Engine": "memcached", + "EngineVersion": "1.4.24", + "NumCacheNodes": 2, + "PendingModifiedValues": { + }, + "PreferredAvailabilityZone": "Multiple", + "PreferredMaintenanceWindow": "wed:06:00-wed:07:00" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists the details for the cache cluster my-mem-cluster.", + "id": "describecacheclusters-1475012269754", + "title": "DescribeCacheClusters" + } + ], + "DescribeCacheEngineVersions": [ + { + "input": { + }, + "output": { + "CacheEngineVersions": [ + { + "CacheEngineDescription": "memcached", + "CacheEngineVersionDescription": "memcached version 1.4.14", + "CacheParameterGroupFamily": "memcached1.4", + "Engine": "memcached", + "EngineVersion": "1.4.14" + }, + { + "CacheEngineDescription": "memcached", + "CacheEngineVersionDescription": "memcached version 1.4.24", + "CacheParameterGroupFamily": "memcached1.4", + "Engine": "memcached", + "EngineVersion": "1.4.24" + }, + { + "CacheEngineDescription": "memcached", + "CacheEngineVersionDescription": "memcached version 1.4.33", + "CacheParameterGroupFamily": "memcached1.4", + "Engine": "memcached", + "EngineVersion": "1.4.33" + }, + { + "CacheEngineDescription": "memcached", + "CacheEngineVersionDescription": "memcached version 1.4.5", + "CacheParameterGroupFamily": "memcached1.4", + "Engine": "memcached", + "EngineVersion": "1.4.5" + }, + { + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.6.13", + "CacheParameterGroupFamily": "redis2.6", + "Engine": "redis", + "EngineVersion": "2.6.13" + }, + { + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.19", + "CacheParameterGroupFamily": "redis2.8", + "Engine": "redis", + "EngineVersion": "2.8.19" + }, + { + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.21", + "CacheParameterGroupFamily": "redis2.8", + "Engine": "redis", + "EngineVersion": "2.8.21" + }, + { + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.22 R5", + "CacheParameterGroupFamily": "redis2.8", + "Engine": "redis", + "EngineVersion": "2.8.22" + }, + { + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.23 R4", + "CacheParameterGroupFamily": "redis2.8", + "Engine": "redis", + "EngineVersion": "2.8.23" + }, + { + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.24 R3", + "CacheParameterGroupFamily": "redis2.8", + "Engine": "redis", + "EngineVersion": "2.8.24" + }, + { + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.6", + "CacheParameterGroupFamily": "redis2.8", + "Engine": "redis", + "EngineVersion": "2.8.6" + }, + { + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 3.2.4", + "CacheParameterGroupFamily": "redis3.2", + "Engine": "redis", + "EngineVersion": "3.2.4" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists the details for up to 25 Memcached and Redis cache engine versions.", + "id": "describecacheengineversions-1475012638790", + "title": "DescribeCacheEngineVersions" + }, + { + "input": { + "DefaultOnly": false, + "Engine": "redis", + "MaxRecords": 50 + }, + "output": { + "CacheEngineVersions": [ + { + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.6.13", + "CacheParameterGroupFamily": "redis2.6", + "Engine": "redis", + "EngineVersion": "2.6.13" + }, + { + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.19", + "CacheParameterGroupFamily": "redis2.8", + "Engine": "redis", + "EngineVersion": "2.8.19" + }, + { + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.21", + "CacheParameterGroupFamily": "redis2.8", + "Engine": "redis", + "EngineVersion": "2.8.21" + }, + { + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.22 R5", + "CacheParameterGroupFamily": "redis2.8", + "Engine": "redis", + "EngineVersion": "2.8.22" + }, + { + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.23 R4", + "CacheParameterGroupFamily": "redis2.8", + "Engine": "redis", + "EngineVersion": "2.8.23" + }, + { + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.24 R3", + "CacheParameterGroupFamily": "redis2.8", + "Engine": "redis", + "EngineVersion": "2.8.24" + }, + { + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 2.8.6", + "CacheParameterGroupFamily": "redis2.8", + "Engine": "redis", + "EngineVersion": "2.8.6" + }, + { + "CacheEngineDescription": "Redis", + "CacheEngineVersionDescription": "redis version 3.2.4", + "CacheParameterGroupFamily": "redis3.2", + "Engine": "redis", + "EngineVersion": "3.2.4" + } + ], + "Marker": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists the details for up to 50 Redis cache engine versions.", + "id": "describecacheengineversions-1475012638790", + "title": "DescribeCacheEngineVersions" + } + ], + "DescribeCacheParameterGroups": [ + { + "input": { + "CacheParameterGroupName": "custom-mem1-4" + }, + "output": { + "CacheParameterGroups": [ + { + "CacheParameterGroupFamily": "memcached1.4", + "CacheParameterGroupName": "custom-mem1-4", + "Description": "Custom memcache param group" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.", + "id": "describecacheparametergroups-1483045457557", + "title": "DescribeCacheParameterGroups" + } + ], + "DescribeCacheParameters": [ + { + "input": { + "CacheParameterGroupName": "custom-redis2-8", + "MaxRecords": 100, + "Source": "user" + }, + "output": { + "Marker": "", + "Parameters": [ + { + "AllowedValues": "yes,no", + "ChangeType": "requires-reboot", + "DataType": "string", + "Description": "Apply rehashing or not.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "activerehashing", + "ParameterValue": "yes", + "Source": "system" + }, + { + "AllowedValues": "always,everysec,no", + "ChangeType": "immediate", + "DataType": "string", + "Description": "fsync policy for AOF persistence", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "appendfsync", + "ParameterValue": "everysec", + "Source": "system" + }, + { + "AllowedValues": "yes,no", + "ChangeType": "immediate", + "DataType": "string", + "Description": "Enable Redis persistence.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "appendonly", + "ParameterValue": "no", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Normal client output buffer hard limit in bytes.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "client-output-buffer-limit-normal-hard-limit", + "ParameterValue": "0", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Normal client output buffer soft limit in bytes.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "client-output-buffer-limit-normal-soft-limit", + "ParameterValue": "0", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Normal client output buffer soft limit in seconds.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "client-output-buffer-limit-normal-soft-seconds", + "ParameterValue": "0", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Pubsub client output buffer hard limit in bytes.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "client-output-buffer-limit-pubsub-hard-limit", + "ParameterValue": "33554432", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Pubsub client output buffer soft limit in bytes.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "client-output-buffer-limit-pubsub-soft-limit", + "ParameterValue": "8388608", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Pubsub client output buffer soft limit in seconds.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "client-output-buffer-limit-pubsub-soft-seconds", + "ParameterValue": "60", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Slave client output buffer soft limit in seconds.", + "IsModifiable": false, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "client-output-buffer-limit-slave-soft-seconds", + "ParameterValue": "60", + "Source": "system" + }, + { + "AllowedValues": "yes,no", + "ChangeType": "immediate", + "DataType": "string", + "Description": "If enabled, clients who attempt to write to a read-only slave will be disconnected. Applicable to 2.8.23 and higher.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.23", + "ParameterName": "close-on-slave-write", + "ParameterValue": "yes", + "Source": "system" + }, + { + "AllowedValues": "1-1200000", + "ChangeType": "requires-reboot", + "DataType": "integer", + "Description": "Set the number of databases.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "databases", + "ParameterValue": "16", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "The maximum number of hash entries in order for the dataset to be compressed.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "hash-max-ziplist-entries", + "ParameterValue": "512", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "The threshold of biggest hash entries in order for the dataset to be compressed.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "hash-max-ziplist-value", + "ParameterValue": "64", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "The maximum number of list entries in order for the dataset to be compressed.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "list-max-ziplist-entries", + "ParameterValue": "512", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "The threshold of biggest list entries in order for the dataset to be compressed.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "list-max-ziplist-value", + "ParameterValue": "64", + "Source": "system" + }, + { + "AllowedValues": "5000", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Max execution time of a Lua script in milliseconds. 0 for unlimited execution without warnings.", + "IsModifiable": false, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "lua-time-limit", + "ParameterValue": "5000", + "Source": "system" + }, + { + "AllowedValues": "1-65000", + "ChangeType": "requires-reboot", + "DataType": "integer", + "Description": "The maximum number of Redis clients.", + "IsModifiable": false, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "maxclients", + "ParameterValue": "65000", + "Source": "system" + }, + { + "AllowedValues": "volatile-lru,allkeys-lru,volatile-random,allkeys-random,volatile-ttl,noeviction", + "ChangeType": "immediate", + "DataType": "string", + "Description": "Max memory policy.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "maxmemory-policy", + "ParameterValue": "volatile-lru", + "Source": "system" + }, + { + "AllowedValues": "1-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Max memory samples.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "maxmemory-samples", + "ParameterValue": "3", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Maximum number of seconds within which the master must receive a ping from a slave to take writes. Use this parameter together with min-slaves-to-write to regulate when the master stops accepting writes. Setting this value to 0 means the master always takes writes.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "min-slaves-max-lag", + "ParameterValue": "10", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Number of slaves that must be connected in order for master to take writes. Use this parameter together with min-slaves-max-lag to regulate when the master stops accepting writes. Setting this to 0 means the master always takes writes.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "min-slaves-to-write", + "ParameterValue": "0", + "Source": "system" + }, + { + "ChangeType": "immediate", + "DataType": "string", + "Description": "The keyspace events for Redis to notify Pub/Sub clients about. By default all notifications are disabled", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "notify-keyspace-events", + "Source": "system" + }, + { + "AllowedValues": "16384-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "The replication backlog size in bytes for PSYNC. This is the size of the buffer which accumulates slave data when slave is disconnected for some time, so that when slave reconnects again, only transfer the portion of data which the slave missed. Minimum value is 16K.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "repl-backlog-size", + "ParameterValue": "1048576", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "The amount of time in seconds after the master no longer have any slaves connected for the master to free the replication backlog. A value of 0 means to never release the backlog.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "repl-backlog-ttl", + "ParameterValue": "3600", + "Source": "system" + }, + { + "AllowedValues": "11-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "The timeout in seconds for bulk transfer I/O during sync and master timeout from the perspective of the slave, and slave timeout from the perspective of the master.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "repl-timeout", + "ParameterValue": "60", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "The amount of memory reserved for non-cache memory usage, in bytes. You may want to increase this parameter for nodes with read replicas, AOF enabled, etc, to reduce swap usage.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "reserved-memory", + "ParameterValue": "0", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "The limit in the size of the set in order for the dataset to be compressed.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "set-max-intset-entries", + "ParameterValue": "512", + "Source": "system" + }, + { + "AllowedValues": "yes,no", + "ChangeType": "immediate", + "DataType": "string", + "Description": "Configures if chaining of slaves is allowed", + "IsModifiable": false, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "slave-allow-chaining", + "ParameterValue": "no", + "Source": "system" + }, + { + "AllowedValues": "-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "The execution time, in microseconds, to exceed in order for the command to get logged. Note that a negative number disables the slow log, while a value of zero forces the logging of every command.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "slowlog-log-slower-than", + "ParameterValue": "10000", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "The length of the slow log. There is no limit to this length. Just be aware that it will consume memory. You can reclaim memory used by the slow log with SLOWLOG RESET.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "slowlog-max-len", + "ParameterValue": "128", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "If non-zero, send ACKs every given number of seconds.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "tcp-keepalive", + "ParameterValue": "0", + "Source": "system" + }, + { + "AllowedValues": "0,20-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Close connection if client is idle for a given number of seconds, or never if 0.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "timeout", + "ParameterValue": "0", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "The maximum number of sorted set entries in order for the dataset to be compressed.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "zset-max-ziplist-entries", + "ParameterValue": "128", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "The threshold of biggest sorted set entries in order for the dataset to be compressed.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "zset-max-ziplist-value", + "ParameterValue": "64", + "Source": "system" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists up to 100 user parameter values for the parameter group custom.redis2.8.", + "id": "describecacheparameters-1475013576900", + "title": "DescribeCacheParameters" + } + ], + "DescribeCacheSecurityGroups": [ + { + "input": { + "CacheSecurityGroupName": "my-sec-group" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group.", + "id": "describecachesecuritygroups-1483047200801", + "title": "DescribeCacheSecurityGroups" + } + ], + "DescribeCacheSubnetGroups": [ + { + "input": { + "MaxRecords": 25 + }, + "output": { + "CacheSubnetGroups": [ + { + "CacheSubnetGroupDescription": "Default CacheSubnetGroup", + "CacheSubnetGroupName": "default", + "Subnets": [ + { + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + }, + "SubnetIdentifier": "subnet-1a2b3c4d" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-east-1c" + }, + "SubnetIdentifier": "subnet-a1b2c3d4" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-east-1e" + }, + "SubnetIdentifier": "subnet-abcd1234" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-east-1b" + }, + "SubnetIdentifier": "subnet-1234abcd" + } + ], + "VpcId": "vpc-91280df6" + } + ], + "Marker": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Describes up to 25 cache subnet groups.", + "id": "describecachesubnetgroups-1482439214064", + "title": "DescribeCacheSubnetGroups" + } + ], + "DescribeEngineDefaultParameters": [ + { + "input": { + "CacheParameterGroupFamily": "redis2.8", + "MaxRecords": 25 + }, + "output": { + "EngineDefaults": { + "CacheNodeTypeSpecificParameters": [ + { + "AllowedValues": "0-", + "CacheNodeTypeSpecificValues": [ + { + "CacheNodeType": "cache.c1.xlarge", + "Value": "650117120" + }, + { + "CacheNodeType": "cache.m1.large", + "Value": "702545920" + }, + { + "CacheNodeType": "cache.m1.medium", + "Value": "309329920" + }, + { + "CacheNodeType": "cache.m1.small", + "Value": "94371840" + }, + { + "CacheNodeType": "cache.m1.xlarge", + "Value": "1488977920" + }, + { + "CacheNodeType": "cache.m2.2xlarge", + "Value": "3502243840" + }, + { + "CacheNodeType": "cache.m2.4xlarge", + "Value": "7088373760" + }, + { + "CacheNodeType": "cache.m2.xlarge", + "Value": "1709178880" + }, + { + "CacheNodeType": "cache.m3.2xlarge", + "Value": "2998927360" + }, + { + "CacheNodeType": "cache.m3.large", + "Value": "650117120" + }, + { + "CacheNodeType": "cache.m3.medium", + "Value": "309329920" + }, + { + "CacheNodeType": "cache.m3.xlarge", + "Value": "1426063360" + }, + { + "CacheNodeType": "cache.m4.10xlarge", + "Value": "16604761424" + }, + { + "CacheNodeType": "cache.m4.2xlarge", + "Value": "3188912636" + }, + { + "CacheNodeType": "cache.m4.4xlarge", + "Value": "6525729063" + }, + { + "CacheNodeType": "cache.m4.large", + "Value": "689259315" + }, + { + "CacheNodeType": "cache.m4.xlarge", + "Value": "1532850176" + }, + { + "CacheNodeType": "cache.r3.2xlarge", + "Value": "6081740800" + }, + { + "CacheNodeType": "cache.r3.4xlarge", + "Value": "12268339200" + }, + { + "CacheNodeType": "cache.r3.8xlarge", + "Value": "24536678400" + }, + { + "CacheNodeType": "cache.r3.large", + "Value": "1468006400" + }, + { + "CacheNodeType": "cache.r3.xlarge", + "Value": "3040870400" + }, + { + "CacheNodeType": "cache.t1.micro", + "Value": "14260633" + }, + { + "CacheNodeType": "cache.t2.medium", + "Value": "346134937" + }, + { + "CacheNodeType": "cache.t2.micro", + "Value": "58195968" + }, + { + "CacheNodeType": "cache.t2.small", + "Value": "166513868" + } + ], + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Slave client output buffer hard limit in bytes.", + "IsModifiable": false, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "client-output-buffer-limit-slave-hard-limit", + "Source": "system" + }, + { + "AllowedValues": "0-", + "CacheNodeTypeSpecificValues": [ + { + "CacheNodeType": "cache.c1.xlarge", + "Value": "650117120" + }, + { + "CacheNodeType": "cache.m1.large", + "Value": "702545920" + }, + { + "CacheNodeType": "cache.m1.medium", + "Value": "309329920" + }, + { + "CacheNodeType": "cache.m1.small", + "Value": "94371840" + }, + { + "CacheNodeType": "cache.m1.xlarge", + "Value": "1488977920" + }, + { + "CacheNodeType": "cache.m2.2xlarge", + "Value": "3502243840" + }, + { + "CacheNodeType": "cache.m2.4xlarge", + "Value": "7088373760" + }, + { + "CacheNodeType": "cache.m2.xlarge", + "Value": "1709178880" + }, + { + "CacheNodeType": "cache.m3.2xlarge", + "Value": "2998927360" + }, + { + "CacheNodeType": "cache.m3.large", + "Value": "650117120" + }, + { + "CacheNodeType": "cache.m3.medium", + "Value": "309329920" + }, + { + "CacheNodeType": "cache.m3.xlarge", + "Value": "1426063360" + }, + { + "CacheNodeType": "cache.m4.10xlarge", + "Value": "16604761424" + }, + { + "CacheNodeType": "cache.m4.2xlarge", + "Value": "3188912636" + }, + { + "CacheNodeType": "cache.m4.4xlarge", + "Value": "6525729063" + }, + { + "CacheNodeType": "cache.m4.large", + "Value": "689259315" + }, + { + "CacheNodeType": "cache.m4.xlarge", + "Value": "1532850176" + }, + { + "CacheNodeType": "cache.r3.2xlarge", + "Value": "6081740800" + }, + { + "CacheNodeType": "cache.r3.4xlarge", + "Value": "12268339200" + }, + { + "CacheNodeType": "cache.r3.8xlarge", + "Value": "24536678400" + }, + { + "CacheNodeType": "cache.r3.large", + "Value": "1468006400" + }, + { + "CacheNodeType": "cache.r3.xlarge", + "Value": "3040870400" + }, + { + "CacheNodeType": "cache.t1.micro", + "Value": "14260633" + }, + { + "CacheNodeType": "cache.t2.medium", + "Value": "346134937" + }, + { + "CacheNodeType": "cache.t2.micro", + "Value": "58195968" + }, + { + "CacheNodeType": "cache.t2.small", + "Value": "166513868" + } + ], + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Slave client output buffer soft limit in bytes.", + "IsModifiable": false, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "client-output-buffer-limit-slave-soft-limit", + "Source": "system" + }, + { + "AllowedValues": "0-", + "CacheNodeTypeSpecificValues": [ + { + "CacheNodeType": "cache.c1.xlarge", + "Value": "6501171200" + }, + { + "CacheNodeType": "cache.m1.large", + "Value": "7025459200" + }, + { + "CacheNodeType": "cache.m1.medium", + "Value": "3093299200" + }, + { + "CacheNodeType": "cache.m1.small", + "Value": "943718400" + }, + { + "CacheNodeType": "cache.m1.xlarge", + "Value": "14889779200" + }, + { + "CacheNodeType": "cache.m2.2xlarge", + "Value": "35022438400" + }, + { + "CacheNodeType": "cache.m2.4xlarge", + "Value": "70883737600" + }, + { + "CacheNodeType": "cache.m2.xlarge", + "Value": "17091788800" + }, + { + "CacheNodeType": "cache.m3.2xlarge", + "Value": "29989273600" + }, + { + "CacheNodeType": "cache.m3.large", + "Value": "6501171200" + }, + { + "CacheNodeType": "cache.m3.medium", + "Value": "2988441600" + }, + { + "CacheNodeType": "cache.m3.xlarge", + "Value": "14260633600" + }, + { + "CacheNodeType": "cache.m4.10xlarge", + "Value": "166047614239" + }, + { + "CacheNodeType": "cache.m4.2xlarge", + "Value": "31889126359" + }, + { + "CacheNodeType": "cache.m4.4xlarge", + "Value": "65257290629" + }, + { + "CacheNodeType": "cache.m4.large", + "Value": "6892593152" + }, + { + "CacheNodeType": "cache.m4.xlarge", + "Value": "15328501760" + }, + { + "CacheNodeType": "cache.r3.2xlarge", + "Value": "62495129600" + }, + { + "CacheNodeType": "cache.r3.4xlarge", + "Value": "126458265600" + }, + { + "CacheNodeType": "cache.r3.8xlarge", + "Value": "254384537600" + }, + { + "CacheNodeType": "cache.r3.large", + "Value": "14470348800" + }, + { + "CacheNodeType": "cache.r3.xlarge", + "Value": "30513561600" + }, + { + "CacheNodeType": "cache.t1.micro", + "Value": "142606336" + }, + { + "CacheNodeType": "cache.t2.medium", + "Value": "3461349376" + }, + { + "CacheNodeType": "cache.t2.micro", + "Value": "581959680" + }, + { + "CacheNodeType": "cache.t2.small", + "Value": "1665138688" + } + ], + "ChangeType": "immediate", + "DataType": "integer", + "Description": "The maximum configurable amount of memory to use to store items, in bytes.", + "IsModifiable": false, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "maxmemory", + "Source": "system" + } + ], + "CacheParameterGroupFamily": "redis2.8", + "Marker": "bWluLXNsYXZlcy10by13cml0ZQ==", + "Parameters": [ + { + "AllowedValues": "yes,no", + "ChangeType": "requires-reboot", + "DataType": "string", + "Description": "Apply rehashing or not.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "activerehashing", + "ParameterValue": "yes", + "Source": "system" + }, + { + "AllowedValues": "always,everysec,no", + "ChangeType": "immediate", + "DataType": "string", + "Description": "fsync policy for AOF persistence", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "appendfsync", + "ParameterValue": "everysec", + "Source": "system" + }, + { + "AllowedValues": "yes,no", + "ChangeType": "immediate", + "DataType": "string", + "Description": "Enable Redis persistence.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "appendonly", + "ParameterValue": "no", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Normal client output buffer hard limit in bytes.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "client-output-buffer-limit-normal-hard-limit", + "ParameterValue": "0", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Normal client output buffer soft limit in bytes.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "client-output-buffer-limit-normal-soft-limit", + "ParameterValue": "0", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Normal client output buffer soft limit in seconds.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "client-output-buffer-limit-normal-soft-seconds", + "ParameterValue": "0", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Pubsub client output buffer hard limit in bytes.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "client-output-buffer-limit-pubsub-hard-limit", + "ParameterValue": "33554432", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Pubsub client output buffer soft limit in bytes.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "client-output-buffer-limit-pubsub-soft-limit", + "ParameterValue": "8388608", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Pubsub client output buffer soft limit in seconds.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "client-output-buffer-limit-pubsub-soft-seconds", + "ParameterValue": "60", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Slave client output buffer soft limit in seconds.", + "IsModifiable": false, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "client-output-buffer-limit-slave-soft-seconds", + "ParameterValue": "60", + "Source": "system" + }, + { + "AllowedValues": "yes,no", + "ChangeType": "immediate", + "DataType": "string", + "Description": "If enabled, clients who attempt to write to a read-only slave will be disconnected. Applicable to 2.8.23 and higher.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.23", + "ParameterName": "close-on-slave-write", + "ParameterValue": "yes", + "Source": "system" + }, + { + "AllowedValues": "1-1200000", + "ChangeType": "requires-reboot", + "DataType": "integer", + "Description": "Set the number of databases.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "databases", + "ParameterValue": "16", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "The maximum number of hash entries in order for the dataset to be compressed.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "hash-max-ziplist-entries", + "ParameterValue": "512", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "The threshold of biggest hash entries in order for the dataset to be compressed.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "hash-max-ziplist-value", + "ParameterValue": "64", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "The maximum number of list entries in order for the dataset to be compressed.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "list-max-ziplist-entries", + "ParameterValue": "512", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "The threshold of biggest list entries in order for the dataset to be compressed.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "list-max-ziplist-value", + "ParameterValue": "64", + "Source": "system" + }, + { + "AllowedValues": "5000", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Max execution time of a Lua script in milliseconds. 0 for unlimited execution without warnings.", + "IsModifiable": false, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "lua-time-limit", + "ParameterValue": "5000", + "Source": "system" + }, + { + "AllowedValues": "1-65000", + "ChangeType": "requires-reboot", + "DataType": "integer", + "Description": "The maximum number of Redis clients.", + "IsModifiable": false, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "maxclients", + "ParameterValue": "65000", + "Source": "system" + }, + { + "AllowedValues": "volatile-lru,allkeys-lru,volatile-random,allkeys-random,volatile-ttl,noeviction", + "ChangeType": "immediate", + "DataType": "string", + "Description": "Max memory policy.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "maxmemory-policy", + "ParameterValue": "volatile-lru", + "Source": "system" + }, + { + "AllowedValues": "1-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Max memory samples.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "maxmemory-samples", + "ParameterValue": "3", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Maximum number of seconds within which the master must receive a ping from a slave to take writes. Use this parameter together with min-slaves-to-write to regulate when the master stops accepting writes. Setting this value to 0 means the master always takes writes.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "min-slaves-max-lag", + "ParameterValue": "10", + "Source": "system" + }, + { + "AllowedValues": "0-", + "ChangeType": "immediate", + "DataType": "integer", + "Description": "Number of slaves that must be connected in order for master to take writes. Use this parameter together with min-slaves-max-lag to regulate when the master stops accepting writes. Setting this to 0 means the master always takes writes.", + "IsModifiable": true, + "MinimumEngineVersion": "2.8.6", + "ParameterName": "min-slaves-to-write", + "ParameterValue": "0", + "Source": "system" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns the default engine and system parameter information for the specified cache engine.", + "id": "describeenginedefaultparameters-1481738057686", + "title": "DescribeEngineDefaultParameters" + } + ], + "DescribeEvents": [ + { + "input": { + "Duration": 360, + "SourceType": "cache-cluster" + }, + "output": { + "Events": [ + { + "Date": "2016-12-22T16:27:56.088Z", + "Message": "Added cache node 0001 in availability zone us-east-1e", + "SourceIdentifier": "redis-cluster", + "SourceType": "cache-cluster" + }, + { + "Date": "2016-12-22T16:27:56.078Z", + "Message": "Cache cluster created", + "SourceIdentifier": "redis-cluster", + "SourceType": "cache-cluster" + }, + { + "Date": "2016-12-22T16:05:17.326Z", + "Message": "Added cache node 0002 in availability zone us-east-1c", + "SourceIdentifier": "my-memcached2", + "SourceType": "cache-cluster" + }, + { + "Date": "2016-12-22T16:05:17.323Z", + "Message": "Added cache node 0001 in availability zone us-east-1e", + "SourceIdentifier": "my-memcached2", + "SourceType": "cache-cluster" + }, + { + "Date": "2016-12-22T16:05:17.314Z", + "Message": "Cache cluster created", + "SourceIdentifier": "my-memcached2", + "SourceType": "cache-cluster" + } + ], + "Marker": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Describes all the cache-cluster events for the past 120 minutes.", + "id": "describeevents-1481843894757", + "title": "DescribeEvents" + }, + { + "input": { + "StartTime": "2016-12-22T15:00:00.000Z" + }, + "output": { + "Events": [ + { + "Date": "2016-12-22T21:35:46.674Z", + "Message": "Snapshot succeeded for snapshot with ID 'cr-bkup' of replication group with ID 'clustered-redis'", + "SourceIdentifier": "clustered-redis-0001-001", + "SourceType": "cache-cluster" + }, + { + "Date": "2016-12-22T16:27:56.088Z", + "Message": "Added cache node 0001 in availability zone us-east-1e", + "SourceIdentifier": "redis-cluster", + "SourceType": "cache-cluster" + }, + { + "Date": "2016-12-22T16:27:56.078Z", + "Message": "Cache cluster created", + "SourceIdentifier": "redis-cluster", + "SourceType": "cache-cluster" + }, + { + "Date": "2016-12-22T16:05:17.326Z", + "Message": "Added cache node 0002 in availability zone us-east-1c", + "SourceIdentifier": "my-memcached2", + "SourceType": "cache-cluster" + }, + { + "Date": "2016-12-22T16:05:17.323Z", + "Message": "Added cache node 0001 in availability zone us-east-1e", + "SourceIdentifier": "my-memcached2", + "SourceType": "cache-cluster" + }, + { + "Date": "2016-12-22T16:05:17.314Z", + "Message": "Cache cluster created", + "SourceIdentifier": "my-memcached2", + "SourceType": "cache-cluster" + } + ], + "Marker": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Describes all the replication-group events from 3:00P to 5:00P on November 11, 2016.", + "id": "describeevents-1481843894757", + "title": "DescribeEvents" + } + ], + "DescribeReplicationGroups": [ + { + "input": { + }, + "output": { + "Marker": "", + "ReplicationGroups": [ + { + "AutomaticFailover": "enabled", + "Description": "Test cluster", + "MemberClusters": [ + "clustered-redis-0001-001", + "clustered-redis-0001-002", + "clustered-redis-0002-001", + "clustered-redis-0002-002" + ], + "NodeGroups": [ + { + "NodeGroupId": "0001", + "NodeGroupMembers": [ + { + "CacheClusterId": "clustered-redis-0001-001", + "CacheNodeId": "0001", + "PreferredAvailabilityZone": "us-east-1e" + }, + { + "CacheClusterId": "clustered-redis-0001-002", + "CacheNodeId": "0001", + "PreferredAvailabilityZone": "us-east-1c" + } + ], + "Status": "available" + }, + { + "NodeGroupId": "0002", + "NodeGroupMembers": [ + { + "CacheClusterId": "clustered-redis-0002-001", + "CacheNodeId": "0001", + "PreferredAvailabilityZone": "us-east-1c" + }, + { + "CacheClusterId": "clustered-redis-0002-002", + "CacheNodeId": "0001", + "PreferredAvailabilityZone": "us-east-1b" + } + ], + "Status": "available" + } + ], + "PendingModifiedValues": { + }, + "ReplicationGroupId": "clustered-redis", + "Status": "available" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns information about the replication group myreplgroup.", + "id": "describereplicationgroups-1481742639427", + "title": "DescribeReplicationGroups" + } + ], + "DescribeReservedCacheNodes": [ + { + "input": { + "MaxRecords": 25 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns information about reserved cache nodes for this account, or about a specified reserved cache node. If the account has no reserved cache nodes, the operation returns an empty list, as shown here.", + "id": "describereservedcachenodes-1481742348045", + "title": "DescribeReservedCacheNodes" + } + ], + "DescribeReservedCacheNodesOfferings": [ + { + "input": { + "MaxRecords": 20 + }, + "output": { + "Marker": "1ef01f5b-433f-94ff-a530-61a56bfc8e7a", + "ReservedCacheNodesOfferings": [ + { + "CacheNodeType": "cache.m1.small", + "Duration": 94608000, + "FixedPrice": 157.0, + "OfferingType": "Medium Utilization", + "ProductDescription": "memcached", + "RecurringCharges": [ + + ], + "ReservedCacheNodesOfferingId": "0167633d-37f6-4222-b872-b1f22eb79ba4", + "UsagePrice": 0.017 + }, + { + "CacheNodeType": "cache.m4.xlarge", + "Duration": 94608000, + "FixedPrice": 1248.0, + "OfferingType": "Heavy Utilization", + "ProductDescription": "redis", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.077, + "RecurringChargeFrequency": "Hourly" + } + ], + "ReservedCacheNodesOfferingId": "02c04e13-baca-4e71-9ceb-620eed94827d", + "UsagePrice": 0.0 + }, + { + "CacheNodeType": "cache.m2.4xlarge", + "Duration": 94608000, + "FixedPrice": 2381.0, + "OfferingType": "Medium Utilization", + "ProductDescription": "memcached", + "RecurringCharges": [ + + ], + "ReservedCacheNodesOfferingId": "02e1755e-76e8-48e3-8d82-820a5726a458", + "UsagePrice": 0.276 + }, + { + "CacheNodeType": "cache.m1.small", + "Duration": 94608000, + "FixedPrice": 188.0, + "OfferingType": "Heavy Utilization", + "ProductDescription": "redis", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.013, + "RecurringChargeFrequency": "Hourly" + } + ], + "ReservedCacheNodesOfferingId": "03315215-7b87-421a-a3dd-785021e4113f", + "UsagePrice": 0.0 + }, + { + "CacheNodeType": "cache.m4.10xlarge", + "Duration": 31536000, + "FixedPrice": 6158.0, + "OfferingType": "Heavy Utilization", + "ProductDescription": "redis", + "RecurringCharges": [ + { + "RecurringChargeAmount": 1.125, + "RecurringChargeFrequency": "Hourly" + } + ], + "ReservedCacheNodesOfferingId": "05ffbb44-2ace-4476-a2a5-8ec99f866fb3", + "UsagePrice": 0.0 + }, + { + "CacheNodeType": "cache.m1.small", + "Duration": 31536000, + "FixedPrice": 101.0, + "OfferingType": "Medium Utilization", + "ProductDescription": "redis", + "RecurringCharges": [ + + ], + "ReservedCacheNodesOfferingId": "065c71ae-4a4e-4f1e-bebf-37525f4c6cb2", + "UsagePrice": 0.023 + }, + { + "CacheNodeType": "cache.m1.medium", + "Duration": 94608000, + "FixedPrice": 314.0, + "OfferingType": "Medium Utilization", + "ProductDescription": "memcached", + "RecurringCharges": [ + + ], + "ReservedCacheNodesOfferingId": "06774b12-7f5e-48c1-907a-f286c63f327d", + "UsagePrice": 0.034 + }, + { + "CacheNodeType": "cache.m2.xlarge", + "Duration": 31536000, + "FixedPrice": 163.0, + "OfferingType": "Light Utilization", + "ProductDescription": "memcached", + "RecurringCharges": [ + + ], + "ReservedCacheNodesOfferingId": "0924ac6b-847f-4761-ba6b-4290b2adf719", + "UsagePrice": 0.137 + }, + { + "CacheNodeType": "cache.m2.xlarge", + "Duration": 94608000, + "FixedPrice": 719.0, + "OfferingType": "Heavy Utilization", + "ProductDescription": "redis", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.049, + "RecurringChargeFrequency": "Hourly" + } + ], + "ReservedCacheNodesOfferingId": "09eeb126-69b6-4d3f-8f94-ca3510629f53", + "UsagePrice": 0.0 + }, + { + "CacheNodeType": "cache.r3.2xlarge", + "Duration": 94608000, + "FixedPrice": 4132.0, + "OfferingType": "Heavy Utilization", + "ProductDescription": "redis", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.182, + "RecurringChargeFrequency": "Hourly" + } + ], + "ReservedCacheNodesOfferingId": "0a516ad8-557f-4310-9dd0-2448c2ff4d62", + "UsagePrice": 0.0 + }, + { + "CacheNodeType": "cache.c1.xlarge", + "Duration": 94608000, + "FixedPrice": 875.0, + "OfferingType": "Light Utilization", + "ProductDescription": "memcached", + "RecurringCharges": [ + + ], + "ReservedCacheNodesOfferingId": "0b0c1cc5-2177-4150-95d7-c67ec34dcb19", + "UsagePrice": 0.363 + }, + { + "CacheNodeType": "cache.m4.10xlarge", + "Duration": 94608000, + "FixedPrice": 12483.0, + "OfferingType": "Heavy Utilization", + "ProductDescription": "memcached", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.76, + "RecurringChargeFrequency": "Hourly" + } + ], + "ReservedCacheNodesOfferingId": "0c2b139b-1cff-43d0-8fba-0c753f9b1950", + "UsagePrice": 0.0 + }, + { + "CacheNodeType": "cache.c1.xlarge", + "Duration": 31536000, + "FixedPrice": 1620.0, + "OfferingType": "Heavy Utilization", + "ProductDescription": "memcached", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.207, + "RecurringChargeFrequency": "Hourly" + } + ], + "ReservedCacheNodesOfferingId": "0c52115b-38cb-47a2-8dbc-e02e40b6a13f", + "UsagePrice": 0.0 + }, + { + "CacheNodeType": "cache.m2.4xlarge", + "Duration": 94608000, + "FixedPrice": 2381.0, + "OfferingType": "Medium Utilization", + "ProductDescription": "redis", + "RecurringCharges": [ + + ], + "ReservedCacheNodesOfferingId": "12fcb19c-5416-4e1d-934f-28f1e2cb8599", + "UsagePrice": 0.276 + }, + { + "CacheNodeType": "cache.m4.xlarge", + "Duration": 31536000, + "FixedPrice": 616.0, + "OfferingType": "Heavy Utilization", + "ProductDescription": "memcached", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.112, + "RecurringChargeFrequency": "Hourly" + } + ], + "ReservedCacheNodesOfferingId": "13af20ad-914d-4d8b-9763-fa2e565f3549", + "UsagePrice": 0.0 + }, + { + "CacheNodeType": "cache.r3.8xlarge", + "Duration": 94608000, + "FixedPrice": 16528.0, + "OfferingType": "Heavy Utilization", + "ProductDescription": "memcached", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.729, + "RecurringChargeFrequency": "Hourly" + } + ], + "ReservedCacheNodesOfferingId": "14da3d3f-b526-4dbf-b09b-355578b2a576", + "UsagePrice": 0.0 + }, + { + "CacheNodeType": "cache.m1.medium", + "Duration": 94608000, + "FixedPrice": 140.0, + "OfferingType": "Light Utilization", + "ProductDescription": "redis", + "RecurringCharges": [ + + ], + "ReservedCacheNodesOfferingId": "15d7018c-71fb-4717-8409-4bdcdca18da7", + "UsagePrice": 0.052 + }, + { + "CacheNodeType": "cache.m4.4xlarge", + "Duration": 94608000, + "FixedPrice": 4993.0, + "OfferingType": "Heavy Utilization", + "ProductDescription": "memcached", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.304, + "RecurringChargeFrequency": "Hourly" + } + ], + "ReservedCacheNodesOfferingId": "1ae7ec5f-a76e-49b6-822b-629b1768a13a", + "UsagePrice": 0.0 + }, + { + "CacheNodeType": "cache.m3.2xlarge", + "Duration": 31536000, + "FixedPrice": 1772.0, + "OfferingType": "Heavy Utilization", + "ProductDescription": "redis", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.25, + "RecurringChargeFrequency": "Hourly" + } + ], + "ReservedCacheNodesOfferingId": "1d31242b-3925-48d1-b882-ce03204e6013", + "UsagePrice": 0.0 + }, + { + "CacheNodeType": "cache.t1.micro", + "Duration": 31536000, + "FixedPrice": 54.0, + "OfferingType": "Medium Utilization", + "ProductDescription": "memcached", + "RecurringCharges": [ + + ], + "ReservedCacheNodesOfferingId": "1ef01f5b-94ff-433f-a530-61a56bfc8e7a", + "UsagePrice": 0.008 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists available reserved cache node offerings.", + "id": "describereseredcachenodeofferings-1481742869998", + "title": "DescribeReseredCacheNodeOfferings" + }, + { + "input": { + "CacheNodeType": "cache.r3.large", + "Duration": "3", + "MaxRecords": 25, + "OfferingType": "Light Utilization", + "ReservedCacheNodesOfferingId": "" + }, + "output": { + "Marker": "", + "ReservedCacheNodesOfferings": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists available reserved cache node offerings for cache.r3.large nodes with a 3 year commitment.", + "id": "describereseredcachenodeofferings-1481742869998", + "title": "DescribeReseredCacheNodeOfferings" + }, + { + "input": { + "CacheNodeType": "", + "Duration": "", + "Marker": "", + "MaxRecords": 25, + "OfferingType": "", + "ProductDescription": "", + "ReservedCacheNodesOfferingId": "438012d3-4052-4cc7-b2e3-8d3372e0e706" + }, + "output": { + "Marker": "", + "ReservedCacheNodesOfferings": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists available reserved cache node offerings.", + "id": "describereseredcachenodeofferings-1481742869998", + "title": "DescribeReseredCacheNodeOfferings" + } + ], + "DescribeSnapshots": [ + { + "input": { + "SnapshotName": "snapshot-20161212" + }, + "output": { + "Marker": "", + "Snapshots": [ + { + "AutoMinorVersionUpgrade": true, + "CacheClusterCreateTime": "2016-12-21T22:27:12.543Z", + "CacheClusterId": "my-redis5", + "CacheNodeType": "cache.m3.large", + "CacheParameterGroupName": "default.redis3.2", + "CacheSubnetGroupName": "default", + "Engine": "redis", + "EngineVersion": "3.2.4", + "NodeSnapshots": [ + { + "CacheNodeCreateTime": "2016-12-21T22:27:12.543Z", + "CacheNodeId": "0001", + "CacheSize": "3 MB", + "SnapshotCreateTime": "2016-12-21T22:30:26Z" + } + ], + "NumCacheNodes": 1, + "Port": 6379, + "PreferredAvailabilityZone": "us-east-1c", + "PreferredMaintenanceWindow": "fri:05:30-fri:06:30", + "SnapshotName": "snapshot-20161212", + "SnapshotRetentionLimit": 7, + "SnapshotSource": "manual", + "SnapshotStatus": "available", + "SnapshotWindow": "10:00-11:00", + "VpcId": "vpc-91280df6" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns information about the snapshot mysnapshot. By default.", + "id": "describesnapshots-1481743399584", + "title": "DescribeSnapshots" + } + ], + "ListAllowedNodeTypeModifications": [ + { + "input": { + "ReplicationGroupId": "myreplgroup" + }, + "output": { + "ScaleUpModifications": [ + "cache.m4.10xlarge", + "cache.m4.2xlarge", + "cache.m4.4xlarge", + "cache.m4.xlarge", + "cache.r3.2xlarge", + "cache.r3.4xlarge", + "cache.r3.8xlarge", + "cache.r3.xlarge" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.", + "id": "listallowednodetypemodifications-1481748494872", + "title": "ListAllowedNodeTypeModifications" + }, + { + "input": { + "CacheClusterId": "mycluster" + }, + "output": { + "ScaleUpModifications": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.", + "id": "listallowednodetypemodifications-1481748494872", + "title": "ListAllowedNodeTypeModifications" + } + ], + "ListTagsForResource": [ + { + "input": { + "ResourceName": "arn:aws:elasticache:us-west-2: Creates an application that has one configuration template named default and no application versions.
Creates an application that has one configuration template named default and no application versions.
Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:
Specify a commit in an AWS CodeCommit repository with SourceBuildInformation.
Specify a build in an AWS CodeBuild with SourceBuildInformation and BuildConfiguration.
Specify a source bundle in S3 with SourceBundle
Omit both SourceBuildInformation and SourceBundle to use the default sample application.
Once you create an application version with a specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.
Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:
Specify a commit in an AWS CodeCommit repository with SourceBuildInformation.
Specify a build in an AWS CodeBuild with SourceBuildInformation and BuildConfiguration.
Specify a source bundle in S3 with SourceBundle
Omit both SourceBuildInformation and SourceBundle to use the default sample application.
After you create an application version with a specified Amazon S3 bucket and key location, you can't change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.
Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings.
Templates aren't associated with any environment. The EnvironmentName response element is always null.
Related Topics
" + "documentation":"Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings.
Templates aren't associated with any environment. The EnvironmentName response element is always null.
Related Topics
" }, "CreateEnvironment":{ "name":"CreateEnvironment", @@ -140,7 +140,7 @@ {"shape":"TooManyEnvironmentsException"}, {"shape":"InsufficientPrivilegesException"} ], - "documentation":"Launches an environment for the specified application using the specified configuration.
" + "documentation":"Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.
" }, "CreatePlatformVersion":{ "name":"CreatePlatformVersion", @@ -440,7 +440,7 @@ {"shape":"InsufficientPrivilegesException"}, {"shape":"ElasticBeanstalkServiceException"} ], - "documentation":"Describes the version of the platform.
" + "documentation":"Describes a platform version. Provides full details. Compare to ListPlatformVersions, which provides summary information about a list of platform versions.
For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.
" }, "ListAvailableSolutionStacks":{ "name":"ListAvailableSolutionStacks", @@ -454,6 +454,19 @@ }, "documentation":"Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.
" }, + "ListPlatformBranches":{ + "name":"ListPlatformBranches", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPlatformBranchesRequest"}, + "output":{ + "shape":"ListPlatformBranchesResult", + "resultWrapper":"ListPlatformBranchesResult" + }, + "documentation":"Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch.
For definitions of platform branch and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.
" + }, "ListPlatformVersions":{ "name":"ListPlatformVersions", "http":{ @@ -469,7 +482,7 @@ {"shape":"InsufficientPrivilegesException"}, {"shape":"ElasticBeanstalkServiceException"} ], - "documentation":"Lists the available platforms.
" + "documentation":"Lists the platform versions available for your account in an AWS Region. Provides summary information about each platform version. Compare to DescribePlatformVersion, which provides full details about a single platform version.
For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", @@ -487,7 +500,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceTypeNotSupportedException"} ], - "documentation":"Returns the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.
Currently, Elastic Beanstalk only supports tagging of Elastic Beanstalk environments. For details about environment tagging, see Tagging Resources in Your Elastic Beanstalk Environment.
" + "documentation":"Return the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.
Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources.
" }, "RebuildEnvironment":{ "name":"RebuildEnvironment", @@ -647,7 +660,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceTypeNotSupportedException"} ], - "documentation":"Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: TagsToAdd for tags to add or update, and TagsToRemove.
Currently, Elastic Beanstalk only supports tagging of Elastic Beanstalk environments. For details about environment tagging, see Tagging Resources in Your Elastic Beanstalk Environment.
If you create a custom IAM user policy to control permission to this operation, specify one of the following two virtual actions (or both) instead of the API operation name:
Controls permission to call UpdateTagsForResource and pass a list of tags to add in the TagsToAdd parameter.
Controls permission to call UpdateTagsForResource and pass a list of tag keys to remove in the TagsToRemove parameter.
For details about creating a custom user policy, see Creating a Custom User Policy.
" + "documentation":"Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: TagsToAdd for tags to add or update, and TagsToRemove.
Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources.
If you create a custom IAM user policy to control permission to this operation, specify one of the following two virtual actions (or both) instead of the API operation name:
Controls permission to call UpdateTagsForResource and pass a list of tags to add in the TagsToAdd parameter.
Controls permission to call UpdateTagsForResource and pass a list of tag keys to remove in the TagsToRemove parameter.
For details about creating a custom user policy, see Creating a Custom User Policy.
" }, "ValidateConfigurationSettings":{ "name":"ValidateConfigurationSettings", @@ -812,10 +825,10 @@ }, "VersionLifecycleConfig":{ "shape":"ApplicationVersionLifecycleConfig", - "documentation":"The application version lifecycle configuration.
" + "documentation":"Defines lifecycle settings for application versions.
" } }, - "documentation":"The resource lifecycle configuration for an application. Defines lifecycle settings for resources that belong to the application, and the service role that Elastic Beanstalk assumes in order to apply lifecycle settings. The version lifecycle configuration defines lifecycle settings for application versions.
" + "documentation":"The resource lifecycle configuration for an application. Defines lifecycle settings for resources that belong to the application, and the service role that AWS Elastic Beanstalk assumes in order to apply lifecycle settings. The version lifecycle configuration defines lifecycle settings for application versions.
" }, "ApplicationResourceLifecycleDescriptionMessage":{ "type":"structure", @@ -996,6 +1009,8 @@ }, "BoxedBoolean":{"type":"boolean"}, "BoxedInt":{"type":"integer"}, + "BranchName":{"type":"string"}, + "BranchOrder":{"type":"integer"}, "BuildConfiguration":{ "type":"structure", "required":[ @@ -1221,11 +1236,11 @@ "members":{ "ResourceName":{ "shape":"ResourceName", - "documentation":"A unique resource name for a time-based scaling configuration option.
" + "documentation":"A unique resource name for the option setting. Use it for a time–based scaling configuration option.
" }, "Namespace":{ "shape":"OptionNamespace", - "documentation":"A unique namespace identifying the option's associated AWS resource.
" + "documentation":"A unique namespace that identifies the option's associated AWS resource.
" }, "OptionName":{ "shape":"ConfigurationOptionName", @@ -1236,7 +1251,7 @@ "documentation":"The current value for the configuration option.
" } }, - "documentation":"A specification identifying an individual configuration option along with its current value. For a list of possible option values, go to Option Values in the AWS Elastic Beanstalk Developer Guide.
" + "documentation":"A specification identifying an individual configuration option along with its current value. For a list of possible namespaces and option values, see Option Values in the AWS Elastic Beanstalk Developer Guide.
" }, "ConfigurationOptionSettingsList":{ "type":"list", @@ -1260,7 +1275,7 @@ }, "PlatformArn":{ "shape":"PlatformArn", - "documentation":"The ARN of the platform.
" + "documentation":"The ARN of the platform version.
" }, "Options":{ "shape":"ConfigurationOptionDescriptionsList", @@ -1278,7 +1293,7 @@ }, "PlatformArn":{ "shape":"PlatformArn", - "documentation":"The ARN of the platform.
" + "documentation":"The ARN of the platform version.
" }, "ApplicationName":{ "shape":"ApplicationName", @@ -1354,15 +1369,15 @@ "members":{ "ApplicationName":{ "shape":"ApplicationName", - "documentation":"The name of the application.
Constraint: This name must be unique within your account. If the specified name already exists, the action returns an InvalidParameterValue error.
The name of the application. Must be unique within your account.
" }, "Description":{ "shape":"Description", - "documentation":"Describes the application.
" + "documentation":"Your description of the application.
" }, "ResourceLifecycleConfig":{ "shape":"ApplicationResourceLifecycleConfig", - "documentation":"Specify an application resource lifecycle configuration to prevent your application from accumulating too many versions.
" + "documentation":"Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.
" }, "Tags":{ "shape":"Tags", @@ -1388,7 +1403,7 @@ }, "Description":{ "shape":"Description", - "documentation":"Describes this version.
" + "documentation":"A description of this application version.
" }, "SourceBuildInformation":{ "shape":"SourceBuildInformation", @@ -1426,35 +1441,35 @@ "members":{ "ApplicationName":{ "shape":"ApplicationName", - "documentation":"The name of the application to associate with this configuration template. If no application is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.
The name of the Elastic Beanstalk application to associate with this configuration template.
" }, "TemplateName":{ "shape":"ConfigurationTemplateName", - "documentation":"The name of the configuration template.
Constraint: This name must be unique per application.
Default: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.
The name of the configuration template.
Constraint: This name must be unique per application.
" }, "SolutionStackName":{ "shape":"SolutionStackName", - "documentation":"The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values.
Use ListAvailableSolutionStacks to obtain a list of available solution stacks.
A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk returns an InvalidParameterValue error.
If a solution stack name is not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template.
" + "documentation":"The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see Supported Platforms in the AWS Elastic Beanstalk Developer Guide.
You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration.
Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.
The ARN of the custom platform.
" + "documentation":"The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.
If you specify PlatformArn, then don't specify SolutionStackName.
If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
Values specified in the OptionSettings parameter of this call overrides any values obtained from the SourceConfiguration.
If no configuration template is found, returns an InvalidParameterValue error.
Constraint: If both the solution stack name parameter and the source configuration parameters are specified, the solution stack of the source configuration template must match the specified solution stack name or else AWS Elastic Beanstalk returns an InvalidParameterCombination error.
An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
Values specified in OptionSettings override any values obtained from the SourceConfiguration.
You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.
Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.
" }, "EnvironmentId":{ "shape":"EnvironmentId", - "documentation":"The ID of the environment used with this configuration template.
" + "documentation":"The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration.
Describes this configuration.
" + "documentation":"An optional description for this configuration.
" }, "OptionSettings":{ "shape":"ConfigurationOptionSettingsList", - "documentation":"If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template.
" + "documentation":"Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see Option Values in the AWS Elastic Beanstalk Developer Guide.
" }, "Tags":{ "shape":"Tags", @@ -1469,11 +1484,11 @@ "members":{ "ApplicationName":{ "shape":"ApplicationName", - "documentation":"The name of the application that contains the version to be deployed.
If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error.
The name of the application that is associated with this environment.
" }, "EnvironmentName":{ "shape":"EnvironmentName", - "documentation":"A unique name for the deployment environment. Used in the application URL.
Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique within a region in your account. If the specified name already exists in the region, AWS Elastic Beanstalk returns an InvalidParameterValue error.
Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.
" + "documentation":"A unique name for the environment.
Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It can't start or end with a hyphen. This name must be unique within a region in your account. If the specified name already exists in the region, Elastic Beanstalk returns an InvalidParameterValue error.
If you don't specify the CNAMEPrefix parameter, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.
Describes this environment.
" + "documentation":"Your description for this environment.
" }, "CNAMEPrefix":{ "shape":"DNSCnamePrefix", - "documentation":"If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
" + "documentation":"If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
" }, "Tier":{ "shape":"EnvironmentTier", - "documentation":"This specifies the tier to use for creating this environment.
" + "documentation":"Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.
" }, "Tags":{ "shape":"Tags", @@ -1497,19 +1512,19 @@ }, "VersionLabel":{ "shape":"VersionLabel", - "documentation":"The name of the application version to deploy.
If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error.
Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.
" + "documentation":"The name of the application version to deploy.
Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
" }, "TemplateName":{ "shape":"ConfigurationTemplateName", - "documentation":" The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.
The name of the Elastic Beanstalk configuration template to use with the environment.
If you specify TemplateName, then don't specify SolutionStackName.
This is an alternative to specifying a template name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.
For a list of current solution stacks, see Elastic Beanstalk Supported Platforms.
" + "documentation":"The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. If specified, Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack. For a list of current solution stacks, see Elastic Beanstalk Supported Platforms in the AWS Elastic Beanstalk Platforms guide.
If you specify SolutionStackName, don't specify PlatformArn or TemplateName.
The ARN of the platform.
" + "documentation":"The Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.
If you specify PlatformArn, don't specify SolutionStackName.
The ARN of the version of the custom platform.
" + "documentation":"The ARN of a custom platform version. If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this custom platform version.
" }, "RequestId":{ "shape":"RequestId", @@ -2085,7 +2100,7 @@ "members":{ "PlatformArn":{ "shape":"PlatformArn", - "documentation":"The ARN of the version of the platform.
" + "documentation":"The ARN of the platform version.
" } } }, @@ -2094,7 +2109,7 @@ "members":{ "PlatformDescription":{ "shape":"PlatformDescription", - "documentation":"Detailed information about the version of the platform.
" + "documentation":"Detailed information about the platform version.
" } } }, @@ -2141,7 +2156,7 @@ }, "PlatformArn":{ "shape":"PlatformArn", - "documentation":"The ARN of the platform.
" + "documentation":"The ARN of the platform version.
" }, "TemplateName":{ "shape":"ConfigurationTemplateName", @@ -2441,7 +2456,7 @@ }, "PlatformArn":{ "shape":"PlatformArn", - "documentation":"The ARN of the platform.
" + "documentation":"The ARN of the platform version.
" }, "RequestId":{ "shape":"RequestId", @@ -2698,20 +2713,50 @@ }, "documentation":"A list of available AWS Elastic Beanstalk solution stacks.
" }, + "ListPlatformBranchesRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"SearchFilters", + "documentation":"Criteria for restricting the resulting list of platform branches. The filter is evaluated as a logical conjunction (AND) of the separate SearchFilter terms.
The following list shows valid attribute values for each of the SearchFilter terms. Most operators take a single value. The in and not_in operators can take multiple values.
Attribute = BranchName:
Operator: = | != | begins_with | ends_with | contains | in | not_in
Attribute = LifecycleState:
Operator: = | != | in | not_in
Values: beta | supported | deprecated | retired
Attribute = PlatformName:
Operator: = | != | begins_with | ends_with | contains | in | not_in
Attribute = TierType:
Operator: = | !=
Values: WebServer/Standard | Worker/SQS/HTTP
Array size: limited to 10 SearchFilter objects.
Within each SearchFilter item, the Values array is limited to 10 items.
The maximum number of platform branch values returned in one call.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.
If no NextToken is specified, the first page is retrieved.
Summary information about the platform branches.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"In a paginated request, if this value isn't null, it's the token that you can pass in a subsequent request to get the next response page.
List only the platforms where the platform member value relates to one of the supplied values.
" + "documentation":"Criteria for restricting the resulting list of platform versions. The filter is interpreted as a logical conjunction (AND) of the separate PlatformFilter terms.
The maximum number of platform values returned in one call.
" + "documentation":"The maximum number of platform version values returned in one call.
" }, "NextToken":{ "shape":"Token", - "documentation":"The starting index into the remaining list of platforms. Use the NextToken value from a previous ListPlatformVersion call.
For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.
If no NextToken is specified, the first page is retrieved.
Detailed information about the platforms.
" + "documentation":"Summary information about the platform versions.
" }, "NextToken":{ "shape":"Token", - "documentation":"The starting index into the remaining list of platforms. if this value is not null, you can use it in a subsequent ListPlatformVersion call.
In a paginated request, if this value isn't null, it's the token that you can pass in a subsequent request to get the next response page.
The Amazon Resource Name (ARN) of the resouce for which a tag list is requested.
Must be the ARN of an Elastic Beanstalk environment.
" + "documentation":"The Amazon Resource Name (ARN) of the resouce for which a tag list is requested.
Must be the ARN of an Elastic Beanstalk resource.
" } } }, @@ -2993,102 +3038,149 @@ "member":{"shape":"OptionSpecification"} }, "PlatformArn":{"type":"string"}, + "PlatformBranchLifecycleState":{"type":"string"}, + "PlatformBranchMaxRecords":{ + "type":"integer", + "min":1 + }, + "PlatformBranchSummary":{ + "type":"structure", + "members":{ + "PlatformName":{ + "shape":"PlatformName", + "documentation":"The name of the platform to which this platform branch belongs.
" + }, + "BranchName":{ + "shape":"BranchName", + "documentation":"The name of the platform branch.
" + }, + "LifecycleState":{ + "shape":"PlatformBranchLifecycleState", + "documentation":"The support life cycle state of the platform branch.
Possible values: beta | supported | deprecated | retired
An ordinal number that designates the order in which platform branches have been added to a platform. This can be helpful, for example, if your code calls the ListPlatformBranches action and then displays a list of platform branches.
A larger BranchOrder value designates a newer platform branch within the platform.
The environment tiers that platform versions in this branch support.
Possible values: WebServer/Standard | Worker/SQS/HTTP
Summary information about a platform branch.
" + }, + "PlatformBranchSummaryList":{ + "type":"list", + "member":{"shape":"PlatformBranchSummary"} + }, "PlatformCategory":{"type":"string"}, "PlatformDescription":{ "type":"structure", "members":{ "PlatformArn":{ "shape":"PlatformArn", - "documentation":"The ARN of the platform.
" + "documentation":"The ARN of the platform version.
" }, "PlatformOwner":{ "shape":"PlatformOwner", - "documentation":"The AWS account ID of the person who created the platform.
" + "documentation":"The AWS account ID of the person who created the platform version.
" }, "PlatformName":{ "shape":"PlatformName", - "documentation":"The name of the platform.
" + "documentation":"The name of the platform version.
" }, "PlatformVersion":{ "shape":"PlatformVersion", - "documentation":"The version of the platform.
" + "documentation":"The version of the platform version.
" }, "SolutionStackName":{ "shape":"SolutionStackName", - "documentation":"The name of the solution stack used by the platform.
" + "documentation":"The name of the solution stack used by the platform version.
" }, "PlatformStatus":{ "shape":"PlatformStatus", - "documentation":"The status of the platform.
" + "documentation":"The status of the platform version.
" }, "DateCreated":{ "shape":"CreationDate", - "documentation":"The date when the platform was created.
" + "documentation":"The date when the platform version was created.
" }, "DateUpdated":{ "shape":"UpdateDate", - "documentation":"The date when the platform was last updated.
" + "documentation":"The date when the platform version was last updated.
" }, "PlatformCategory":{ "shape":"PlatformCategory", - "documentation":"The category of the platform.
" + "documentation":"The category of the platform version.
" }, "Description":{ "shape":"Description", - "documentation":"The description of the platform.
" + "documentation":"The description of the platform version.
" }, "Maintainer":{ "shape":"Maintainer", - "documentation":"Information about the maintainer of the platform.
" + "documentation":"Information about the maintainer of the platform version.
" }, "OperatingSystemName":{ "shape":"OperatingSystemName", - "documentation":"The operating system used by the platform.
" + "documentation":"The operating system used by the platform version.
" }, "OperatingSystemVersion":{ "shape":"OperatingSystemVersion", - "documentation":"The version of the operating system used by the platform.
" + "documentation":"The version of the operating system used by the platform version.
" }, "ProgrammingLanguages":{ "shape":"PlatformProgrammingLanguages", - "documentation":"The programming languages supported by the platform.
" + "documentation":"The programming languages supported by the platform version.
" }, "Frameworks":{ "shape":"PlatformFrameworks", - "documentation":"The frameworks supported by the platform.
" + "documentation":"The frameworks supported by the platform version.
" }, "CustomAmiList":{ "shape":"CustomAmiList", - "documentation":"The custom AMIs supported by the platform.
" + "documentation":"The custom AMIs supported by the platform version.
" }, "SupportedTierList":{ "shape":"SupportedTierList", - "documentation":"The tiers supported by the platform.
" + "documentation":"The tiers supported by the platform version.
" }, "SupportedAddonList":{ "shape":"SupportedAddonList", - "documentation":"The additions supported by the platform.
" + "documentation":"The additions supported by the platform version.
" + }, + "PlatformLifecycleState":{ + "shape":"PlatformLifecycleState", + "documentation":"The state of the platform version in its lifecycle.
Possible values: Recommended | null
If a null value is returned, the platform version isn't the recommended one for its branch. Each platform branch has a single recommended platform version, typically the most recent one.
" + }, + "PlatformBranchName":{ + "shape":"BranchName", + "documentation":"The platform branch to which the platform version belongs.
" + }, + "PlatformBranchLifecycleState":{ + "shape":"PlatformBranchLifecycleState", + "documentation":"The state of the platform version's branch in its lifecycle.
Possible values: Beta | Supported | Deprecated | Retired
Detailed information about a platform.
" + "documentation":"Detailed information about a platform version.
" }, "PlatformFilter":{ "type":"structure", "members":{ "Type":{ "shape":"PlatformFilterType", - "documentation":"The custom platform attribute to which the filter values are applied.
Valid Values: PlatformName | PlatformVersion | PlatformStatus | PlatformOwner
The platform version attribute to which the filter values are applied.
Valid values: PlatformName | PlatformVersion | PlatformStatus | PlatformBranchName | PlatformLifecycleState | PlatformOwner | SupportedTier | SupportedAddon | ProgrammingLanguageName | OperatingSystemName
The operator to apply to the Type with each of the Values.
Valid Values: = (equal to) | != (not equal to) | < (less than) | <= (less than or equal to) | > (greater than) | >= (greater than or equal to) | contains | begins_with | ends_with
The operator to apply to the Type with each of the Values.
Valid values: = | != | < | <= | > | >= | contains | begins_with | ends_with
The list of values applied to the custom platform attribute.
" + "documentation":"The list of values applied to the filtering platform version attribute. Only one value is supported for all current operators.
The following list shows valid filter values for some filter attributes.
PlatformStatus: Creating | Failed | Ready | Deleting | Deleted
PlatformLifecycleState: recommended
SupportedTier: WebServer/Standard | Worker/SQS/HTTP
SupportedAddon: Log/S3 | Monitoring/Healthd | WorkerDaemon/SQSD
Specify criteria to restrict the results when listing custom platforms.
The filter is evaluated as the expression:
Type Operator Values[i]
Describes criteria to restrict the results when listing platform versions.
The filter is evaluated as follows: Type Operator Values[1]
The version of the framework.
" } }, - "documentation":"A framework supported by the custom platform.
" + "documentation":"A framework supported by the platform.
" }, "PlatformFrameworks":{ "type":"list", "member":{"shape":"PlatformFramework"} }, + "PlatformLifecycleState":{"type":"string"}, "PlatformMaxRecords":{ "type":"integer", "min":1 @@ -3158,38 +3251,54 @@ "members":{ "PlatformArn":{ "shape":"PlatformArn", - "documentation":"The ARN of the platform.
" + "documentation":"The ARN of the platform version.
" }, "PlatformOwner":{ "shape":"PlatformOwner", - "documentation":"The AWS account ID of the person who created the platform.
" + "documentation":"The AWS account ID of the person who created the platform version.
" }, "PlatformStatus":{ "shape":"PlatformStatus", - "documentation":"The status of the platform. You can create an environment from the platform once it is ready.
" + "documentation":"The status of the platform version. You can create an environment from the platform version once it is ready.
" }, "PlatformCategory":{ "shape":"PlatformCategory", - "documentation":"The category of platform.
" + "documentation":"The category of platform version.
" }, "OperatingSystemName":{ "shape":"OperatingSystemName", - "documentation":"The operating system used by the platform.
" + "documentation":"The operating system used by the platform version.
" }, "OperatingSystemVersion":{ "shape":"OperatingSystemVersion", - "documentation":"The version of the operating system used by the platform.
" + "documentation":"The version of the operating system used by the platform version.
" }, "SupportedTierList":{ "shape":"SupportedTierList", - "documentation":"The tiers in which the platform runs.
" + "documentation":"The tiers in which the platform version runs.
" }, "SupportedAddonList":{ "shape":"SupportedAddonList", - "documentation":"The additions associated with the platform.
" + "documentation":"The additions associated with the platform version.
" + }, + "PlatformLifecycleState":{ + "shape":"PlatformLifecycleState", + "documentation":"The state of the platform version in its lifecycle.
Possible values: recommended | empty
If an empty value is returned, the platform version is supported but isn't the recommended one for its branch.
" + }, + "PlatformVersion":{ + "shape":"PlatformVersion", + "documentation":"The version string of the platform version.
" + }, + "PlatformBranchName":{ + "shape":"BranchName", + "documentation":"The platform branch to which the platform version belongs.
" + }, + "PlatformBranchLifecycleState":{ + "shape":"PlatformBranchLifecycleState", + "documentation":"The state of the platform version's branch in its lifecycle.
Possible values: beta | supported | deprecated | retired
Detailed information about a platform.
" + "documentation":"Summary information about a platform version.
" }, "PlatformSummaryList":{ "type":"list", @@ -3324,7 +3433,7 @@ "members":{ "ResourceArn":{ "shape":"ResourceArn", - "documentation":"The Amazon Resource Name (ARN) of the resouce for which a tag list was requested.
" + "documentation":"The Amazon Resource Name (ARN) of the resource for which a tag list was requested.
" }, "ResourceTags":{ "shape":"TagList", @@ -3434,6 +3543,35 @@ "exception":true }, "SampleTimestamp":{"type":"timestamp"}, + "SearchFilter":{ + "type":"structure", + "members":{ + "Attribute":{ + "shape":"SearchFilterAttribute", + "documentation":"The result attribute to which the filter values are applied. Valid values vary by API action.
" + }, + "Operator":{ + "shape":"SearchFilterOperator", + "documentation":"The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.
The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.
Describes criteria to restrict a list of results.
For operators that apply a single value to the attribute, the filter is evaluated as follows: Attribute Operator Values[1]
Some operators, e.g. in, can apply multiple values. In this case, the filter is evaluated as a logical union (OR) of applications of the operator to the attribute with each one of the values: (Attribute Operator Values[1]) OR (Attribute Operator Values[2]) OR ...
The valid values for attributes of SearchFilter depend on the API action. For valid values, see the reference page for the API action you're calling that takes a SearchFilter parameter.
The name of the configuration template.
" } }, - "documentation":"A specification for an environment configuration
" + "documentation":"A specification for an environment configuration.
" }, "SourceLocation":{ "type":"string", @@ -3939,7 +4077,7 @@ "members":{ "ResourceArn":{ "shape":"ResourceArn", - "documentation":"The Amazon Resource Name (ARN) of the resouce to be updated.
Must be the ARN of an Elastic Beanstalk environment.
" + "documentation":"The Amazon Resource Name (ARN) of the resouce to be updated.
Must be the ARN of an Elastic Beanstalk resource.
" }, "TagsToAdd":{ "shape":"TagList", diff --git a/botocore/data/emr/2009-03-31/service-2.json b/botocore/data/emr/2009-03-31/service-2.json index 8a42b4f5..997e4b04 100644 --- a/botocore/data/emr/2009-03-31/service-2.json +++ b/botocore/data/emr/2009-03-31/service-2.json @@ -179,6 +179,16 @@ ], "documentation":"Returns the Amazon EMR block public access configuration for your AWS account in the current Region. For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide.
" }, + "GetManagedScalingPolicy":{ + "name":"GetManagedScalingPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetManagedScalingPolicyInput"}, + "output":{"shape":"GetManagedScalingPolicyOutput"}, + "documentation":"Fetches the attached managed scaling policy for an Amazon EMR cluster.
" + }, "ListBootstrapActions":{ "name":"ListBootstrapActions", "http":{ @@ -340,6 +350,16 @@ ], "documentation":"Creates or updates an Amazon EMR block public access configuration for your AWS account in the current Region. For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide.
" }, + "PutManagedScalingPolicy":{ + "name":"PutManagedScalingPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutManagedScalingPolicyInput"}, + "output":{"shape":"PutManagedScalingPolicyOutput"}, + "documentation":"Creates or updates a managed scaling policy for an Amazon EMR cluster. The managed scaling policy defines the limits for resources, such as EC2 instances that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
" + }, "RemoveAutoScalingPolicy":{ "name":"RemoveAutoScalingPolicy", "http":{ @@ -350,6 +370,16 @@ "output":{"shape":"RemoveAutoScalingPolicyOutput"}, "documentation":"Removes an automatic scaling policy from a specified instance group within an EMR cluster.
" }, + "RemoveManagedScalingPolicy":{ + "name":"RemoveManagedScalingPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveManagedScalingPolicyInput"}, + "output":{"shape":"RemoveManagedScalingPolicyOutput"}, + "documentation":"Removes a managed scaling policy from a specified EMR cluster.
" + }, "RemoveTags":{ "name":"RemoveTags", "http":{ @@ -955,13 +985,13 @@ "shape":"ArnType", "documentation":"The Amazon Resource Name of the cluster.
" }, - "StepConcurrencyLevel":{ - "shape":"Integer", - "documentation":"Specifies the number of steps that can be executed concurrently.
" - }, "OutpostArn":{ "shape":"OptionalArnType", "documentation":"The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.
" + }, + "StepConcurrencyLevel":{ + "shape":"Integer", + "documentation":"Specifies the number of steps that can be executed concurrently.
" } }, "documentation":"The detailed description of the cluster.
" @@ -1111,6 +1141,41 @@ "LESS_THAN_OR_EQUAL" ] }, + "ComputeLimits":{ + "type":"structure", + "required":[ + "UnitType", + "MinimumCapacityUnits", + "MaximumCapacityUnits" + ], + "members":{ + "UnitType":{ + "shape":"ComputeLimitsUnitType", + "documentation":"The unit type used for specifying a managed scaling policy.
" + }, + "MinimumCapacityUnits":{ + "shape":"Integer", + "documentation":"The lower boundary of EC2 units. It is measured through VCPU cores or instances for instance groups and measured through units for instance fleets. Managed scaling activities are not allowed beyond this boundary. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
" + }, + "MaximumCapacityUnits":{ + "shape":"Integer", + "documentation":"The upper boundary of EC2 units. It is measured through VCPU cores or instances for instance groups and measured through units for instance fleets. Managed scaling activities are not allowed beyond this boundary. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
" + }, + "MaximumOnDemandCapacityUnits":{ + "shape":"Integer", + "documentation":"The upper boundary of on-demand EC2 units. It is measured through VCPU cores or instances for instance groups and measured through units for instance fleets. The on-demand units are not allowed to scale beyond this boundary. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
" + } + }, + "documentation":"The EC2 unit limits for a managed scaling policy. The managed scaling activity of a cluster can not be above or below these limits. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
" + }, + "ComputeLimitsUnitType":{ + "type":"string", + "enum":[ + "InstanceFleetUnits", + "Instances", + "VCPU" + ] + }, "Configuration":{ "type":"structure", "members":{ @@ -1456,7 +1521,7 @@ "members":{ "BlockPublicAccessConfiguration":{ "shape":"BlockPublicAccessConfiguration", - "documentation":"A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges in the BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating the block public access configuration to remove the exception.
A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges in the BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating the block public access configuration to remove the exception.
For accounts that created clusters in a Region before November 25, 2019, block public access is disabled by default in that Region. To use this feature, you must manually enable and configure it. For accounts that did not create an EMR cluster in a Region before this date, block public access is enabled by default in that Region.
Specifies the ID of the cluster for which the managed scaling policy will be fetched.
" + } + } + }, + "GetManagedScalingPolicyOutput":{ + "type":"structure", + "members":{ + "ManagedScalingPolicy":{ + "shape":"ManagedScalingPolicy", + "documentation":"Specifies the managed scaling policy that is attached to an Amazon EMR cluster.
" + } + } + }, "HadoopJarStepConfig":{ "type":"structure", "required":["Jar"], @@ -2850,6 +2934,16 @@ "documentation":"This output contains the list of steps returned in reverse order. This means that the last step is the first element in the list.
" }, "Long":{"type":"long"}, + "ManagedScalingPolicy":{ + "type":"structure", + "members":{ + "ComputeLimits":{ + "shape":"ComputeLimits", + "documentation":"The EC2 unit limits for a managed scaling policy. The managed scaling activity of a cluster is not allowed to go above or below these limits. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
" + } + }, + "documentation":"Managed scaling policy for an Amazon EMR cluster. The policy specifies the limits for resources that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
" + }, "Marker":{"type":"string"}, "MarketType":{ "type":"string", @@ -3030,7 +3124,7 @@ "members":{ "BlockPublicAccessConfiguration":{ "shape":"BlockPublicAccessConfiguration", - "documentation":"A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges in the BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating BlockPublicSecurityGroupRules to remove the exception.
A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges in the BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating BlockPublicSecurityGroupRules to remove the exception.
For accounts that created clusters in a Region before November 25, 2019, block public access is disabled by default in that Region. To use this feature, you must manually enable and configure it. For accounts that did not create an EMR cluster in a Region before this date, block public access is enabled by default in that Region.
Specifies the ID of an EMR cluster where the managed scaling policy is attached.
" + }, + "ManagedScalingPolicy":{ + "shape":"ManagedScalingPolicy", + "documentation":"Specifies the constraints for the managed scaling policy.
" + } + } + }, + "PutManagedScalingPolicyOutput":{ + "type":"structure", + "members":{ + } + }, "RemoveAutoScalingPolicyInput":{ "type":"structure", "required":[ @@ -3061,6 +3177,21 @@ "members":{ } }, + "RemoveManagedScalingPolicyInput":{ + "type":"structure", + "required":["ClusterId"], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"Specifies the ID of the cluster from which the managed scaling policy will be removed.
" + } + } + }, + "RemoveManagedScalingPolicyOutput":{ + "type":"structure", + "members":{ + } + }, "RemoveTagsInput":{ "type":"structure", "required":[ @@ -3195,6 +3326,10 @@ "StepConcurrencyLevel":{ "shape":"Integer", "documentation":"Specifies the number of steps that can be executed concurrently. The default value is 1. The maximum value is 256.
The specified managed scaling policy for an Amazon EMR cluster.
" } }, "documentation":"Input to the RunJobFlow operation.
" diff --git a/botocore/data/endpoints.json b/botocore/data/endpoints.json index cffb6ff6..7c465a73 100644 --- a/botocore/data/endpoints.json +++ b/botocore/data/endpoints.json @@ -8,8 +8,11 @@ "dnsSuffix" : "amazonaws.com", "partition" : "aws", "partitionName" : "AWS Standard", - "regionRegex" : "^(us|eu|ap|sa|ca|me)\\-\\w+\\-\\d+$", + "regionRegex" : "^(us|eu|ap|sa|ca|me|af)\\-\\w+\\-\\d+$", "regions" : { + "af-south-1" : { + "description" : "Africa (Cape Town)" + }, "ap-east-1" : { "description" : "Asia Pacific (Hong Kong)" }, @@ -73,6 +76,7 @@ }, "access-analyzer" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -95,6 +99,7 @@ }, "acm" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -202,6 +207,12 @@ }, "api.ecr" : { "endpoints" : { + "af-south-1" : { + "credentialScope" : { + "region" : "af-south-1" + }, + "hostname" : "api.ecr.af-south-1.amazonaws.com" + }, "ap-east-1" : { "credentialScope" : { "region" : "ap-east-1" @@ -274,6 +285,30 @@ }, "hostname" : "api.ecr.eu-west-3.amazonaws.com" }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "ecr-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "ecr-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "ecr-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "ecr-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { "credentialScope" : { "region" : "me-south-1" @@ -312,6 +347,28 @@ } } }, + "api.elastic-inference" : { + "endpoints" : { + "ap-northeast-1" : { + "hostname" : "api.elastic-inference.ap-northeast-1.amazonaws.com" + }, + "ap-northeast-2" : { + "hostname" : "api.elastic-inference.ap-northeast-2.amazonaws.com" + }, + "eu-west-1" : { + "hostname" : "api.elastic-inference.eu-west-1.amazonaws.com" + }, + "us-east-1" : { + "hostname" : "api.elastic-inference.us-east-1.amazonaws.com" + }, + "us-east-2" : { + "hostname" : "api.elastic-inference.us-east-2.amazonaws.com" + }, + "us-west-2" : { + "hostname" : "api.elastic-inference.us-west-2.amazonaws.com" + } + } + }, "api.mediatailor" : { "endpoints" : { "ap-northeast-1" : { }, @@ -382,6 +439,7 @@ }, "apigateway" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -407,6 +465,7 @@ "protocols" : [ "http", "https" ] }, "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -515,6 +574,7 @@ "protocols" : [ "http", "https" ] }, "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -591,6 +651,30 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "fips.batch.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "fips.batch.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "fips.batch.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "fips.batch.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, @@ -672,6 +756,7 @@ }, "cloudformation" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -687,9 +772,33 @@ "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "cloudformation-fips.us-east-1.amazonaws.com" + }, "us-east-2" : { }, + "us-east-2-fips" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "cloudformation-fips.us-east-2.amazonaws.com" + }, "us-west-1" : { }, - "us-west-2" : { } + "us-west-1-fips" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "cloudformation-fips.us-west-1.amazonaws.com" + }, + "us-west-2" : { }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "cloudformation-fips.us-west-2.amazonaws.com" + } } }, "cloudfront" : { @@ -762,6 +871,7 @@ }, "cloudtrail" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -774,6 +884,30 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "cloudtrail-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "cloudtrail-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "cloudtrail-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "cloudtrail-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, @@ -858,6 +992,7 @@ }, "codedeploy" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -915,6 +1050,36 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "hostname" : "codepipeline-fips.ca-central-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "codepipeline-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "codepipeline-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "codepipeline-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "codepipeline-fips.us-west-2.amazonaws.com" + }, "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, @@ -948,6 +1113,7 @@ "ap-southeast-2" : { }, "ca-central-1" : { }, "eu-central-1" : { }, + "eu-north-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, @@ -1055,6 +1221,24 @@ "eu-central-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "comprehend-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "comprehend-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "comprehend-fips.us-west-2.amazonaws.com" + }, "us-east-1" : { }, "us-east-2" : { }, "us-west-2" : { } @@ -1145,6 +1329,7 @@ "eu-central-1" : { }, "eu-north-1" : { }, "eu-west-1" : { }, + "eu-west-2" : { }, "us-east-1" : { }, "us-west-2" : { } } @@ -1249,6 +1434,7 @@ }, "directconnect" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -1261,6 +1447,30 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "directconnect-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "directconnect-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "directconnect-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "directconnect-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, @@ -1271,12 +1481,14 @@ }, "discovery" : { "endpoints" : { + "ap-southeast-2" : { }, "eu-central-1" : { }, "us-west-2" : { } } }, "dms" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -1399,6 +1611,36 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "hostname" : "ds-fips.ca-central-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "ds-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "ds-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "ds-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "ds-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, @@ -1412,6 +1654,7 @@ "protocols" : [ "http", "https" ] }, "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -1474,6 +1717,7 @@ "protocols" : [ "http", "https" ] }, "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -1486,6 +1730,36 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "hostname" : "ec2-fips.ca-central-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "ec2-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "ec2-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "ec2-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "ec2-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, @@ -1496,6 +1770,7 @@ }, "ecs" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -1508,6 +1783,30 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "ecs-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "ecs-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "ecs-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "ecs-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, @@ -1518,6 +1817,7 @@ }, "elasticache" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -1546,6 +1846,7 @@ }, "elasticbeanstalk" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -1558,6 +1859,30 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "elasticbeanstalk-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "elasticbeanstalk-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "elasticbeanstalk-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "elasticbeanstalk-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, @@ -1580,6 +1905,114 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-ap-east-1" : { + "credentialScope" : { + "region" : "ap-east-1" + }, + "hostname" : "elasticfilesystem-fips.ap-east-1.amazonaws.com" + }, + "fips-ap-northeast-1" : { + "credentialScope" : { + "region" : "ap-northeast-1" + }, + "hostname" : "elasticfilesystem-fips.ap-northeast-1.amazonaws.com" + }, + "fips-ap-northeast-2" : { + "credentialScope" : { + "region" : "ap-northeast-2" + }, + "hostname" : "elasticfilesystem-fips.ap-northeast-2.amazonaws.com" + }, + "fips-ap-south-1" : { + "credentialScope" : { + "region" : "ap-south-1" + }, + "hostname" : "elasticfilesystem-fips.ap-south-1.amazonaws.com" + }, + "fips-ap-southeast-1" : { + "credentialScope" : { + "region" : "ap-southeast-1" + }, + "hostname" : "elasticfilesystem-fips.ap-southeast-1.amazonaws.com" + }, + "fips-ap-southeast-2" : { + "credentialScope" : { + "region" : "ap-southeast-2" + }, + "hostname" : "elasticfilesystem-fips.ap-southeast-2.amazonaws.com" + }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "hostname" : "elasticfilesystem-fips.ca-central-1.amazonaws.com" + }, + "fips-eu-central-1" : { + "credentialScope" : { + "region" : "eu-central-1" + }, + "hostname" : "elasticfilesystem-fips.eu-central-1.amazonaws.com" + }, + "fips-eu-north-1" : { + "credentialScope" : { + "region" : "eu-north-1" + }, + "hostname" : "elasticfilesystem-fips.eu-north-1.amazonaws.com" + }, + "fips-eu-west-1" : { + "credentialScope" : { + "region" : "eu-west-1" + }, + "hostname" : "elasticfilesystem-fips.eu-west-1.amazonaws.com" + }, + "fips-eu-west-2" : { + "credentialScope" : { + "region" : "eu-west-2" + }, + "hostname" : "elasticfilesystem-fips.eu-west-2.amazonaws.com" + }, + "fips-eu-west-3" : { + "credentialScope" : { + "region" : "eu-west-3" + }, + "hostname" : "elasticfilesystem-fips.eu-west-3.amazonaws.com" + }, + "fips-me-south-1" : { + "credentialScope" : { + "region" : "me-south-1" + }, + "hostname" : "elasticfilesystem-fips.me-south-1.amazonaws.com" + }, + "fips-sa-east-1" : { + "credentialScope" : { + "region" : "sa-east-1" + }, + "hostname" : "elasticfilesystem-fips.sa-east-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "elasticfilesystem-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "elasticfilesystem-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "elasticfilesystem-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "elasticfilesystem-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, @@ -1593,6 +2026,7 @@ "protocols" : [ "https" ] }, "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -1605,6 +2039,30 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "elasticloadbalancing-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "elasticloadbalancing-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "elasticloadbalancing-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "elasticloadbalancing-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, @@ -1619,6 +2077,7 @@ "sslCommonName" : "{region}.{service}.{dnsSuffix}" }, "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -1633,6 +2092,36 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "hostname" : "elasticmapreduce-fips.ca-central-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "elasticmapreduce-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "elasticmapreduce-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "elasticmapreduce-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "elasticmapreduce-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { @@ -1677,6 +2166,7 @@ }, "es" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -1705,6 +2195,7 @@ }, "events" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -1717,6 +2208,30 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "events-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "events-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "events-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "events-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, @@ -1739,6 +2254,30 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "firehose-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "firehose-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "firehose-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "firehose-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, @@ -1890,7 +2429,9 @@ }, "fsx" : { "endpoints" : { + "ap-east-1" : { }, "ap-northeast-1" : { }, + "ap-northeast-2" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, "eu-central-1" : { }, @@ -1926,6 +2467,7 @@ "protocols" : [ "http", "https" ] }, "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -1990,6 +2532,30 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "glue-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "glue-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "glue-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "glue-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, @@ -2019,7 +2585,9 @@ }, "groundstation" : { "endpoints" : { + "ap-southeast-2" : { }, "eu-north-1" : { }, + "eu-west-1" : { }, "me-south-1" : { }, "us-east-2" : { }, "us-west-2" : { } @@ -2087,6 +2655,12 @@ "region" : "us-east-1" }, "hostname" : "iam.amazonaws.com" + }, + "iam-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "iam-fips.amazonaws.com" } }, "isRegionalized" : false, @@ -2116,6 +2690,30 @@ "eu-north-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "inspector-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "inspector-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "inspector-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "inspector-fips.us-west-2.amazonaws.com" + }, "us-east-1" : { }, "us-east-2" : { }, "us-west-1" : { }, @@ -2298,6 +2896,7 @@ }, "kinesis" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -2310,6 +2909,30 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "kinesis-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "kinesis-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "kinesis-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "kinesis-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, @@ -2360,6 +2983,7 @@ }, "kms" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -2399,6 +3023,7 @@ }, "lambda" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -2411,6 +3036,30 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "lambda-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "lambda-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "lambda-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "lambda-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, @@ -2433,6 +3082,30 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "license-manager-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "license-manager-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "license-manager-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "license-manager-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, @@ -2460,6 +3133,7 @@ }, "logs" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -2489,6 +3163,7 @@ "managedblockchain" : { "endpoints" : { "ap-northeast-1" : { }, + "ap-northeast-2" : { }, "ap-southeast-1" : { }, "eu-west-1" : { }, "us-east-1" : { } @@ -2564,6 +3239,7 @@ "ap-southeast-1" : { }, "ap-southeast-2" : { }, "eu-central-1" : { }, + "eu-north-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, @@ -2581,6 +3257,7 @@ "eu-central-1" : { }, "eu-north-1" : { }, "eu-west-1" : { }, + "eu-west-2" : { }, "us-east-1" : { }, "us-west-2" : { } } @@ -2592,6 +3269,7 @@ } }, "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -2614,6 +3292,7 @@ }, "mgh" : { "endpoints" : { + "ap-southeast-2" : { }, "eu-central-1" : { }, "us-west-2" : { } } @@ -2630,8 +3309,11 @@ } }, "endpoints" : { + "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "eu-central-1" : { }, "eu-west-1" : { }, + "eu-west-2" : { }, "us-east-1" : { }, "us-west-2" : { } } @@ -2641,6 +3323,7 @@ "protocols" : [ "http", "https" ] }, "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -2653,6 +3336,30 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "monitoring-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "monitoring-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "monitoring-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "monitoring-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, @@ -2907,6 +3614,12 @@ "region" : "us-east-1" }, "hostname" : "organizations.us-east-1.amazonaws.com" + }, + "fips-aws-global" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "organizations-fips.us-east-1.amazonaws.com" } }, "isRegionalized" : false, @@ -2983,6 +3696,30 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "polly-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "polly-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "polly-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "polly-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, @@ -3097,6 +3834,7 @@ }, "rds" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -3121,6 +3859,7 @@ }, "redshift" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -3133,6 +3872,36 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "hostname" : "redshift-fips.ca-central-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "redshift-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "redshift-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "redshift-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "redshift-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, @@ -3159,6 +3928,7 @@ }, "resource-groups" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -3248,6 +4018,8 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, "us-west-1" : { }, @@ -3261,8 +4033,11 @@ } }, "endpoints" : { + "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "eu-central-1" : { }, "eu-west-1" : { }, + "eu-west-2" : { }, "us-east-1" : { }, "us-west-2" : { } } @@ -3319,6 +4094,7 @@ "signatureVersions" : [ "s3v4" ] }, "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { "hostname" : "s3.ap-northeast-1.amazonaws.com", @@ -3782,12 +4558,24 @@ "sslCommonName" : "shield.us-east-1.amazonaws.com" }, "endpoints" : { - "us-east-1" : { } + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "shield-fips.us-east-1.amazonaws.com" + }, + "us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "shield.us-east-1.amazonaws.com" + } }, "isRegionalized" : false }, "sms" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -3844,6 +4632,96 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-ap-northeast-1" : { + "credentialScope" : { + "region" : "ap-northeast-1" + }, + "hostname" : "snowball-fips.ap-northeast-1.amazonaws.com" + }, + "fips-ap-northeast-2" : { + "credentialScope" : { + "region" : "ap-northeast-2" + }, + "hostname" : "snowball-fips.ap-northeast-2.amazonaws.com" + }, + "fips-ap-south-1" : { + "credentialScope" : { + "region" : "ap-south-1" + }, + "hostname" : "snowball-fips.ap-south-1.amazonaws.com" + }, + "fips-ap-southeast-1" : { + "credentialScope" : { + "region" : "ap-southeast-1" + }, + "hostname" : "snowball-fips.ap-southeast-1.amazonaws.com" + }, + "fips-ap-southeast-2" : { + "credentialScope" : { + "region" : "ap-southeast-2" + }, + "hostname" : "snowball-fips.ap-southeast-2.amazonaws.com" + }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "hostname" : "snowball-fips.ca-central-1.amazonaws.com" + }, + "fips-eu-central-1" : { + "credentialScope" : { + "region" : "eu-central-1" + }, + "hostname" : "snowball-fips.eu-central-1.amazonaws.com" + }, + "fips-eu-west-1" : { + "credentialScope" : { + "region" : "eu-west-1" + }, + "hostname" : "snowball-fips.eu-west-1.amazonaws.com" + }, + "fips-eu-west-2" : { + "credentialScope" : { + "region" : "eu-west-2" + }, + "hostname" : "snowball-fips.eu-west-2.amazonaws.com" + }, + "fips-eu-west-3" : { + "credentialScope" : { + "region" : "eu-west-3" + }, + "hostname" : "snowball-fips.eu-west-3.amazonaws.com" + }, + "fips-sa-east-1" : { + "credentialScope" : { + "region" : "sa-east-1" + }, + "hostname" : "snowball-fips.sa-east-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "snowball-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "snowball-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "snowball-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "snowball-fips.us-west-2.amazonaws.com" + }, "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, @@ -3856,6 +4734,7 @@ "protocols" : [ "http", "https" ] }, "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -3868,6 +4747,30 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "sns-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "sns-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "sns-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "sns-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, @@ -3882,6 +4785,7 @@ "sslCommonName" : "{region}.queue.{dnsSuffix}" }, "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -3930,6 +4834,7 @@ }, "ssm" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -3942,8 +4847,56 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "ssm-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "ssm-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "ssm-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "ssm-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, + "ssm-facade-fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "ssm-facade-fips.us-east-1.amazonaws.com" + }, + "ssm-facade-fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "ssm-facade-fips.us-east-2.amazonaws.com" + }, + "ssm-facade-fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "ssm-facade-fips.us-west-1.amazonaws.com" + }, + "ssm-facade-fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "ssm-facade-fips.us-west-2.amazonaws.com" + }, "us-east-1" : { }, "us-east-2" : { }, "us-west-1" : { }, @@ -3952,6 +4905,7 @@ }, "states" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -3964,6 +4918,30 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "states-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "states-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "states-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "states-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, @@ -4060,6 +5038,7 @@ }, "sts" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -4124,6 +5103,7 @@ }, "swf" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -4136,6 +5116,30 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "swf-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "swf-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "swf-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "swf-fips.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, @@ -4146,6 +5150,7 @@ }, "tagging" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -4182,6 +5187,30 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "fips.transcribe.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "fips.transcribe.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "fips.transcribe.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "fips.transcribe.us-west-2.amazonaws.com" + }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, @@ -4263,6 +5292,12 @@ }, "waf" : { "endpoints" : { + "aws-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "waf-fips.amazonaws.com" + }, "aws-global" : { "credentialScope" : { "region" : "us-east-1" @@ -4275,22 +5310,222 @@ }, "waf-regional" : { "endpoints" : { - "ap-northeast-1" : { }, - "ap-northeast-2" : { }, - "ap-south-1" : { }, - "ap-southeast-1" : { }, - "ap-southeast-2" : { }, - "ca-central-1" : { }, - "eu-central-1" : { }, - "eu-north-1" : { }, - "eu-west-1" : { }, - "eu-west-2" : { }, - "eu-west-3" : { }, - "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "ap-east-1" : { + "credentialScope" : { + "region" : "ap-east-1" + }, + "hostname" : "waf-regional.ap-east-1.amazonaws.com" + }, + "ap-northeast-1" : { + "credentialScope" : { + "region" : "ap-northeast-1" + }, + "hostname" : "waf-regional.ap-northeast-1.amazonaws.com" + }, + "ap-northeast-2" : { + "credentialScope" : { + "region" : "ap-northeast-2" + }, + "hostname" : "waf-regional.ap-northeast-2.amazonaws.com" + }, + "ap-south-1" : { + "credentialScope" : { + "region" : "ap-south-1" + }, + "hostname" : "waf-regional.ap-south-1.amazonaws.com" + }, + "ap-southeast-1" : { + "credentialScope" : { + "region" : "ap-southeast-1" + }, + "hostname" : "waf-regional.ap-southeast-1.amazonaws.com" + }, + "ap-southeast-2" : { + "credentialScope" : { + "region" : "ap-southeast-2" + }, + "hostname" : "waf-regional.ap-southeast-2.amazonaws.com" + }, + "ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "hostname" : "waf-regional.ca-central-1.amazonaws.com" + }, + "eu-central-1" : { + "credentialScope" : { + "region" : "eu-central-1" + }, + "hostname" : "waf-regional.eu-central-1.amazonaws.com" + }, + "eu-north-1" : { + "credentialScope" : { + "region" : "eu-north-1" + }, + "hostname" : "waf-regional.eu-north-1.amazonaws.com" + }, + "eu-west-1" : { + "credentialScope" : { + "region" : "eu-west-1" + }, + "hostname" : "waf-regional.eu-west-1.amazonaws.com" + }, + "eu-west-2" : { + "credentialScope" : { + "region" : "eu-west-2" + }, + "hostname" : "waf-regional.eu-west-2.amazonaws.com" + }, + "eu-west-3" : { + "credentialScope" : { + "region" : "eu-west-3" + }, + "hostname" : "waf-regional.eu-west-3.amazonaws.com" + }, + "fips-ap-east-1" : { + "credentialScope" : { + "region" : "ap-east-1" + }, + "hostname" : "waf-regional-fips.ap-east-1.amazonaws.com" + }, + "fips-ap-northeast-1" : { + "credentialScope" : { + "region" : "ap-northeast-1" + }, + "hostname" : "waf-regional-fips.ap-northeast-1.amazonaws.com" + }, + "fips-ap-northeast-2" : { + "credentialScope" : { + "region" : "ap-northeast-2" + }, + "hostname" : "waf-regional-fips.ap-northeast-2.amazonaws.com" + }, + "fips-ap-south-1" : { + "credentialScope" : { + "region" : "ap-south-1" + }, + "hostname" : "waf-regional-fips.ap-south-1.amazonaws.com" + }, + "fips-ap-southeast-1" : { + "credentialScope" : { + "region" : "ap-southeast-1" + }, + "hostname" : "waf-regional-fips.ap-southeast-1.amazonaws.com" + }, + "fips-ap-southeast-2" : { + "credentialScope" : { + "region" : "ap-southeast-2" + }, + "hostname" : "waf-regional-fips.ap-southeast-2.amazonaws.com" + }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "hostname" : "waf-regional-fips.ca-central-1.amazonaws.com" + }, + "fips-eu-central-1" : { + "credentialScope" : { + "region" : "eu-central-1" + }, + "hostname" : "waf-regional-fips.eu-central-1.amazonaws.com" + }, + "fips-eu-north-1" : { + "credentialScope" : { + "region" : "eu-north-1" + }, + "hostname" : "waf-regional-fips.eu-north-1.amazonaws.com" + }, + "fips-eu-west-1" : { + "credentialScope" : { + "region" : "eu-west-1" + }, + "hostname" : "waf-regional-fips.eu-west-1.amazonaws.com" + }, + "fips-eu-west-2" : { + "credentialScope" : { + "region" : "eu-west-2" + }, + "hostname" : "waf-regional-fips.eu-west-2.amazonaws.com" + }, + "fips-eu-west-3" : { + "credentialScope" : { + "region" : "eu-west-3" + }, + "hostname" : "waf-regional-fips.eu-west-3.amazonaws.com" + }, + "fips-me-south-1" : { + "credentialScope" : { + "region" : "me-south-1" + }, + "hostname" : "waf-regional-fips.me-south-1.amazonaws.com" + }, + "fips-sa-east-1" : { + "credentialScope" : { + "region" : "sa-east-1" + }, + "hostname" : "waf-regional-fips.sa-east-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "waf-regional-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "waf-regional-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "waf-regional-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "waf-regional-fips.us-west-2.amazonaws.com" + }, + "me-south-1" : { + "credentialScope" : { + "region" : "me-south-1" + }, + "hostname" : "waf-regional.me-south-1.amazonaws.com" + }, + "sa-east-1" : { + "credentialScope" : { + "region" : "sa-east-1" + }, + "hostname" : "waf-regional.sa-east-1.amazonaws.com" + }, + "us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "waf-regional.us-east-1.amazonaws.com" + }, + "us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "waf-regional.us-east-2.amazonaws.com" + }, + "us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "waf-regional.us-west-1.amazonaws.com" + }, + "us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "waf-regional.us-west-2.amazonaws.com" + } } }, "workdocs" : { @@ -4299,6 +5534,18 @@ "ap-southeast-1" : { }, "ap-southeast-2" : { }, "eu-west-1" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "workdocs-fips.us-east-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "workdocs-fips.us-west-2.amazonaws.com" + }, "us-east-1" : { }, "us-west-2" : { } } @@ -4330,6 +5577,7 @@ }, "xray" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -4392,6 +5640,12 @@ } } }, + "api.sagemaker" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, "apigateway" : { "endpoints" : { "cn-north-1" : { }, @@ -4414,6 +5668,7 @@ }, "athena" : { "endpoints" : { + "cn-north-1" : { }, "cn-northwest-1" : { } } }, @@ -4560,7 +5815,19 @@ "elasticfilesystem" : { "endpoints" : { "cn-north-1" : { }, - "cn-northwest-1" : { } + "cn-northwest-1" : { }, + "fips-cn-north-1" : { + "credentialScope" : { + "region" : "cn-north-1" + }, + "hostname" : "elasticfilesystem-fips.cn-north-1.amazonaws.com.cn" + }, + "fips-cn-northwest-1" : { + "credentialScope" : { + "region" : "cn-northwest-1" + }, + "hostname" : "elasticfilesystem-fips.cn-northwest-1.amazonaws.com.cn" + } } }, "elasticloadbalancing" : { @@ -4615,6 +5882,7 @@ }, "glue" : { "endpoints" : { + "cn-north-1" : { }, "cn-northwest-1" : { } } }, @@ -4662,6 +5930,12 @@ "cn-northwest-1" : { } } }, + "kafka" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, "kinesis" : { "endpoints" : { "cn-north-1" : { }, @@ -4738,6 +6012,12 @@ "cn-northwest-1" : { } } }, + "runtime.sagemaker" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, "s3" : { "defaults" : { "protocols" : [ "http", "https" ], @@ -4797,7 +6077,13 @@ }, "snowball" : { "endpoints" : { - "cn-north-1" : { } + "cn-north-1" : { }, + "fips-cn-north-1" : { + "credentialScope" : { + "region" : "cn-north-1" + }, + "hostname" : "snowball-fips.cn-north-1.amazonaws.com.cn" + } } }, "sns" : { @@ -4951,6 +6237,18 @@ }, "api.ecr" : { "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "ecr-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "ecr-fips.us-gov-west-1.amazonaws.com" + }, "us-gov-east-1" : { "credentialScope" : { "region" : "us-gov-east-1" @@ -5039,6 +6337,18 @@ }, "batch" : { "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "batch.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "batch.us-gov-west-1.amazonaws.com" + }, "us-gov-east-1" : { }, "us-gov-west-1" : { } } @@ -5079,11 +6389,29 @@ "codebuild" : { "endpoints" : { "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1-fips" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "codebuild-fips.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { }, + "us-gov-west-1-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "codebuild-fips.us-gov-west-1.amazonaws.com" + } } }, "codecommit" : { "endpoints" : { + "fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "codecommit-fips.us-gov-west-1.amazonaws.com" + }, "us-gov-east-1" : { }, "us-gov-west-1" : { } } @@ -5106,11 +6434,28 @@ } } }, + "codepipeline" : { + "endpoints" : { + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "codepipeline-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-west-1" : { } + } + }, "comprehend" : { "defaults" : { "protocols" : [ "https" ] }, "endpoints" : { + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "comprehend-fips.us-gov-west-1.amazonaws.com" + }, "us-gov-west-1" : { } } }, @@ -5156,8 +6501,18 @@ }, "directconnect" : { "endpoints" : { - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "directconnect.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "directconnect.us-gov-west-1.amazonaws.com" + } } }, "dms" : { @@ -5174,6 +6529,18 @@ }, "ds" : { "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "ds-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "ds-fips.us-gov-west-1.amazonaws.com" + }, "us-gov-east-1" : { }, "us-gov-west-1" : { } } @@ -5198,12 +6565,34 @@ }, "ec2" : { "endpoints" : { - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "ec2.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "ec2.us-gov-west-1.amazonaws.com" + } } }, "ecs" : { "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "ecs-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "ecs-fips.us-gov-west-1.amazonaws.com" + }, "us-gov-east-1" : { }, "us-gov-west-1" : { } } @@ -5222,12 +6611,34 @@ }, "elasticbeanstalk" : { "endpoints" : { - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "elasticbeanstalk.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "elasticbeanstalk.us-gov-west-1.amazonaws.com" + } } }, "elasticfilesystem" : { "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "elasticfilesystem-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "elasticfilesystem-fips.us-gov-west-1.amazonaws.com" + }, "us-gov-east-1" : { }, "us-gov-west-1" : { } } @@ -5268,6 +6679,18 @@ }, "firehose" : { "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "firehose-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "firehose-fips.us-gov-west-1.amazonaws.com" + }, "us-gov-east-1" : { }, "us-gov-west-1" : { } } @@ -5291,6 +6714,18 @@ }, "glue" : { "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "glue-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "glue-fips.us-gov-west-1.amazonaws.com" + }, "us-gov-east-1" : { }, "us-gov-west-1" : { } } @@ -5332,6 +6767,18 @@ }, "inspector" : { "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "inspector-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "inspector-fips.us-gov-west-1.amazonaws.com" + }, "us-gov-east-1" : { }, "us-gov-west-1" : { } } @@ -5371,12 +6818,36 @@ }, "lambda" : { "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "lambda-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "lambda-fips.us-gov-west-1.amazonaws.com" + }, "us-gov-east-1" : { }, "us-gov-west-1" : { } } }, "license-manager" : { "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "license-manager-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "license-manager-fips.us-gov-west-1.amazonaws.com" + }, "us-gov-east-1" : { }, "us-gov-west-1" : { } } @@ -5405,6 +6876,18 @@ }, "monitoring" : { "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "monitoring.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "monitoring.us-gov-west-1.amazonaws.com" + }, "us-gov-east-1" : { }, "us-gov-west-1" : { } } @@ -5437,8 +6920,20 @@ "isRegionalized" : false, "partitionEndpoint" : "aws-us-gov-global" }, + "outposts" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, "polly" : { "endpoints" : { + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "polly-fips.us-gov-west-1.amazonaws.com" + }, "us-gov-west-1" : { } } }, @@ -5456,8 +6951,18 @@ }, "redshift" : { "endpoints" : { - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "redshift.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "redshift.us-gov-west-1.amazonaws.com" + } } }, "rekognition" : { @@ -5581,6 +7086,12 @@ } } }, + "securityhub" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, "serverlessrepo" : { "defaults" : { "protocols" : [ "https" ] @@ -5596,6 +7107,13 @@ }, "servicecatalog" : { "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-east-1-fips" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "servicecatalog-fips.us-gov-east-1.amazonaws.com" + }, "us-gov-west-1" : { }, "us-gov-west-1-fips" : { "credentialScope" : { @@ -5625,6 +7143,18 @@ }, "snowball" : { "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "snowball-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "snowball-fips.us-gov-west-1.amazonaws.com" + }, "us-gov-east-1" : { }, "us-gov-west-1" : { } } @@ -5654,6 +7184,18 @@ }, "states" : { "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "states-fips.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "states.us-gov-west-1.amazonaws.com" + }, "us-gov-east-1" : { }, "us-gov-west-1" : { } } @@ -5706,8 +7248,18 @@ }, "swf" : { "endpoints" : { - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "swf.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "swf.us-gov-west-1.amazonaws.com" + } } }, "tagging" : { @@ -5721,6 +7273,18 @@ "protocols" : [ "https" ] }, "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "fips.transcribe.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "fips.transcribe.us-gov-west-1.amazonaws.com" + }, "us-gov-east-1" : { }, "us-gov-west-1" : { } } @@ -5741,7 +7305,18 @@ }, "waf-regional" : { "endpoints" : { - "us-gov-west-1" : { } + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "waf-regional-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "waf-regional.us-gov-west-1.amazonaws.com" + } } }, "workspaces" : { @@ -5822,6 +7397,14 @@ "us-iso-east-1" : { } } }, + "comprehend" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "us-iso-east-1" : { } + } + }, "config" : { "endpoints" : { "us-iso-east-1" : { } diff --git a/botocore/data/es/2015-01-01/examples-1.json b/botocore/data/es/2015-01-01/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/es/2015-01-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/es/2015-01-01/service-2.json b/botocore/data/es/2015-01-01/service-2.json index 79a65449..4d8fcd91 100644 --- a/botocore/data/es/2015-01-01/service-2.json +++ b/botocore/data/es/2015-01-01/service-2.json @@ -25,6 +25,24 @@ ], "documentation":"Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.
" }, + "AssociatePackage":{ + "name":"AssociatePackage", + "http":{ + "method":"POST", + "requestUri":"/2015-01-01/packages/associate/{PackageID}/{DomainName}" + }, + "input":{"shape":"AssociatePackageRequest"}, + "output":{"shape":"AssociatePackageResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Associates a package with an Amazon ES domain.
" + }, "CancelElasticsearchServiceSoftwareUpdate":{ "name":"CancelElasticsearchServiceSoftwareUpdate", "http":{ @@ -60,6 +78,25 @@ ], "documentation":"Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
" }, + "CreatePackage":{ + "name":"CreatePackage", + "http":{ + "method":"POST", + "requestUri":"/2015-01-01/packages" + }, + "input":{"shape":"CreatePackageRequest"}, + "output":{"shape":"CreatePackageResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"InternalException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidTypeException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} + ], + "documentation":"Create a package for use with Amazon ES domains.
" + }, "DeleteElasticsearchDomain":{ "name":"DeleteElasticsearchDomain", "http":{ @@ -89,6 +126,24 @@ ], "documentation":"Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service Domains.
" }, + "DeletePackage":{ + "name":"DeletePackage", + "http":{ + "method":"DELETE", + "requestUri":"/2015-01-01/packages/{PackageID}" + }, + "input":{"shape":"DeletePackageRequest"}, + "output":{"shape":"DeletePackageResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Delete the package.
" + }, "DescribeElasticsearchDomain":{ "name":"DescribeElasticsearchDomain", "http":{ @@ -154,6 +209,23 @@ ], "documentation":" Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.
Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.
" + }, "DescribeReservedElasticsearchInstanceOfferings":{ "name":"DescribeReservedElasticsearchInstanceOfferings", "http":{ @@ -186,6 +258,24 @@ ], "documentation":"Returns information about reserved Elasticsearch instances for this account.
" }, + "DissociatePackage":{ + "name":"DissociatePackage", + "http":{ + "method":"POST", + "requestUri":"/2015-01-01/packages/dissociate/{PackageID}/{DomainName}" + }, + "input":{"shape":"DissociatePackageRequest"}, + "output":{"shape":"DissociatePackageResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ], + "documentation":"Dissociates a package from the Amazon ES domain.
" + }, "GetCompatibleElasticsearchVersions":{ "name":"GetCompatibleElasticsearchVersions", "http":{ @@ -250,6 +340,23 @@ ], "documentation":"Returns the name of all Elasticsearch domains owned by the current user's account.
" }, + "ListDomainsForPackage":{ + "name":"ListDomainsForPackage", + "http":{ + "method":"GET", + "requestUri":"/2015-01-01/packages/{PackageID}/domains" + }, + "input":{"shape":"ListDomainsForPackageRequest"}, + "output":{"shape":"ListDomainsForPackageResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} + ], + "documentation":"Lists all Amazon ES domains associated with the package.
" + }, "ListElasticsearchInstanceTypes":{ "name":"ListElasticsearchInstanceTypes", "http":{ @@ -282,6 +389,23 @@ ], "documentation":"List all supported Elasticsearch versions
" }, + "ListPackagesForDomain":{ + "name":"ListPackagesForDomain", + "http":{ + "method":"GET", + "requestUri":"/2015-01-01/domain/{DomainName}/packages" + }, + "input":{"shape":"ListPackagesForDomainRequest"}, + "output":{"shape":"ListPackagesForDomainResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} + ], + "documentation":"Lists all packages associated with the Amazon ES domain.
" + }, "ListTags":{ "name":"ListTags", "http":{ @@ -388,6 +512,14 @@ "type":"string", "documentation":"The Amazon Resource Name (ARN) of the Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
" }, + "AccessDeniedException":{ + "type":"structure", + "members":{ + }, + "documentation":"An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
", + "error":{"httpStatusCode":403}, + "exception":true + }, "AccessPoliciesStatus":{ "type":"structure", "required":[ @@ -516,6 +648,38 @@ }, "documentation":"Specifies the status of advanced security options for the specified Elasticsearch domain.
" }, + "AssociatePackageRequest":{ + "type":"structure", + "required":[ + "PackageID", + "DomainName" + ], + "members":{ + "PackageID":{ + "shape":"PackageID", + "documentation":"Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value.
Name of the domain that you want to associate the package with.
", + "location":"uri", + "locationName":"DomainName" + } + }, + "documentation":" Container for request parameters to AssociatePackage operation.
DomainPackageDetails
Container for response returned by AssociatePackage operation.
A map from an ElasticsearchVersion to a list of compatible ElasticsearchVersion s to which the domain can be upgraded.
An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.
", + "error":{"httpStatusCode":409}, + "exception":true + }, "CreateElasticsearchDomainRequest":{ "type":"structure", "required":["DomainName"], @@ -680,6 +852,44 @@ }, "documentation":"The result of a CreateElasticsearchDomain operation. Contains the status of the newly created Elasticsearch domain.
Unique identifier for the package.
" + }, + "PackageType":{ + "shape":"PackageType", + "documentation":"Type of package. Currently supports only TXT-DICTIONARY.
" + }, + "PackageDescription":{ + "shape":"PackageDescription", + "documentation":"Description of the package.
" + }, + "PackageSource":{ + "shape":"PackageSource", + "documentation":"The customer S3 location PackageSource for importing the package.
Container for request parameters to CreatePackage operation.
Information about the package PackageDetails.
Container for response returned by CreatePackage operation.
The result of a DeleteElasticsearchDomain request. Contains the status of the pending deletion, or no status if the domain and all of its resources have been deleted.
Internal ID of the package that you want to delete. Use DescribePackages to find this value.
Container for request parameters to DeletePackage operation.
PackageDetails
Container for response parameters to DeletePackage operation.
Container for the parameters received from DescribeElasticsearchInstanceTypeLimits operation.
Any field from PackageDetails.
A list of values for the specified field.
" + } + }, + "documentation":"Filter to apply in DescribePackage response.
A list of DescribePackagesFilter to filter the packages included in a DescribePackages response.
Only returns packages that match the DescribePackagesFilterList values.
Limits results to a maximum number of packages.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
" + } + }, + "documentation":" Container for request parameters to DescribePackage operation.
List of PackageDetails objects.
Container for response returned by DescribePackages operation.
Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value.
Name of the domain that you want to associate the package with.
", + "location":"uri", + "locationName":"DomainName" + } + }, + "documentation":" Container for request parameters to DissociatePackage operation.
DomainPackageDetails
Container for response returned by DissociatePackage operation.
A list of Elasticsearch domain names.
" }, + "DomainPackageDetails":{ + "type":"structure", + "members":{ + "PackageID":{ + "shape":"PackageID", + "documentation":"Internal ID of the package.
" + }, + "PackageName":{ + "shape":"PackageName", + "documentation":"User specified name of the package.
" + }, + "PackageType":{ + "shape":"PackageType", + "documentation":"Currently supports only TXT-DICTIONARY.
" + }, + "LastUpdated":{ + "shape":"LastUpdated", + "documentation":"Timestamp of the most-recent update to the association status.
" + }, + "DomainName":{ + "shape":"DomainName", + "documentation":"Name of the domain you've associated a package with.
" + }, + "DomainPackageStatus":{ + "shape":"DomainPackageStatus", + "documentation":"State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.
" + }, + "ReferencePath":{ + "shape":"ReferencePath", + "documentation":"The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.
" + }, + "ErrorDetails":{ + "shape":"ErrorDetails", + "documentation":"Additional information if the package is in an error state. Null otherwise.
" + } + }, + "documentation":"Information on a package that is associated with a domain.
" + }, + "DomainPackageDetailsList":{ + "type":"list", + "member":{"shape":"DomainPackageDetails"} + }, + "DomainPackageStatus":{ + "type":"string", + "enum":[ + "ASSOCIATING", + "ASSOCIATION_FAILED", + "ACTIVE", + "DISSOCIATING", + "DISSOCIATION_FAILED" + ] + }, "Double":{"type":"double"}, "EBSOptions":{ "type":"structure", @@ -1372,7 +1753,15 @@ "key":{"shape":"String"}, "value":{"shape":"ServiceUrl"} }, + "ErrorDetails":{ + "type":"structure", + "members":{ + "ErrorType":{"shape":"ErrorType"}, + "ErrorMessage":{"shape":"ErrorMessage"} + } + }, "ErrorMessage":{"type":"string"}, + "ErrorType":{"type":"string"}, "GUID":{ "type":"string", "pattern":"\\p{XDigit}{8}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{12}" @@ -1519,6 +1908,7 @@ "max":500, "min":1 }, + "LastUpdated":{"type":"timestamp"}, "LimitExceededException":{ "type":"structure", "members":{ @@ -1564,6 +1954,42 @@ }, "documentation":"The result of a ListDomainNames operation. Contains the names of all Elasticsearch domains owned by this account.
The package for which to list domains.
", + "location":"uri", + "locationName":"PackageID" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"Limits results to a maximum number of domains.
", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
", + "location":"querystring", + "locationName":"nextToken" + } + }, + "documentation":" Container for request parameters to ListDomainsForPackage operation.
List of DomainPackageDetails objects.
Container for response parameters to ListDomainsForPackage operation.
Container for the parameters for response received from ListElasticsearchVersions operation.
The name of the domain for which you want to list associated packages.
", + "location":"uri", + "locationName":"DomainName" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"Limits results to a maximum number of packages.
", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
", + "location":"querystring", + "locationName":"nextToken" + } + }, + "documentation":" Container for request parameters to ListPackagesForDomain operation.
List of DomainPackageDetails objects.
Pagination token that needs to be supplied to the next call to get the next page of results.
" + } + }, + "documentation":" Container for response parameters to ListPackagesForDomain operation.
Provides the current status of the entity.
" }, + "PackageDescription":{ + "type":"string", + "max":1024 + }, + "PackageDetails":{ + "type":"structure", + "members":{ + "PackageID":{ + "shape":"PackageID", + "documentation":"Internal ID of the package.
" + }, + "PackageName":{ + "shape":"PackageName", + "documentation":"User specified name of the package.
" + }, + "PackageType":{ + "shape":"PackageType", + "documentation":"Currently supports only TXT-DICTIONARY.
" + }, + "PackageDescription":{ + "shape":"PackageDescription", + "documentation":"User-specified description of the package.
" + }, + "PackageStatus":{ + "shape":"PackageStatus", + "documentation":"Current state of the package. Values are COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED
" + }, + "CreatedAt":{ + "shape":"CreatedAt", + "documentation":"Timestamp which tells creation date of the package.
" + }, + "ErrorDetails":{ + "shape":"ErrorDetails", + "documentation":"Additional information if the package is in an error state. Null otherwise.
" + } + }, + "documentation":"Basic information about a package.
" + }, + "PackageDetailsList":{ + "type":"list", + "member":{"shape":"PackageDetails"} + }, + "PackageID":{"type":"string"}, + "PackageName":{ + "type":"string", + "max":28, + "min":3, + "pattern":"[a-z][a-z0-9\\-]+" + }, + "PackageSource":{ + "type":"structure", + "members":{ + "S3BucketName":{ + "shape":"S3BucketName", + "documentation":"Name of the bucket containing the package.
" + }, + "S3Key":{ + "shape":"S3Key", + "documentation":"Key (file name) of the package.
" + } + }, + "documentation":"The S3 location for importing the package specified as S3BucketName and S3Key
Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
" + }, + "OptionalDeployment":{ + "shape":"Boolean", + "documentation":"True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate.
The current options of an Elasticsearch domain service software options.
" diff --git a/botocore/data/events/2015-10-07/examples-1.json b/botocore/data/events/2015-10-07/examples-1.json index faff7689..0ea7e3b0 100644 --- a/botocore/data/events/2015-10-07/examples-1.json +++ b/botocore/data/events/2015-10-07/examples-1.json @@ -1,5 +1,5 @@ { - "version":"1.0", - "examples":{ + "version": "1.0", + "examples": { } } diff --git a/botocore/data/firehose/2015-08-04/service-2.json b/botocore/data/firehose/2015-08-04/service-2.json index b7d343d1..daa2f5af 100644 --- a/botocore/data/firehose/2015-08-04/service-2.json +++ b/botocore/data/firehose/2015-08-04/service-2.json @@ -128,7 +128,7 @@ {"shape":"LimitExceededException"}, {"shape":"InvalidKMSResourceException"} ], - "documentation":"Enables server-side encryption (SSE) for the delivery stream.
This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data Firehose first sets the encryption status of the stream to ENABLING, and then to ENABLED. The encryption status of a delivery stream is the Status property in DeliveryStreamEncryptionConfiguration. If the operation fails, the encryption status changes to ENABLING_FAILED. You can continue to read and write data to your delivery stream while the encryption status is ENABLING, but the data is not encrypted. It can take up to 5 seconds after the encryption status changes to ENABLED before all records written to the delivery stream are encrypted. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively.
To check the encryption status of a delivery stream, use DescribeDeliveryStream.
Even if encryption is currently enabled for a delivery stream, you can still invoke this operation on it to change the ARN of the CMK or both its type and ARN. In this case, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement and creates a grant that enables it to use the new CMK to encrypt and decrypt data and to manage the grant.
If a delivery stream already has encryption enabled and then you invoke this operation to change the ARN of the CMK or both its type and ARN and you get ENABLING_FAILED, this only means that the attempt to change the CMK failed. In this case, encryption remains enabled with the old CMK.
If the encryption status of your delivery stream is ENABLING_FAILED, you can invoke this operation again.
You can only enable SSE for a delivery stream that uses DirectPut as its source.
The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour period.
Enables server-side encryption (SSE) for the delivery stream.
This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data Firehose first sets the encryption status of the stream to ENABLING, and then to ENABLED. The encryption status of a delivery stream is the Status property in DeliveryStreamEncryptionConfiguration. If the operation fails, the encryption status changes to ENABLING_FAILED. You can continue to read and write data to your delivery stream while the encryption status is ENABLING, but the data is not encrypted. It can take up to 5 seconds after the encryption status changes to ENABLED before all records written to the delivery stream are encrypted. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively.
To check the encryption status of a delivery stream, use DescribeDeliveryStream.
Even if encryption is currently enabled for a delivery stream, you can still invoke this operation on it to change the ARN of the CMK or both its type and ARN. If you invoke this method to change the CMK, and the old CMK is of type CUSTOMER_MANAGED_CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement. If the new CMK is of type CUSTOMER_MANAGED_CMK, Kinesis Data Firehose creates a grant that enables it to use the new CMK to encrypt and decrypt data and to manage the grant.
If a delivery stream already has encryption enabled and then you invoke this operation to change the ARN of the CMK or both its type and ARN and you get ENABLING_FAILED, this only means that the attempt to change the CMK failed. In this case, encryption remains enabled with the old CMK.
If the encryption status of your delivery stream is ENABLING_FAILED, you can invoke this operation again with a valid CMK. The CMK must be enabled and the key policy mustn't explicitly deny the permission for Kinesis Data Firehose to invoke KMS encrypt and decrypt operations.
You can enable SSE for a delivery stream only if it's a delivery stream that uses DirectPut as its source.
The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour period.
COPY command for Amazon Redshift."
},
- "CopyOptions":{"type":"string"},
+ "CopyOptions":{
+ "type":"string",
+ "max":204800,
+ "min":0,
+ "pattern":".*"
+ },
"CreateDeliveryStreamInput":{
"type":"structure",
"required":["DeliveryStreamName"],
@@ -361,15 +368,15 @@
"members":{
"SchemaConfiguration":{
"shape":"SchemaConfiguration",
- "documentation":"Specifies the AWS Glue Data Catalog table that contains the column information.
" + "documentation":"Specifies the AWS Glue Data Catalog table that contains the column information. This parameter is required if Enabled is set to true.
Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON.
" + "documentation":"Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON. This parameter is required if Enabled is set to true.
Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format.
" + "documentation":"Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format. This parameter is required if Enabled is set to true.
Specifies that you want Kinesis Data Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. Kinesis Data Firehose uses the serializer and deserializer that you specify, in addition to the column information from the AWS Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see Kinesis Data Firehose Record Format Conversion.
" }, - "DataTableColumns":{"type":"string"}, + "DataTableColumns":{ + "type":"string", + "max":204800, + "min":0, + "pattern":".*" + }, "DataTableName":{ "type":"string", - "min":1 + "max":512, + "min":1, + "pattern":".*" }, "DeleteDeliveryStreamInput":{ "type":"structure", @@ -504,10 +518,10 @@ }, "KeyType":{ "shape":"KeyType", - "documentation":"Indicates the type of customer master key (CMK) to use for encryption. The default setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with KeyType set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Kinesis Data Firehose service to use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose manages that grant.
When you invoke StartDeliveryStreamEncryption to change the CMK for a delivery stream that is already encrypted with a customer managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement.
" + "documentation":"Indicates the type of customer master key (CMK) to use for encryption. The default setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with KeyType set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Kinesis Data Firehose service to use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose manages that grant.
When you invoke StartDeliveryStreamEncryption to change the CMK for a delivery stream that is encrypted with a customer managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement.
You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. If a CreateDeliveryStream or StartDeliveryStreamEncryption operation exceeds this limit, Kinesis Data Firehose throws a LimitExceededException.
To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the AWS Key Management Service developer guide.
Used to specify the type and Amazon Resource Name (ARN) of the CMK needed for Server-Side Encryption (SSE).
" + "documentation":"Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
" }, "DeliveryStreamEncryptionStatus":{ "type":"string", @@ -530,6 +544,13 @@ "INVALID_KMS_KEY", "KMS_KEY_NOT_FOUND", "KMS_OPT_IN_REQUIRED", + "CREATE_ENI_FAILED", + "DELETE_ENI_FAILED", + "SUBNET_NOT_FOUND", + "SECURITY_GROUP_NOT_FOUND", + "ENI_ACCESS_DENIED", + "SUBNET_ACCESS_DENIED", + "SECURITY_GROUP_ACCESS_DENIED", "UNKNOWN_ERROR" ] }, @@ -651,7 +672,8 @@ "DestinationId":{ "type":"string", "max":100, - "min":1 + "min":1, + "pattern":"[a-zA-Z0-9-]+" }, "ElasticsearchBufferingHints":{ "type":"structure", @@ -738,6 +760,10 @@ "CloudWatchLoggingOptions":{ "shape":"CloudWatchLoggingOptions", "documentation":"The Amazon CloudWatch logging options for your delivery stream.
" + }, + "VpcConfiguration":{ + "shape":"VpcConfiguration", + "documentation":"The details of the VPC of the Amazon ES destination.
" } }, "documentation":"Describes the configuration of a destination in Amazon ES.
" @@ -792,6 +818,10 @@ "CloudWatchLoggingOptions":{ "shape":"CloudWatchLoggingOptions", "documentation":"The Amazon CloudWatch logging options.
" + }, + "VpcConfigurationDescription":{ + "shape":"VpcConfigurationDescription", + "documentation":"The details of the VPC of the Amazon ES destination.
" } }, "documentation":"The destination description in Amazon ES.
" @@ -855,7 +885,8 @@ "ElasticsearchIndexName":{ "type":"string", "max":80, - "min":1 + "min":1, + "pattern":".*" }, "ElasticsearchIndexRotationPeriod":{ "type":"string", @@ -892,7 +923,8 @@ "ElasticsearchTypeName":{ "type":"string", "max":100, - "min":0 + "min":0, + "pattern":".*" }, "EncryptionConfiguration":{ "type":"structure", @@ -910,7 +942,12 @@ }, "ErrorCode":{"type":"string"}, "ErrorMessage":{"type":"string"}, - "ErrorOutputPrefix":{"type":"string"}, + "ErrorOutputPrefix":{ + "type":"string", + "max":1024, + "min":0, + "pattern":".*" + }, "ExtendedS3DestinationConfiguration":{ "type":"structure", "required":[ @@ -1107,7 +1144,12 @@ "max":600, "min":180 }, - "HECEndpoint":{"type":"string"}, + "HECEndpoint":{ + "type":"string", + "max":2048, + "min":0, + "pattern":".*" + }, "HECEndpointType":{ "type":"string", "enum":[ @@ -1115,7 +1157,12 @@ "Event" ] }, - "HECToken":{"type":"string"}, + "HECToken":{ + "type":"string", + "max":2048, + "min":0, + "pattern":".*" + }, "HiveJsonSerDe":{ "type":"structure", "members":{ @@ -1134,7 +1181,7 @@ "documentation":"Specifies which deserializer to use. You can choose either the Apache Hive JSON SerDe or the OpenX JSON SerDe. If both are non-null, the server rejects the request.
" } }, - "documentation":"Specifies the deserializer you want to use to convert the format of the input data.
" + "documentation":"Specifies the deserializer you want to use to convert the format of the input data. This parameter is required if Enabled is set to true.
Specifies which serializer to use. You can choose either the ORC SerDe or the Parquet SerDe. If both are non-null, the server rejects the request.
" } }, - "documentation":"Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data before it writes it to Amazon S3.
" + "documentation":"Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true.
Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.
Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3.
" + "documentation":"Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true.
The IDs of the subnets that you want Kinesis Data Firehose to use to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.
The number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.
" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"The ARN of the IAM role that you want the delivery stream to use to create endpoints in the destination VPC.
" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdList", + "documentation":"The IDs of the security groups that you want Kinesis Data Firehose to use when it creates ENIs in the VPC of the Amazon ES destination.
" + } + }, + "documentation":"The details of the VPC of the Amazon ES destination.
" + }, + "VpcConfigurationDescription":{ + "type":"structure", + "required":[ + "SubnetIds", + "RoleARN", + "SecurityGroupIds", + "VpcId" + ], + "members":{ + "SubnetIds":{ + "shape":"SubnetIdList", + "documentation":"The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.
The number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.
" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"The ARN of the IAM role that you want the delivery stream uses to create endpoints in the destination VPC.
" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdList", + "documentation":"The IDs of the security groups that Kinesis Data Firehose uses when it creates ENIs in the VPC of the Amazon ES destination.
" + }, + "VpcId":{ + "shape":"NonEmptyStringWithoutWhitespace", + "documentation":"The ID of the Amazon ES destination's VPC.
" + } + }, + "documentation":"The details of the VPC of the Amazon ES destination.
" } }, "documentation":"Amazon Kinesis Data Firehose is a fully managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon Elasticsearch Service (Amazon ES), Amazon Redshift, and Splunk.
" diff --git a/botocore/data/fms/2018-01-01/examples-1.json b/botocore/data/fms/2018-01-01/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/fms/2018-01-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/fms/2018-01-01/service-2.json b/botocore/data/fms/2018-01-01/service-2.json index df678e7b..dc81eb32 100644 --- a/botocore/data/fms/2018-01-01/service-2.json +++ b/botocore/data/fms/2018-01-01/service-2.json @@ -235,7 +235,7 @@ {"shape":"InternalErrorException"}, {"shape":"InvalidTypeException"} ], - "documentation":"Creates an AWS Firewall Manager policy.
Firewall Manager provides the following types of policies:
A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources
An AWS WAF policy, which contains a rule group and defines which resources are to be protected by that rule group
A security group policy, which manages VPC security groups across your AWS organization.
Each policy is specific to one of the three types. If you want to enforce more than one policy type across accounts, you can create multiple policies. You can create multiple policies for each type.
You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information about subscribing to Shield Advanced, see CreateSubscription.
" + "documentation":"Creates an AWS Firewall Manager policy.
Firewall Manager provides the following types of policies:
A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources
An AWS WAF policy (type WAFV2), which defines rule groups to run first in the corresponding AWS WAF web ACL and rule groups to run last in the web ACL.
An AWS WAF Classic policy (type WAF), which defines a rule group.
A security group policy, which manages VPC security groups across your AWS organization.
Each policy is specific to one of the types. If you want to enforce more than one policy type across accounts, create multiple policies. You can create multiple policies for each type.
You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information about subscribing to Shield Advanced, see CreateSubscription.
" }, "TagResource":{ "name":"TagResource", @@ -294,7 +294,7 @@ "members":{ "AdminAccount":{ "shape":"AWSAccountId", - "documentation":"The AWS account ID to associate with AWS Firewall Manager as the AWS Firewall Manager administrator account. This can be an AWS Organizations master account or a member account. For more information about AWS Organizations and master accounts, see Managing the AWS Accounts in Your Organization.
" + "documentation":"The AWS account ID to associate with AWS Firewall Manager as the AWS Firewall Manager administrator account. This can be an AWS Organizations master account or a member account. For more information about AWS Organizations and master accounts, see Managing the AWS Accounts in Your Organization.
" } } }, @@ -333,7 +333,10 @@ }, "CustomerPolicyScopeIdType":{ "type":"string", - "enum":["ACCOUNT"] + "enum":[ + "ACCOUNT", + "ORG_UNIT" + ] }, "CustomerPolicyScopeMap":{ "type":"map", @@ -687,8 +690,9 @@ }, "ManagedServiceData":{ "type":"string", - "max":1024, - "min":1 + "max":4096, + "min":1, + "pattern":".*" }, "MemberAccounts":{ "type":"list", @@ -753,11 +757,11 @@ }, "IncludeMap":{ "shape":"CustomerPolicyScopeMap", - "documentation":"Specifies the AWS account IDs to include in the policy. If IncludeMap is null, all accounts in the organization in AWS Organizations are included in the policy. If IncludeMap is not null, only values listed in IncludeMap are included in the policy.
The key to the map is ACCOUNT. For example, a valid IncludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]}.
Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to include in the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.
You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, AWS Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap.
You can specify account IDs, OUs, or a combination:
Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}.
Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}.
Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.
Specifies the AWS account IDs to exclude from the policy. The IncludeMap values are evaluated first, with all the appropriate account IDs added to the policy. Then the accounts listed in ExcludeMap are removed, resulting in the final list of accounts to add to the policy.
The key to the map is ACCOUNT. For example, a valid ExcludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]}.
Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to exclude from the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.
You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, AWS Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap.
You can specify account IDs, OUs, or a combination:
Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}.
Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}.
Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.
An AWS Firewall Manager policy.
" @@ -1014,7 +1018,7 @@ }, "ManagedServiceData":{ "shape":"ManagedServiceData", - "documentation":"Details about the service that are specific to the service type, in JSON format. For service type SHIELD_ADVANCED, this is an empty string.
Example: WAF
ManagedServiceData\": \"{\\\"type\\\": \\\"WAF\\\", \\\"ruleGroups\\\": [{\\\"id\\\": \\\"12345678-1bcd-9012-efga-0987654321ab\\\", \\\"overrideAction\\\" : {\\\"type\\\": \\\"COUNT\\\"}}], \\\"defaultAction\\\": {\\\"type\\\": \\\"BLOCK\\\"}}
Example: SECURITY_GROUPS_COMMON
\"SecurityServicePolicyData\":{\"Type\":\"SECURITY_GROUPS_COMMON\",\"ManagedServiceData\":\"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false,\\\"securityGroups\\\":[{\\\"id\\\":\\\" sg-000e55995d61a06bd\\\"}]}\"},\"RemediationEnabled\":false,\"ResourceType\":\"AWS::EC2::NetworkInterface\"}
Example: SECURITY_GROUPS_CONTENT_AUDIT
\"SecurityServicePolicyData\":{\"Type\":\"SECURITY_GROUPS_CONTENT_AUDIT\",\"ManagedServiceData\":\"{\\\"type\\\":\\\"SECURITY_GROUPS_CONTENT_AUDIT\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\" sg-000e55995d61a06bd \\\"}],\\\"securityGroupAction\\\":{\\\"type\\\":\\\"ALLOW\\\"}}\"},\"RemediationEnabled\":false,\"ResourceType\":\"AWS::EC2::NetworkInterface\"}
The security group action for content audit can be ALLOW or DENY. For ALLOW, all in-scope security group rules must be within the allowed range of the policy's security group rules. For DENY, all in-scope security group rules must not contain a value or a range that matches a rule value or range in the policy security group.
Example: SECURITY_GROUPS_USAGE_AUDIT
\"SecurityServicePolicyData\":{\"Type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"ManagedServiceData\":\"{\\\"type\\\":\\\"SECURITY_GROUPS_USAGE_AUDIT\\\",\\\"deleteUnusedSecurityGroups\\\":true,\\\"coalesceRedundantSecurityGroups\\\":true}\"},\"RemediationEnabled\":false,\"Resou rceType\":\"AWS::EC2::SecurityGroup\"}
Details about the service that are specific to the service type, in JSON format. For service type SHIELD_ADVANCED, this is an empty string.
Example: WAFV2
\"ManagedServiceData\": \"{\\\"type\\\":\\\"WAFV2\\\",\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"preProcessRuleGroups\\\":[{\\\"managedRuleGroupIdentifier\\\":null,\\\"ruleGroupArn\\\":\\\"rulegrouparn\\\",\\\"overrideAction\\\":{\\\"type\\\":\\\"COUNT\\\"},\\\"excludedRules\\\":[{\\\"name\\\":\\\"EntityName\\\"}],\\\"ruleGroupType\\\":\\\"RuleGroup\\\"}],\\\"postProcessRuleGroups\\\":[{\\\"managedRuleGroupIdentifier\\\":{\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesAdminProtectionRuleSet\\\",\\\"vendor\\\":\\\"AWS\\\"},\\\"ruleGroupArn\\\":\\\"rulegrouparn\\\",\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"excludedRules\\\":[],\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\"}],\\\"overrideCustomerWebACLAssociation\\\":false}\"
Example: WAF Classic
\"ManagedServiceData\": \"{\\\"type\\\": \\\"WAF\\\", \\\"ruleGroups\\\": [{\\\"id\\\": \\\"12345678-1bcd-9012-efga-0987654321ab\\\", \\\"overrideAction\\\" : {\\\"type\\\": \\\"COUNT\\\"}}], \\\"defaultAction\\\": {\\\"type\\\": \\\"BLOCK\\\"}}
Example: SECURITY_GROUPS_COMMON
\"SecurityServicePolicyData\":{\"Type\":\"SECURITY_GROUPS_COMMON\",\"ManagedServiceData\":\"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false, \\\"applyToAllEC2InstanceENIs\\\":false,\\\"securityGroups\\\":[{\\\"id\\\":\\\" sg-000e55995d61a06bd\\\"}]}\"},\"RemediationEnabled\":false,\"ResourceType\":\"AWS::EC2::NetworkInterface\"}
Example: SECURITY_GROUPS_CONTENT_AUDIT
\"SecurityServicePolicyData\":{\"Type\":\"SECURITY_GROUPS_CONTENT_AUDIT\",\"ManagedServiceData\":\"{\\\"type\\\":\\\"SECURITY_GROUPS_CONTENT_AUDIT\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\" sg-000e55995d61a06bd \\\"}],\\\"securityGroupAction\\\":{\\\"type\\\":\\\"ALLOW\\\"}}\"},\"RemediationEnabled\":false,\"ResourceType\":\"AWS::EC2::NetworkInterface\"}
The security group action for content audit can be ALLOW or DENY. For ALLOW, all in-scope security group rules must be within the allowed range of the policy's security group rules. For DENY, all in-scope security group rules must not contain a value or a range that matches a rule value or range in the policy security group.
Example: SECURITY_GROUPS_USAGE_AUDIT
\"SecurityServicePolicyData\":{\"Type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"ManagedServiceData\":\"{\\\"type\\\":\\\"SECURITY_GROUPS_USAGE_AUDIT\\\",\\\"deleteUnusedSecurityGroups\\\":true,\\\"coalesceRedundantSecurityGroups\\\":true}\"},\"RemediationEnabled\":false,\"Resou rceType\":\"AWS::EC2::SecurityGroup\"}
Details about the security service that is being used to protect the resources.
" @@ -1023,6 +1027,7 @@ "type":"string", "enum":[ "WAF", + "WAFV2", "SHIELD_ADVANCED", "SECURITY_GROUPS_COMMON", "SECURITY_GROUPS_CONTENT_AUDIT", diff --git a/botocore/data/frauddetector/2019-11-15/service-2.json b/botocore/data/frauddetector/2019-11-15/service-2.json index 225f69e1..5c40fb61 100644 --- a/botocore/data/frauddetector/2019-11-15/service-2.json +++ b/botocore/data/frauddetector/2019-11-15/service-2.json @@ -68,6 +68,7 @@ "output":{"shape":"CreateModelVersionResult"}, "errors":[ {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], @@ -103,6 +104,22 @@ ], "documentation":"Creates a variable.
" }, + "DeleteDetector":{ + "name":"DeleteDetector", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDetectorRequest"}, + "output":{"shape":"DeleteDetectorResult"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Deletes the detector. Before deleting a detector, you must first delete all detector versions and rule versions associated with the detector.
" + }, "DeleteDetectorVersion":{ "name":"DeleteDetectorVersion", "http":{ @@ -115,9 +132,10 @@ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"} + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"} ], - "documentation":"Deletes the detector version.
" + "documentation":"Deletes the detector version. You cannot delete detector versions that are in ACTIVE status.
Deletes the specified event.
" }, + "DeleteRuleVersion":{ + "name":"DeleteRuleVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRuleVersionRequest"}, + "output":{"shape":"DeleteRuleVersionResult"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Deletes the rule version. You cannot delete a rule version if it is used by an ACTIVE or INACTIVE detector version.
An exception indicating there was a conflict during a delete operation. The following delete operations can cause a conflict exception:
DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.
DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.
DeleteRuleVersion: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.
The model versions to include in the detector version.
" + }, + "ruleExecutionMode":{ + "shape":"RuleExecutionMode", + "documentation":"The rule execution mode for the rules included in the detector version.
You can define and edit the rule mode at the detector version level, when it is in draft status.
If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.
If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules.
The default behavior is FIRST_MATCHED.
The ID of the detector to delete.
" + } + } + }, + "DeleteDetectorResult":{ + "type":"structure", + "members":{ + } + }, "DeleteDetectorVersionRequest":{ "type":"structure", "required":[ @@ -800,6 +862,33 @@ "members":{ } }, + "DeleteRuleVersionRequest":{ + "type":"structure", + "required":[ + "detectorId", + "ruleId", + "ruleVersion" + ], + "members":{ + "detectorId":{ + "shape":"identifier", + "documentation":"The ID of the detector that includes the rule version to delete.
" + }, + "ruleId":{ + "shape":"identifier", + "documentation":"The rule ID of the rule version to delete.
" + }, + "ruleVersion":{ + "shape":"nonEmptyString", + "documentation":"The rule version to delete.
" + } + } + }, + "DeleteRuleVersionResult":{ + "type":"structure", + "members":{ + } + }, "DescribeDetectorRequest":{ "type":"structure", "required":["detectorId"], @@ -1059,6 +1148,10 @@ "createdTime":{ "shape":"time", "documentation":"The timestamp when the detector version was created.
" + }, + "ruleExecutionMode":{ + "shape":"RuleExecutionMode", + "documentation":"The execution mode of the rule in the dectector
FIRST_MATCHED indicates that Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.
ALL_MATCHED indicates that Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status.
The model scores for models used in the detector version.
" + }, + "ruleResults":{ + "shape":"ListOfRuleResults", + "documentation":"The rule results in the prediction.
" } } }, @@ -1395,6 +1492,10 @@ "type":"list", "member":{"shape":"ModelVersion"} }, + "ListOfRuleResults":{ + "type":"list", + "member":{"shape":"RuleResult"} + }, "ListOfStrings":{ "type":"list", "member":{"shape":"string"} @@ -1930,10 +2031,31 @@ "type":"list", "member":{"shape":"RuleDetail"} }, + "RuleExecutionMode":{ + "type":"string", + "enum":[ + "ALL_MATCHED", + "FIRST_MATCHED" + ] + }, "RuleList":{ "type":"list", "member":{"shape":"Rule"} }, + "RuleResult":{ + "type":"structure", + "members":{ + "ruleId":{ + "shape":"string", + "documentation":"The rule ID that was matched, based on the rule execution mode.
" + }, + "outcomes":{ + "shape":"ListOfStrings", + "documentation":"The outcomes of the matched rule, based on the rule execution mode.
" + } + }, + "documentation":"The rule results.
" + }, "RulesMaxResults":{ "type":"integer", "box":true, @@ -2026,6 +2148,10 @@ "modelVersions":{ "shape":"ListOfModelVersions", "documentation":"The model versions to include in the detector version.
" + }, + "ruleExecutionMode":{ + "shape":"RuleExecutionMode", + "documentation":"The rule execution mode to add to the detector.
If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.
If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status.
The default behavior is FIRST_MATCHED.
Creates an Amazon FSx for Lustre data repository task. You use data repository tasks to perform bulk operations between your Amazon FSx file system and its linked data repository. An example of a data repository task is exporting any data and metadata changes, including POSIX metadata, to files, directories, and symbolic links (symlinks) from your FSx file system to its linked data repository. A CreateDataRepositoryTask operation will fail if a data repository is not linked to the FSx file system. To learn more about data repository tasks, see Using Data Repository Tasks. To learn more about linking a data repository to your file system, see Step 1: Create Your Amazon FSx for Lustre File System.
Creates an Amazon FSx for Lustre data repository task. You use data repository tasks to perform bulk operations between your Amazon FSx file system and its linked data repository. An example of a data repository task is exporting any data and metadata changes, including POSIX metadata, to files, directories, and symbolic links (symlinks) from your FSx file system to its linked data repository. A CreateDataRepositoryTask operation will fail if a data repository is not linked to the FSx file system. To learn more about data repository tasks, see Using Data Repository Tasks. To learn more about linking a data repository to your file system, see Setting the Export Prefix.
(Optional) The path or paths on the Amazon FSx file system to use when the data repository task is processed. The default path is the file system root directory.
" + "documentation":"(Optional) The path or paths on the Amazon FSx file system to use when the data repository task is processed. The default path is the file system root directory. The paths you provide need to be relative to the mount point of the file system. If the mount point is /mnt/fsx and /mnt/fsx/path1 is a directory or file on the file system you want to export, then the path to provide is path1. If a path that you provide isn't valid, the task fails.
Defines whether or not Amazon FSx provides a CompletionReport once the task has completed. A CompletionReport provides a detailed report on the files that Amazon FSx processed that meet the criteria specified by the Scope parameter.
Defines whether or not Amazon FSx provides a CompletionReport once the task has completed. A CompletionReport provides a detailed report on the files that Amazon FSx processed that meet the criteria specified by the Scope parameter. For more information, see Working with Task Completion Reports.
A list of IDs for the subnets that the file system will be accessible from. Currently, you can specify only one subnet. The file server is also launched in that subnet's Availability Zone.
" + "documentation":"Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID property.
For Windows SINGLE_AZ_1 and SINGLE_AZ_2 deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.
A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups apply to all network interfaces. This value isn't returned in later describe requests.
" + "documentation":"A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups apply to all network interfaces. This value isn't returned in later DescribeFileSystem requests.
" }, "Tags":{ "shape":"Tags", @@ -621,6 +622,10 @@ "WindowsConfiguration":{ "shape":"CreateFileSystemWindowsConfiguration", "documentation":"The configuration for this Microsoft Windows file system.
" + }, + "StorageType":{ + "shape":"StorageType", + "documentation":"Sets the storage type for the Windows file system you're creating from a backup. Valid values are SSD and HDD.
Set to SSD to use solid state drive storage. Supported on all Windows deployment types.
Set to HDD to use hard disk drive storage. Supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types.
Default value is SSD.
HDD and SSD storage types have different minimum storage capacity requirements. A restored file system's storage capacity is tied to the file system that was backed up. You can create a file system that uses HDD storage from a backup of a file system that used SSD storage only if the original SSD file system had a storage capacity of at least 2000 GiB.
The request object for the CreateFileSystemFromBackup operation.
(Optional) For the PERSISTENT_1 deployment type, describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB. File system throughput capacity is calculated by multiplying file system storage capacity (TiB) by the PerUnitStorageThroughput (MB/s/TiB). For a 2.4 TiB file system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput yields 120 MB/s of file system throughput. You pay for the amount of throughput that you provision. (Default = 200 MB/s/TiB)
Valid values are 50, 100, 200.
" + "documentation":" Required for the PERSISTENT_1 deployment type, describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB. File system throughput capacity is calculated by multiplying file system storage capacity (TiB) by the PerUnitStorageThroughput (MB/s/TiB). For a 2.4 TiB file system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput yields 117 MB/s of file system throughput. You pay for the amount of throughput that you provision.
Valid values are 50, 100, 200.
" } }, - "documentation":"The Lustre configuration for the file system being created. This value is required if FileSystemType is set to LUSTRE.
The Lustre configuration for the file system being created.
" }, "CreateFileSystemRequest":{ "type":"structure", @@ -684,11 +689,15 @@ }, "StorageCapacity":{ "shape":"StorageCapacity", - "documentation":"The storage capacity of the file system being created.
For Windows file systems, valid values are 32 GiB - 65,536 GiB.
For SCRATCH_1 Lustre file systems, valid values are 1,200, 2,400, 3,600, then continuing in increments of 3600 GiB. For SCRATCH_2 and PERSISTENT_1 file systems, valid values are 1200, 2400, then continuing in increments of 2400 GiB.
Sets the storage capacity of the file system that you're creating.
For Lustre file systems:
For SCRATCH_2 and PERSISTENT_1 deployment types, valid values are 1.2, 2.4, and increments of 2.4 TiB.
For SCRATCH_1 deployment type, valid values are 1.2, 2.4, and increments of 3.6 TiB.
For Windows file systems:
If StorageType=SSD, valid values are 32 GiB - 65,536 GiB (64 TiB).
If StorageType=HDD, valid values are 2000 GiB - 65,536 GiB (64 TiB).
Sets the storage type for the Amazon FSx for Windows file system you're creating. Valid values are SSD and HDD.
Set to SSD to use solid state drive storage. SSD is supported on all Windows deployment types.
Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types.
Default value is SSD. For more information, see Storage Type Options in the Amazon FSx for Windows User Guide.
Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID property.
For Windows SINGLE_AZ_1 file system deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.
Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID property.
For Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.
The Microsoft Windows configuration for the file system being created. This value is required if FileSystemType is set to WINDOWS.
The Microsoft Windows configuration for the file system being created.
" }, "LustreConfiguration":{"shape":"CreateFileSystemLustreConfiguration"} }, @@ -728,7 +737,7 @@ "SelfManagedActiveDirectoryConfiguration":{"shape":"SelfManagedActiveDirectoryConfiguration"}, "DeploymentType":{ "shape":"WindowsDeploymentType", - "documentation":"Specifies the file system deployment type, valid values are the following:
MULTI_AZ_1 - Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in AWS Regions that have a minimum of three Availability Zones.
SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured for single AZ redundancy.
To learn more about high availability Multi-AZ file systems, see High Availability for Amazon FSx for Windows File Server.
" + "documentation":"Specifies the file system deployment type, valid values are the following:
MULTI_AZ_1 - Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in AWS Regions that have a minimum of three Availability Zones. Also supports HDD storage type
SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured for single AZ redundancy.
SINGLE_AZ_2 - The latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports HDD storage type.
For more information, see Availability and Durability: Single-AZ and Multi-AZ File Systems.
" }, "PreferredSubnetId":{ "shape":"SubnetId", @@ -1208,13 +1217,17 @@ "shape":"StorageCapacity", "documentation":"The storage capacity of the file system in gigabytes (GB).
" }, + "StorageType":{ + "shape":"StorageType", + "documentation":"The storage type of the file system. Valid values are SSD and HDD. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.
The ID of the primary VPC for the file system.
" }, "SubnetIds":{ "shape":"SubnetIds", - "documentation":"The ID of the subnet to contain the endpoint for the file system. One and only one is supported. The file system is launched in the Availability Zone associated with this subnet.
" + "documentation":"Specifies the IDs of the subnets that the file system is accessible from. For Windows MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the PreferredSubnetID property. All other file systems have only one subnet ID.
For Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the endpoint for the file system. For MULTI_AZ_1 Windows file systems, the endpoint for the file system is available in the PreferredSubnetID.
The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems and Amazon FSx for Lustre PERSISTENT_1 file systems at rest. In either case, if not specified, the Amazon FSx managed key is used. The Amazon FSx for Lustre SCRATCH_1 and SCRATCH_2 file systems are always encrypted at rest using Amazon FSx managed keys. For more information, see Encrypt in the AWS Key Management Service API Reference.
The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify AWS resources. We require an ARN when you need to specify a resource unambiguously across all of AWS. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", "max":512, "min":8, - "pattern":"^arn:aws[a-z-]{0,7}:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.-]{0,127}$" + "pattern":"^arn:(?=[^:]+:fsx:[^:]+:\\d{12}:)((|(?=[a-z0-9-.]{1,63})(?!\\d{1,3}(\\.\\d{1,3}){3})(?![^:]*-{2})(?![^:]*-\\.)(?![^:]*\\.-)[a-z0-9].*(?The storage capacity for your Amazon FSx file system, in gibibytes.", "min":0 }, + "StorageType":{ + "type":"string", + "documentation":"The storage type for your Amazon FSx file system.
", + "enum":[ + "SSD", + "HDD" + ] + }, "SubnetId":{ "type":"string", "documentation":"The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.
", @@ -1947,7 +1968,8 @@ "type":"string", "enum":[ "MULTI_AZ_1", - "SINGLE_AZ_1" + "SINGLE_AZ_1", + "SINGLE_AZ_2" ] }, "WindowsFileSystemConfiguration":{ @@ -1960,19 +1982,19 @@ "SelfManagedActiveDirectoryConfiguration":{"shape":"SelfManagedActiveDirectoryAttributes"}, "DeploymentType":{ "shape":"WindowsDeploymentType", - "documentation":"Specifies the file system deployment type, valid values are the following:
MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability.
SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy.
Specifies the file system deployment type, valid values are the following:
MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.
SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.
SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.
For more information, see Single-AZ and Multi-AZ File Systems.
" }, "RemoteAdministrationEndpoint":{ "shape":"DNSName", - "documentation":"For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.
For SINGLE_AZ_1 deployment types, this is the DNS name of the file system.
This endpoint is temporarily unavailable when the file system is undergoing maintenance.
" + "documentation":"For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.
For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.
This endpoint is temporarily unavailable when the file system is undergoing maintenance.
" }, "PreferredSubnetId":{ "shape":"SubnetId", - "documentation":"For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.
For SINGLE_AZ_1 deployment types, this value is the same as that for SubnetIDs.
For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.
For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs. For more information, see Availability and Durability: Single-AZ and Multi-AZ File Systems
For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.
Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for both SINGLE_AZ_1 and MULTI_AZ_1 deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information and instruction on mapping and mounting file shares, see https://docs.aws.amazon.com/fsx/latest/WindowsGuide/accessing-file-shares.html.
For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.
Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares.
" }, "ThroughputCapacity":{ "shape":"MegabytesPerSecond", diff --git a/botocore/data/gamelift/2015-10-01/service-2.json b/botocore/data/gamelift/2015-10-01/service-2.json index 1f0ff2d4..bf9e17b7 100644 --- a/botocore/data/gamelift/2015-10-01/service-2.json +++ b/botocore/data/gamelift/2015-10-01/service-2.json @@ -28,6 +28,24 @@ ], "documentation":"Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches built with that configuration cannot be completed unless all players accept the proposed match within a specified time limit.
When FlexMatch builds a match, all the matchmaking tickets involved in the proposed match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for your game to get acceptance from all players in the ticket. Acceptances are only valid for tickets when they are in this status; all other acceptances result in an error.
To register acceptance, specify the ticket ID, a response, and one or more players. Once all players have registered acceptance, the matchmaking tickets advance to status PLACING, where a new game session is created for the match.
If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed match is dropped. The matchmaking tickets are then handled in one of two ways: For tickets where one or more players rejected the match, the ticket status is returned to SEARCHING to find a new match. For tickets where one or more players failed to respond, the ticket status is set to CANCELLED, and processing is terminated. A new matchmaking request for these players can be submitted as needed.
Learn more
Add FlexMatch to a Game Client
Related operations
" }, + "ClaimGameServer":{ + "name":"ClaimGameServer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ClaimGameServerInput"}, + "output":{"shape":"ClaimGameServerOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"OutOfCapacityException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.
Locates an available game server and temporarily reserves it to host gameplay and players. This action is called by a game client or client service (such as a matchmaker) to request hosting resources for a new game session. In response, GameLift FleetIQ searches for an available game server in the specified game server group, places the game server in \"claimed\" status for 60 seconds, and returns connection information back to the requester so that players can connect to the game server.
There are two ways you can claim a game server. For the first option, you provide a game server group ID only, which prompts GameLift FleetIQ to search for an available game server in the specified group and claim it. With this option, GameLift FleetIQ attempts to consolidate gameplay on as few instances as possible to minimize hosting costs. For the second option, you request a specific game server by its ID. This option results in a less efficient claiming process because it does not take advantage of consolidation and may fail if the requested game server is unavailable.
To claim a game server, identify a game server group and (optionally) a game server ID. If your game requires that game data be provided to the game server at the start of a game, such as a game map or player information, you can provide it in your claim request.
When a game server is successfully claimed, connection information is returned. A claimed game server's utilization status remains AVAILABLE, while the claim status is set to CLAIMED for up to 60 seconds. This time period allows the game server to be prompted to update its status to UTILIZED (using UpdateGameServer). If the game server's status is not updated within 60 seconds, the game server reverts to unclaimed status and is available to be claimed by another request.
If you try to claim a specific game server, this request will fail in the following cases: (1) if the game server utilization status is UTILIZED, (2) if the game server claim status is CLAIMED, or (3) if the instance that the game server is running on is flagged as draining.
Learn more
Related operations
Creates a new Amazon GameLift build record for your game server binary files and points to the location of your game server build files in an Amazon Simple Storage Service (Amazon S3) location.
Game server binaries must be combined into a zip file for use with Amazon GameLift.
To create new builds directly from a file directory, use the AWS CLI command upload-build . This helper command uploads build files and creates a new build record in one step, and automatically handles the necessary permissions.
The CreateBuild operation should be used only in the following scenarios:
To create a new game build with build files that are in an Amazon S3 bucket under your own AWS account. To use this option, you must first give Amazon GameLift access to that Amazon S3 bucket. Then call CreateBuild and specify a build name, operating system, and the Amazon S3 storage location of your game build.
To upload build files directly to Amazon GameLift's Amazon S3 account. To use this option, first call CreateBuild and specify a build name and operating system. This action creates a new build record and returns an Amazon S3 storage location (bucket and key only) and temporary access credentials. Use the credentials to manually upload your build file to the provided storage location (see the Amazon S3 topic Uploading Objects). You can upload build files to the GameLift Amazon S3 location only once.
If successful, this operation creates a new build record with a unique build ID and places it in INITIALIZED status. You can use DescribeBuild to check the status of your build. A build must be in READY status before it can be used to create fleets.
Learn more
Uploading Your Game https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
Create a Build with Files in Amazon S3
Related operations
" + "documentation":"Creates a new Amazon GameLift build resource for your game server binary files. Game server binaries must be combined into a zip file for use with Amazon GameLift.
When setting up a new game build for GameLift, we recommend using the AWS CLI command upload-build . This helper command combines two tasks: (1) it uploads your build files from a file directory to a GameLift Amazon S3 location, and (2) it creates a new build resource.
The CreateBuild operation can used in the following scenarios:
To create a new game build with build files that are in an S3 location under an AWS account that you control. To use this option, you must first give Amazon GameLift access to the S3 bucket. With permissions in place, call CreateBuild and specify a build name, operating system, and the S3 storage location of your game build.
To directly upload your build files to a GameLift S3 location. To use this option, first call CreateBuild and specify a build name and operating system. This action creates a new build resource and also returns an S3 location with temporary access credentials. Use the credentials to manually upload your build files to the specified S3 location. For more information, see Uploading Objects in the Amazon S3 Developer Guide. Build files can be uploaded to the GameLift S3 location once only; that can't be updated.
If successful, this operation creates a new build resource with a unique build ID and places it in INITIALIZED status. A build must be in READY status before you can create fleets with it.
Learn more
Create a Build with Files in Amazon S3
Related operations
" }, "CreateFleet":{ "name":"CreateFleet", @@ -80,7 +98,24 @@ {"shape":"UnauthorizedException"}, {"shape":"TaggingFailedException"} ], - "documentation":"Creates a new fleet to run your game servers. whether they are custom game builds or Realtime Servers with game-specific script. A fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances, each of which can host multiple game sessions. When creating a fleet, you choose the hardware specifications, set some configuration options, and specify the game server to deploy on the new fleet.
To create a new fleet, you must provide the following: (1) a fleet name, (2) an EC2 instance type and fleet type (spot or on-demand), (3) the build ID for your game build or script ID if using Realtime Servers, and (4) a runtime configuration, which determines how game servers will run on each instance in the fleet.
If the CreateFleet call is successful, Amazon GameLift performs the following tasks. You can track the process of a fleet by checking the fleet status or by monitoring fleet creation events:
Creates a fleet record. Status: NEW.
Begins writing events to the fleet event log, which can be accessed in the Amazon GameLift console.
Sets the fleet's target capacity to 1 (desired instances), which triggers Amazon GameLift to start one new EC2 instance.
Downloads the game build or Realtime script to the new instance and installs it. Statuses: DOWNLOADING, VALIDATING, BUILDING.
Starts launching server processes on the instance. If the fleet is configured to run multiple server processes per instance, Amazon GameLift staggers each process launch by a few seconds. Status: ACTIVATING.
Sets the fleet's status to ACTIVE as soon as one server process is ready to host a game session.
Learn more
Related operations
Manage fleet actions:
Creates a new fleet to run your game servers. whether they are custom game builds or Realtime Servers with game-specific script. A fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances, each of which can host multiple game sessions. When creating a fleet, you choose the hardware specifications, set some configuration options, and specify the game server to deploy on the new fleet.
To create a new fleet, provide the following: (1) a fleet name, (2) an EC2 instance type and fleet type (spot or on-demand), (3) the build ID for your game build or script ID if using Realtime Servers, and (4) a runtime configuration, which determines how game servers will run on each instance in the fleet.
If the CreateFleet call is successful, Amazon GameLift performs the following tasks. You can track the process of a fleet by checking the fleet status or by monitoring fleet creation events:
Creates a fleet resource. Status: NEW.
Begins writing events to the fleet event log, which can be accessed in the Amazon GameLift console.
Sets the fleet's target capacity to 1 (desired instances), which triggers Amazon GameLift to start one new EC2 instance.
Downloads the game build or Realtime script to the new instance and installs it. Statuses: DOWNLOADING, VALIDATING, BUILDING.
Starts launching server processes on the instance. If the fleet is configured to run multiple server processes per instance, Amazon GameLift staggers each process launch by a few seconds. Status: ACTIVATING.
Sets the fleet's status to ACTIVE as soon as one server process is ready to host a game session.
Learn more
Related operations
This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.
Creates a GameLift FleetIQ game server group to manage a collection of EC2 instances for game hosting. In addition to creating the game server group, this action also creates an Auto Scaling group in your AWS account and establishes a link between the two groups. You have full control over configuration of the Auto Scaling group, but GameLift FleetIQ routinely certain Auto Scaling group properties in order to optimize the group's instances for low-cost game hosting. You can view the status of your game server groups in the GameLift Console. Game server group metrics and events are emitted to Amazon CloudWatch.
Prior creating a new game server group, you must set up the following:
An EC2 launch template. The template provides configuration settings for a set of EC2 instances and includes the game server build that you want to deploy and run on each instance. For more information on creating a launch template, see Launching an Instance from a Launch Template in the Amazon EC2 User Guide.
An IAM role. The role sets up limited access to your AWS account, allowing GameLift FleetIQ to create and manage the EC2 Auto Scaling group, get instance data, and emit metrics and events to CloudWatch. For more information on setting up an IAM permissions policy with principal access for GameLift, see Specifying a Principal in a Policy in the Amazon S3 Developer Guide.
To create a new game server group, provide a name and specify the IAM role and EC2 launch template. You also need to provide a list of instance types to be used in the group and set initial maximum and minimum limits on the group's instance count. You can optionally set an autoscaling policy with target tracking based on a GameLift FleetIQ metric.
Once the game server group and corresponding Auto Scaling group are created, you have full access to change the Auto Scaling group's configuration as needed. Keep in mind, however, that some properties are periodically updated by GameLift FleetIQ as it balances the group's instances based on availability and cost.
Learn more
Updating a GameLift FleetIQ-Linked Auto Scaling Group
Related operations
Establishes a new queue for processing requests to place new game sessions. A queue identifies where new game sessions can be hosted -- by specifying a list of destinations (fleets or aliases) -- and how long requests can wait in the queue before timing out. You can set up a queue to try to place game sessions on fleets in multiple Regions. To add placement requests to a queue, call StartGameSessionPlacement and reference the queue name.
Destination order. When processing a request for a game session, Amazon GameLift tries each destination in order until it finds one with available resources to host the new game session. A queue's default order is determined by how destinations are listed. The default order is overridden when a game session placement request provides player latency information. Player latency information enables Amazon GameLift to prioritize destinations where players report the lowest average latency, as a result placing the new game session where the majority of players will have the best possible gameplay experience.
Player latency policies. For placement requests containing player latency information, use player latency policies to protect individual players from very high latencies. With a latency cap, even when a destination can deliver a low latency for most players, the game is not placed where any individual player is reporting latency higher than a policy's maximum. A queue can have multiple latency policies, which are enforced consecutively starting with the policy with the lowest latency cap. Use multiple policies to gradually relax latency controls; for example, you might set a policy with a low latency cap for the first 60 seconds, a second policy with a higher cap for the next 60 seconds, etc.
To create a new queue, provide a name, timeout value, a list of destinations and, if desired, a set of latency policies. If successful, a new queue object is returned.
" + "documentation":"Establishes a new queue for processing requests to place new game sessions. A queue identifies where new game sessions can be hosted -- by specifying a list of destinations (fleets or aliases) -- and how long requests can wait in the queue before timing out. You can set up a queue to try to place game sessions on fleets in multiple Regions. To add placement requests to a queue, call StartGameSessionPlacement and reference the queue name.
Destination order. When processing a request for a game session, Amazon GameLift tries each destination in order until it finds one with available resources to host the new game session. A queue's default order is determined by how destinations are listed. The default order is overridden when a game session placement request provides player latency information. Player latency information enables Amazon GameLift to prioritize destinations where players report the lowest average latency, as a result placing the new game session where the majority of players will have the best possible gameplay experience.
Player latency policies. For placement requests containing player latency information, use player latency policies to protect individual players from very high latencies. With a latency cap, even when a destination can deliver a low latency for most players, the game is not placed where any individual player is reporting latency higher than a policy's maximum. A queue can have multiple latency policies, which are enforced consecutively starting with the policy with the lowest latency cap. Use multiple policies to gradually relax latency controls; for example, you might set a policy with a low latency cap for the first 60 seconds, a second policy with a higher cap for the next 60 seconds, etc.
To create a new queue, provide a name, timeout value, a list of destinations and, if desired, a set of latency policies. If successful, a new queue object is returned.
Learn more
Related operations
" }, "CreateMatchmakingConfiguration":{ "name":"CreateMatchmakingConfiguration", @@ -272,7 +307,7 @@ {"shape":"TaggingFailedException"}, {"shape":"InvalidRequestException"} ], - "documentation":"Deletes a build. This action permanently deletes the build record and any uploaded build files.
To delete a build, specify its ID. Deleting a build does not affect the status of any active fleets using the build, but you can no longer create new fleets with the deleted build.
Learn more
Related operations
" + "documentation":"Deletes a build. This action permanently deletes the build resource and any uploaded build files. Deleting a build does not affect the status of any active fleets using the build, but you can no longer create new fleets with the deleted build.
To delete a build, specify the build ID.
Learn more
Related operations
" }, "DeleteFleet":{ "name":"DeleteFleet", @@ -289,7 +324,23 @@ {"shape":"InvalidRequestException"}, {"shape":"TaggingFailedException"} ], - "documentation":"Deletes everything related to a fleet. Before deleting a fleet, you must set the fleet's desired capacity to zero. See UpdateFleetCapacity.
If the fleet being deleted has a VPC peering connection, you first need to get a valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. You do not need to explicitly delete the VPC peering connection--this is done as part of the delete fleet process.
This action removes the fleet's resources and the fleet record. Once a fleet is deleted, you can no longer use that fleet.
Learn more
Related operations
Manage fleet actions:
Deletes everything related to a fleet. Before deleting a fleet, you must set the fleet's desired capacity to zero. See UpdateFleetCapacity.
If the fleet being deleted has a VPC peering connection, you first need to get a valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. You do not need to explicitly delete the VPC peering connection--this is done as part of the delete fleet process.
This action removes the fleet and its resources. Once a fleet is deleted, you can no longer use any of the resource in that fleet.
Learn more
Related operations
This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.
Terminates a game server group and permanently deletes the game server group record. You have several options for how these resources are impacted when deleting the game server group. Depending on the type of delete action selected, this action may affect three types of resources: the game server group, the corresponding Auto Scaling group, and all game servers currently running in the group.
To delete a game server group, identify the game server group to delete and specify the type of delete action to initiate. Game server groups can only be deleted if they are in ACTIVE or ERROR status.
If the delete request is successful, a series of actions are kicked off. The game server group status is changed to DELETE_SCHEDULED, which prevents new game servers from being registered and stops autoscaling activity. Once all game servers in the game server group are de-registered, GameLift FleetIQ can begin deleting resources. If any of the delete actions fail, the game server group is placed in ERROR status.
GameLift FleetIQ emits delete events to Amazon CloudWatch.
Learn more
Related operations
Deletes a game session queue. This action means that any StartGameSessionPlacement requests that reference this queue will fail. To delete a queue, specify the queue name.
" + "documentation":"Deletes a game session queue. This action means that any StartGameSessionPlacement requests that reference this queue will fail. To delete a queue, specify the queue name.
Learn more
Related operations
" }, "DeleteMatchmakingConfiguration":{ "name":"DeleteMatchmakingConfiguration", @@ -405,6 +456,21 @@ ], "documentation":"Removes a VPC peering connection. To delete the connection, you must have a valid authorization for the VPC peering connection that you want to delete. You can check for an authorization by calling DescribeVpcPeeringAuthorizations or request a new one using CreateVpcPeeringAuthorization.
Once a valid authorization exists, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection ID and fleet ID. If successful, the connection is removed.
This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.
Removes the game server resource from the game server group. As a result of this action, the de-registered game server can no longer be claimed and will not returned in a list of active game servers.
To de-register a game server, specify the game server group and game server ID. If successful, this action emits a CloudWatch event with termination time stamp and reason.
Learn more
Related operations
Retrieves properties for a build. To request a build record, specify a build ID. If successful, an object containing the build properties is returned.
Learn more
Related operations
" + "documentation":"Retrieves properties for a custom game build. To request a build resource, specify a build ID. If successful, an object containing the build properties is returned.
Learn more
Related operations
" }, "DescribeEC2InstanceLimits":{ "name":"DescribeEC2InstanceLimits", @@ -450,7 +516,7 @@ {"shape":"InternalServiceException"}, {"shape":"UnauthorizedException"} ], - "documentation":"Retrieves the following information for the specified EC2 instance type:
maximum number of instances allowed per AWS account (service limit)
current usage level for the AWS account
Service limits vary depending on Region. Available Regions for Amazon GameLift can be found in the AWS Management Console for Amazon GameLift (see the drop-down list in the upper right corner).
Learn more
Related operations
Describe fleets:
Update fleets:
Manage fleet actions:
Retrieves the following information for the specified EC2 instance type:
Maximum number of instances allowed per AWS account (service limit).
Current usage for the AWS account.
To learn more about the capabilities of each instance type, see Amazon EC2 Instance Types. Note that the instance types offered may vary depending on the region.
Learn more
Related operations
Retrieves fleet properties, including metadata, status, and configuration, for one or more fleets. You can request attributes for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetAttributes object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.
Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
Learn more
Related operations
Describe fleets:
Manage fleet actions:
Retrieves core properties, including configuration, status, and metadata, for a fleet.
To get attributes for one or more fleets, provide a list of fleet IDs or fleet ARNs. To get attributes for all fleets, do not specify a fleet identifier. When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetAttributes object is returned for each fleet requested, unless the fleet identifier is not found.
Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed number.
Learn more
Related operations
Describe fleets:
Retrieves the current status of fleet capacity for one or more fleets. This information includes the number of instances that have been requested for the fleet and the number currently active. You can request capacity for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetCapacity object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.
Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
Learn more
Related operations
Describe fleets:
Manage fleet actions:
Retrieves the current capacity statistics for one or more fleets. These statistics present a snapshot of the fleet's instances and provide insight on current or imminent scaling activity. To get statistics on game hosting activity in the fleet, see DescribeFleetUtilization.
You can request capacity for all fleets or specify a list of one or more fleet identifiers. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetCapacity object is returned for each requested fleet ID. When a list of fleet IDs is provided, attribute objects are returned only for fleets that currently exist.
Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
Learn more
Related operations
Describe fleets:
Retrieves entries from the specified fleet's event log. You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of event log entries matching the request are returned.
Learn more
Related operations
Describe fleets:
Manage fleet actions:
Retrieves entries from the specified fleet's event log. You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of event log entries matching the request are returned.
Learn more
Related operations
Describe fleets:
Retrieves the inbound connection permissions for a fleet. Connection permissions include a range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. To get a fleet's inbound connection permissions, specify a fleet ID. If successful, a collection of IpPermission objects is returned for the requested fleet ID. If the requested fleet has been deleted, the result set is empty.
Learn more
Related operations
Describe fleets:
Manage fleet actions:
Retrieves a fleet's inbound connection permissions. Connection permissions specify the range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game sessions that are running on instances in the fleet use connections that fall in this range.
To get a fleet's inbound connection permissions, specify the fleet's unique identifier. If successful, a collection of IpPermission objects is returned for the requested fleet ID. If the requested fleet has been deleted, the result set is empty.
Learn more
Related operations
Describe fleets:
Retrieves utilization statistics for one or more fleets. You can request utilization data for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetUtilization object is returned for each requested fleet ID. When specifying a list of fleet IDs, utilization objects are returned only for fleets that currently exist.
Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
Learn more
Related operations
Describe fleets:
Manage fleet actions:
Retrieves utilization statistics for one or more fleets. These statistics provide insight into how available hosting resources are currently being used. To get statistics on available hosting resources, see DescribeFleetCapacity.
You can request utilization data for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetUtilization object is returned for each requested fleet ID, unless the fleet identifier is not found.
Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
Learn more
Related operations
Describe fleets:
This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.
Retrieves information for a game server resource. Information includes the game server statuses, health check info, and the instance the game server is running on.
To retrieve game server information, specify the game server ID. If successful, the requested game server object is returned.
Learn more
Related operations
This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.
Retrieves information on a game server group.
To get attributes for a game server group, provide a group name or ARN value. If successful, a GameServerGroup object is returned.
Learn more
Related operations
Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionQueue object is returned for each requested queue. When specifying a list of queues, objects are returned only for queues that currently exist in the Region.
" + "documentation":"Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionQueue object is returned for each requested queue. When specifying a list of queues, objects are returned only for queues that currently exist in the Region.
Learn more
Related operations
" }, "DescribeGameSessions":{ "name":"DescribeGameSessions", @@ -612,7 +710,7 @@ {"shape":"NotFoundException"}, {"shape":"InternalServiceException"} ], - "documentation":"Retrieves information about a fleet's instances, including instance IDs. Use this action to get details on all instances in the fleet or get details on one specific instance.
To get a specific instance, specify fleet ID and instance ID. To get all instances in a fleet, specify a fleet ID only. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, an Instance object is returned for each result.
" + "documentation":"Retrieves information about a fleet's instances, including instance IDs. Use this action to get details on all instances in the fleet or get details on one specific instance.
To get a specific instance, specify fleet ID and instance ID. To get all instances in a fleet, specify a fleet ID only. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, an Instance object is returned for each result.
Learn more
Remotely Access Fleet Instances
Related operations
" }, "DescribeMatchmaking":{ "name":"DescribeMatchmaking", @@ -690,7 +788,7 @@ {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"} ], - "documentation":"Retrieves the current runtime configuration for the specified fleet. The runtime configuration tells Amazon GameLift how to launch server processes on instances in the fleet.
Learn more
Related operations
Describe fleets:
Manage fleet actions:
Retrieves a fleet's runtime configuration settings. The runtime configuration tells Amazon GameLift which server processes to run (and how) on each instance in the fleet.
To get a runtime configuration, specify the fleet's unique identifier. If successful, a RuntimeConfiguration object is returned for the requested fleet. If the requested fleet has been deleted, the result set is empty.
Learn more
Running Multiple Processes on a Fleet
Related operations
Describe fleets:
Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or watching activity in real time.
Access requires credentials that match the operating system of the instance. For a Windows instance, Amazon GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, Amazon GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a .pem file before using. If you're making this request using the AWS CLI, saving the secret can be handled as part of the GetInstanceAccess request. (See the example later in this topic). For more information on remote access, see Remotely Accessing an Instance.
To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances. If successful, an InstanceAccess object is returned containing the instance's IP address and a set of credentials.
" + "documentation":"Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or observing activity in real time.
To remotely access an instance, you need credentials that match the operating system of the instance. For a Windows instance, Amazon GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, Amazon GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a .pem file before using. If you're making this request using the AWS CLI, saving the secret can be handled as part of the GetInstanceAccess request, as shown in one of the examples for this action.
To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances. If successful, an InstanceAccess object is returned that contains the instance's IP address and a set of credentials.
Learn more
Remotely Access Fleet Instances
Related operations
" }, "ListAliases":{ "name":"ListAliases", @@ -815,7 +913,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalServiceException"} ], - "documentation":"Retrieves build records for all builds associated with the AWS account in use. You can limit results to builds that are in a specific status by using the Status parameter. Use the pagination parameters to retrieve results in a set of sequential pages.
Build records are not listed in any particular order.
Learn more
Related operations
" + "documentation":"Retrieves build resources for all builds associated with the AWS account in use. You can limit results to builds that are in a specific status by using the Status parameter. Use the pagination parameters to retrieve results in a set of sequential pages.
Build resources are not listed in any particular order.
Learn more
Related operations
" }, "ListFleets":{ "name":"ListFleets", @@ -831,7 +929,37 @@ {"shape":"InvalidRequestException"}, {"shape":"UnauthorizedException"} ], - "documentation":"Retrieves a collection of fleet records for this AWS account. You can filter the result set to find only those fleets that are deployed with a specific build or script. Use the pagination parameters to retrieve results in sequential pages.
Fleet records are not listed in a particular order.
Learn more
Related operations
Manage fleet actions:
Retrieves a collection of fleet resources for this AWS account. You can filter the result set to find only those fleets that are deployed with a specific build or script. Use the pagination parameters to retrieve results in sequential pages.
Fleet resources are not listed in a particular order.
Learn more
Related operations
This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.
Retrieves information on all game servers groups that exist in the current AWS account for the selected region. Use the pagination parameters to retrieve results in a set of sequential pages.
Learn more
Related operations
This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.
Retrieves information on all game servers that are currently running in a specified game server group. If there are custom key sort values for your game servers, you can opt to have the returned list sorted based on these values. Use the pagination parameters to retrieve results in a set of sequential pages.
Learn more
Related operations
Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's capacity when a certain threshold is reached. There are two types of scaling policies: target-based and rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this option is the most commonly used. Use rule-based policies when you need to exert fine-grained control over auto-scaling.
Fleets can have multiple scaling policies of each type in force at the same time; you can have one target-based policy, one or multiple rule-based scaling policies, or both. We recommend caution, however, because multiple auto-scaling policies can have unintended consequences.
You can temporarily suspend all scaling policies for a fleet by calling StopFleetActions with the fleet action AUTO_SCALING. To resume scaling policies, call StartFleetActions with the same fleet action. To stop just one scaling policy--or to permanently remove it, you must delete the policy with DeleteScalingPolicy.
Learn more about how to work with auto-scaling in Set Up Fleet Automatic Scaling.
Target-based policy
A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a fleet's hosting capacity is ready to host game sessions but is not currently in use. This is the fleet's buffer; it measures the additional player demand that the fleet could handle at current capacity. With a target-based policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is needed to maintain that target.
For example, you might choose to maintain a 10% buffer for a fleet that has the capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action whenever the fleet's available capacity falls below or rises above 10 game sessions. Amazon GameLift will start new instances or stop unused instances in order to return to the 10% buffer.
To create or update a target-based policy, specify a fleet ID and name, and set the policy type to \"TargetBased\". Specify the metric to track (PercentAvailableGameSessions) and reference a TargetConfiguration object with your desired buffer value. Exclude all other parameters. On a successful request, the policy name is returned. The scaling policy is automatically in force as soon as it's successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.
Rule-based policy
A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies the type of action to initiate when triggered. With a rule-based policy, you can select from several available fleet metrics. Each policy specifies whether to scale up or scale down (and by how much), so you need one policy for each type of action.
For example, a policy may make the following statement: \"If the percentage of idle instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity by 10%.\"
A policy's rule statement has the following structure:
If [MetricName] is [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment].
To implement the example, the rule statement would look like this:
If [PercentIdleInstances] is [GreaterThanThreshold] [20] for [15] minutes, then [PercentChangeInCapacity] to/by [10].
To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the policy type to \"RuleBased\". Specify the parameter values for a policy rule statement. On a successful request, the policy name is returned. Scaling policies are automatically in force as soon as they're successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.
Manage scaling policies:
PutScalingPolicy (auto-scaling)
DescribeScalingPolicies (auto-scaling)
DeleteScalingPolicy (auto-scaling)
Manage fleet actions:
This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.
Creates a new game server resource and notifies GameLift FleetIQ that the game server is ready to host gameplay and players. This action is called by a game server process that is running on an instance in a game server group. Registering game servers enables GameLift FleetIQ to track available game servers and enables game clients and services to claim a game server for a new game session.
To register a game server, identify the game server group and instance where the game server is running, and provide a unique identifier for the game server. You can also include connection and game server data; when a game client or service requests a game server by calling ClaimGameServer, this information is returned in response.
Once a game server is successfully registered, it is put in status AVAILABLE. A request to register a game server may fail if the instance it is in the process of shutting down as part of instance rebalancing or scale-down activity.
Learn more
Related operations
Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see CreateBuild.
To request new credentials, specify the build ID as returned with an initial CreateBuild request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID.
Learn more
Related operations
" + "documentation":"Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see CreateBuild.
To request new credentials, specify the build ID as returned with an initial CreateBuild request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID.
Learn more
Create a Build with Files in S3
Related operations
" }, "ResolveAlias":{ "name":"ResolveAlias", @@ -913,6 +1058,22 @@ ], "documentation":"Retrieves the fleet ID that an alias is currently pointing to.
" }, + "ResumeGameServerGroup":{ + "name":"ResumeGameServerGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResumeGameServerGroupInput"}, + "output":{"shape":"ResumeGameServerGroupOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.
Reinstates activity on a game server group after it has been suspended. A game server group may be suspended by calling SuspendGameServerGroup, or it may have been involuntarily suspended due to a configuration problem. You can manually resume activity on the group once the configuration problem has been resolved. Refer to the game server group status and status reason for more information on why group activity is suspended.
To resume activity, specify a game server group ARN and the type of activity to be resumed.
Learn more
Related operations
Resumes activity on a fleet that was suspended with StopFleetActions. Currently, this operation is used to restart a fleet's auto-scaling activity.
To start fleet actions, specify the fleet ID and the type of actions to restart. When auto-scaling fleet actions are restarted, Amazon GameLift once again initiates scaling events as triggered by the fleet's scaling policies. If actions on the fleet were never stopped, this operation will have no effect. You can view a fleet's stopped actions using DescribeFleetAttributes.
Learn more
Related operations
Describe fleets:
Update fleets:
Manage fleet actions:
Resumes activity on a fleet that was suspended with StopFleetActions. Currently, this operation is used to restart a fleet's auto-scaling activity.
To start fleet actions, specify the fleet ID and the type of actions to restart. When auto-scaling fleet actions are restarted, Amazon GameLift once again initiates scaling events as triggered by the fleet's scaling policies. If actions on the fleet were never stopped, this operation will have no effect. You can view a fleet's stopped actions using DescribeFleetAttributes.
Learn more
Related operations
Suspends activity on a fleet. Currently, this operation is used to stop a fleet's auto-scaling activity. It is used to temporarily stop scaling events triggered by the fleet's scaling policies. The policies can be retained and auto-scaling activity can be restarted using StartFleetActions. You can view a fleet's stopped actions using DescribeFleetAttributes.
To stop fleet actions, specify the fleet ID and the type of actions to suspend. When auto-scaling fleet actions are stopped, Amazon GameLift no longer initiates scaling events except to maintain the fleet's desired instances setting (FleetCapacity. Changes to the fleet's capacity must be done manually using UpdateFleetCapacity.
Learn more
Related operations
Describe fleets:
Update fleets:
Manage fleet actions:
Suspends activity on a fleet. Currently, this operation is used to stop a fleet's auto-scaling activity. It is used to temporarily stop triggering scaling events. The policies can be retained and auto-scaling activity can be restarted using StartFleetActions. You can view a fleet's stopped actions using DescribeFleetAttributes.
To stop fleet actions, specify the fleet ID and the type of actions to suspend. When auto-scaling fleet actions are stopped, Amazon GameLift no longer initiates scaling events except in response to manual changes using UpdateFleetCapacity.
Learn more
Related operations
Cancels a matchmaking ticket or match backfill ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is stopped, and the ticket status is changed to CANCELLED.
This call is also used to turn off automatic backfill for an individual game session. This is for game sessions that are created with a matchmaking configuration that has automatic backfill enabled. The ticket ID is included in the MatchmakerData of an updated game session object, which is provided to the game server.
If the action is successful, the service sends back an empty JSON struct with the HTTP 200 response (not an empty HTTP body).
Learn more
Add FlexMatch to a Game Client
Related operations
" }, + "SuspendGameServerGroup":{ + "name":"SuspendGameServerGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SuspendGameServerGroupInput"}, + "output":{"shape":"SuspendGameServerGroupOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.
Temporarily stops activity on a game server group without terminating instances or the game server group. Activity can be restarted by calling ResumeGameServerGroup. Activities that can suspended are:
Instance type replacement. This activity evaluates the current Spot viability of all instance types that are defined for the game server group. It updates the Auto Scaling group to remove nonviable Spot instance types (which have a higher chance of game server interruptions) and rebalances capacity across the remaining viable Spot instance types. When this activity is suspended, the Auto Scaling group continues with its current balance, regardless of viability. Instance protection, utilization metrics, and capacity autoscaling activities continue to be active.
To suspend activity, specify a game server group ARN and the type of activity to be suspended.
Learn more
Related operations
Assigns a tag to a GameLift resource. AWS resource tags provide an additional management tool set. You can use tags to organize resources, create IAM permissions policies to manage access to groups of resources, customize AWS cost breakdowns, etc. This action handles the permissions necessary to manage tags for the following GameLift resource types:
Build
Script
Fleet
Alias
GameSessionQueue
MatchmakingConfiguration
MatchmakingRuleSet
To add a tag to a resource, specify the unique ARN value for the resource and provide a trig list containing one or more tags. The operation succeeds even if the list includes tags that are already assigned to the specified resource.
Learn more
Tagging AWS Resources in the AWS General Reference
Related operations
" + "documentation":"Assigns a tag to a GameLift resource. AWS resource tags provide an additional management tool set. You can use tags to organize resources, create IAM permissions policies to manage access to groups of resources, customize AWS cost breakdowns, etc. This action handles the permissions necessary to manage tags for the following GameLift resource types:
Build
Script
Fleet
Alias
GameSessionQueue
MatchmakingConfiguration
MatchmakingRuleSet
To add a tag to a resource, specify the unique ARN value for the resource and provide a tag list containing one or more tags. The operation succeeds even if the list includes tags that are already assigned to the specified resource.
Learn more
Tagging AWS Resources in the AWS General Reference
Related operations
" }, "UntagResource":{ "name":"UntagResource", @@ -1104,7 +1281,7 @@ {"shape":"NotFoundException"}, {"shape":"InternalServiceException"} ], - "documentation":"Updates metadata in a build record, including the build name and version. To update the metadata, specify the build ID to update and provide the new values. If successful, a build object containing the updated metadata is returned.
Learn more
Related operations
" + "documentation":"Updates metadata in a build resource, including the build name and version. To update the metadata, specify the build ID to update and provide the new values. If successful, a build object containing the updated metadata is returned.
Learn more
Related operations
" }, "UpdateFleetAttributes":{ "name":"UpdateFleetAttributes", @@ -1123,7 +1300,7 @@ {"shape":"InvalidRequestException"}, {"shape":"UnauthorizedException"} ], - "documentation":"Updates fleet properties, including name and description, for a fleet. To update metadata, specify the fleet ID and the property values that you want to change. If successful, the fleet ID for the updated fleet is returned.
Learn more
Related operations
Update fleets:
Manage fleet actions:
Updates fleet properties, including name and description, for a fleet. To update metadata, specify the fleet ID and the property values that you want to change. If successful, the fleet ID for the updated fleet is returned.
Learn more
Related operations
Update fleets:
Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) that you want this fleet to contain. Before calling this action, you may want to call DescribeEC2InstanceLimits to get the maximum capacity based on the fleet's EC2 instance type.
Specify minimum and maximum number of instances. Amazon GameLift will not change fleet capacity to values fall outside of this range. This is particularly important when using auto-scaling (see PutScalingPolicy) to allow capacity to adjust based on player demand while imposing limits on automatic adjustments.
To update fleet capacity, specify the fleet ID and the number of instances you want the fleet to host. If successful, Amazon GameLift starts or terminates instances so that the fleet's active instance count matches the desired instance count. You can view a fleet's current capacity information by calling DescribeFleetCapacity. If the desired instance count is higher than the instance type's limit, the \"Limit Exceeded\" exception occurs.
Learn more
Related operations
Update fleets:
Manage fleet actions:
Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) that you want this fleet to contain. Before calling this action, you may want to call DescribeEC2InstanceLimits to get the maximum capacity based on the fleet's EC2 instance type.
Specify minimum and maximum number of instances. Amazon GameLift will not change fleet capacity to values fall outside of this range. This is particularly important when using auto-scaling (see PutScalingPolicy) to allow capacity to adjust based on player demand while imposing limits on automatic adjustments.
To update fleet capacity, specify the fleet ID and the number of instances you want the fleet to host. If successful, Amazon GameLift starts or terminates instances so that the fleet's active instance count matches the desired instance count. You can view a fleet's current capacity information by calling DescribeFleetCapacity. If the desired instance count is higher than the instance type's limit, the \"Limit Exceeded\" exception occurs.
Learn more
Related operations
Update fleets:
Updates port settings for a fleet. To update settings, specify the fleet ID to be updated and list the permissions you want to update. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions. If successful, the fleet ID for the updated fleet is returned.
Learn more
Related operations
Update fleets:
Manage fleet actions:
Updates port settings for a fleet. To update settings, specify the fleet ID to be updated and list the permissions you want to update. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions. If successful, the fleet ID for the updated fleet is returned.
Learn more
Related operations
Update fleets:
This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.
Updates information about a registered game server. This action is called by a game server process that is running on an instance in a game server group. There are three reasons to update game server information: (1) to change the utilization status of the game server, (2) to report game server health status, and (3) to change game server metadata. A registered game server should regularly report health and should update utilization status when it is supporting gameplay so that GameLift FleetIQ can accurately track game server availability. You can make all three types of updates in the same request.
To update the game server's utilization status, identify the game server and game server group and specify the current utilization status. Use this status to identify when game servers are currently hosting games and when they are available to be claimed.
To report health status, identify the game server and game server group and set health check to HEALTHY. If a game server does not report health status for a certain length of time, the game server is no longer considered healthy and will be eventually de-registered from the game server group to avoid affecting utilization metrics. The best practice is to report health every 60 seconds.
To change game server metadata, provide updated game server data and custom sort key values.
Once a game server is successfully updated, the relevant statuses and timestamps are updated.
Learn more
Related operations
This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.
Updates GameLift FleetIQ-specific properties for a game server group. These properties include instance rebalancing and game server protection. Many Auto Scaling group properties are updated directly. These include autoscaling policies, minimum/maximum/desired instance counts, and launch template.
To update the game server group, specify the game server group ID and provide the updated values.
Updated properties are validated to ensure that GameLift FleetIQ can continue to perform its core instance rebalancing activity. When you change Auto Scaling group properties directly and the changes cause errors with GameLift FleetIQ activities, an alert is sent.
Learn more
Updating a GameLift FleetIQ-Linked Auto Scaling Group
Related operations
Updates settings for a game session queue, which determines how new game session requests in the queue are processed. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations.
" + "documentation":"Updates settings for a game session queue, which determines how new game session requests in the queue are processed. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations.
Learn more
Related operations
" }, "UpdateMatchmakingConfiguration":{ "name":"UpdateMatchmakingConfiguration", @@ -1228,7 +1437,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InvalidFleetStatusException"} ], - "documentation":"Updates the current runtime configuration for the specified fleet, which tells Amazon GameLift how to launch server processes on instances in the fleet. You can update a fleet's runtime configuration at any time after the fleet is created; it does not need to be in an ACTIVE status.
To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration object with an updated set of server process configurations.
Each instance in a Amazon GameLift fleet checks regularly for an updated runtime configuration and changes how it launches server processes to comply with the latest version. Existing server processes are not affected by the update; runtime configuration changes are applied gradually as existing processes shut down and new processes are launched during Amazon GameLift's normal process recycling activity.
Learn more
Related operations
Update fleets:
Manage fleet actions:
Updates the current runtime configuration for the specified fleet, which tells Amazon GameLift how to launch server processes on instances in the fleet. You can update a fleet's runtime configuration at any time after the fleet is created; it does not need to be in an ACTIVE status.
To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration object with an updated set of server process configurations.
Each instance in a Amazon GameLift fleet checks regularly for an updated runtime configuration and changes how it launches server processes to comply with the latest version. Existing server processes are not affected by the update; runtime configuration changes are applied gradually as existing processes shut down and new processes are launched during Amazon GameLift's normal process recycling activity.
Learn more
Related operations
Update fleets:
A descriptive label that is associated with an alias. Alias names do not need to be unique.
" }, "AliasArn":{ - "shape":"ArnStringModel", - "documentation":"Amazon Resource Name (ARN) that is assigned to a GameLift alias resource and uniquely identifies it. ARNs are unique across all Regions.. In a GameLift alias ARN, the resource ID matches the alias ID value.
" + "shape":"AliasArn", + "documentation":"Amazon Resource Name (ARN) that is assigned to a GameLift alias resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift alias ARN, the resource ID matches the alias ID value.
" }, "Description":{ "shape":"FreeText", @@ -1332,7 +1541,15 @@ }, "documentation":"Properties that describe an alias resource.
" }, + "AliasArn":{ + "type":"string", + "pattern":"^arn:.*:alias\\/alias-\\S+" + }, "AliasId":{ + "type":"string", + "pattern":"^alias-\\S+" + }, + "AliasIdOrArn":{ "type":"string", "pattern":"^alias-\\S+|^arn:.*:alias\\/alias-\\S+" }, @@ -1373,6 +1590,12 @@ }, "documentation":"Values for use in Player attribute key-value pairs. This object lets you specify an attribute value using any of the valid data types: string, number, string array, or data map. Each AttributeValue object can use only one of the available properties.
An identifier for the game server group. When claiming a specific game server, this is the game server group whether the game server is located. When requesting that GameLift FleetIQ locate an available game server, this is the game server group to search on. You can use either the GameServerGroup name or ARN value.
" + }, + "GameServerId":{ + "shape":"GameServerId", + "documentation":"A custom string that uniquely identifies the game server to claim. If this parameter is left empty, GameLift FleetIQ searches for an available game server in the specified game server group.
" + }, + "GameServerData":{ + "shape":"GameServerData", + "documentation":"A set of custom game server properties, formatted as a single string value, to be passed to the claimed game server.
" + } + } + }, + "ClaimGameServerOutput":{ + "type":"structure", + "members":{ + "GameServer":{ + "shape":"GameServer", + "documentation":"Object that describes the newly claimed game server resource.
" + } + } + }, "ComparisonOperatorType":{ "type":"string", "enum":[ @@ -1542,7 +1803,7 @@ }, "StorageLocation":{ "shape":"S3Location", - "documentation":"Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region.
" + "documentation":"Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an S3 bucket that you own. The storage location must specify an S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your S3 bucket. The S3 bucket and your new build must be in the same Region.
" }, "OperatingSystem":{ "shape":"OperatingSystem", @@ -1560,11 +1821,11 @@ "members":{ "Build":{ "shape":"Build", - "documentation":"The newly created build record, including a unique build IDs and status.
" + "documentation":"The newly created build resource, including a unique build IDs and status.
" }, "UploadCredentials":{ "shape":"AwsCredentials", - "documentation":"This element is returned only when the operation is called without a storage location. It contains credentials to use when you are uploading a build file to an Amazon S3 bucket that is owned by Amazon GameLift. Credentials have a limited life span. To refresh these credentials, call RequestUploadCredentials.
" + "documentation":"This element is returned only when the operation is called without a storage location. It contains credentials to use when you are uploading a build file to an S3 bucket that is owned by Amazon GameLift. Credentials have a limited life span. To refresh these credentials, call RequestUploadCredentials.
" }, "StorageLocation":{ "shape":"S3Location", @@ -1589,11 +1850,11 @@ "documentation":"A human-readable description of a fleet.
" }, "BuildId":{ - "shape":"BuildId", + "shape":"BuildIdOrArn", "documentation":"A unique identifier for a build to be deployed on the new fleet. You can use either the build ID or ARN value. The custom game server build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
A unique identifier for a Realtime script to be deployed on the new fleet. You can use either the script ID or ARN value. The Realtime script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.
" }, "ServerLaunchPath":{ @@ -1669,16 +1930,82 @@ }, "documentation":"Represents the returned data in response to a request action.
" }, + "CreateGameServerGroupInput":{ + "type":"structure", + "required":[ + "GameServerGroupName", + "RoleArn", + "MinSize", + "MaxSize", + "LaunchTemplate", + "InstanceDefinitions" + ], + "members":{ + "GameServerGroupName":{ + "shape":"GameServerGroupName", + "documentation":"An identifier for the new game server group. This value is used to generate unique ARN identifiers for the EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name must be unique per Region per AWS account.
" + }, + "RoleArn":{ + "shape":"IamRoleArn", + "documentation":"The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups. The submitted role is validated to ensure that it contains the necessary permissions for game server groups.
" + }, + "MinSize":{ + "shape":"WholeNumber", + "documentation":"The minimum number of instances allowed in the EC2 Auto Scaling group. During autoscaling events, GameLift FleetIQ and EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1.
" + }, + "MaxSize":{ + "shape":"PositiveInteger", + "documentation":"The maximum number of instances allowed in the EC2 Auto Scaling group. During autoscaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum.
" + }, + "LaunchTemplate":{ + "shape":"LaunchTemplateSpecification", + "documentation":"The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. You can specify the template using either the template name or ID. For help with creating a launch template, see Creating a Launch Template for an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
" + }, + "InstanceDefinitions":{ + "shape":"InstanceDefinitions", + "documentation":"A set of EC2 instance types to use when creating instances in the group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide.
" + }, + "AutoScalingPolicy":{ + "shape":"GameServerGroupAutoScalingPolicy", + "documentation":"Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. The scaling policy uses the metric \"PercentUtilizedGameServers\" to maintain a buffer of idle game servers that can immediately accommodate new games and players. Once the game server and Auto Scaling groups are created, you can update the scaling policy settings directly in Auto Scaling Groups.
" + }, + "BalancingStrategy":{ + "shape":"BalancingStrategy", + "documentation":"The fallback balancing method to use for the game server group when Spot instances in a Region become unavailable or are not viable for game hosting. Once triggered, this method remains active until Spot instances can once again be used. Method options include:
SPOT_ONLY -- If Spot instances are unavailable, the game server group provides no hosting capacity. No new instances are started, and the existing nonviable Spot instances are terminated (once current gameplay ends) and not replaced.
SPOT_PREFERRED -- If Spot instances are unavailable, the game server group continues to provide hosting capacity by using On-Demand instances. Existing nonviable Spot instances are terminated (once current gameplay ends) and replaced with new On-Demand instances.
A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running may by terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running. An exception to this is Spot Instances, which may be terminated by AWS regardless of protection status. This property is set to NO_PROTECTION by default.
" + }, + "VpcSubnets":{ + "shape":"VpcSubnets", + "documentation":"A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all GameLift FleetIQ-supported availability zones are used; this parameter allows you to specify VPCs that you've set up.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.
" + } + } + }, + "CreateGameServerGroupOutput":{ + "type":"structure", + "members":{ + "GameServerGroup":{ + "shape":"GameServerGroup", + "documentation":"The newly created game server group object, including the new ARN value for the GameLift FleetIQ game server group and the object's status. The EC2 Auto Scaling group ARN is initially null, since the group has not yet been created. This value is added once the game server group status reaches ACTIVE.
" + } + } + }, "CreateGameSessionInput":{ "type":"structure", "required":["MaximumPlayerSessionCount"], "members":{ "FleetId":{ - "shape":"FleetId", + "shape":"FleetIdOrArn", "documentation":"A unique identifier for a fleet to create a game session in. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.
" }, "AliasId":{ - "shape":"AliasId", + "shape":"AliasIdOrArn", "documentation":"A unique identifier for an alias associated with the fleet to create a game session in. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.
" }, "MaximumPlayerSessionCount":{ @@ -2035,7 +2362,7 @@ "required":["AliasId"], "members":{ "AliasId":{ - "shape":"AliasId", + "shape":"AliasIdOrArn", "documentation":"A unique identifier of the alias that you want to delete. You can use either the alias ID or ARN value.
" } }, @@ -2046,7 +2373,7 @@ "required":["BuildId"], "members":{ "BuildId":{ - "shape":"BuildId", + "shape":"BuildIdOrArn", "documentation":"A unique identifier for a build to delete. You can use either the build ID or ARN value.
" } }, @@ -2057,18 +2384,41 @@ "required":["FleetId"], "members":{ "FleetId":{ - "shape":"FleetId", + "shape":"FleetIdOrArn", "documentation":"A unique identifier for a fleet to be deleted. You can use either the fleet ID or ARN value.
" } }, "documentation":"Represents the input for a request action.
" }, + "DeleteGameServerGroupInput":{ + "type":"structure", + "required":["GameServerGroupName"], + "members":{ + "GameServerGroupName":{ + "shape":"GameServerGroupNameOrArn", + "documentation":"The unique identifier of the game server group to delete. Use either the GameServerGroup name or ARN value.
" + }, + "DeleteOption":{ + "shape":"GameServerGroupDeleteOption", + "documentation":"The type of delete to perform. Options include:
SAFE_DELETE – Terminates the game server group and EC2 Auto Scaling group only when it has no game servers that are in IN_USE status.
FORCE_DELETE – Terminates the game server group, including all active game servers regardless of their utilization status, and the EC2 Auto Scaling group.
RETAIN – Does a safe delete of the game server group but retains the EC2 Auto Scaling group as is.
An object that describes the deleted game server group resource, with status updated to DELETE_SCHEDULED.
" + } + } + }, "DeleteGameSessionQueueInput":{ "type":"structure", "required":["Name"], "members":{ "Name":{ - "shape":"GameSessionQueueName", + "shape":"GameSessionQueueNameOrArn", "documentation":"A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value.
" } }, @@ -2124,7 +2474,7 @@ "documentation":"A descriptive label that is associated with a scaling policy. Policy names do not need to be unique.
" }, "FleetId":{ - "shape":"FleetId", + "shape":"FleetIdOrArn", "documentation":"A unique identifier for a fleet to be deleted. You can use either the fleet ID or ARN value.
" } }, @@ -2135,7 +2485,7 @@ "required":["ScriptId"], "members":{ "ScriptId":{ - "shape":"ScriptId", + "shape":"ScriptIdOrArn", "documentation":"A unique identifier for a Realtime script to delete. You can use either the script ID or ARN value.
" } } @@ -2186,12 +2536,29 @@ "members":{ } }, + "DeregisterGameServerInput":{ + "type":"structure", + "required":[ + "GameServerGroupName", + "GameServerId" + ], + "members":{ + "GameServerGroupName":{ + "shape":"GameServerGroupNameOrArn", + "documentation":"An identifier for the game server group where the game server to be de-registered is running. Use either the GameServerGroup name or ARN value.
" + }, + "GameServerId":{ + "shape":"GameServerId", + "documentation":"The identifier for the game server to be de-registered.
" + } + } + }, "DescribeAliasInput":{ "type":"structure", "required":["AliasId"], "members":{ "AliasId":{ - "shape":"AliasId", + "shape":"AliasIdOrArn", "documentation":"The unique identifier for the fleet alias that you want to retrieve. You can use either the alias ID or ARN value.
" } }, @@ -2212,7 +2579,7 @@ "required":["BuildId"], "members":{ "BuildId":{ - "shape":"BuildId", + "shape":"BuildIdOrArn", "documentation":"A unique identifier for a build to retrieve properties for. You can use either the build ID or ARN value.
" } }, @@ -2252,8 +2619,8 @@ "type":"structure", "members":{ "FleetIds":{ - "shape":"FleetIdList", - "documentation":"A unique identifier for a fleet(s) to retrieve attributes for. You can use either the fleet ID or ARN value.
" + "shape":"FleetIdOrArnList", + "documentation":"A list of unique fleet identifiers to retrieve attributes for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter. If the list of fleet identifiers includes fleets that don't currently exist, the request succeeds but no attributes for that fleet are returned.
" }, "Limit":{ "shape":"PositiveInteger", @@ -2271,7 +2638,7 @@ "members":{ "FleetAttributes":{ "shape":"FleetAttributesList", - "documentation":"A collection of objects containing attribute metadata for each requested fleet ID.
" + "documentation":"A collection of objects containing attribute metadata for each requested fleet ID. Attribute objects are returned only for fleets that currently exist.
" }, "NextToken":{ "shape":"NonZeroAndMaxString", @@ -2284,7 +2651,7 @@ "type":"structure", "members":{ "FleetIds":{ - "shape":"FleetIdList", + "shape":"FleetIdOrArnList", "documentation":"A unique identifier for a fleet(s) to retrieve capacity information for. You can use either the fleet ID or ARN value.
" }, "Limit":{ @@ -2317,7 +2684,7 @@ "required":["FleetId"], "members":{ "FleetId":{ - "shape":"FleetId", + "shape":"FleetIdOrArn", "documentation":"A unique identifier for a fleet to get event logs for. You can use either the fleet ID or ARN value.
" }, "StartTime":{ @@ -2358,7 +2725,7 @@ "required":["FleetId"], "members":{ "FleetId":{ - "shape":"FleetId", + "shape":"FleetIdOrArn", "documentation":"A unique identifier for a fleet to retrieve port settings for. You can use either the fleet ID or ARN value.
" } }, @@ -2378,8 +2745,8 @@ "type":"structure", "members":{ "FleetIds":{ - "shape":"FleetIdList", - "documentation":"A unique identifier for a fleet(s) to retrieve utilization data for. You can use either the fleet ID or ARN value.
" + "shape":"FleetIdOrArnList", + "documentation":"A unique identifier for a fleet(s) to retrieve utilization data for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter. If the list of fleet identifiers includes fleets that don't currently exist, the request succeeds but no attributes for that fleet are returned.
" }, "Limit":{ "shape":"PositiveInteger", @@ -2406,11 +2773,56 @@ }, "documentation":"Represents the returned data in response to a request action.
" }, + "DescribeGameServerGroupInput":{ + "type":"structure", + "required":["GameServerGroupName"], + "members":{ + "GameServerGroupName":{ + "shape":"GameServerGroupNameOrArn", + "documentation":"The unique identifier for the game server group being requested. Use either the GameServerGroup name or ARN value.
" + } + } + }, + "DescribeGameServerGroupOutput":{ + "type":"structure", + "members":{ + "GameServerGroup":{ + "shape":"GameServerGroup", + "documentation":"An object that describes the requested game server group resource.
" + } + } + }, + "DescribeGameServerInput":{ + "type":"structure", + "required":[ + "GameServerGroupName", + "GameServerId" + ], + "members":{ + "GameServerGroupName":{ + "shape":"GameServerGroupNameOrArn", + "documentation":"An identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.
" + }, + "GameServerId":{ + "shape":"GameServerId", + "documentation":"The identifier for the game server to be retrieved.
" + } + } + }, + "DescribeGameServerOutput":{ + "type":"structure", + "members":{ + "GameServer":{ + "shape":"GameServer", + "documentation":"Object that describes the requested game server resource.
" + } + } + }, "DescribeGameSessionDetailsInput":{ "type":"structure", "members":{ "FleetId":{ - "shape":"FleetId", + "shape":"FleetIdOrArn", "documentation":"A unique identifier for a fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.
" }, "GameSessionId":{ @@ -2418,7 +2830,7 @@ "documentation":"A unique identifier for the game session to retrieve.
" }, "AliasId":{ - "shape":"AliasId", + "shape":"AliasIdOrArn", "documentation":"A unique identifier for an alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.
" }, "StatusFilter":{ @@ -2475,7 +2887,7 @@ "type":"structure", "members":{ "Names":{ - "shape":"GameSessionQueueNameList", + "shape":"GameSessionQueueNameOrArnList", "documentation":"A list of queue names to retrieve information for. You can use either the queue ID or ARN value. To request settings for all queues, leave this parameter empty.
" }, "Limit":{ @@ -2507,7 +2919,7 @@ "type":"structure", "members":{ "FleetId":{ - "shape":"FleetId", + "shape":"FleetIdOrArn", "documentation":"A unique identifier for a fleet to retrieve all game sessions for. You can use either the fleet ID or ARN value.
" }, "GameSessionId":{ @@ -2515,7 +2927,7 @@ "documentation":"A unique identifier for the game session to retrieve.
" }, "AliasId":{ - "shape":"AliasId", + "shape":"AliasIdOrArn", "documentation":"A unique identifier for an alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.
" }, "StatusFilter":{ @@ -2552,7 +2964,7 @@ "required":["FleetId"], "members":{ "FleetId":{ - "shape":"FleetId", + "shape":"FleetIdOrArn", "documentation":"A unique identifier for a fleet to retrieve instance information for. You can use either the fleet ID or ARN value.
" }, "InstanceId":{ @@ -2723,7 +3135,7 @@ "required":["FleetId"], "members":{ "FleetId":{ - "shape":"FleetId", + "shape":"FleetIdOrArn", "documentation":"A unique identifier for a fleet to get the runtime configuration for. You can use either the fleet ID or ARN value.
" } }, @@ -2744,7 +3156,7 @@ "required":["FleetId"], "members":{ "FleetId":{ - "shape":"FleetId", + "shape":"FleetIdOrArn", "documentation":"A unique identifier for a fleet to retrieve scaling policies for. You can use either the fleet ID or ARN value.
" }, "StatusFilter":{ @@ -2781,7 +3193,7 @@ "required":["ScriptId"], "members":{ "ScriptId":{ - "shape":"ScriptId", + "shape":"ScriptIdOrArn", "documentation":"A unique identifier for a Realtime script to retrieve properties for. You can use either the script ID or ARN value.
" } } @@ -2882,7 +3294,7 @@ "documentation":"Number of instances in the fleet that are no longer active but haven't yet been terminated.
" } }, - "documentation":"Current status of fleet capacity. The number of active instances should match or be in the process of matching the number of desired instances. Pending and terminating counts are non-zero only if fleet capacity is adjusting to an UpdateFleetCapacity request, or if access to resources is temporarily affected.
Manage fleet actions:
Current status of fleet capacity. The number of active instances should match or be in the process of matching the number of desired instances. Pending and terminating counts are non-zero only if fleet capacity is adjusting to an UpdateFleetCapacity request, or if access to resources is temporarily affected.
The type of event being logged.
Fleet creation events (ordered by fleet creation activity):
FLEET_CREATED -- A fleet record was successfully created with a status of NEW. Event messaging includes the fleet ID.
FLEET_STATE_DOWNLOADING -- Fleet status changed from NEW to DOWNLOADING. The compressed build has started downloading to a fleet instance for installation.
FLEET_BINARY_DOWNLOAD_FAILED -- The build failed to download to the fleet instance.
FLEET_CREATION_EXTRACTING_BUILD – The game server build was successfully downloaded to an instance, and the build files are now being extracted from the uploaded build and saved to an instance. Failure at this stage prevents a fleet from moving to ACTIVE status. Logs for this stage display a list of the files that are extracted and saved on the instance. Access the logs by using the URL in PreSignedLogUrl.
FLEET_CREATION_RUNNING_INSTALLER – The game server build files were successfully extracted, and the Amazon GameLift is now running the build's install script (if one is included). Failure in this stage prevents a fleet from moving to ACTIVE status. Logs for this stage list the installation steps and whether or not the install completed successfully. Access the logs by using the URL in PreSignedLogUrl.
FLEET_CREATION_VALIDATING_RUNTIME_CONFIG -- The build process was successful, and the Amazon GameLift is now verifying that the game server launch paths, which are specified in the fleet's runtime configuration, exist. If any listed launch path exists, Amazon GameLift tries to launch a game server process and waits for the process to report ready. Failures in this stage prevent a fleet from moving to ACTIVE status. Logs for this stage list the launch paths in the runtime configuration and indicate whether each is found. Access the logs by using the URL in PreSignedLogUrl.
FLEET_STATE_VALIDATING -- Fleet status changed from DOWNLOADING to VALIDATING.
FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND -- Validation of the runtime configuration failed because the executable specified in a launch path does not exist on the instance.
FLEET_STATE_BUILDING -- Fleet status changed from VALIDATING to BUILDING.
FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE -- Validation of the runtime configuration failed because the executable specified in a launch path failed to run on the fleet instance.
FLEET_STATE_ACTIVATING -- Fleet status changed from BUILDING to ACTIVATING.
FLEET_ACTIVATION_FAILED - The fleet failed to successfully complete one of the steps in the fleet activation process. This event code indicates that the game build was successfully downloaded to a fleet instance, built, and validated, but was not able to start a server process. Learn more at Debug Fleet Creation Issues
FLEET_STATE_ACTIVE -- The fleet's status changed from ACTIVATING to ACTIVE. The fleet is now ready to host game sessions.
VPC peering events:
FLEET_VPC_PEERING_SUCCEEDED -- A VPC peering connection has been established between the VPC for an Amazon GameLift fleet and a VPC in your AWS account.
FLEET_VPC_PEERING_FAILED -- A requested VPC peering connection has failed. Event details and status information (see DescribeVpcPeeringConnections) provide additional detail. A common reason for peering failure is that the two VPCs have overlapping CIDR blocks of IPv4 addresses. To resolve this, change the CIDR block for the VPC in your AWS account. For more information on VPC peering failures, see https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html
FLEET_VPC_PEERING_DELETED -- A VPC peering connection has been successfully deleted.
Spot instance events:
INSTANCE_INTERRUPTED -- A spot instance was interrupted by EC2 with a two-minute notification.
Other fleet events:
FLEET_SCALING_EVENT -- A change was made to the fleet's capacity settings (desired instances, minimum/maximum scaling limits). Event messaging includes the new capacity settings.
FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED -- A change was made to the fleet's game session protection policy setting. Event messaging includes both the old and new policy setting.
FLEET_DELETED -- A request to delete a fleet was initiated.
GENERIC_EVENT -- An unspecified event has occurred.
The type of event being logged.
Fleet creation events (ordered by fleet creation activity):
FLEET_CREATED -- A fleet resource was successfully created with a status of NEW. Event messaging includes the fleet ID.
FLEET_STATE_DOWNLOADING -- Fleet status changed from NEW to DOWNLOADING. The compressed build has started downloading to a fleet instance for installation.
FLEET_BINARY_DOWNLOAD_FAILED -- The build failed to download to the fleet instance.
FLEET_CREATION_EXTRACTING_BUILD – The game server build was successfully downloaded to an instance, and the build files are now being extracted from the uploaded build and saved to an instance. Failure at this stage prevents a fleet from moving to ACTIVE status. Logs for this stage display a list of the files that are extracted and saved on the instance. Access the logs by using the URL in PreSignedLogUrl.
FLEET_CREATION_RUNNING_INSTALLER – The game server build files were successfully extracted, and the Amazon GameLift is now running the build's install script (if one is included). Failure in this stage prevents a fleet from moving to ACTIVE status. Logs for this stage list the installation steps and whether or not the install completed successfully. Access the logs by using the URL in PreSignedLogUrl.
FLEET_CREATION_VALIDATING_RUNTIME_CONFIG -- The build process was successful, and the Amazon GameLift is now verifying that the game server launch paths, which are specified in the fleet's runtime configuration, exist. If any listed launch path exists, Amazon GameLift tries to launch a game server process and waits for the process to report ready. Failures in this stage prevent a fleet from moving to ACTIVE status. Logs for this stage list the launch paths in the runtime configuration and indicate whether each is found. Access the logs by using the URL in PreSignedLogUrl.
FLEET_STATE_VALIDATING -- Fleet status changed from DOWNLOADING to VALIDATING.
FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND -- Validation of the runtime configuration failed because the executable specified in a launch path does not exist on the instance.
FLEET_STATE_BUILDING -- Fleet status changed from VALIDATING to BUILDING.
FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE -- Validation of the runtime configuration failed because the executable specified in a launch path failed to run on the fleet instance.
FLEET_STATE_ACTIVATING -- Fleet status changed from BUILDING to ACTIVATING.
FLEET_ACTIVATION_FAILED - The fleet failed to successfully complete one of the steps in the fleet activation process. This event code indicates that the game build was successfully downloaded to a fleet instance, built, and validated, but was not able to start a server process. Learn more at Debug Fleet Creation Issues
FLEET_STATE_ACTIVE -- The fleet's status changed from ACTIVATING to ACTIVE. The fleet is now ready to host game sessions.
VPC peering events:
FLEET_VPC_PEERING_SUCCEEDED -- A VPC peering connection has been established between the VPC for an Amazon GameLift fleet and a VPC in your AWS account.
FLEET_VPC_PEERING_FAILED -- A requested VPC peering connection has failed. Event details and status information (see DescribeVpcPeeringConnections) provide additional detail. A common reason for peering failure is that the two VPCs have overlapping CIDR blocks of IPv4 addresses. To resolve this, change the CIDR block for the VPC in your AWS account. For more information on VPC peering failures, see https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html
FLEET_VPC_PEERING_DELETED -- A VPC peering connection has been successfully deleted.
Spot instance events:
INSTANCE_INTERRUPTED -- A spot instance was interrupted by EC2 with a two-minute notification.
Other fleet events:
FLEET_SCALING_EVENT -- A change was made to the fleet's capacity settings (desired instances, minimum/maximum scaling limits). Event messaging includes the new capacity settings.
FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED -- A change was made to the fleet's game session protection policy setting. Event messaging includes both the old and new policy setting.
FLEET_DELETED -- A request to delete a fleet was initiated.
GENERIC_EVENT -- An unspecified event has occurred.
A unique identifier for a fleet.
" }, "FleetArn":{ - "shape":"ArnStringModel", + "shape":"FleetArn", "documentation":"The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift fleet ARN, the resource ID matches the FleetId value.
" }, "FleetType":{ @@ -3147,7 +3563,7 @@ "documentation":"Indicates whether a TLS/SSL certificate was generated for the fleet.
" } }, - "documentation":"General properties describing a fleet.
Manage fleet actions:
General properties describing a fleet.
Current status of fleet capacity.
" } }, - "documentation":"Information about the fleet's capacity. Fleet capacity is measured in EC2 instances. By default, new fleets have a capacity of one instance, but can be updated as needed. The maximum number of instances for a fleet is determined by the fleet's instance type.
Manage fleet actions:
Information about the fleet's capacity. Fleet capacity is measured in EC2 instances. By default, new fleets have a capacity of one instance, but can be updated as needed. The maximum number of instances for a fleet is determined by the fleet's instance type.
The maximum number of players allowed across all game sessions currently being hosted on all instances in the fleet.
" } }, - "documentation":"Current status of fleet utilization, including the number of game and player sessions being hosted.
Manage fleet actions:
Current status of fleet utilization, including the number of game and player sessions being hosted.
The name identifier for the game server group where the game server is located.
" + }, + "GameServerGroupArn":{ + "shape":"GameServerGroupArn", + "documentation":"The ARN identifier for the game server group where the game server is located.
" + }, + "GameServerId":{ + "shape":"GameServerId", + "documentation":"A custom string that uniquely identifies the game server. Game server IDs are developer-defined and are unique across all game server groups in an AWS account.
" + }, + "InstanceId":{ + "shape":"GameServerInstanceId", + "documentation":"The unique identifier for the instance where the game server is located.
" + }, + "ConnectionInfo":{ + "shape":"GameServerConnectionInfo", + "documentation":"The port and IP address that must be used to establish a client connection to the game server.
" + }, + "GameServerData":{ + "shape":"GameServerData", + "documentation":"A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service in response to requests ListGameServers or ClaimGameServer. This property can be updated using UpdateGameServer.
" + }, + "CustomSortKey":{ + "shape":"GameServerSortKey", + "documentation":"A game server tag that can be used to request sorted lists of game servers when calling ListGameServers. Custom sort keys are developer-defined. This property can be updated using UpdateGameServer.
" + }, + "ClaimStatus":{ + "shape":"GameServerClaimStatus", + "documentation":"Indicates when an available game server has been reserved but has not yet started hosting a game. Once it is claimed, game server remains in CLAIMED status for a maximum of one minute. During this time, game clients must connect to the game server and start the game, which triggers the game server to update its utilization status. After one minute, the game server claim status reverts to null.
" + }, + "UtilizationStatus":{ + "shape":"GameServerUtilizationStatus", + "documentation":"Indicates whether the game server is currently available for new games or is busy. Possible statuses include:
AVAILABLE - The game server is available to be claimed. A game server that has been claimed remains in this status until it reports game hosting activity.
IN_USE - The game server is currently hosting a game session with players.
Time stamp indicating when the game server resource was created with a RegisterGameServer request. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
" + }, + "LastClaimTime":{ + "shape":"Timestamp", + "documentation":"Time stamp indicating the last time the game server was claimed with a ClaimGameServer request. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\"). This value is used to calculate when the game server's claim status.
" + }, + "LastHealthCheckTime":{ + "shape":"Timestamp", + "documentation":"Time stamp indicating the last time the game server was updated with health status using an UpdateGameServer request. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\"). After game server registration, this property is only changed when a game server update specifies a health check value.
" + } + }, + "documentation":"This data type is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.
Properties describing a game server resource.
A game server resource is created by a successful call to RegisterGameServer and deleted by calling DeregisterGameServer.
" + }, + "GameServerClaimStatus":{ + "type":"string", + "enum":["CLAIMED"] + }, + "GameServerConnectionInfo":{ + "type":"string", + "max":512, + "min":1, + "pattern":".*\\S.*" + }, + "GameServerData":{ + "type":"string", + "max":1024, + "min":1, + "pattern":".*\\S.*" + }, + "GameServerGroup":{ + "type":"structure", + "members":{ + "GameServerGroupName":{ + "shape":"GameServerGroupName", + "documentation":"A developer-defined identifier for the game server group. The name is unique per Region per AWS account.
" + }, + "GameServerGroupArn":{ + "shape":"GameServerGroupArn", + "documentation":"A generated unique ID for the game server group.
" + }, + "RoleArn":{ + "shape":"IamRoleArn", + "documentation":"The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups. The submitted role is validated to ensure that it contains the necessary permissions for game server groups.
" + }, + "InstanceDefinitions":{ + "shape":"InstanceDefinitions", + "documentation":"The set of EC2 instance types that GameLift FleetIQ can use when rebalancing and autoscaling instances in the group.
" + }, + "BalancingStrategy":{ + "shape":"BalancingStrategy", + "documentation":"The fallback balancing method to use for the game server group when Spot instances in a Region become unavailable or are not viable for game hosting. Once triggered, this method remains active until Spot instances can once again be used. Method options include:
SPOT_ONLY -- If Spot instances are unavailable, the game server group provides no hosting capacity. No new instances are started, and the existing nonviable Spot instances are terminated (once current gameplay ends) and not replaced.
SPOT_PREFERRED -- If Spot instances are unavailable, the game server group continues to provide hosting capacity by using On-Demand instances. Existing nonviable Spot instances are terminated (once current gameplay ends) and replaced with new On-Demand instances.
A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running may be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see DeleteGameServerGroup). An exception to this is Spot Instances, which may be terminated by AWS regardless of protection status.
" + }, + "AutoScalingGroupArn":{ + "shape":"AutoScalingGroupArn", + "documentation":"A generated unique ID for the EC2 Auto Scaling group with is associated with this game server group.
" + }, + "Status":{ + "shape":"GameServerGroupStatus", + "documentation":"The current status of the game server group. Possible statuses include:
NEW - GameLift FleetIQ has validated the CreateGameServerGroup() request.
ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes creating an autoscaling group in your AWS account.
ACTIVE - The game server group has been successfully created.
DELETE_SCHEDULED - A request to delete the game server group has been received.
DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. GameLift FleetIQ must first complete and release hosts before it deletes the autoscaling group and the game server group.
DELETED - The game server group has been successfully deleted.
ERROR - The asynchronous processes of activating or deleting a game server group has failed, resulting in an error state.
Additional information about the current game server group status. This information may provide additional insight on groups that in ERROR status.
" + }, + "SuspendedActions":{ + "shape":"GameServerGroupActions", + "documentation":"A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.
" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
" + }, + "LastUpdatedTime":{ + "shape":"Timestamp", + "documentation":"A time stamp indicating when this game server group was last updated.
" + } + }, + "documentation":"This data type is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.
Properties describing a game server group resource. A game server group manages certain properties of a corresponding EC2 Auto Scaling group.
A game server group is created by a successful call to CreateGameServerGroup and deleted by calling DeleteGameServerGroup. Game server group activity can be temporarily suspended and resumed by calling SuspendGameServerGroup and ResumeGameServerGroup.
" + }, + "GameServerGroupAction":{ + "type":"string", + "enum":["REPLACE_INSTANCE_TYPES"] + }, + "GameServerGroupActions":{ + "type":"list", + "member":{"shape":"GameServerGroupAction"}, + "max":1, + "min":1 + }, + "GameServerGroupArn":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^arn:.*:gameservergroup\\/[a-zA-Z0-9-\\.]*" + }, + "GameServerGroupAutoScalingPolicy":{ + "type":"structure", + "required":["TargetTrackingConfiguration"], + "members":{ + "EstimatedInstanceWarmup":{ + "shape":"PositiveInteger", + "documentation":"Length of time, in seconds, it takes for a new instance to start new game server processes and register with GameLift FleetIQ. Specifying a warm-up time can be useful, particularly with game servers that take a long time to start up, because it avoids prematurely starting new instances
" + }, + "TargetTrackingConfiguration":{ + "shape":"TargetTrackingConfiguration", + "documentation":"Settings for a target-based scaling policy applied to Auto Scaling group. These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric \"PercentUtilizedGameServers\" and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.
" + } + }, + "documentation":"This data type is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.
Configuration settings for intelligent autoscaling that uses target tracking. An autoscaling policy can be specified when a new game server group is created with CreateGameServerGroup. If a group has an autoscaling policy, the Auto Scaling group takes action based on this policy, in addition to (and potentially in conflict with) any other autoscaling policies that are separately applied to the Auto Scaling group.
" + }, + "GameServerGroupDeleteOption":{ + "type":"string", + "enum":[ + "SAFE_DELETE", + "FORCE_DELETE", + "RETAIN" + ] + }, + "GameServerGroupInstanceType":{ + "type":"string", + "enum":[ + "c4.large", + "c4.xlarge", + "c4.2xlarge", + "c4.4xlarge", + "c4.8xlarge", + "c5.large", + "c5.xlarge", + "c5.2xlarge", + "c5.4xlarge", + "c5.9xlarge", + "c5.12xlarge", + "c5.18xlarge", + "c5.24xlarge", + "r4.large", + "r4.xlarge", + "r4.2xlarge", + "r4.4xlarge", + "r4.8xlarge", + "r4.16xlarge", + "r5.large", + "r5.xlarge", + "r5.2xlarge", + "r5.4xlarge", + "r5.8xlarge", + "r5.12xlarge", + "r5.16xlarge", + "r5.24xlarge", + "m4.large", + "m4.xlarge", + "m4.2xlarge", + "m4.4xlarge", + "m4.10xlarge", + "m5.large", + "m5.xlarge", + "m5.2xlarge", + "m5.4xlarge", + "m5.8xlarge", + "m5.12xlarge", + "m5.16xlarge", + "m5.24xlarge" + ] + }, + "GameServerGroupName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9-\\.]+" + }, + "GameServerGroupNameOrArn":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9-\\.]+|^arn:.*:gameservergroup\\/[a-zA-Z0-9-\\.]+" + }, + "GameServerGroupStatus":{ + "type":"string", + "enum":[ + "NEW", + "ACTIVATING", + "ACTIVE", + "DELETE_SCHEDULED", + "DELETING", + "DELETED", + "ERROR" + ] + }, + "GameServerGroups":{ + "type":"list", + "member":{"shape":"GameServerGroup"} + }, + "GameServerHealthCheck":{ + "type":"string", + "enum":["HEALTHY"] + }, + "GameServerId":{ + "type":"string", + "max":128, + "min":3, + "pattern":"[a-zA-Z0-9-\\.]+" + }, + "GameServerInstanceId":{ + "type":"string", + "max":19, + "min":19, + "pattern":"^i-[0-9a-zA-Z]{17}$" + }, + "GameServerProtectionPolicy":{ + "type":"string", + "enum":[ + "NO_PROTECTION", + "FULL_PROTECTION" + ] + }, + "GameServerSortKey":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[a-zA-Z0-9-\\.]+" + }, + "GameServerUtilizationStatus":{ + "type":"string", + "enum":[ + "AVAILABLE", + "UTILIZED" + ] + }, + "GameServers":{ + "type":"list", + "member":{"shape":"GameServer"} + }, "GameSession":{ "type":"structure", "members":{ @@ -3292,7 +3993,7 @@ "documentation":"A unique identifier for a fleet that the game session is running on.
" }, "FleetArn":{ - "shape":"ArnStringModel", + "shape":"FleetArn", "documentation":"The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.
" }, "CreationTime":{ @@ -3516,7 +4217,7 @@ "documentation":"A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
" }, "GameSessionQueueArn":{ - "shape":"ArnStringModel", + "shape":"GameSessionQueueArn", "documentation":"Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift game session queue ARN, the resource ID matches the Name value.
" }, "TimeoutInSeconds":{ @@ -3534,6 +4235,12 @@ }, "documentation":"Configuration of a queue that is used to process game session placement requests. The queue configuration identifies several game features:
The destinations where a new game session can potentially be hosted. Amazon GameLift tries these destinations in an order based on either the queue's default order or player latency information, if provided in a placement request. With latency information, Amazon GameLift can place game sessions where the majority of players are reporting the lowest possible latency.
The length of time that placement requests can wait in the queue before timing out.
A set of optional latency policies that protect individual players from high latencies, preventing game sessions from being placed where any individual player is reporting latency higher than a policy's maximum.
A unique identifier for a fleet that contains the instance you want access to. You can use either the fleet ID or ARN value. The fleet can be in any of the following statuses: ACTIVATING, ACTIVE, or ERROR. Fleets with an ERROR status may be accessible for a short time before they are deleted.
Represents the returned data in response to a request action.
" }, + "IamRoleArn":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^arn:.*:role\\/[\\w+=,.@-]+" + }, "IdStringModel":{ "type":"string", "max":48, @@ -3718,6 +4437,27 @@ "documentation":"Set of credentials required to remotely access a fleet instance. Access credentials are requested by calling GetInstanceAccess and returned in an InstanceAccess object.
", "sensitive":true }, + "InstanceDefinition":{ + "type":"structure", + "required":["InstanceType"], + "members":{ + "InstanceType":{ + "shape":"GameServerGroupInstanceType", + "documentation":"An EC2 instance type designation.
" + }, + "WeightedCapacity":{ + "shape":"WeightedCapacity", + "documentation":"Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. Instance weights are used by GameLift FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see Instance Weighting in the Amazon EC2 Auto Scaling User Guide. Default value is \"1\".
" + } + }, + "documentation":"This data type is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.
An allowed instance type for your game server group. GameLift FleetIQ periodically evaluates each defined instance type for viability. It then updates the Auto Scaling group with the list of viable instance types.
" + }, + "InstanceDefinitions":{ + "type":"list", + "member":{"shape":"InstanceDefinition"}, + "max":20, + "min":2 + }, "InstanceId":{ "type":"string", "pattern":"[a-zA-Z0-9\\.-]+" @@ -3814,6 +4554,42 @@ "key":{"shape":"NonEmptyString"}, "value":{"shape":"PositiveInteger"} }, + "LaunchTemplateId":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]+" + }, + "LaunchTemplateName":{ + "type":"string", + "max":128, + "min":3, + "pattern":"[a-zA-Z0-9\\(\\)\\.\\-/_]+" + }, + "LaunchTemplateSpecification":{ + "type":"structure", + "members":{ + "LaunchTemplateId":{ + "shape":"LaunchTemplateId", + "documentation":"A unique identifier for an existing EC2 launch template.
" + }, + "LaunchTemplateName":{ + "shape":"LaunchTemplateName", + "documentation":"A readable identifier for an existing EC2 launch template.
" + }, + "Version":{ + "shape":"LaunchTemplateVersion", + "documentation":"The version of the EC2 launch template to use. If no version is specified, the default version will be used. EC2 allows you to specify a default version for a launch template, if none is set, the default is the first version created.
" + } + }, + "documentation":"This data type is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.
An EC2 launch template that contains configuration settings and game server code to be deployed to all instances in a game server group.
" + }, + "LaunchTemplateVersion":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]+" + }, "LimitExceededException":{ "type":"structure", "members":{ @@ -3881,7 +4657,7 @@ "members":{ "Builds":{ "shape":"BuildList", - "documentation":"A collection of build records that match the request.
" + "documentation":"A collection of build resources that match the request.
" }, "NextToken":{ "shape":"NonEmptyString", @@ -3894,12 +4670,12 @@ "type":"structure", "members":{ "BuildId":{ - "shape":"BuildId", - "documentation":"A unique identifier for a build to return fleets for. Use this parameter to return only fleets using the specified build. Use either the build ID or ARN value.To retrieve all fleets, leave this parameter empty.
" + "shape":"BuildIdOrArn", + "documentation":"A unique identifier for a build to return fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value. To retrieve all fleets, do not include either a BuildId and ScriptID parameter.
" }, "ScriptId":{ - "shape":"ScriptId", - "documentation":"A unique identifier for a Realtime script to return fleets for. Use this parameter to return only fleets using the specified script. Use either the script ID or ARN value.To retrieve all fleets, leave this parameter empty.
" + "shape":"ScriptIdOrArn", + "documentation":"A unique identifier for a Realtime script to return fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value. To retrieve all fleets, leave this parameter empty.
" }, "Limit":{ "shape":"PositiveInteger", @@ -3926,6 +4702,67 @@ }, "documentation":"Represents the returned data in response to a request action.
" }, + "ListGameServerGroupsInput":{ + "type":"structure", + "members":{ + "Limit":{ + "shape":"PositiveInteger", + "documentation":"The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.
" + } + } + }, + "ListGameServerGroupsOutput":{ + "type":"structure", + "members":{ + "GameServerGroups":{ + "shape":"GameServerGroups", + "documentation":"A collection of game server group objects that match the request.
" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"A token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
" + } + } + }, + "ListGameServersInput":{ + "type":"structure", + "required":["GameServerGroupName"], + "members":{ + "GameServerGroupName":{ + "shape":"GameServerGroupNameOrArn", + "documentation":"An identifier for the game server group for the game server you want to list. Use either the GameServerGroup name or ARN value.
" + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"Indicates how to sort the returned data based on the game servers' custom key sort value. If this parameter is left empty, the list of game servers is returned in no particular order.
" + }, + "Limit":{ + "shape":"PositiveInteger", + "documentation":"The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.
" + } + } + }, + "ListGameServersOutput":{ + "type":"structure", + "members":{ + "GameServers":{ + "shape":"GameServers", + "documentation":"A collection of game server objects that match the request.
" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"A token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
" + } + } + }, "ListScriptsInput":{ "type":"structure", "members":{ @@ -4258,6 +5095,10 @@ "type":"string", "min":1 }, + "NonNegativeDouble":{ + "type":"double", + "min":0 + }, "NonZeroAndMaxString":{ "type":"string", "max":1024, @@ -4279,6 +5120,14 @@ "AMAZON_LINUX_2" ] }, + "OutOfCapacityException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "documentation":"The specified game server group has no available game servers to fulfill a ClaimGameServer request. Clients can retry such requests immediately or after a waiting period.
A unique identifier for a fleet that the player's game session is running on.
" }, "FleetArn":{ - "shape":"ArnStringModel", + "shape":"FleetArn", "documentation":"The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.
" }, "CreationTime":{ @@ -4502,7 +5351,7 @@ "documentation":"A descriptive label that is associated with a scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.
" }, "FleetId":{ - "shape":"FleetId", + "shape":"FleetIdOrArn", "documentation":"A unique identifier for a fleet to apply this policy to. You can use either the fleet ID or ARN value. The fleet cannot be in any of the following statuses: ERROR or DELETING.
" }, "ScalingAdjustment":{ @@ -4554,12 +5403,59 @@ "type":"list", "member":{"shape":"ArnStringModel"} }, + "RegisterGameServerInput":{ + "type":"structure", + "required":[ + "GameServerGroupName", + "GameServerId", + "InstanceId" + ], + "members":{ + "GameServerGroupName":{ + "shape":"GameServerGroupNameOrArn", + "documentation":"An identifier for the game server group where the game server is running. You can use either the GameServerGroup name or ARN value.
" + }, + "GameServerId":{ + "shape":"GameServerId", + "documentation":"A custom string that uniquely identifies the new game server. Game server IDs are developer-defined and must be unique across all game server groups in your AWS account.
" + }, + "InstanceId":{ + "shape":"GameServerInstanceId", + "documentation":"The unique identifier for the instance where the game server is running. This ID is available in the instance metadata.
" + }, + "ConnectionInfo":{ + "shape":"GameServerConnectionInfo", + "documentation":"Information needed to make inbound client connections to the game server. This might include IP address and port, DNS name, etc.
" + }, + "GameServerData":{ + "shape":"GameServerData", + "documentation":"A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on a game servers using ListGameServers or ClaimGameServer.
" + }, + "CustomSortKey":{ + "shape":"GameServerSortKey", + "documentation":"A game server tag that can be used to request sorted lists of game servers using ListGameServers. Custom sort keys are developer-defined based on how you want to organize the retrieved game server information.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"A list of labels to assign to the new game server resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.
" + } + } + }, + "RegisterGameServerOutput":{ + "type":"structure", + "members":{ + "GameServer":{ + "shape":"GameServer", + "documentation":"Object that describes the newly created game server resource.
" + } + } + }, "RequestUploadCredentialsInput":{ "type":"structure", "required":["BuildId"], "members":{ "BuildId":{ - "shape":"BuildId", + "shape":"BuildIdOrArn", "documentation":"A unique identifier for a build to get credentials for. You can use either the build ID or ARN value.
" } }, @@ -4584,7 +5480,7 @@ "required":["AliasId"], "members":{ "AliasId":{ - "shape":"AliasId", + "shape":"AliasIdOrArn", "documentation":"The unique identifier of the alias that you want to retrieve a fleet ID for. You can use either the alias ID or ARN value.
" } }, @@ -4598,7 +5494,7 @@ "documentation":"The fleet identifier that the alias is pointing to.
" }, "FleetArn":{ - "shape":"ArnStringModel", + "shape":"FleetArn", "documentation":"The Amazon Resource Name (ARN) associated with the GameLift fleet resource that this alias points to.
" } }, @@ -4618,6 +5514,32 @@ }, "documentation":"A policy that limits the number of game sessions a player can create on the same fleet. This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: \"An individual player can create a maximum number of new game sessions within a specified time period\".
The policy is evaluated when a player tries to create a new game session. For example: Assume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes.
The unique identifier of the game server group to resume activity on. Use either the GameServerGroup name or ARN value.
" + }, + "ResumeActions":{ + "shape":"GameServerGroupActions", + "documentation":"The action to resume for this game server group.
" + } + } + }, + "ResumeGameServerGroupOutput":{ + "type":"structure", + "members":{ + "GameServerGroup":{ + "shape":"GameServerGroup", + "documentation":"An object that describes the game server group resource, with the SuspendedActions property updated to reflect the resumed activity.
" + } + } + }, "RoutingStrategy":{ "type":"structure", "members":{ @@ -4669,14 +5591,14 @@ "documentation":"The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
A collection of server process configurations that describe what processes to run on each instance in a fleet. Server processes run either a custom game build executable or a Realtime Servers script. Each instance in the fleet starts the specified server processes and continues to start new processes as existing processes end. Each instance regularly checks for an updated runtime configuration.
The runtime configuration enables the instances in a fleet to run multiple processes simultaneously. Learn more about Running Multiple Processes on a Fleet .
A Amazon GameLift instance is limited to 50 processes running simultaneously. To calculate the total number of processes in a runtime configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess object.
Manage fleet actions:
A collection of server process configurations that describe what processes to run on each instance in a fleet. Server processes run either a custom game build executable or a Realtime Servers script. Each instance in the fleet starts the specified server processes and continues to start new processes as existing processes end. Each instance regularly checks for an updated runtime configuration.
The runtime configuration enables the instances in a fleet to run multiple processes simultaneously. Learn more about Running Multiple Processes on a Fleet .
A Amazon GameLift instance is limited to 50 processes running simultaneously. To calculate the total number of processes in a runtime configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess object.
An Amazon S3 bucket identifier. This is the name of the S3 bucket.
" + "documentation":"An S3 bucket identifier. This is the name of the S3 bucket.
" }, "Key":{ "shape":"NonEmptyString", @@ -4691,7 +5613,7 @@ "documentation":"The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved.
" } }, - "documentation":"The location in Amazon S3 where build or script files are stored for access by Amazon GameLift. This location is specified in CreateBuild, CreateScript, and UpdateScript requests.
" + "documentation":"The location in S3 where build or script files are stored for access by Amazon GameLift. This location is specified in CreateBuild, CreateScript, and UpdateScript requests.
" }, "ScalingAdjustmentType":{ "type":"string", @@ -4803,6 +5725,10 @@ "pattern":"^arn:.*:script\\/script-\\S+" }, "ScriptId":{ + "type":"string", + "pattern":"^script-\\S+" + }, + "ScriptIdOrArn":{ "type":"string", "pattern":"^script-\\S+|^arn:.*:script\\/script-\\S+" }, @@ -4814,11 +5740,11 @@ "type":"structure", "members":{ "FleetId":{ - "shape":"FleetId", + "shape":"FleetIdOrArn", "documentation":"A unique identifier for a fleet to search for active game sessions. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.
" }, "AliasId":{ - "shape":"AliasId", + "shape":"AliasIdOrArn", "documentation":"A unique identifier for an alias associated with the fleet to search for active game sessions. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.
" }, "FilterExpression":{ @@ -4888,6 +5814,13 @@ "min":0, "pattern":"[a-zA-Z0-9:_/-]*" }, + "SortOrder":{ + "type":"string", + "enum":[ + "ASCENDING", + "DESCENDING" + ] + }, "StartFleetActionsInput":{ "type":"structure", "required":[ @@ -4896,7 +5829,7 @@ ], "members":{ "FleetId":{ - "shape":"FleetId", + "shape":"FleetIdOrArn", "documentation":"A unique identifier for a fleet to start actions on. You can use either the fleet ID or ARN value.
" }, "Actions":{ @@ -4923,8 +5856,8 @@ "documentation":"A unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all Regions and cannot be reused unless you are resubmitting a canceled or timed-out placement request.
" }, "GameSessionQueueName":{ - "shape":"GameSessionQueueName", - "documentation":"Name of the queue to use to place the new game session. You can use either the qieue name or ARN value.
" + "shape":"GameSessionQueueNameOrArn", + "documentation":"Name of the queue to use to place the new game session. You can use either the queue name or ARN value.
" }, "GameProperties":{ "shape":"GamePropertyList", @@ -5040,7 +5973,7 @@ ], "members":{ "FleetId":{ - "shape":"FleetId", + "shape":"FleetIdOrArn", "documentation":"A unique identifier for a fleet to stop actions on. You can use either the fleet ID or ARN value.
" }, "Actions":{ @@ -5101,6 +6034,32 @@ "member":{"shape":"NonZeroAndMaxString"} }, "StringModel":{"type":"string"}, + "SuspendGameServerGroupInput":{ + "type":"structure", + "required":[ + "GameServerGroupName", + "SuspendActions" + ], + "members":{ + "GameServerGroupName":{ + "shape":"GameServerGroupNameOrArn", + "documentation":"The unique identifier of the game server group to stop activity on. Use either the GameServerGroup name or ARN value.
" + }, + "SuspendActions":{ + "shape":"GameServerGroupActions", + "documentation":"The action to suspend for this game server group.
" + } + } + }, + "SuspendGameServerGroupOutput":{ + "type":"structure", + "members":{ + "GameServerGroup":{ + "shape":"GameServerGroup", + "documentation":"An object that describes the game server group resource, with the SuspendedActions property updated to reflect the suspended activity.
" + } + } + }, "Tag":{ "type":"structure", "required":[ @@ -5182,6 +6141,17 @@ }, "documentation":"Settings for a target-based scaling policy (see ScalingPolicy. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value.
Manage scaling policies:
PutScalingPolicy (auto-scaling)
DescribeScalingPolicies (auto-scaling)
DeleteScalingPolicy (auto-scaling)
Manage fleet actions:
Desired value to use with a game server group target-based scaling policy.
" + } + }, + "documentation":"This data type is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.
Settings for a target-based scaling policy applied to Auto Scaling group. These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric \"PercentUtilizedGameServers\" and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.
" + }, "TerminalRoutingStrategyException":{ "type":"structure", "members":{ @@ -5216,11 +6186,11 @@ "members":{ "ResourceARN":{ "shape":"AmazonResourceName", - "documentation":"The Amazon Resource Name (ARN) that is assigned to and uniquely identifies the GameLift resource that you want to remove tags from. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe action for the resource type.
" + "documentation":"The Amazon Resource Name (ARN) that is assigned to and uniquely identifies the GameLift resource that you want to remove tags from. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe action for the resource type.
" }, "TagKeys":{ "shape":"TagKeyList", - "documentation":"A list of one or more tags to remove from the specified GameLift resource. Tags are developer-defined and structured as key-value pairs.
" + "documentation":"A list of one or more tag keys to remove from the specified GameLift resource. An AWS resource can have only one tag with a specific tag key, so specifying the tag key identifies which tag to remove.
" } } }, @@ -5234,7 +6204,7 @@ "required":["AliasId"], "members":{ "AliasId":{ - "shape":"AliasId", + "shape":"AliasIdOrArn", "documentation":"A unique identifier for the alias that you want to update. You can use either the alias ID or ARN value.
" }, "Name":{ @@ -5267,7 +6237,7 @@ "required":["BuildId"], "members":{ "BuildId":{ - "shape":"BuildId", + "shape":"BuildIdOrArn", "documentation":"A unique identifier for a build to update. You can use either the build ID or ARN value.
" }, "Name":{ @@ -5286,7 +6256,7 @@ "members":{ "Build":{ "shape":"Build", - "documentation":"The updated build record.
" + "documentation":"The updated build resource.
" } }, "documentation":"Represents the returned data in response to a request action.
" @@ -5296,7 +6266,7 @@ "required":["FleetId"], "members":{ "FleetId":{ - "shape":"FleetId", + "shape":"FleetIdOrArn", "documentation":"A unique identifier for a fleet to update attribute metadata for. You can use either the fleet ID or ARN value.
" }, "Name":{ @@ -5337,7 +6307,7 @@ "required":["FleetId"], "members":{ "FleetId":{ - "shape":"FleetId", + "shape":"FleetIdOrArn", "documentation":"A unique identifier for a fleet to update capacity for. You can use either the fleet ID or ARN value.
" }, "DesiredInstances":{ @@ -5370,16 +6340,16 @@ "required":["FleetId"], "members":{ "FleetId":{ - "shape":"FleetId", + "shape":"FleetIdOrArn", "documentation":"A unique identifier for a fleet to update port settings for. You can use either the fleet ID or ARN value.
" }, "InboundPermissionAuthorizations":{ "shape":"IpPermissionsList", - "documentation":"A collection of port settings to be added to the fleet record.
" + "documentation":"A collection of port settings to be added to the fleet resource.
" }, "InboundPermissionRevocations":{ "shape":"IpPermissionsList", - "documentation":"A collection of port settings to be removed from the fleet record.
" + "documentation":"A collection of port settings to be removed from the fleet resource.
" } }, "documentation":"Represents the input for a request action.
" @@ -5394,6 +6364,83 @@ }, "documentation":"Represents the returned data in response to a request action.
" }, + "UpdateGameServerGroupInput":{ + "type":"structure", + "required":["GameServerGroupName"], + "members":{ + "GameServerGroupName":{ + "shape":"GameServerGroupNameOrArn", + "documentation":"The unique identifier of the game server group to update. Use either the GameServerGroup name or ARN value.
" + }, + "RoleArn":{ + "shape":"IamRoleArn", + "documentation":"The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups. The submitted role is validated to ensure that it contains the necessary permissions for game server groups.
" + }, + "InstanceDefinitions":{ + "shape":"InstanceDefinitions", + "documentation":"An updated list of EC2 instance types to use when creating instances in the group. The instance definition must specify instance types that are supported by GameLift FleetIQ, and must include at least two instance types. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide..
" + }, + "GameServerProtectionPolicy":{ + "shape":"GameServerProtectionPolicy", + "documentation":"A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running may by terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running. An exception to this is Spot Instances, which may be terminated by AWS regardless of protection status. This property is set to NO_PROTECTION by default.
" + }, + "BalancingStrategy":{ + "shape":"BalancingStrategy", + "documentation":"The fallback balancing method to use for the game server group when Spot instances in a Region become unavailable or are not viable for game hosting. Once triggered, this method remains active until Spot instances can once again be used. Method options include:
SPOT_ONLY -- If Spot instances are unavailable, the game server group provides no hosting capacity. No new instances are started, and the existing nonviable Spot instances are terminated (once current gameplay ends) and not replaced.
SPOT_PREFERRED -- If Spot instances are unavailable, the game server group continues to provide hosting capacity by using On-Demand instances. Existing nonviable Spot instances are terminated (once current gameplay ends) and replaced with new On-Demand instances.
An object that describes the game server group resource with updated properties.
" + } + } + }, + "UpdateGameServerInput":{ + "type":"structure", + "required":[ + "GameServerGroupName", + "GameServerId" + ], + "members":{ + "GameServerGroupName":{ + "shape":"GameServerGroupNameOrArn", + "documentation":"An identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.
" + }, + "GameServerId":{ + "shape":"GameServerId", + "documentation":"The identifier for the game server to be updated.
" + }, + "GameServerData":{ + "shape":"GameServerData", + "documentation":"A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on a game servers using DescribeGameServer or ClaimGameServer.
" + }, + "CustomSortKey":{ + "shape":"GameServerSortKey", + "documentation":"A game server tag that can be used to request sorted lists of game servers using ListGameServers. Custom sort keys are developer-defined based on how you want to organize the retrieved game server information.
" + }, + "UtilizationStatus":{ + "shape":"GameServerUtilizationStatus", + "documentation":"Indicates whether the game server is available or is currently hosting gameplay.
" + }, + "HealthCheck":{ + "shape":"GameServerHealthCheck", + "documentation":"Indicates health status of the game server. An update that explicitly includes this parameter updates the game server's LastHealthCheckTime time stamp.
" + } + } + }, + "UpdateGameServerOutput":{ + "type":"structure", + "members":{ + "GameServer":{ + "shape":"GameServer", + "documentation":"Object that describes the newly updated game server resource.
" + } + } + }, "UpdateGameSessionInput":{ "type":"structure", "required":["GameSessionId"], @@ -5436,7 +6483,7 @@ "required":["Name"], "members":{ "Name":{ - "shape":"GameSessionQueueName", + "shape":"GameSessionQueueNameOrArn", "documentation":"A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value.
" }, "TimeoutInSeconds":{ @@ -5541,7 +6588,7 @@ ], "members":{ "FleetId":{ - "shape":"FleetId", + "shape":"FleetIdOrArn", "documentation":"A unique identifier for a fleet to update runtime configuration for. You can use either the fleet ID or ARN value.
" }, "RuntimeConfiguration":{ @@ -5566,7 +6613,7 @@ "required":["ScriptId"], "members":{ "ScriptId":{ - "shape":"ScriptId", + "shape":"ScriptIdOrArn", "documentation":"A unique identifier for a Realtime script to update. You can use either the script ID or ARN value.
" }, "Name":{ @@ -5655,7 +6702,7 @@ "documentation":"A unique identifier for a fleet. This ID determines the ID of the Amazon GameLift VPC for your fleet.
" }, "FleetArn":{ - "shape":"ArnStringModel", + "shape":"FleetArn", "documentation":"The Amazon Resource Name (ARN) associated with the GameLift fleet resource for this connection.
" }, "IpV4CidrBlock":{ @@ -5699,6 +6746,24 @@ }, "documentation":"Represents status information for a VPC peering connection. Status is associated with a VpcPeeringConnection object. Status codes and messages are provided from EC2 (see VpcPeeringConnectionStateReason). Connection status information is also communicated as a fleet Event.
" }, + "VpcSubnet":{ + "type":"string", + "max":15, + "min":15, + "pattern":"^subnet-[0-9a-z]{8}$" + }, + "VpcSubnets":{ + "type":"list", + "member":{"shape":"VpcSubnet"}, + "max":20, + "min":1 + }, + "WeightedCapacity":{ + "type":"string", + "max":3, + "min":1, + "pattern":"^[\\u0031-\\u0039][\\u0030-\\u0039]{0,2}$" + }, "WholeNumber":{ "type":"integer", "min":0 @@ -5708,5 +6773,5 @@ "max":5000000 } }, - "documentation":"Amazon GameLift is a managed service for developers who need a scalable, dedicated server solution for their multiplayer games. Use Amazon GameLift for these tasks: (1) set up computing resources and deploy your game servers, (2) run game sessions and get players into games, (3) automatically scale your resources to meet player demand and manage costs, and (4) track in-depth metrics on game server performance and player usage.
When setting up hosting resources, you can deploy your custom game server or use the Amazon GameLift Realtime Servers. Realtime Servers gives you the ability to quickly stand up lightweight, efficient game servers with the core Amazon GameLift infrastructure already built in.
Get Amazon GameLift Tools and Resources
This reference guide describes the low-level service API for Amazon GameLift and provides links to language-specific SDK reference topics. See also Amazon GameLift Tools and Resources.
API Summary
The Amazon GameLift service API includes two key sets of actions:
Manage game sessions and player access -- Integrate this functionality into game client services in order to create new game sessions, retrieve information on existing game sessions; reserve a player slot in a game session, request matchmaking, etc.
Configure and manage game server resources -- Manage your Amazon GameLift hosting resources, including builds, scripts, fleets, queues, and aliases. Set up matchmakers, configure auto-scaling, retrieve game logs, and get hosting and game metrics.
Task-based list of API actions
" + "documentation":"Amazon GameLift provides a range of multiplayer game hosting solutions. As a fully managed service, GameLift helps you:
Set up EC2-based computing resources and use GameLift FleetIQ to and deploy your game servers on low-cost, reliable Spot instances.
Track game server availability and route players into game sessions to minimize latency.
Automatically scale your resources to meet player demand and manage costs
Optionally add FlexMatch matchmaking.
With GameLift as a managed service, you have the option to deploy your custom game server or use Amazon GameLift Realtime Servers to quickly stand up lightweight game servers for your game. Realtime Servers provides an efficient game server framework with core Amazon GameLift infrastructure already built in.
Now in Public Preview:
Use GameLift FleetIQ as a standalone feature with EC2 instances and Auto Scaling groups. GameLift FleetIQ provides optimizations that make low-cost Spot instances viable for game hosting. This extension of GameLift FleetIQ gives you access to these optimizations while managing your EC2 instances and Auto Scaling groups within your own AWS account.
Get Amazon GameLift Tools and Resources
This reference guide describes the low-level service API for Amazon GameLift and provides links to language-specific SDK reference topics. See also Amazon GameLift Tools and Resources.
API Summary
The Amazon GameLift service API includes two key sets of actions:
Manage game sessions and player access -- Integrate this functionality into game client services in order to create new game sessions, retrieve information on existing game sessions; reserve a player slot in a game session, request matchmaking, etc.
Configure and manage game server resources -- Manage your Amazon GameLift hosting resources, including builds, scripts, fleets, queues, and aliases. Set up matchmakers, configure auto-scaling, retrieve game logs, and get hosting and game metrics.
Task-based list of API actions
" } diff --git a/botocore/data/globalaccelerator/2018-08-08/service-2.json b/botocore/data/globalaccelerator/2018-08-08/service-2.json index 6afaaf6e..e3a362e9 100644 --- a/botocore/data/globalaccelerator/2018-08-08/service-2.json +++ b/botocore/data/globalaccelerator/2018-08-08/service-2.json @@ -186,7 +186,7 @@ {"shape":"EndpointGroupNotFoundException"}, {"shape":"InternalServiceErrorException"} ], - "documentation":"Describe an endpoint group.
" + "documentation":"Describe an endpoint group. To see an AWS CLI example of describing an endpoint group, scroll down to Example.
" }, "DescribeListener":{ "name":"DescribeListener", @@ -232,7 +232,7 @@ {"shape":"AccessDeniedException"}, {"shape":"InvalidNextTokenException"} ], - "documentation":"Lists the IP address ranges that were specified in calls to ProvisionByoipCidr.
To see an AWS CLI example of listing BYOIP CIDR addresses, scroll down to Example.
" + "documentation":"Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes.
To see an AWS CLI example of listing BYOIP CIDR addresses, scroll down to Example.
" }, "ListEndpointGroups":{ "name":"ListEndpointGroups", @@ -552,9 +552,31 @@ "State":{ "shape":"ByoipCidrState", "documentation":"The state of the address pool.
" + }, + "Events":{ + "shape":"ByoipCidrEvents", + "documentation":"A history of status changes for an IP address range that that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).
" } }, - "documentation":"Information about an IP address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP).
The following describes each BYOIP State that your IP address range can be in.
PENDING_PROVISIONING — You’ve submitted a request to provision an IP address range but it is not yet provisioned with AWS Global Accelerator.
READY — The address range is provisioned with AWS Global Accelerator and can be advertised.
PENDING_ADVERTISING — You’ve submitted a request for AWS Global Accelerator to advertise an address range but it is not yet being advertised.
ADVERTISING — The address range is being advertised by AWS Global Accelerator.
PENDING_WITHDRAWING — You’ve submitted a request to withdraw an address range from being advertised but it is still being advertised by AWS Global Accelerator.
PENDING_DEPROVISIONING — You’ve submitted a request to deprovision an address range from AWS Global Accelerator but it is still provisioned.
DEPROVISIONED — The address range is deprovisioned from AWS Global Accelerator.
FAILED_PROVISION — The request to provision the address range from AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
FAILED_ADVERTISING — The request for AWS Global Accelerator to advertise the address range was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
FAILED_WITHDRAW — The request to withdraw the address range from advertising by AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
FAILED_DEPROVISION — The request to deprovision the address range from AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
Information about an IP address range that is provisioned for use with your AWS resources through bring your own IP address (BYOIP).
The following describes each BYOIP State that your IP address range can be in.
PENDING_PROVISIONING — You’ve submitted a request to provision an IP address range but it is not yet provisioned with AWS Global Accelerator.
READY — The address range is provisioned with AWS Global Accelerator and can be advertised.
PENDING_ADVERTISING — You’ve submitted a request for AWS Global Accelerator to advertise an address range but it is not yet being advertised.
ADVERTISING — The address range is being advertised by AWS Global Accelerator.
PENDING_WITHDRAWING — You’ve submitted a request to withdraw an address range from being advertised but it is still being advertised by AWS Global Accelerator.
PENDING_DEPROVISIONING — You’ve submitted a request to deprovision an address range from AWS Global Accelerator but it is still provisioned.
DEPROVISIONED — The address range is deprovisioned from AWS Global Accelerator.
FAILED_PROVISION — The request to provision the address range from AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
FAILED_ADVERTISING — The request for AWS Global Accelerator to advertise the address range was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
FAILED_WITHDRAW — The request to withdraw the address range from advertising by AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
FAILED_DEPROVISION — The request to deprovision the address range from AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
A string that contains an Event message describing changes that you make in the status of an IP address range that you bring to AWS 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 bring your own IP address (BYOIP).
" + } + }, + "documentation":"A complex type that contains a Message and a Timestamp value for changes that you make in the status an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).
Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.
If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.
For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
" + "documentation":"Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.
If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.
For more information, see Preserve Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
" } }, "documentation":"A complex type for endpoints.
" diff --git a/botocore/data/glue/2017-03-31/examples-1.json b/botocore/data/glue/2017-03-31/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/glue/2017-03-31/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/glue/2017-03-31/service-2.json b/botocore/data/glue/2017-03-31/service-2.json index 78bdb8fa..0b2c5a93 100644 --- a/botocore/data/glue/2017-03-31/service-2.json +++ b/botocore/data/glue/2017-03-31/service-2.json @@ -2934,7 +2934,7 @@ }, "ConnectionProperties":{ "shape":"ConnectionProperties", - "documentation":"These key-value pairs define parameters for the connection:
HOST - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.
PORT - The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.
USER_NAME - The name under which to log in to the database. The value string for USER_NAME is \"USERNAME\".
PASSWORD - A password, if one is used, for the user name.
ENCRYPTED_PASSWORD - When you enable connection password protection by setting ConnectionPasswordEncryption in the Data Catalog encryption settings, this field stores the encrypted password.
JDBC_DRIVER_JAR_URI - The Amazon Simple Storage Service (Amazon S3) path of the JAR file that contains the JDBC driver to use.
JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use.
JDBC_ENGINE - The name of the JDBC engine to use.
JDBC_ENGINE_VERSION - The version of the JDBC engine to use.
CONFIG_FILES - (Reserved for future use.)
INSTANCE_ID - The instance ID to use.
JDBC_CONNECTION_URL - The URL for the JDBC connection.
JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false.
CUSTOM_JDBC_CERT - An Amazon S3 location specifying the customer's root certificate. AWS Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. AWS Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.
SKIP_CUSTOM_JDBC_CERT_VALIDATION - By default, this is false. AWS Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true to skip AWS Glue’s validation of the customer certificate.
CUSTOM_JDBC_CERT_STRING - A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN; in Microsoft SQL Server, this is used as the hostNameInCertificate.
These key-value pairs define parameters for the connection:
HOST - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.
PORT - The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.
USER_NAME - The name under which to log in to the database. The value string for USER_NAME is \"USERNAME\".
PASSWORD - A password, if one is used, for the user name.
ENCRYPTED_PASSWORD - When you enable connection password protection by setting ConnectionPasswordEncryption in the Data Catalog encryption settings, this field stores the encrypted password.
JDBC_DRIVER_JAR_URI - The Amazon Simple Storage Service (Amazon S3) path of the JAR file that contains the JDBC driver to use.
JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use.
JDBC_ENGINE - The name of the JDBC engine to use.
JDBC_ENGINE_VERSION - The version of the JDBC engine to use.
CONFIG_FILES - (Reserved for future use.)
INSTANCE_ID - The instance ID to use.
JDBC_CONNECTION_URL - The URL for connecting to a JDBC data source.
JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false.
CUSTOM_JDBC_CERT - An Amazon S3 location specifying the customer's root certificate. AWS Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. AWS Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.
SKIP_CUSTOM_JDBC_CERT_VALIDATION - By default, this is false. AWS Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true to skip AWS Glue’s validation of the customer certificate.
CUSTOM_JDBC_CERT_STRING - A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN; in Microsoft SQL Server, this is used as the hostNameInCertificate.
CONNECTION_URL - The URL for connecting to a general (non-JDBC) data source.
KAFKA_BOOTSTRAP_SERVERS - A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.
The type of the connection. Currently, only JDBC is supported; SFTP is not supported.
" + "documentation":"The type of the connection. Currently, these types are supported:
JDBC - Designates a connection to a database through Java Database Connectivity (JDBC).
KAFKA - Designates a connection to an Apache Kafka streaming platform.
MONGODB - Designates a connection to a MongoDB document database.
SFTP is not supported.
" }, "MatchCriteria":{ "shape":"MatchCriteria", @@ -3035,14 +3035,18 @@ "JDBC_ENFORCE_SSL", "CUSTOM_JDBC_CERT", "SKIP_CUSTOM_JDBC_CERT_VALIDATION", - "CUSTOM_JDBC_CERT_STRING" + "CUSTOM_JDBC_CERT_STRING", + "CONNECTION_URL", + "KAFKA_BOOTSTRAP_SERVERS" ] }, "ConnectionType":{ "type":"string", "enum":[ "JDBC", - "SFTP" + "SFTP", + "MONGODB", + "KAFKA" ] }, "ConnectionsList":{ @@ -6129,10 +6133,7 @@ }, "GetUserDefinedFunctionsRequest":{ "type":"structure", - "required":[ - "DatabaseName", - "Pattern" - ], + "required":["Pattern"], "members":{ "CatalogId":{ "shape":"CatalogIdString", diff --git a/botocore/data/guardduty/2017-11-28/paginators-1.json b/botocore/data/guardduty/2017-11-28/paginators-1.json index 92a10d33..d2d3d851 100644 --- a/botocore/data/guardduty/2017-11-28/paginators-1.json +++ b/botocore/data/guardduty/2017-11-28/paginators-1.json @@ -41,6 +41,12 @@ "limit_key": "MaxResults", "output_token": "NextToken", "result_key": "FilterNames" + }, + "ListOrganizationAdminAccounts": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "AdminAccounts" } } } diff --git a/botocore/data/guardduty/2017-11-28/service-2.json b/botocore/data/guardduty/2017-11-28/service-2.json index a84dd0cd..1daf16c1 100644 --- a/botocore/data/guardduty/2017-11-28/service-2.json +++ b/botocore/data/guardduty/2017-11-28/service-2.json @@ -40,7 +40,7 @@ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], - "documentation":"Archives GuardDuty findings specified by the list of finding IDs.
Only the master account can archive findings. Member accounts do not have permission to archive findings from their accounts.
Archives GuardDuty findings that are specified by the list of finding IDs.
Only the master account can archive findings. Member accounts don't have permission to archive findings from their accounts.
Creates a single Amazon GuardDuty detector. A detector is a resource that represents the GuardDuty service. To start using GuardDuty, you must create a detector in each region that you enable the service. You can have only one detector per account per region.
" + "documentation":"Creates a single Amazon GuardDuty detector. A detector is a resource that represents the GuardDuty service. To start using GuardDuty, you must create a detector in each Region where you enable the service. You can have only one detector per account per Region.
" }, "CreateFilter":{ "name":"CreateFilter", @@ -85,7 +85,7 @@ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], - "documentation":"Creates a new IPSet, called Trusted IP list in the consoler user interface. An IPSet is a list IP addresses trusted for secure communication with AWS infrastructure and applications. GuardDuty does not generate findings for IP addresses included in IPSets. Only users from the master account can use this operation.
" + "documentation":"Creates a new IPSet, which is called a trusted IP list in the console user interface. An IPSet is a list of IP addresses that are trusted for secure communication with AWS infrastructure and applications. GuardDuty doesn't generate findings for IP addresses that are included in IPSets. Only users from the master account can use this operation.
" }, "CreateMembers":{ "name":"CreateMembers", @@ -115,7 +115,7 @@ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], - "documentation":"Creates a publishing destination to send findings to. The resource to send findings to must exist before you use this operation.
" + "documentation":"Creates a publishing destination to export findings to. The resource to export findings to must exist before you use this operation.
" }, "CreateSampleFindings":{ "name":"CreateSampleFindings", @@ -145,7 +145,7 @@ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], - "documentation":"Create a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets. Only users of the master account can use this operation.
" + "documentation":"Creates a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets. Only users of the master account can use this operation.
" }, "DeclineInvitations":{ "name":"DeclineInvitations", @@ -160,7 +160,7 @@ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], - "documentation":"Declines invitations sent to the current member account by AWS account specified by their account IDs.
" + "documentation":"Declines invitations sent to the current member account by AWS accounts specified by their account IDs.
" }, "DeleteDetector":{ "name":"DeleteDetector", @@ -175,7 +175,7 @@ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], - "documentation":"Deletes a Amazon GuardDuty detector specified by the detector ID.
" + "documentation":"Deletes an Amazon GuardDuty detector that is specified by the detector ID.
" }, "DeleteFilter":{ "name":"DeleteFilter", @@ -205,7 +205,7 @@ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], - "documentation":"Deletes the IPSet specified by the ipSetId. IPSets are called Trusted IP lists in the console user interface.
Deletes the IPSet specified by the ipSetId. IPSets are called trusted IP lists in the console user interface.
Deletes ThreatIntelSet specified by the ThreatIntelSet ID.
" + "documentation":"Deletes the ThreatIntelSet specified by the ThreatIntelSet ID.
" + }, + "DescribeOrganizationConfiguration":{ + "name":"DescribeOrganizationConfiguration", + "http":{ + "method":"GET", + "requestUri":"/detector/{detectorId}/admin", + "responseCode":200 + }, + "input":{"shape":"DescribeOrganizationConfigurationRequest"}, + "output":{"shape":"DescribeOrganizationConfigurationResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"Returns information about the account selected as the delegated administrator for GuardDuty.
" }, "DescribePublishingDestination":{ "name":"DescribePublishingDestination", @@ -282,6 +297,21 @@ ], "documentation":"Returns information about the publishing destination specified by the provided destinationId.
Disables GuardDuty administrator permissions for an AWS account within the Organization.
" + }, "DisassociateFromMasterAccount":{ "name":"DisassociateFromMasterAccount", "http":{ @@ -312,6 +342,21 @@ ], "documentation":"Disassociates GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.
" }, + "EnableOrganizationAdminAccount":{ + "name":"EnableOrganizationAdminAccount", + "http":{ + "method":"POST", + "requestUri":"/admin/enable", + "responseCode":200 + }, + "input":{"shape":"EnableOrganizationAdminAccountRequest"}, + "output":{"shape":"EnableOrganizationAdminAccountResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"Enables GuardDuty administrator permissions for an AWS account within the organization.
" + }, "GetDetector":{ "name":"GetDetector", "http":{ @@ -370,7 +415,7 @@ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], - "documentation":"Lists Amazon GuardDuty findings' statistics for the specified detector ID.
" + "documentation":"Lists Amazon GuardDuty findings statistics for the specified detector ID.
" }, "GetIPSet":{ "name":"GetIPSet", @@ -460,7 +505,7 @@ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], - "documentation":"Invites other AWS accounts (created as members of the current AWS account by CreateMembers) to enable GuardDuty and allow the current AWS account to view and manage these accounts' GuardDuty findings on their behalf as the master account.
" + "documentation":"Invites other AWS accounts (created as members of the current AWS account by CreateMembers) to enable GuardDuty, and allow the current AWS account to view and manage these accounts' GuardDuty findings on their behalf as the master account.
" }, "ListDetectors":{ "name":"ListDetectors", @@ -550,7 +595,22 @@ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], - "documentation":"Lists details about all member accounts for the current GuardDuty master account.
" + "documentation":"Lists details about associated member accounts for the current GuardDuty master account.
" + }, + "ListOrganizationAdminAccounts":{ + "name":"ListOrganizationAdminAccounts", + "http":{ + "method":"GET", + "requestUri":"/admin", + "responseCode":200 + }, + "input":{"shape":"ListOrganizationAdminAccountsRequest"}, + "output":{"shape":"ListOrganizationAdminAccountsResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"Lists the accounts configured as AWS Organization delegated administrators.
" }, "ListPublishingDestinations":{ "name":"ListPublishingDestinations", @@ -580,7 +640,7 @@ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], - "documentation":"Lists tags for a resource. Tagging is currently supported for detectors, finding filters, IP sets, and Threat Intel sets, with a limit of 50 tags per resource. When invoked, this operation returns all assigned tags for a given resource..
" + "documentation":"Lists tags for a resource. Tagging is currently supported for detectors, finding filters, IP sets, and threat intel sets, with a limit of 50 tags per resource. When invoked, this operation returns all assigned tags for a given resource.
" }, "ListThreatIntelSets":{ "name":"ListThreatIntelSets", @@ -625,7 +685,7 @@ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], - "documentation":"Stops GuardDuty monitoring for the specified member accounnts. Use the StartMonitoringMembers to restart monitoring for those accounts.
Stops GuardDuty monitoring for the specified member accounts. Use the StartMonitoringMembers operation to restart monitoring for those accounts.
Updates the IPSet specified by the IPSet ID.
" }, + "UpdateOrganizationConfiguration":{ + "name":"UpdateOrganizationConfiguration", + "http":{ + "method":"POST", + "requestUri":"/detector/{detectorId}/admin", + "responseCode":200 + }, + "input":{"shape":"UpdateOrganizationConfigurationRequest"}, + "output":{"shape":"UpdateOrganizationConfigurationResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"Updates the delegated administrator account with the values provided.
" + }, "UpdatePublishingDestination":{ "name":"UpdatePublishingDestination", "http":{ @@ -760,7 +835,7 @@ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], - "documentation":"Updates the ThreatIntelSet specified by ThreatIntelSet ID.
" + "documentation":"Updates the ThreatIntelSet specified by the ThreatIntelSet ID.
" } }, "shapes":{ @@ -785,7 +860,7 @@ }, "InvitationId":{ "shape":"String", - "documentation":"This value is used to validate the master account to the member account.
", + "documentation":"The value that is used to validate the master account to the member account.
", "locationName":"invitationId" } } @@ -800,7 +875,7 @@ "members":{ "AccessKeyId":{ "shape":"String", - "documentation":"Access key ID of the user.
", + "documentation":"The access key ID of the user.
", "locationName":"accessKeyId" }, "PrincipalId":{ @@ -830,12 +905,12 @@ "members":{ "AccountId":{ "shape":"AccountId", - "documentation":"Member account ID.
", + "documentation":"The member account ID.
", "locationName":"accountId" }, "Email":{ "shape":"Email", - "documentation":"Member account's email address.
", + "documentation":"The email address of the member account.
", "locationName":"email" } }, @@ -863,7 +938,7 @@ "members":{ "ActionType":{ "shape":"String", - "documentation":"GuardDuty Finding activity type.
", + "documentation":"The GuardDuty finding activity type.
", "locationName":"actionType" }, "AwsApiCallAction":{ @@ -887,7 +962,38 @@ "locationName":"portProbeAction" } }, - "documentation":"Contains information about action.
" + "documentation":"Contains information about actions.
" + }, + "AdminAccount":{ + "type":"structure", + "members":{ + "AdminAccountId":{ + "shape":"String", + "documentation":"The AWS account ID for the account.
", + "locationName":"adminAccountId" + }, + "AdminStatus":{ + "shape":"AdminStatus", + "documentation":"Indicates whether the account is enabled as the delegated administrator.
", + "locationName":"adminStatus" + } + }, + "documentation":"The account within the organization specified as the GuardDuty delegated administrator.
" + }, + "AdminAccounts":{ + "type":"list", + "member":{"shape":"AdminAccount"}, + "max":1, + "min":0 + }, + "AdminStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLE_IN_PROGRESS" + ], + "max":300, + "min":1 }, "ArchiveFindingsRequest":{ "type":"structure", @@ -904,7 +1010,7 @@ }, "FindingIds":{ "shape":"FindingIds", - "documentation":"IDs of the findings that you want to archive.
", + "documentation":"The IDs of the findings that you want to archive.
", "locationName":"findingIds" } } @@ -919,27 +1025,27 @@ "members":{ "Api":{ "shape":"String", - "documentation":"AWS API name.
", + "documentation":"The AWS API name.
", "locationName":"api" }, "CallerType":{ "shape":"String", - "documentation":"AWS API caller type.
", + "documentation":"The AWS API caller type.
", "locationName":"callerType" }, "DomainDetails":{ "shape":"DomainDetails", - "documentation":"Domain information for the AWS API call.
", + "documentation":"The domain information for the AWS API call.
", "locationName":"domainDetails" }, "RemoteIpDetails":{ "shape":"RemoteIpDetails", - "documentation":"Remote IP information of the connection.
", + "documentation":"The remote IP information of the connection.
", "locationName":"remoteIpDetails" }, "ServiceName":{ "shape":"String", - "documentation":"AWS service name whose API was invoked.
", + "documentation":"The AWS service name whose API was invoked.
", "locationName":"serviceName" } }, @@ -959,7 +1065,7 @@ "locationName":"__type" } }, - "documentation":"Bad request exception object.
", + "documentation":"A bad request exception object.
", "error":{"httpStatusCode":400}, "exception":true }, @@ -969,7 +1075,7 @@ "members":{ "CityName":{ "shape":"String", - "documentation":"City name of the remote IP address.
", + "documentation":"The city name of the remote IP address.
", "locationName":"cityName" } }, @@ -985,68 +1091,68 @@ "members":{ "Eq":{ "shape":"Eq", - "documentation":"Represents the equal condition to be applied to a single field when querying for findings.
", + "documentation":"Represents the equal condition to be applied to a single field when querying for findings.
", "deprecated":true, "locationName":"eq" }, "Neq":{ "shape":"Neq", - "documentation":"Represents the not equal condition to be applied to a single field when querying for findings.
", + "documentation":"Represents the not equal condition to be applied to a single field when querying for findings.
", "deprecated":true, "locationName":"neq" }, "Gt":{ "shape":"Integer", - "documentation":"Represents a greater than condition to be applied to a single field when querying for findings.
", + "documentation":"Represents a greater than condition to be applied to a single field when querying for findings.
", "deprecated":true, "locationName":"gt" }, "Gte":{ "shape":"Integer", - "documentation":"Represents a greater than equal condition to be applied to a single field when querying for findings.
", + "documentation":"Represents a greater than or equal condition to be applied to a single field when querying for findings.
", "deprecated":true, "locationName":"gte" }, "Lt":{ "shape":"Integer", - "documentation":"Represents a less than condition to be applied to a single field when querying for findings.
", + "documentation":"Represents a less than condition to be applied to a single field when querying for findings.
", "deprecated":true, "locationName":"lt" }, "Lte":{ "shape":"Integer", - "documentation":"Represents a less than equal condition to be applied to a single field when querying for findings.
", + "documentation":"Represents a less than or equal condition to be applied to a single field when querying for findings.
", "deprecated":true, "locationName":"lte" }, "Equals":{ "shape":"Equals", - "documentation":"Represents an equal condition to be applied to a single field when querying for findings.
", + "documentation":"Represents an equal condition to be applied to a single field when querying for findings.
", "locationName":"equals" }, "NotEquals":{ "shape":"NotEquals", - "documentation":"Represents an not equal condition to be applied to a single field when querying for findings.
", + "documentation":"Represents a not equal condition to be applied to a single field when querying for findings.
", "locationName":"notEquals" }, "GreaterThan":{ "shape":"Long", - "documentation":"Represents a greater than condition to be applied to a single field when querying for findings.
", + "documentation":"Represents a greater than condition to be applied to a single field when querying for findings.
", "locationName":"greaterThan" }, "GreaterThanOrEqual":{ "shape":"Long", - "documentation":"Represents a greater than equal condition to be applied to a single field when querying for findings.
", + "documentation":"Represents a greater than or equal condition to be applied to a single field when querying for findings.
", "locationName":"greaterThanOrEqual" }, "LessThan":{ "shape":"Long", - "documentation":"Represents a less than condition to be applied to a single field when querying for findings.
", + "documentation":"Represents a less than condition to be applied to a single field when querying for findings.
", "locationName":"lessThan" }, "LessThanOrEqual":{ "shape":"Long", - "documentation":"Represents a less than equal condition to be applied to a single field when querying for findings.
", + "documentation":"Represents a less than or equal condition to be applied to a single field when querying for findings.
", "locationName":"lessThanOrEqual" } }, @@ -1062,16 +1168,16 @@ "members":{ "CountryCode":{ "shape":"String", - "documentation":"Country code of the remote IP address.
", + "documentation":"The country code of the remote IP address.
", "locationName":"countryCode" }, "CountryName":{ "shape":"String", - "documentation":"Country name of the remote IP address.
", + "documentation":"The country name of the remote IP address.
", "locationName":"countryName" } }, - "documentation":"Contains information about the country in which the remote IP address is located.
" + "documentation":"Contains information about the country where the remote IP address is located.
" }, "CreateDetectorRequest":{ "type":"structure", @@ -1079,7 +1185,7 @@ "members":{ "Enable":{ "shape":"Boolean", - "documentation":"A boolean value that specifies whether the detector is to be enabled.
", + "documentation":"A Boolean value that specifies whether the detector is to be enabled.
", "locationName":"enable" }, "ClientToken":{ @@ -1090,7 +1196,7 @@ }, "FindingPublishingFrequency":{ "shape":"FindingPublishingFrequency", - "documentation":"A enum value that specifies how frequently customer got Finding updates published.
", + "documentation":"An enum value that specifies how frequently updated findings are exported.
", "locationName":"findingPublishingFrequency" }, "Tags":{ @@ -1120,7 +1226,7 @@ "members":{ "DetectorId":{ "shape":"DetectorId", - "documentation":"The unique ID of the detector of the GuardDuty account for which you want to create a filter.
", + "documentation":"The unique ID of the detector of the GuardDuty account that you want to create a filter for.
", "location":"uri", "locationName":"detectorId" }, @@ -1146,7 +1252,7 @@ }, "FindingCriteria":{ "shape":"FindingCriteria", - "documentation":"Represents the criteria to be used in the filter for querying findings.
", + "documentation":"Represents the criteria to be used in the filter for querying findings.
You can only use the following attributes to query findings:
accountId
region
confidence
id
resource.accessKeyDetails.accessKeyId
resource.accessKeyDetails.principalId
resource.accessKeyDetails.userName
resource.accessKeyDetails.userType
resource.instanceDetails.iamInstanceProfile.id
resource.instanceDetails.imageId
resource.instanceDetails.instanceId
resource.instanceDetails.outpostArn
resource.instanceDetails.networkInterfaces.ipv6Addresses
resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
resource.instanceDetails.networkInterfaces.publicDnsName
resource.instanceDetails.networkInterfaces.publicIp
resource.instanceDetails.networkInterfaces.securityGroups.groupId
resource.instanceDetails.networkInterfaces.securityGroups.groupName
resource.instanceDetails.networkInterfaces.subnetId
resource.instanceDetails.networkInterfaces.vpcId
resource.instanceDetails.tags.key
resource.instanceDetails.tags.value
resource.resourceType
service.action.actionType
service.action.awsApiCallAction.api
service.action.awsApiCallAction.callerType
service.action.awsApiCallAction.remoteIpDetails.city.cityName
service.action.awsApiCallAction.remoteIpDetails.country.countryName
service.action.awsApiCallAction.remoteIpDetails.ipAddressV4
service.action.awsApiCallAction.remoteIpDetails.organization.asn
service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
service.action.awsApiCallAction.serviceName
service.action.dnsRequestAction.domain
service.action.networkConnectionAction.blocked
service.action.networkConnectionAction.connectionDirection
service.action.networkConnectionAction.localPortDetails.port
service.action.networkConnectionAction.protocol
service.action.networkConnectionAction.remoteIpDetails.city.cityName
service.action.networkConnectionAction.remoteIpDetails.country.countryName
service.action.networkConnectionAction.remoteIpDetails.ipAddressV4
service.action.networkConnectionAction.remoteIpDetails.organization.asn
service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
service.action.networkConnectionAction.remotePortDetails.port
service.additionalInfo.threatListName
service.archived
When this attribute is set to TRUE, only archived findings are listed. When it's set to FALSE, only unarchived findings are listed. When this attribute is not set, all existing findings are listed.
service.resourceRole
severity
type
updatedAt
Type: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ depending on whether the value contains milliseconds.
The unique ID of the detector of the GuardDuty account for which you want to create an IPSet.
", + "documentation":"The unique ID of the detector of the GuardDuty account that you want to create an IPSet for.
", "location":"uri", "locationName":"detectorId" }, "Name":{ "shape":"Name", - "documentation":"The user friendly name to identify the IPSet. This name is displayed in all findings that are triggered by activity that involves IP addresses included in this IPSet.
", + "documentation":"The user-friendly name to identify the IPSet.
Allowed characters are alphanumerics, spaces, hyphens (-), and underscores (_).
", "locationName":"name" }, "Format":{ @@ -1201,12 +1307,12 @@ }, "Location":{ "shape":"Location", - "documentation":"The URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)
", + "documentation":"The URI of the file that contains the IPSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.
", "locationName":"location" }, "Activate":{ "shape":"Boolean", - "documentation":"A boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.
", + "documentation":"A Boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.
", "locationName":"activate" }, "ClientToken":{ @@ -1242,7 +1348,7 @@ "members":{ "DetectorId":{ "shape":"DetectorId", - "documentation":"The unique ID of the detector of the GuardDuty account with which you want to associate member accounts.
", + "documentation":"The unique ID of the detector of the GuardDuty account that you want to associate member accounts with.
", "location":"uri", "locationName":"detectorId" }, @@ -1259,7 +1365,7 @@ "members":{ "UnprocessedAccounts":{ "shape":"UnprocessedAccounts", - "documentation":"A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
", + "documentation":"A list of objects that include the accountIds of the unprocessed accounts and a result string that explains why each was unprocessed.
The type of resource for the publishing destination. Currently only S3 is supported.
", + "documentation":"The type of resource for the publishing destination. Currently only Amazon S3 buckets are supported.
", "locationName":"destinationType" }, "DestinationProperties":{ "shape":"DestinationProperties", - "documentation":"Properties of the publishing destination, including the ARNs for the destination and the KMS key used for encryption.
", + "documentation":"The properties of the publishing destination, including the ARNs for the destination and the KMS key used for encryption.
", "locationName":"destinationProperties" }, "ClientToken":{ @@ -1302,7 +1408,7 @@ "members":{ "DestinationId":{ "shape":"String", - "documentation":"The ID of the publishing destination created.
", + "documentation":"The ID of the publishing destination that is created.
", "locationName":"destinationId" } } @@ -1319,7 +1425,7 @@ }, "FindingTypes":{ "shape":"FindingTypes", - "documentation":"Types of sample findings to generate.
", + "documentation":"The types of sample findings to generate.
", "locationName":"findingTypes" } } @@ -1341,13 +1447,13 @@ "members":{ "DetectorId":{ "shape":"DetectorId", - "documentation":"The unique ID of the detector of the GuardDuty account for which you want to create a threatIntelSet.
", + "documentation":"The unique ID of the detector of the GuardDuty account that you want to create a threatIntelSet for.
", "location":"uri", "locationName":"detectorId" }, "Name":{ "shape":"Name", - "documentation":"A user-friendly ThreatIntelSet name that is displayed in all finding generated by activity that involves IP addresses included in this ThreatIntelSet.
", + "documentation":"A user-friendly ThreatIntelSet name displayed in all findings that are generated by activity that involves IP addresses included in this ThreatIntelSet.
", "locationName":"name" }, "Format":{ @@ -1357,12 +1463,12 @@ }, "Location":{ "shape":"Location", - "documentation":"The URI of the file that contains the ThreatIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key).
", + "documentation":"The URI of the file that contains the ThreatIntelSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.
", "locationName":"location" }, "Activate":{ "shape":"Boolean", - "documentation":"A boolean value that indicates whether GuardDuty is to start using the uploaded ThreatIntelSet.
", + "documentation":"A Boolean value that indicates whether GuardDuty is to start using the uploaded ThreatIntelSet.
", "locationName":"activate" }, "ClientToken":{ @@ -1373,7 +1479,7 @@ }, "Tags":{ "shape":"TagMap", - "documentation":"The tags to be added to a new Threat List resource.
", + "documentation":"The tags to be added to a new threat list resource.
", "locationName":"tags" } } @@ -1411,7 +1517,7 @@ "members":{ "UnprocessedAccounts":{ "shape":"UnprocessedAccounts", - "documentation":"A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
", + "documentation":"A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.
", "locationName":"unprocessedAccounts" } } @@ -1442,13 +1548,13 @@ "members":{ "DetectorId":{ "shape":"DetectorId", - "documentation":"The unique ID of the detector the filter is associated with.
", + "documentation":"The unique ID of the detector that the filter is associated with.
", "location":"uri", "locationName":"detectorId" }, "FilterName":{ "shape":"String", - "documentation":"The name of the filter you want to delete.
", + "documentation":"The name of the filter that you want to delete.
", "location":"uri", "locationName":"filterName" } @@ -1502,7 +1608,7 @@ "members":{ "UnprocessedAccounts":{ "shape":"UnprocessedAccounts", - "documentation":"A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
", + "documentation":"A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.
", "locationName":"unprocessedAccounts" } } @@ -1573,13 +1679,13 @@ "members":{ "DetectorId":{ "shape":"DetectorId", - "documentation":"The unique ID of the detector the threatIntelSet is associated with.
", + "documentation":"The unique ID of the detector that the threatIntelSet is associated with.
", "location":"uri", "locationName":"detectorId" }, "ThreatIntelSetId":{ "shape":"String", - "documentation":"The unique ID of the threatIntelSet you want to delete.
", + "documentation":"The unique ID of the threatIntelSet that you want to delete.
", "location":"uri", "locationName":"threatIntelSetId" } @@ -1590,6 +1696,37 @@ "members":{ } }, + "DescribeOrganizationConfigurationRequest":{ + "type":"structure", + "required":["DetectorId"], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"The ID of the detector to retrieve information about the delegated administrator from.
", + "location":"uri", + "locationName":"detectorId" + } + } + }, + "DescribeOrganizationConfigurationResponse":{ + "type":"structure", + "required":[ + "AutoEnable", + "MemberAccountLimitReached" + ], + "members":{ + "AutoEnable":{ + "shape":"Boolean", + "documentation":"Indicates whether GuardDuty is automatically enabled for accounts added to the organization.
", + "locationName":"autoEnable" + }, + "MemberAccountLimitReached":{ + "shape":"Boolean", + "documentation":"Indicates whether the maximum number of allowed member accounts are already associated with the delegated administrator master account.
", + "locationName":"memberAccountLimitReached" + } + } + }, "DescribePublishingDestinationRequest":{ "type":"structure", "required":[ @@ -1628,7 +1765,7 @@ }, "DestinationType":{ "shape":"DestinationType", - "documentation":"The type of the publishing destination. Currently, only S3 is supported.
", + "documentation":"The type of publishing destination. Currently, only Amazon S3 buckets are supported.
", "locationName":"destinationType" }, "Status":{ @@ -1663,7 +1800,7 @@ }, "DestinationType":{ "shape":"DestinationType", - "documentation":"The type of resource used for the publishing destination. Currently, only S3 is supported.
", + "documentation":"The type of resource used for the publishing destination. Currently, only Amazon S3 buckets are supported.
", "locationName":"destinationType" }, "Status":{ @@ -1672,7 +1809,7 @@ "locationName":"status" } }, - "documentation":"Contains information about a publishing destination, including the ID, type, and status.
" + "documentation":"Contains information about the publishing destination, including the ID, type, and status.
" }, "DestinationProperties":{ "type":"structure", @@ -1688,7 +1825,7 @@ "locationName":"kmsKeyArn" } }, - "documentation":"Contains the ARN of the resource to publish to, such as an S3 bucket, and the ARN of the KMS key to use to encrypt published findings.
" + "documentation":"Contains the Amazon Resource Name (ARN) of the resource to publish to, such as an S3 bucket, and the ARN of the KMS key to use to encrypt published findings.
" }, "DestinationType":{ "type":"string", @@ -1720,6 +1857,22 @@ "max":300, "min":1 }, + "DisableOrganizationAdminAccountRequest":{ + "type":"structure", + "required":["AdminAccountId"], + "members":{ + "AdminAccountId":{ + "shape":"String", + "documentation":"The AWS Account ID for the Organizations account to be disabled as a GuardDuty delegated administrator.
", + "locationName":"adminAccountId" + } + } + }, + "DisableOrganizationAdminAccountResponse":{ + "type":"structure", + "members":{ + } + }, "DisassociateFromMasterAccountRequest":{ "type":"structure", "required":["DetectorId"], @@ -1746,13 +1899,13 @@ "members":{ "DetectorId":{ "shape":"DetectorId", - "documentation":"The unique ID of the detector of the GuardDuty account whose members you want to disassociate from master.
", + "documentation":"The unique ID of the detector of the GuardDuty account whose members you want to disassociate from the master account.
", "location":"uri", "locationName":"detectorId" }, "AccountIds":{ "shape":"AccountIds", - "documentation":"A list of account IDs of the GuardDuty member accounts that you want to disassociate from master.
", + "documentation":"A list of account IDs of the GuardDuty member accounts that you want to disassociate from the master account.
", "locationName":"accountIds" } } @@ -1763,7 +1916,7 @@ "members":{ "UnprocessedAccounts":{ "shape":"UnprocessedAccounts", - "documentation":"A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
", + "documentation":"A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.
", "locationName":"unprocessedAccounts" } } @@ -1773,7 +1926,7 @@ "members":{ "Domain":{ "shape":"String", - "documentation":"Domain information for the API request.
", + "documentation":"The domain information for the API request.
", "locationName":"domain" } }, @@ -1784,7 +1937,7 @@ "members":{ "Domain":{ "shape":"String", - "documentation":"Domain information for the AWS API call.
", + "documentation":"The domain information for the AWS API call.
", "locationName":"domain" } }, @@ -1796,6 +1949,22 @@ "max":64, "min":1 }, + "EnableOrganizationAdminAccountRequest":{ + "type":"structure", + "required":["AdminAccountId"], + "members":{ + "AdminAccountId":{ + "shape":"String", + "documentation":"The AWS Account ID for the Organizations account to be enabled as a GuardDuty delegated administrator.
", + "locationName":"adminAccountId" + } + } + }, + "EnableOrganizationAdminAccountResponse":{ + "type":"structure", + "members":{ + } + }, "Eq":{ "type":"list", "member":{"shape":"String"} @@ -1874,7 +2043,7 @@ }, "Arn":{ "shape":"String", - "documentation":"The ARN for the finding.
", + "documentation":"The ARN of the finding.
", "locationName":"arn" }, "Confidence":{ @@ -1884,7 +2053,7 @@ }, "CreatedAt":{ "shape":"String", - "documentation":"The time and date at which the finding was created.
", + "documentation":"The time and date when the finding was created.
", "locationName":"createdAt" }, "Description":{ @@ -1904,7 +2073,7 @@ }, "Region":{ "shape":"String", - "documentation":"The Region in which the finding was generated.
", + "documentation":"The Region where the finding was generated.
", "locationName":"region" }, "Resource":{ @@ -1927,17 +2096,17 @@ }, "Title":{ "shape":"String", - "documentation":"The title for the finding.
", + "documentation":"The title of the finding.
", "locationName":"title" }, "Type":{ "shape":"FindingType", - "documentation":"The type of the finding.
", + "documentation":"The type of finding.
", "locationName":"type" }, "UpdatedAt":{ "shape":"String", - "documentation":"The time and date at which the finding was laste updated.
", + "documentation":"The time and date when the finding was last updated.
", "locationName":"updatedAt" } }, @@ -1988,7 +2157,7 @@ "members":{ "CountBySeverity":{ "shape":"CountBySeverity", - "documentation":"Represents a map of severity to count statistic for a set of findings
", + "documentation":"Represents a map of severity to count statistics for a set of findings.
", "locationName":"countBySeverity" } }, @@ -2016,12 +2185,12 @@ "members":{ "Lat":{ "shape":"Double", - "documentation":"Latitude information of remote IP address.
", + "documentation":"The latitude information of the remote IP address.
", "locationName":"lat" }, "Lon":{ "shape":"Double", - "documentation":"Longitude information of remote IP address.
", + "documentation":"The longitude information of the remote IP address.
", "locationName":"lon" } }, @@ -2048,12 +2217,12 @@ "members":{ "CreatedAt":{ "shape":"String", - "documentation":"Detector creation timestamp.
", + "documentation":"The timestamp of when the detector was created.
", "locationName":"createdAt" }, "FindingPublishingFrequency":{ "shape":"FindingPublishingFrequency", - "documentation":"Finding publishing frequency.
", + "documentation":"The publishing frequency of the finding.
", "locationName":"findingPublishingFrequency" }, "ServiceRole":{ @@ -2068,7 +2237,7 @@ }, "UpdatedAt":{ "shape":"String", - "documentation":"Detector last update timestamp.
", + "documentation":"The last-updated timestamp for the detector.
", "locationName":"updatedAt" }, "Tags":{ @@ -2087,7 +2256,7 @@ "members":{ "DetectorId":{ "shape":"DetectorId", - "documentation":"The unique ID of the detector the filter is associated with.
", + "documentation":"The unique ID of the detector that the filter is associated with.
", "location":"uri", "locationName":"detectorId" }, @@ -2154,7 +2323,7 @@ }, "FindingIds":{ "shape":"FindingIds", - "documentation":"IDs of the findings that you want to retrieve.
", + "documentation":"The IDs of the findings that you want to retrieve.
", "locationName":"findingIds" }, "SortCriteria":{ @@ -2190,12 +2359,12 @@ }, "FindingStatisticTypes":{ "shape":"FindingStatisticTypes", - "documentation":"Types of finding statistics to retrieve.
", + "documentation":"The types of finding statistics to retrieve.
", "locationName":"findingStatisticTypes" }, "FindingCriteria":{ "shape":"FindingCriteria", - "documentation":"Represents the criteria used for querying findings.
", + "documentation":"Represents the criteria that is used for querying findings.
", "locationName":"findingCriteria" } } @@ -2206,7 +2375,7 @@ "members":{ "FindingStatistics":{ "shape":"FindingStatistics", - "documentation":"Finding statistics object.
", + "documentation":"The finding statistics object.
", "locationName":"findingStatistics" } } @@ -2220,7 +2389,7 @@ "members":{ "DetectorId":{ "shape":"DetectorId", - "documentation":"The unique ID of the detector the ipSet is associated with.
", + "documentation":"The unique ID of the detector that the IPSet is associated with.
", "location":"uri", "locationName":"detectorId" }, @@ -2243,7 +2412,7 @@ "members":{ "Name":{ "shape":"Name", - "documentation":"The user friendly name for the IPSet.
", + "documentation":"The user-friendly name for the IPSet.
", "locationName":"name" }, "Format":{ @@ -2253,17 +2422,17 @@ }, "Location":{ "shape":"Location", - "documentation":"The URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)
", + "documentation":"The URI of the file that contains the IPSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.
", "locationName":"location" }, "Status":{ "shape":"IpSetStatus", - "documentation":"The status of ipSet file uploaded.
", + "documentation":"The status of IPSet file that was uploaded.
", "locationName":"status" }, "Tags":{ "shape":"TagMap", - "documentation":"The tags of the IP set resource.
", + "documentation":"The tags of the IPSet resource.
", "locationName":"tags" } } @@ -2301,7 +2470,7 @@ "members":{ "Master":{ "shape":"Master", - "documentation":"Master account details.
", + "documentation":"The master account details.
", "locationName":"master" } } @@ -2340,7 +2509,7 @@ }, "UnprocessedAccounts":{ "shape":"UnprocessedAccounts", - "documentation":"A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
", + "documentation":"A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.
", "locationName":"unprocessedAccounts" } } @@ -2354,13 +2523,13 @@ "members":{ "DetectorId":{ "shape":"DetectorId", - "documentation":"The unique ID of the detector the threatIntelSet is associated with.
", + "documentation":"The unique ID of the detector that the threatIntelSet is associated with.
", "location":"uri", "locationName":"detectorId" }, "ThreatIntelSetId":{ "shape":"String", - "documentation":"The unique ID of the threatIntelSet you want to get.
", + "documentation":"The unique ID of the threatIntelSet that you want to get.
", "location":"uri", "locationName":"threatIntelSetId" } @@ -2377,7 +2546,7 @@ "members":{ "Name":{ "shape":"Name", - "documentation":"A user-friendly ThreatIntelSet name that is displayed in all finding generated by activity that involves IP addresses included in this ThreatIntelSet.
", + "documentation":"A user-friendly ThreatIntelSet name displayed in all findings that are generated by activity that involves IP addresses included in this ThreatIntelSet.
", "locationName":"name" }, "Format":{ @@ -2387,7 +2556,7 @@ }, "Location":{ "shape":"Location", - "documentation":"The URI of the file that contains the ThreatIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key).
", + "documentation":"The URI of the file that contains the ThreatIntelSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.
", "locationName":"location" }, "Status":{ @@ -2397,7 +2566,7 @@ }, "Tags":{ "shape":"TagMap", - "documentation":"The tags of the Threat List resource.
", + "documentation":"The tags of the threat list resource.
", "locationName":"tags" } } @@ -2411,12 +2580,12 @@ "members":{ "Arn":{ "shape":"String", - "documentation":"AWS EC2 instance profile ARN.
", + "documentation":"The profile ARN of the EC2 instance.
", "locationName":"arn" }, "Id":{ "shape":"String", - "documentation":"AWS EC2 instance profile ID.
", + "documentation":"The profile ID of the EC2 instance.
", "locationName":"id" } }, @@ -2427,7 +2596,7 @@ "members":{ "AvailabilityZone":{ "shape":"String", - "documentation":"The availability zone of the EC2 instance.
", + "documentation":"The Availability Zone of the EC2 instance.
", "locationName":"availabilityZone" }, "IamInstanceProfile":{ @@ -2472,7 +2641,7 @@ }, "NetworkInterfaces":{ "shape":"NetworkInterfaces", - "documentation":"The network interface information of the EC2 instance.
", + "documentation":"The elastic network interface information of the EC2 instance.
", "locationName":"networkInterfaces" }, "Platform":{ @@ -2508,7 +2677,7 @@ "locationName":"__type" } }, - "documentation":"Internal server error exception object.
", + "documentation":"An internal server error exception object.
", "error":{"httpStatusCode":500}, "exception":true }, @@ -2517,7 +2686,7 @@ "members":{ "AccountId":{ "shape":"AccountId", - "documentation":"The ID of the account from which the invitations was sent.
", + "documentation":"The ID of the account that the invitation was sent from.
", "locationName":"accountId" }, "InvitationId":{ @@ -2532,7 +2701,7 @@ }, "InvitedAt":{ "shape":"String", - "documentation":"Timestamp at which the invitation was sent.
", + "documentation":"The timestamp when the invitation was sent.
", "locationName":"invitedAt" } }, @@ -2553,7 +2722,7 @@ "members":{ "DetectorId":{ "shape":"DetectorId", - "documentation":"The unique ID of the detector of the GuardDuty account with which you want to invite members.
", + "documentation":"The unique ID of the detector of the GuardDuty account that you want to invite members with.
", "location":"uri", "locationName":"detectorId" }, @@ -2564,7 +2733,7 @@ }, "DisableEmailNotification":{ "shape":"Boolean", - "documentation":"A boolean value that specifies whether you want to disable email notification to the accounts that you’re inviting to GuardDuty as members.
", + "documentation":"A Boolean value that specifies whether you want to disable email notification to the accounts that you’re inviting to GuardDuty as members.
", "locationName":"disableEmailNotification" }, "Message":{ @@ -2580,7 +2749,7 @@ "members":{ "UnprocessedAccounts":{ "shape":"UnprocessedAccounts", - "documentation":"A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
", + "documentation":"A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.
", "locationName":"unprocessedAccounts" } } @@ -2627,13 +2796,13 @@ "members":{ "MaxResults":{ "shape":"MaxResults", - "documentation":"You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
", + "documentation":"You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.
", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"String", - "documentation":"You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "documentation":"You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", "location":"querystring", "locationName":"nextToken" } @@ -2645,12 +2814,12 @@ "members":{ "DetectorIds":{ "shape":"DetectorIds", - "documentation":"A list of detector Ids.
", + "documentation":"A list of detector IDs.
", "locationName":"detectorIds" }, "NextToken":{ "shape":"String", - "documentation":"Pagination parameter to be used on the next list operation to retrieve more items.
", + "documentation":"The pagination parameter to be used on the next list operation to retrieve more items.
", "locationName":"nextToken" } } @@ -2661,19 +2830,19 @@ "members":{ "DetectorId":{ "shape":"DetectorId", - "documentation":"The unique ID of the detector the filter is associated with.
", + "documentation":"The unique ID of the detector that the filter is associated with.
", "location":"uri", "locationName":"detectorId" }, "MaxResults":{ "shape":"MaxResults", - "documentation":"You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
", + "documentation":"You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.
", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"String", - "documentation":"You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "documentation":"You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", "location":"querystring", "locationName":"nextToken" } @@ -2685,12 +2854,12 @@ "members":{ "FilterNames":{ "shape":"FilterNames", - "documentation":"A list of filter names
", + "documentation":"A list of filter names.
", "locationName":"filterNames" }, "NextToken":{ "shape":"String", - "documentation":"Pagination parameter to be used on the next list operation to retrieve more items.
", + "documentation":"The pagination parameter to be used on the next list operation to retrieve more items.
", "locationName":"nextToken" } } @@ -2707,7 +2876,7 @@ }, "FindingCriteria":{ "shape":"FindingCriteria", - "documentation":"Represents the criteria used for querying findings. Valid values include:
JSON field name
accountId
region
confidence
id
resource.accessKeyDetails.accessKeyId
resource.accessKeyDetails.principalId
resource.accessKeyDetails.userName
resource.accessKeyDetails.userType
resource.instanceDetails.iamInstanceProfile.id
resource.instanceDetails.imageId
resource.instanceDetails.instanceId
resource.instanceDetails.outpostArn
resource.instanceDetails.networkInterfaces.ipv6Addresses
resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
resource.instanceDetails.networkInterfaces.publicDnsName
resource.instanceDetails.networkInterfaces.publicIp
resource.instanceDetails.networkInterfaces.securityGroups.groupId
resource.instanceDetails.networkInterfaces.securityGroups.groupName
resource.instanceDetails.networkInterfaces.subnetId
resource.instanceDetails.networkInterfaces.vpcId
resource.instanceDetails.tags.key
resource.instanceDetails.tags.value
resource.resourceType
service.action.actionType
service.action.awsApiCallAction.api
service.action.awsApiCallAction.callerType
service.action.awsApiCallAction.remoteIpDetails.city.cityName
service.action.awsApiCallAction.remoteIpDetails.country.countryName
service.action.awsApiCallAction.remoteIpDetails.ipAddressV4
service.action.awsApiCallAction.remoteIpDetails.organization.asn
service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
service.action.awsApiCallAction.serviceName
service.action.dnsRequestAction.domain
service.action.networkConnectionAction.blocked
service.action.networkConnectionAction.connectionDirection
service.action.networkConnectionAction.localPortDetails.port
service.action.networkConnectionAction.protocol
service.action.networkConnectionAction.localIpDetails.ipAddressV4
service.action.networkConnectionAction.remoteIpDetails.city.cityName
service.action.networkConnectionAction.remoteIpDetails.country.countryName
service.action.networkConnectionAction.remoteIpDetails.ipAddressV4
service.action.networkConnectionAction.remoteIpDetails.organization.asn
service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
service.action.networkConnectionAction.remotePortDetails.port
service.additionalInfo.threatListName
service.archived
When this attribute is set to 'true', only archived findings are listed. When it's set to 'false', only unarchived findings are listed. When this attribute is not set, all existing findings are listed.
service.resourceRole
severity
type
updatedAt
Type: Timestamp in Unix Epoch millisecond format: 1486685375000
Represents the criteria used for querying findings. Valid values include:
JSON field name
accountId
region
confidence
id
resource.accessKeyDetails.accessKeyId
resource.accessKeyDetails.principalId
resource.accessKeyDetails.userName
resource.accessKeyDetails.userType
resource.instanceDetails.iamInstanceProfile.id
resource.instanceDetails.imageId
resource.instanceDetails.instanceId
resource.instanceDetails.networkInterfaces.ipv6Addresses
resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
resource.instanceDetails.networkInterfaces.publicDnsName
resource.instanceDetails.networkInterfaces.publicIp
resource.instanceDetails.networkInterfaces.securityGroups.groupId
resource.instanceDetails.networkInterfaces.securityGroups.groupName
resource.instanceDetails.networkInterfaces.subnetId
resource.instanceDetails.networkInterfaces.vpcId
resource.instanceDetails.tags.key
resource.instanceDetails.tags.value
resource.resourceType
service.action.actionType
service.action.awsApiCallAction.api
service.action.awsApiCallAction.callerType
service.action.awsApiCallAction.remoteIpDetails.city.cityName
service.action.awsApiCallAction.remoteIpDetails.country.countryName
service.action.awsApiCallAction.remoteIpDetails.ipAddressV4
service.action.awsApiCallAction.remoteIpDetails.organization.asn
service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
service.action.awsApiCallAction.serviceName
service.action.dnsRequestAction.domain
service.action.networkConnectionAction.blocked
service.action.networkConnectionAction.connectionDirection
service.action.networkConnectionAction.localPortDetails.port
service.action.networkConnectionAction.protocol
service.action.networkConnectionAction.remoteIpDetails.city.cityName
service.action.networkConnectionAction.remoteIpDetails.country.countryName
service.action.networkConnectionAction.remoteIpDetails.ipAddressV4
service.action.networkConnectionAction.remoteIpDetails.organization.asn
service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
service.action.networkConnectionAction.remotePortDetails.port
service.additionalInfo.threatListName
service.archived
When this attribute is set to 'true', only archived findings are listed. When it's set to 'false', only unarchived findings are listed. When this attribute is not set, all existing findings are listed.
service.resourceRole
severity
type
updatedAt
Type: Timestamp in Unix Epoch millisecond format: 1486685375000
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "documentation":"You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", "locationName":"nextToken" } } @@ -2733,12 +2902,12 @@ "members":{ "FindingIds":{ "shape":"FindingIds", - "documentation":"The IDs of the findings you are listing.
", + "documentation":"The IDs of the findings that you're listing.
", "locationName":"findingIds" }, "NextToken":{ "shape":"String", - "documentation":"Pagination parameter to be used on the next list operation to retrieve more items.
", + "documentation":"The pagination parameter to be used on the next list operation to retrieve more items.
", "locationName":"nextToken" } } @@ -2749,7 +2918,7 @@ "members":{ "DetectorId":{ "shape":"DetectorId", - "documentation":"The unique ID of the detector the ipSet is associated with.
", + "documentation":"The unique ID of the detector that the IPSet is associated with.
", "location":"uri", "locationName":"detectorId" }, @@ -2761,7 +2930,7 @@ }, "NextToken":{ "shape":"String", - "documentation":"You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "documentation":"You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", "location":"querystring", "locationName":"nextToken" } @@ -2778,7 +2947,7 @@ }, "NextToken":{ "shape":"String", - "documentation":"Pagination parameter to be used on the next list operation to retrieve more items.
", + "documentation":"The pagination parameter to be used on the next list operation to retrieve more items.
", "locationName":"nextToken" } } @@ -2788,13 +2957,13 @@ "members":{ "MaxResults":{ "shape":"MaxResults", - "documentation":"You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
", + "documentation":"You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.
", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"String", - "documentation":"You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "documentation":"You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", "location":"querystring", "locationName":"nextToken" } @@ -2810,7 +2979,7 @@ }, "NextToken":{ "shape":"String", - "documentation":"Pagination parameter to be used on the next list operation to retrieve more items.
", + "documentation":"The pagination parameter to be used on the next list operation to retrieve more items.
", "locationName":"nextToken" } } @@ -2833,13 +3002,13 @@ }, "NextToken":{ "shape":"String", - "documentation":"You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "documentation":"You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", "location":"querystring", "locationName":"nextToken" }, "OnlyAssociated":{ "shape":"String", - "documentation":"Specifies whether to only return associated members or to return all members (including members which haven't been invited yet or have been disassociated).
", + "documentation":"Specifies what member accounts the response includes based on their relationship status with the master account. The default value is \"true\". If set to \"false\" the response includes all existing member accounts (including members who haven't been invited yet or have been disassociated).
", "location":"querystring", "locationName":"onlyAssociated" } @@ -2855,7 +3024,39 @@ }, "NextToken":{ "shape":"String", - "documentation":"Pagination parameter to be used on the next list operation to retrieve more items.
", + "documentation":"The pagination parameter to be used on the next list operation to retrieve more items.
", + "locationName":"nextToken" + } + } + }, + "ListOrganizationAdminAccountsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return in the response.
", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
An AdminAccounts object that includes a list of accounts configured as GuardDuty delegated administrators.
", + "locationName":"adminAccounts" + }, + "NextToken":{ + "shape":"String", + "documentation":"The pagination parameter to be used on the next list operation to retrieve more items.
", "locationName":"nextToken" } } @@ -2878,7 +3079,7 @@ }, "NextToken":{ "shape":"String", - "documentation":"A token to use for paginating results returned in the repsonse. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
A Destinations obect that includes information about each publishing destination returned.
A Destinations object that includes information about each publishing destination returned.
A token to use for paginating results returned in the repsonse. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
The Amazon Resource Name (ARN) for the given GuardDuty resource
", + "documentation":"The Amazon Resource Name (ARN) for the given GuardDuty resource.
", "location":"uri", "locationName":"resourceArn" } @@ -2928,19 +3129,19 @@ "members":{ "DetectorId":{ "shape":"DetectorId", - "documentation":"The unique ID of the detector the threatIntelSet is associated with.
", + "documentation":"The unique ID of the detector that the threatIntelSet is associated with.
", "location":"uri", "locationName":"detectorId" }, "MaxResults":{ "shape":"MaxResults", - "documentation":"You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
", + "documentation":"You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.
", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"String", - "documentation":"You can use this parameter to paginate results in the response. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "documentation":"You can use this parameter to paginate results in the response. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", "location":"querystring", "locationName":"nextToken" } @@ -2957,7 +3158,7 @@ }, "NextToken":{ "shape":"String", - "documentation":"Pagination parameter to be used on the next list operation to retrieve more items.
", + "documentation":"The pagination parameter to be used on the next list operation to retrieve more items.
", "locationName":"nextToken" } } @@ -2967,7 +3168,7 @@ "members":{ "IpAddressV4":{ "shape":"String", - "documentation":"IPV4 remote address of the connection.
", + "documentation":"The IPv4 local address of the connection.
", "locationName":"ipAddressV4" } }, @@ -2978,12 +3179,12 @@ "members":{ "Port":{ "shape":"Integer", - "documentation":"Port number of the local connection.
", + "documentation":"The port number of the local connection.
", "locationName":"port" }, "PortName":{ "shape":"String", - "documentation":"Port name of the local connection.
", + "documentation":"The port name of the local connection.
", "locationName":"portName" } }, @@ -3000,12 +3201,12 @@ "members":{ "AccountId":{ "shape":"AccountId", - "documentation":"The ID of the account used as the Master account.
", + "documentation":"The ID of the account used as the master account.
", "locationName":"accountId" }, "InvitationId":{ "shape":"String", - "documentation":"This value is used to validate the master account to the member account.
", + "documentation":"The value used to validate the master account to the member account.
", "locationName":"invitationId" }, "RelationshipStatus":{ @@ -3015,11 +3216,11 @@ }, "InvitedAt":{ "shape":"String", - "documentation":"Timestamp at which the invitation was sent.
", + "documentation":"The timestamp when the invitation was sent.
", "locationName":"invitedAt" } }, - "documentation":"Contains information about the Master account and invitation.
" + "documentation":"Contains information about the master account and invitation.
" }, "MaxResults":{ "type":"integer", @@ -3038,22 +3239,22 @@ "members":{ "AccountId":{ "shape":"AccountId", - "documentation":"Member account ID.
", + "documentation":"The ID of the member account.
", "locationName":"accountId" }, "DetectorId":{ "shape":"DetectorId", - "documentation":"Member account's detector ID.
", + "documentation":"The detector ID of the member account.
", "locationName":"detectorId" }, "MasterId":{ "shape":"String", - "documentation":"Master account ID.
", + "documentation":"The master account ID.
", "locationName":"masterId" }, "Email":{ "shape":"Email", - "documentation":"Member account's email address.
", + "documentation":"The email address of the member account.
", "locationName":"email" }, "RelationshipStatus":{ @@ -3063,16 +3264,16 @@ }, "InvitedAt":{ "shape":"String", - "documentation":"Timestamp at which the invitation was sent
", + "documentation":"The timestamp when the invitation was sent.
", "locationName":"invitedAt" }, "UpdatedAt":{ "shape":"String", - "documentation":"Member last updated timestamp.
", + "documentation":"The last-updated timestamp of the member.
", "locationName":"updatedAt" } }, - "documentation":"Continas information about the member account
" + "documentation":"Contains information about the member account.
" }, "Members":{ "type":"list", @@ -3094,37 +3295,37 @@ "members":{ "Blocked":{ "shape":"Boolean", - "documentation":"Network connection blocked information.
", + "documentation":"Indicates whether EC2 blocked the network connection to your instance.
", "locationName":"blocked" }, "ConnectionDirection":{ "shape":"String", - "documentation":"Network connection direction.
", + "documentation":"The network connection direction.
", "locationName":"connectionDirection" }, "LocalPortDetails":{ "shape":"LocalPortDetails", - "documentation":"Local port information of the connection.
", + "documentation":"The local port information of the connection.
", "locationName":"localPortDetails" }, "Protocol":{ "shape":"String", - "documentation":"Network connection protocol.
", + "documentation":"The network connection protocol.
", "locationName":"protocol" }, "LocalIpDetails":{ "shape":"LocalIpDetails", - "documentation":"Local IP information of the connection.
", + "documentation":"The local IP information of the connection.
", "locationName":"localIpDetails" }, "RemoteIpDetails":{ "shape":"RemoteIpDetails", - "documentation":"Remote IP information of the connection.
", + "documentation":"The remote IP information of the connection.
", "locationName":"remoteIpDetails" }, "RemotePortDetails":{ "shape":"RemotePortDetails", - "documentation":"Remote port information of the connection.
", + "documentation":"The remote port information of the connection.
", "locationName":"remotePortDetails" } }, @@ -3135,22 +3336,22 @@ "members":{ "Ipv6Addresses":{ "shape":"Ipv6Addresses", - "documentation":"A list of EC2 instance IPv6 address information.
", + "documentation":"A list of IPv6 addresses for the EC2 instance.
", "locationName":"ipv6Addresses" }, "NetworkInterfaceId":{ "shape":"String", - "documentation":"The ID of the network interface
", + "documentation":"The ID of the network interface.
", "locationName":"networkInterfaceId" }, "PrivateDnsName":{ "shape":"String", - "documentation":"Private DNS name of the EC2 instance.
", + "documentation":"The private DNS name of the EC2 instance.
", "locationName":"privateDnsName" }, "PrivateIpAddress":{ "shape":"String", - "documentation":"Private IP address of the EC2 instance.
", + "documentation":"The private IP address of the EC2 instance.
", "locationName":"privateIpAddress" }, "PrivateIpAddresses":{ @@ -3160,17 +3361,17 @@ }, "PublicDnsName":{ "shape":"String", - "documentation":"Public DNS name of the EC2 instance.
", + "documentation":"The public DNS name of the EC2 instance.
", "locationName":"publicDnsName" }, "PublicIp":{ "shape":"String", - "documentation":"Public IP address of the EC2 instance.
", + "documentation":"The public IP address of the EC2 instance.
", "locationName":"publicIp" }, "SecurityGroups":{ "shape":"SecurityGroups", - "documentation":"Security groups associated with the EC2 instance.
", + "documentation":"The security groups associated with the EC2 instance.
", "locationName":"securityGroups" }, "SubnetId":{ @@ -3184,7 +3385,7 @@ "locationName":"vpcId" } }, - "documentation":"Contains information about the network interface of the Ec2 instance.
" + "documentation":"Contains information about the elastic network interface of the EC2 instance.
" }, "NetworkInterfaces":{ "type":"list", @@ -3206,38 +3407,38 @@ "members":{ "Asn":{ "shape":"String", - "documentation":"Autonomous system number of the internet provider of the remote IP address.
", + "documentation":"The Autonomous System Number (ASN) of the internet provider of the remote IP address.
", "locationName":"asn" }, "AsnOrg":{ "shape":"String", - "documentation":"Organization that registered this ASN.
", + "documentation":"The organization that registered this ASN.
", "locationName":"asnOrg" }, "Isp":{ "shape":"String", - "documentation":"ISP information for the internet provider.
", + "documentation":"The ISP information for the internet provider.
", "locationName":"isp" }, "Org":{ "shape":"String", - "documentation":"Name of the internet provider.
", + "documentation":"The name of the internet provider.
", "locationName":"org" } }, - "documentation":"Continas information about the ISP organization of the remote IP address.
" + "documentation":"Contains information about the ISP organization of the remote IP address.
" }, "PortProbeAction":{ "type":"structure", "members":{ "Blocked":{ "shape":"Boolean", - "documentation":"Port probe blocked information.
", + "documentation":"Indicates whether EC2 blocked the port probe to the instance, such as with an ACL.
", "locationName":"blocked" }, "PortProbeDetails":{ "shape":"PortProbeDetails", - "documentation":"A list of port probe details objects.
", + "documentation":"A list of objects related to port probe details.
", "locationName":"portProbeDetails" } }, @@ -3248,17 +3449,17 @@ "members":{ "LocalPortDetails":{ "shape":"LocalPortDetails", - "documentation":"Local port information of the connection.
", + "documentation":"The local port information of the connection.
", "locationName":"localPortDetails" }, "LocalIpDetails":{ "shape":"LocalIpDetails", - "documentation":"Local IP information of the connection.
", + "documentation":"The local IP information of the connection.
", "locationName":"localIpDetails" }, "RemoteIpDetails":{ "shape":"RemoteIpDetails", - "documentation":"Remote IP information of the connection.
", + "documentation":"The remote IP information of the connection.
", "locationName":"remoteIpDetails" } }, @@ -3273,12 +3474,12 @@ "members":{ "PrivateDnsName":{ "shape":"String", - "documentation":"Private DNS name of the EC2 instance.
", + "documentation":"The private DNS name of the EC2 instance.
", "locationName":"privateDnsName" }, "PrivateIpAddress":{ "shape":"String", - "documentation":"Private IP address of the EC2 instance.
", + "documentation":"The private IP address of the EC2 instance.
", "locationName":"privateIpAddress" } }, @@ -3293,16 +3494,16 @@ "members":{ "Code":{ "shape":"String", - "documentation":"Product code information.
", + "documentation":"The product code information.
", "locationName":"code" }, "ProductType":{ "shape":"String", - "documentation":"Product code type.
", + "documentation":"The product code type.
", "locationName":"productType" } }, - "documentation":"Contains information about the product code for the Ec2 instance.
" + "documentation":"Contains information about the product code for the EC2 instance.
" }, "ProductCodes":{ "type":"list", @@ -3324,43 +3525,43 @@ "members":{ "City":{ "shape":"City", - "documentation":"City information of the remote IP address.
", + "documentation":"The city information of the remote IP address.
", "locationName":"city" }, "Country":{ "shape":"Country", - "documentation":"Country code of the remote IP address.
", + "documentation":"The country code of the remote IP address.
", "locationName":"country" }, "GeoLocation":{ "shape":"GeoLocation", - "documentation":"Location information of the remote IP address.
", + "documentation":"The location information of the remote IP address.
", "locationName":"geoLocation" }, "IpAddressV4":{ "shape":"String", - "documentation":"IPV4 remote address of the connection.
", + "documentation":"The IPv4 remote address of the connection.
", "locationName":"ipAddressV4" }, "Organization":{ "shape":"Organization", - "documentation":"ISP Organization information of the remote IP address.
", + "documentation":"The ISP organization information of the remote IP address.
", "locationName":"organization" } }, - "documentation":"Continas information about the remote IP address of the connection.
" + "documentation":"Contains information about the remote IP address of the connection.
" }, "RemotePortDetails":{ "type":"structure", "members":{ "Port":{ "shape":"Integer", - "documentation":"Port number of the remote connection.
", + "documentation":"The port number of the remote connection.
", "locationName":"port" }, "PortName":{ "shape":"String", - "documentation":"Port name of the remote connection.
", + "documentation":"The port name of the remote connection.
", "locationName":"portName" } }, @@ -3381,7 +3582,7 @@ }, "ResourceType":{ "shape":"String", - "documentation":"The type of the AWS resource.
", + "documentation":"The type of AWS resource.
", "locationName":"resourceType" } }, @@ -3392,12 +3593,12 @@ "members":{ "GroupId":{ "shape":"String", - "documentation":"EC2 instance's security group ID.
", + "documentation":"The security group ID of the EC2 instance.
", "locationName":"groupId" }, "GroupName":{ "shape":"String", - "documentation":"EC2 instance's security group name.
", + "documentation":"The security group name of the EC2 instance.
", "locationName":"groupName" } }, @@ -3412,7 +3613,7 @@ "members":{ "Action":{ "shape":"Action", - "documentation":"Information about the activity described in a finding.
", + "documentation":"Information about the activity that is described in a finding.
", "locationName":"action" }, "Evidence":{ @@ -3427,27 +3628,27 @@ }, "Count":{ "shape":"Integer", - "documentation":"Total count of the occurrences of this finding type.
", + "documentation":"The total count of the occurrences of this finding type.
", "locationName":"count" }, "DetectorId":{ "shape":"DetectorId", - "documentation":"Detector ID for the GuardDuty service.
", + "documentation":"The detector ID for the GuardDuty service.
", "locationName":"detectorId" }, "EventFirstSeen":{ "shape":"String", - "documentation":"First seen timestamp of the activity that prompted GuardDuty to generate this finding.
", + "documentation":"The first-seen timestamp of the activity that prompted GuardDuty to generate this finding.
", "locationName":"eventFirstSeen" }, "EventLastSeen":{ "shape":"String", - "documentation":"Last seen timestamp of the activity that prompted GuardDuty to generate this finding.
", + "documentation":"The last-seen timestamp of the activity that prompted GuardDuty to generate this finding.
", "locationName":"eventLastSeen" }, "ResourceRole":{ "shape":"String", - "documentation":"Resource role information for this finding.
", + "documentation":"The resource role information for this finding.
", "locationName":"resourceRole" }, "ServiceName":{ @@ -3457,7 +3658,7 @@ }, "UserFeedback":{ "shape":"String", - "documentation":"Feedback left about the finding.
", + "documentation":"Feedback that was submitted about the finding.
", "locationName":"userFeedback" } }, @@ -3468,12 +3669,12 @@ "members":{ "AttributeName":{ "shape":"String", - "documentation":"Represents the finding attribute (for example, accountId) by which to sort findings.
", + "documentation":"Represents the finding attribute (for example, accountId) to sort findings by.
", "locationName":"attributeName" }, "OrderBy":{ "shape":"OrderBy", - "documentation":"Order by which the sorted findings are to be displayed.
", + "documentation":"The order by which the sorted findings are to be displayed.
", "locationName":"orderBy" } }, @@ -3505,7 +3706,7 @@ "members":{ "UnprocessedAccounts":{ "shape":"UnprocessedAccounts", - "documentation":"A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
", + "documentation":"A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.
", "locationName":"unprocessedAccounts" } } @@ -3519,13 +3720,13 @@ "members":{ "DetectorId":{ "shape":"DetectorId", - "documentation":"The unique ID of the detector of the GuardDuty account that you want to stop from monitor members' findings.
", + "documentation":"The unique ID of the detector associated with the GuardDuty master account that is monitoring member accounts.
", "location":"uri", "locationName":"detectorId" }, "AccountIds":{ "shape":"AccountIds", - "documentation":"A list of account IDs of the GuardDuty member accounts whose findings you want the master account to stop monitoring.
", + "documentation":"A list of account IDs for the member accounts to stop monitoring.
", "locationName":"accountIds" } } @@ -3536,7 +3737,7 @@ "members":{ "UnprocessedAccounts":{ "shape":"UnprocessedAccounts", - "documentation":"A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
", + "documentation":"A list of objects that contain an accountId for each account that could not be processed, and a result string that indicates why the account was not processed.
", "locationName":"unprocessedAccounts" } } @@ -3547,16 +3748,16 @@ "members":{ "Key":{ "shape":"String", - "documentation":"EC2 instance tag key.
", + "documentation":"The EC2 instance tag key.
", "locationName":"key" }, "Value":{ "shape":"String", - "documentation":"EC2 instance tag value.
", + "documentation":"The EC2 instance tag value.
", "locationName":"value" } }, - "documentation":"Contains information about a tag associated with the Ec2 instance.
" + "documentation":"Contains information about a tag associated with the EC2 instance.
" }, "TagKey":{ "type":"string", @@ -3682,7 +3883,7 @@ }, "FindingIds":{ "shape":"FindingIds", - "documentation":"IDs of the findings to unarchive.
", + "documentation":"The IDs of the findings to unarchive.
", "locationName":"findingIds" } } @@ -3701,7 +3902,7 @@ "members":{ "AccountId":{ "shape":"AccountId", - "documentation":"AWS Account ID.
", + "documentation":"The AWS account ID.
", "locationName":"accountId" }, "Result":{ @@ -3710,7 +3911,7 @@ "locationName":"result" } }, - "documentation":"Contains information about the accounts that were not processed.
" + "documentation":"Contains information about the accounts that weren't processed.
" }, "UnprocessedAccounts":{ "type":"list", @@ -3761,7 +3962,7 @@ }, "FindingPublishingFrequency":{ "shape":"FindingPublishingFrequency", - "documentation":"A enum value that specifies how frequently findings are exported, such as to CloudWatch Events.
", + "documentation":"An enum value that specifies how frequently findings are exported, such as to CloudWatch Events.
", "locationName":"findingPublishingFrequency" } } @@ -3839,7 +4040,7 @@ }, "FindingIds":{ "shape":"FindingIds", - "documentation":"IDs of the findings that you want to mark as useful or not useful.
", + "documentation":"The IDs of the findings that you want to mark as useful or not useful.
", "locationName":"findingIds" }, "Feedback":{ @@ -3885,12 +4086,12 @@ }, "Location":{ "shape":"Location", - "documentation":"The updated URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key).
", + "documentation":"The updated URI of the file that contains the IPSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.
", "locationName":"location" }, "Activate":{ "shape":"Boolean", - "documentation":"The updated boolean value that specifies whether the IPSet is active or not.
", + "documentation":"The updated Boolean value that specifies whether the IPSet is active or not.
", "locationName":"activate" } } @@ -3900,6 +4101,31 @@ "members":{ } }, + "UpdateOrganizationConfigurationRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "AutoEnable" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"The ID of the detector to update the delegated administrator for.
", + "location":"uri", + "locationName":"detectorId" + }, + "AutoEnable":{ + "shape":"Boolean", + "documentation":"Indicates whether to automatically enable member accounts in the organization.
", + "locationName":"autoEnable" + } + } + }, + "UpdateOrganizationConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, "UpdatePublishingDestinationRequest":{ "type":"structure", "required":[ @@ -3909,13 +4135,13 @@ "members":{ "DetectorId":{ "shape":"DetectorId", - "documentation":"The ID of the
", + "documentation":"The ID of the detector associated with the publishing destinations to update.
", "location":"uri", "locationName":"detectorId" }, "DestinationId":{ "shape":"String", - "documentation":"The ID of the detector associated with the publishing destinations to update.
", + "documentation":"The ID of the publishing destination to update.
", "location":"uri", "locationName":"destinationId" }, @@ -3957,12 +4183,12 @@ }, "Location":{ "shape":"Location", - "documentation":"The updated URI of the file that contains the ThreateIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)
", + "documentation":"The updated URI of the file that contains the ThreateIntelSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.
", "locationName":"location" }, "Activate":{ "shape":"Boolean", - "documentation":"The updated boolean value that specifies whether the ThreateIntelSet is active or not.
", + "documentation":"The updated Boolean value that specifies whether the ThreateIntelSet is active or not.
", "locationName":"activate" } } @@ -3973,5 +4199,5 @@ } } }, - "documentation":"Amazon GuardDuty is a continuous security monitoring service that analyzes and processes the following data sources: VPC Flow Logs, AWS CloudTrail event logs, and DNS logs. It uses threat intelligence feeds, such as lists of malicious IPs and domains, and machine learning to identify unexpected and potentially unauthorized and malicious activity within your AWS environment. This can include issues like escalations of privileges, uses of exposed credentials, or communication with malicious IPs, URLs, or domains. For example, GuardDuty can detect compromised EC2 instances serving malware or mining bitcoin. It also monitors AWS account access behavior for signs of compromise, such as unauthorized infrastructure deployments, like instances deployed in a region that has never been used, or unusual API calls, like a password policy change to reduce password strength. GuardDuty informs you of the status of your AWS environment by producing security findings that you can view in the GuardDuty console or through Amazon CloudWatch events. For more information, see Amazon GuardDuty User Guide.
" + "documentation":"Amazon GuardDuty is a continuous security monitoring service that analyzes and processes the following data sources: VPC Flow Logs, AWS CloudTrail event logs, and DNS logs. It uses threat intelligence feeds (such as lists of malicious IPs and domains) and machine learning to identify unexpected, potentially unauthorized, and malicious activity within your AWS environment. This can include issues like escalations of privileges, uses of exposed credentials, or communication with malicious IPs, URLs, or domains. For example, GuardDuty can detect compromised EC2 instances that serve malware or mine bitcoin.
GuardDuty also monitors AWS account access behavior for signs of compromise. Some examples of this are unauthorized infrastructure deployments such as EC2 instances deployed in a Region that has never been used, or unusual API calls like a password policy change to reduce password strength.
GuardDuty informs you of the status of your AWS environment by producing security findings that you can view in the GuardDuty console or through Amazon CloudWatch events. For more information, see the Amazon GuardDuty User Guide .
" } diff --git a/botocore/data/iam/2010-05-08/service-2.json b/botocore/data/iam/2010-05-08/service-2.json index 8f3e7215..72f46101 100644 --- a/botocore/data/iam/2010-05-08/service-2.json +++ b/botocore/data/iam/2010-05-08/service-2.json @@ -849,7 +849,7 @@ {"shape":"NoSuchEntityException"}, {"shape":"InvalidInputException"} ], - "documentation":"Generates a report that includes details about when an IAM resource (user, group, role, or policy) was last used in an attempt to access AWS services. Recent activity usually appears within four hours. IAM reports activity for the last 365 days, or less if your Region began supporting this feature within the last year. For more information, see Regions Where Data Is Tracked.
The service last accessed data includes all attempts to access an AWS API, not just the successful ones. This includes all attempts that were made using the AWS Management Console, the AWS API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that your account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see Logging IAM Events with CloudTrail in the IAM User Guide.
The GenerateServiceLastAccessedDetails operation returns a JobId. Use this parameter in the following operations to retrieve the following details from your report:
GetServiceLastAccessedDetails – Use this operation for users, groups, roles, or policies to list every AWS service that the resource could access using permissions policies. For each service, the response includes information about the most recent access attempt.
GetServiceLastAccessedDetailsWithEntities – Use this operation for groups and policies to list information about the associated entities (users or roles) that attempted to access a specific AWS service.
To check the status of the GenerateServiceLastAccessedDetails request, use the JobId parameter in the same operations and test the JobStatus response parameter.
For additional information about the permissions policies that allow an identity (user, group, or role) to access specific services, use the ListPoliciesGrantingServiceAccess operation.
Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, AWS Organizations policies, IAM permissions boundaries, and AWS STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating Policies in the IAM User Guide.
For more information about service last accessed data, see Reducing Policy Scope by Viewing User Activity in the IAM User Guide.
" + "documentation":"Generates a report that includes details about when an IAM resource (user, group, role, or policy) was last used in an attempt to access AWS services. Recent activity usually appears within four hours. IAM reports activity for the last 365 days, or less if your Region began supporting this feature within the last year. For more information, see Regions Where Data Is Tracked.
The service last accessed data includes all attempts to access an AWS API, not just the successful ones. This includes all attempts that were made using the AWS Management Console, the AWS API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that your account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see Logging IAM Events with CloudTrail in the IAM User Guide.
The GenerateServiceLastAccessedDetails operation returns a JobId. Use this parameter in the following operations to retrieve the following details from your report:
GetServiceLastAccessedDetails – Use this operation for users, groups, roles, or policies to list every AWS service that the resource could access using permissions policies. For each service, the response includes information about the most recent access attempt.
The JobId returned by GenerateServiceLastAccessedDetail must be used by the same role within a session, or by the same user when used to call GetServiceLastAccessedDetail.
GetServiceLastAccessedDetailsWithEntities – Use this operation for groups and policies to list information about the associated entities (users or roles) that attempted to access a specific AWS service.
To check the status of the GenerateServiceLastAccessedDetails request, use the JobId parameter in the same operations and test the JobStatus response parameter.
For additional information about the permissions policies that allow an identity (user, group, or role) to access specific services, use the ListPoliciesGrantingServiceAccess operation.
Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, AWS Organizations policies, IAM permissions boundaries, and AWS STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating Policies in the IAM User Guide.
For more information about service last accessed data, see Reducing Policy Scope by Viewing User Activity in the IAM User Guide.
" }, "GetAccessKeyLastUsed":{ "name":"GetAccessKeyLastUsed", @@ -2598,7 +2598,7 @@ "documentation":"The data type of the value (or values) specified in the ContextKeyValues parameter.
Contains information about a condition context key. It includes the name of the key and specifies the value (or values, if the context key supports multiple values) to use in the simulation. This information is used when evaluating the Condition elements of the input policies.
This data type is used as an input parameter to SimulateCustomPolicy and SimulatePrincipalPolicy .
Contains information about a condition context key. It includes the name of the key and specifies the value (or values, if the context key supports multiple values) to use in the simulation. This information is used when evaluating the Condition elements of the input policies.
This data type is used as an input parameter to SimulateCustomPolicy and SimulatePrincipalPolicy.
" }, "ContextEntryListType":{ "type":"list", @@ -3717,7 +3717,7 @@ "members":{ "JobId":{ "shape":"jobIDType", - "documentation":"The job ID that you can use in the GetServiceLastAccessedDetails or GetServiceLastAccessedDetailsWithEntities operations.
" + "documentation":"The JobId that you can use in the GetServiceLastAccessedDetails or GetServiceLastAccessedDetailsWithEntities operations. The JobId returned by GenerateServiceLastAccessedDetail must be used by the same role within a session, or by the same user when used to call GetServiceLastAccessedDetail.
The ID of the request generated by the GenerateServiceLastAccessedDetails operation.
" + "documentation":"The ID of the request generated by the GenerateServiceLastAccessedDetails operation. The JobId returned by GenerateServiceLastAccessedDetail must be used by the same role within a session, or by the same user when used to call GetServiceLastAccessedDetail.
Applies a policy to a component.
" + "documentation":" Applies a policy to a component. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutComponentPolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.
Applies a policy to an image.
" + "documentation":"Applies a policy to an image. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.
Applies a policy to an image recipe.
" + "documentation":" Applies a policy to an image recipe. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutImageRecipePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.
The AWS Region of the EC2 AMI.
" + "documentation":"The AWS Region of the EC2 AMI.
" }, "image":{ "shape":"NonEmptyString", - "documentation":"The AMI ID of the EC2 AMI.
" + "documentation":"The AMI ID of the EC2 AMI.
" }, "name":{ "shape":"NonEmptyString", - "documentation":"The name of the EC2 AMI.
" + "documentation":"The name of the EC2 AMI.
" }, "description":{ "shape":"NonEmptyString", - "documentation":"The description of the EC2 AMI.
" + "documentation":"The description of the EC2 AMI.
" }, "state":{"shape":"ImageState"} }, @@ -852,15 +852,15 @@ "members":{ "name":{ "shape":"AmiNameString", - "documentation":"The name of the distribution configuration.
" + "documentation":"The name of the distribution configuration.
" }, "description":{ "shape":"NonEmptyString", - "documentation":"The description of the distribution configuration.
" + "documentation":"The description of the distribution configuration.
" }, "amiTags":{ "shape":"TagMap", - "documentation":"The tags to apply to AMIs distributed to this Region.
" + "documentation":"The tags to apply to AMIs distributed to this Region.
" }, "launchPermission":{ "shape":"LaunchPermissionConfiguration", @@ -1010,7 +1010,7 @@ "members":{ "componentArn":{ "shape":"ComponentVersionArnOrBuildVersionArn", - "documentation":"The Amazon Resource Name (ARN) of the component.
" + "documentation":"The Amazon Resource Name (ARN) of the component.
" } }, "documentation":"Configuration details of the component.
" @@ -1282,6 +1282,10 @@ "shape":"ImageTestsConfiguration", "documentation":"The image test configuration of the image pipeline.
" }, + "enhancedImageMetadataEnabled":{ + "shape":"NullableBoolean", + "documentation":"Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
" + }, "schedule":{ "shape":"Schedule", "documentation":"The schedule of the image pipeline.
" @@ -1338,19 +1342,19 @@ }, "semanticVersion":{ "shape":"VersionNumber", - "documentation":"The semantic version of the image recipe.
" + "documentation":"The semantic version of the image recipe.
" }, "components":{ "shape":"ComponentConfigurationList", - "documentation":"The components of the image recipe.
" + "documentation":"The components of the image recipe.
" }, "parentImage":{ "shape":"NonEmptyString", - "documentation":"The parent image of the image recipe.
" + "documentation":"The parent image of the image recipe. The value of the string can be the ARN of the parent image or an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/2019.x.x. The ARN ends with /20xx.x.x, which communicates to EC2 Image Builder that you want to use the latest AMI created in 20xx (year). You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.
The block device mappings of the image recipe.
" + "documentation":"The block device mappings of the image recipe.
" }, "tags":{ "shape":"TagMap", @@ -1358,7 +1362,7 @@ }, "clientToken":{ "shape":"ClientToken", - "documentation":"The idempotency token used to make this request idempotent.
", + "documentation":"The idempotency token used to make this request idempotent.
", "idempotencyToken":true } } @@ -1368,15 +1372,15 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "clientToken":{ "shape":"ClientToken", - "documentation":"The idempotency token used to make this request idempotent.
" + "documentation":"The idempotency token used to make this request idempotent.
" }, "imageRecipeArn":{ "shape":"ImageRecipeArn", - "documentation":"The Amazon Resource Name (ARN) of the image recipe that was created by this request.
" + "documentation":"The Amazon Resource Name (ARN) of the image recipe that was created by this request.
" } } }, @@ -1404,6 +1408,10 @@ "shape":"ImageTestsConfiguration", "documentation":"The image tests configuration of the image.
" }, + "enhancedImageMetadataEnabled":{ + "shape":"NullableBoolean", + "documentation":"Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
" + }, "tags":{ "shape":"TagMap", "documentation":"The tags of the image.
" @@ -1442,51 +1450,51 @@ "members":{ "name":{ "shape":"ResourceName", - "documentation":"The name of the infrastructure configuration.
" + "documentation":"The name of the infrastructure configuration.
" }, "description":{ "shape":"NonEmptyString", - "documentation":"The description of the infrastructure configuration.
" + "documentation":"The description of the infrastructure configuration.
" }, "instanceTypes":{ "shape":"InstanceTypeList", - "documentation":"The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.
" + "documentation":"The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.
" }, "instanceProfileName":{ "shape":"NonEmptyString", - "documentation":"The instance profile to associate with the instance used to customize your EC2 AMI.
" + "documentation":"The instance profile to associate with the instance used to customize your EC2 AMI.
" }, "securityGroupIds":{ "shape":"SecurityGroupIds", - "documentation":"The security group IDs to associate with the instance used to customize your EC2 AMI.
" + "documentation":"The security group IDs to associate with the instance used to customize your EC2 AMI.
" }, "subnetId":{ "shape":"NonEmptyString", - "documentation":"The subnet ID in which to place the instance used to customize your EC2 AMI.
" + "documentation":"The subnet ID in which to place the instance used to customize your EC2 AMI.
" }, "logging":{ "shape":"Logging", - "documentation":"The logging configuration of the infrastructure configuration.
" + "documentation":"The logging configuration of the infrastructure configuration.
" }, "keyPair":{ "shape":"NonEmptyString", - "documentation":"The key pair of the infrastructure configuration. This can be used to log on to and debug the instance used to create your image.
" + "documentation":"The key pair of the infrastructure configuration. This can be used to log on to and debug the instance used to create your image.
" }, "terminateInstanceOnFailure":{ "shape":"NullableBoolean", - "documentation":"The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.
" + "documentation":"The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.
" }, "snsTopicArn":{ "shape":"SnsTopicArn", - "documentation":"The SNS topic on which to send image build events.
" + "documentation":"The SNS topic on which to send image build events.
" }, "tags":{ "shape":"TagMap", - "documentation":"The tags of the infrastructure configuration.
" + "documentation":"The tags of the infrastructure configuration.
" }, "clientToken":{ "shape":"ClientToken", - "documentation":"The idempotency token used to make this request idempotent.
", + "documentation":"The idempotency token used to make this request idempotent.
", "idempotencyToken":true } } @@ -1496,15 +1504,15 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "clientToken":{ "shape":"ClientToken", - "documentation":"The idempotency token used to make this request idempotent.
" + "documentation":"The idempotency token used to make this request idempotent.
" }, "infrastructureConfigurationArn":{ "shape":"InfrastructureConfigurationArn", - "documentation":"The Amazon Resource Name (ARN) of the infrastructure configuration that was created by this request.
" + "documentation":"The Amazon Resource Name (ARN) of the infrastructure configuration that was created by this request.
" } } }, @@ -1515,7 +1523,7 @@ "members":{ "componentBuildVersionArn":{ "shape":"ComponentBuildVersionArn", - "documentation":"The Amazon Resource Name (ARN) of the component build version to delete.
", + "documentation":"The Amazon Resource Name (ARN) of the component build version to delete.
", "location":"querystring", "locationName":"componentBuildVersionArn" } @@ -1526,11 +1534,11 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "componentBuildVersionArn":{ "shape":"ComponentBuildVersionArn", - "documentation":"The Amazon Resource Name (ARN) of the component build version that was deleted.
" + "documentation":"The Amazon Resource Name (ARN) of the component build version that was deleted.
" } } }, @@ -1540,7 +1548,7 @@ "members":{ "distributionConfigurationArn":{ "shape":"DistributionConfigurationArn", - "documentation":"The Amazon Resource Name (ARN) of the distribution configuration to delete.
", + "documentation":"The Amazon Resource Name (ARN) of the distribution configuration to delete.
", "location":"querystring", "locationName":"distributionConfigurationArn" } @@ -1551,11 +1559,11 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "distributionConfigurationArn":{ "shape":"DistributionConfigurationArn", - "documentation":"The Amazon Resource Name (ARN) of the distribution configuration that was deleted.
" + "documentation":"The Amazon Resource Name (ARN) of the distribution configuration that was deleted.
" } } }, @@ -1565,7 +1573,7 @@ "members":{ "imagePipelineArn":{ "shape":"ImagePipelineArn", - "documentation":"The Amazon Resource Name (ARN) of the image pipeline to delete.
", + "documentation":"The Amazon Resource Name (ARN) of the image pipeline to delete.
", "location":"querystring", "locationName":"imagePipelineArn" } @@ -1576,11 +1584,11 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "imagePipelineArn":{ "shape":"ImagePipelineArn", - "documentation":"The Amazon Resource Name (ARN) of the image pipeline that was deleted.
" + "documentation":"The Amazon Resource Name (ARN) of the image pipeline that was deleted.
" } } }, @@ -1590,7 +1598,7 @@ "members":{ "imageRecipeArn":{ "shape":"ImageRecipeArn", - "documentation":"The Amazon Resource Name (ARN) of the image recipe to delete.
", + "documentation":"The Amazon Resource Name (ARN) of the image recipe to delete.
", "location":"querystring", "locationName":"imageRecipeArn" } @@ -1601,11 +1609,11 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "imageRecipeArn":{ "shape":"ImageRecipeArn", - "documentation":"The Amazon Resource Name (ARN) of the image recipe that was deleted.
" + "documentation":"The Amazon Resource Name (ARN) of the image recipe that was deleted.
" } } }, @@ -1615,7 +1623,7 @@ "members":{ "imageBuildVersionArn":{ "shape":"ImageBuildVersionArn", - "documentation":"The Amazon Resource Name (ARN) of the image to delete.
", + "documentation":"The Amazon Resource Name (ARN) of the image to delete.
", "location":"querystring", "locationName":"imageBuildVersionArn" } @@ -1626,11 +1634,11 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "imageBuildVersionArn":{ "shape":"ImageBuildVersionArn", - "documentation":"The Amazon Resource Name (ARN) of the image that was deleted.
" + "documentation":"The Amazon Resource Name (ARN) of the image that was deleted.
" } } }, @@ -1640,7 +1648,7 @@ "members":{ "infrastructureConfigurationArn":{ "shape":"InfrastructureConfigurationArn", - "documentation":"The Amazon Resource Name (ARN) of the infrastructure configuration to delete.
", + "documentation":"The Amazon Resource Name (ARN) of the infrastructure configuration to delete.
", "location":"querystring", "locationName":"infrastructureConfigurationArn" } @@ -1651,11 +1659,11 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "infrastructureConfigurationArn":{ "shape":"InfrastructureConfigurationArn", - "documentation":"The Amazon Resource Name (ARN) of the infrastructure configuration that was deleted.
" + "documentation":"The Amazon Resource Name (ARN) of the infrastructure configuration that was deleted.
" } } }, @@ -1665,15 +1673,15 @@ "members":{ "region":{ "shape":"NonEmptyString", - "documentation":"The target Region.
" + "documentation":"The target Region.
" }, "amiDistributionConfiguration":{ "shape":"AmiDistributionConfiguration", - "documentation":"The specific AMI settings (for example, launch permissions, AMI tags).
" + "documentation":"The specific AMI settings (for example, launch permissions, AMI tags).
" }, "licenseConfigurationArns":{ "shape":"ArnList", - "documentation":"The License Manager Configuration to associate with the AMI in the specified Region.
" + "documentation":"The License Manager Configuration to associate with the AMI in the specified Region.
" } }, "documentation":"Defines the settings for a specific Region.
" @@ -1829,14 +1837,14 @@ "members":{ "name":{ "shape":"FilterName", - "documentation":"The name of the filter. Filter names are case-sensitive.
" + "documentation":"The name of the filter. Filter names are case-sensitive.
" }, "values":{ "shape":"FilterValues", - "documentation":"The filter values. Filter values are case-sensitive.
" + "documentation":"The filter values. Filter values are case-sensitive.
" } }, - "documentation":"A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
" + "documentation":"A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
" }, "FilterList":{ "type":"list", @@ -1873,7 +1881,7 @@ "members":{ "componentArn":{ "shape":"ComponentBuildVersionArn", - "documentation":"The Amazon Resource Name (ARN) of the component whose policy you want to retrieve.
", + "documentation":"The Amazon Resource Name (ARN) of the component whose policy you want to retrieve.
", "location":"querystring", "locationName":"componentArn" } @@ -1884,11 +1892,11 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "policy":{ "shape":"ResourcePolicyDocument", - "documentation":"The component policy.
" + "documentation":"The component policy.
" } } }, @@ -1898,7 +1906,7 @@ "members":{ "componentBuildVersionArn":{ "shape":"ComponentBuildVersionArn", - "documentation":"The Amazon Resource Name (ARN) of the component that you want to retrieve. Regex requires \"/\\d+$\" suffix.
", + "documentation":"The Amazon Resource Name (ARN) of the component that you want to retrieve. Regex requires \"/\\d+$\" suffix.
", "location":"querystring", "locationName":"componentBuildVersionArn" } @@ -1909,11 +1917,11 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "component":{ "shape":"Component", - "documentation":"The component object associated with the specified ARN.
" + "documentation":"The component object associated with the specified ARN.
" } } }, @@ -1923,7 +1931,7 @@ "members":{ "distributionConfigurationArn":{ "shape":"DistributionConfigurationArn", - "documentation":"The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve.
", + "documentation":"The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve.
", "location":"querystring", "locationName":"distributionConfigurationArn" } @@ -1934,11 +1942,11 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "distributionConfiguration":{ "shape":"DistributionConfiguration", - "documentation":"The distribution configuration object.
" + "documentation":"The distribution configuration object.
" } } }, @@ -1948,7 +1956,7 @@ "members":{ "imagePipelineArn":{ "shape":"ImagePipelineArn", - "documentation":"The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve.
", + "documentation":"The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve.
", "location":"querystring", "locationName":"imagePipelineArn" } @@ -1959,11 +1967,11 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "imagePipeline":{ "shape":"ImagePipeline", - "documentation":"The image pipeline object.
" + "documentation":"The image pipeline object.
" } } }, @@ -1973,7 +1981,7 @@ "members":{ "imageArn":{ "shape":"ImageBuildVersionArn", - "documentation":"The Amazon Resource Name (ARN) of the image whose policy you want to retrieve.
", + "documentation":"The Amazon Resource Name (ARN) of the image whose policy you want to retrieve.
", "location":"querystring", "locationName":"imageArn" } @@ -1984,11 +1992,11 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "policy":{ "shape":"ResourcePolicyDocument", - "documentation":"The image policy object.
" + "documentation":"The image policy object.
" } } }, @@ -1998,7 +2006,7 @@ "members":{ "imageRecipeArn":{ "shape":"ImageRecipeArn", - "documentation":"The Amazon Resource Name (ARN) of the image recipe whose policy you want to retrieve.
", + "documentation":"The Amazon Resource Name (ARN) of the image recipe whose policy you want to retrieve.
", "location":"querystring", "locationName":"imageRecipeArn" } @@ -2009,11 +2017,11 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "policy":{ "shape":"ResourcePolicyDocument", - "documentation":"The image recipe policy object.
" + "documentation":"The image recipe policy object.
" } } }, @@ -2023,7 +2031,7 @@ "members":{ "imageRecipeArn":{ "shape":"ImageRecipeArn", - "documentation":"The Amazon Resource Name (ARN) of the image recipe that you want to retrieve.
", + "documentation":"The Amazon Resource Name (ARN) of the image recipe that you want to retrieve.
", "location":"querystring", "locationName":"imageRecipeArn" } @@ -2034,11 +2042,11 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "imageRecipe":{ "shape":"ImageRecipe", - "documentation":"The image recipe object.
" + "documentation":"The image recipe object.
" } } }, @@ -2048,7 +2056,7 @@ "members":{ "imageBuildVersionArn":{ "shape":"ImageBuildVersionArn", - "documentation":"The Amazon Resource Name (ARN) of the image that you want to retrieve.
", + "documentation":"The Amazon Resource Name (ARN) of the image that you want to retrieve.
", "location":"querystring", "locationName":"imageBuildVersionArn" } @@ -2059,11 +2067,11 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "image":{ "shape":"Image", - "documentation":"The image object.
" + "documentation":"The image object.
" } } }, @@ -2085,11 +2093,11 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "infrastructureConfiguration":{ "shape":"InfrastructureConfiguration", - "documentation":"The infrastructure configuration object.
" + "documentation":"The infrastructure configuration object.
" } }, "documentation":"GetInfrastructureConfiguration response object.
" @@ -2122,6 +2130,14 @@ "shape":"Platform", "documentation":"The platform of the image.
" }, + "enhancedImageMetadataEnabled":{ + "shape":"NullableBoolean", + "documentation":"Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
" + }, + "osVersion":{ + "shape":"OsVersion", + "documentation":"The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
" + }, "state":{ "shape":"ImageState", "documentation":"The state of the image.
" @@ -2140,7 +2156,7 @@ }, "infrastructureConfiguration":{ "shape":"InfrastructureConfiguration", - "documentation":"The infrastructure used when creating this image.
" + "documentation":"The infrastructure used when creating this image.
" }, "distributionConfiguration":{ "shape":"DistributionConfiguration", @@ -2192,6 +2208,10 @@ "shape":"Platform", "documentation":"The platform of the image pipeline.
" }, + "enhancedImageMetadataEnabled":{ + "shape":"NullableBoolean", + "documentation":"Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
" + }, "imageRecipeArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
" @@ -2344,11 +2364,11 @@ "members":{ "status":{ "shape":"ImageStatus", - "documentation":"The status of the image.
" + "documentation":"The status of the image.
" }, "reason":{ "shape":"NonEmptyString", - "documentation":"The reason for the image's status.
" + "documentation":"The reason for the image's status.
" } }, "documentation":"Image state shows the image status and the reason for that status.
" @@ -2388,6 +2408,10 @@ "shape":"Platform", "documentation":"The platform of the image.
" }, + "osVersion":{ + "shape":"OsVersion", + "documentation":"The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
" + }, "state":{ "shape":"ImageState", "documentation":"The state of the image.
" @@ -2453,6 +2477,10 @@ "shape":"Platform", "documentation":"The platform of the image semantic version.
" }, + "osVersion":{ + "shape":"OsVersion", + "documentation":"The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
" + }, "owner":{ "shape":"NonEmptyString", "documentation":"The owner of the image semantic version.
" @@ -2497,7 +2525,7 @@ }, "changeDescription":{ "shape":"NonEmptyString", - "documentation":"The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.
" + "documentation":"The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.
" }, "type":{ "shape":"ComponentType", @@ -2505,11 +2533,11 @@ }, "format":{ "shape":"ComponentFormat", - "documentation":"The format of the resource that you want to import as a component.
" + "documentation":"The format of the resource that you want to import as a component.
" }, "platform":{ "shape":"Platform", - "documentation":"The platform of the component.
" + "documentation":"The platform of the component.
" }, "data":{ "shape":"NonEmptyString", @@ -2521,15 +2549,15 @@ }, "kmsKeyId":{ "shape":"NonEmptyString", - "documentation":"The ID of the KMS key that should be used to encrypt this component.
" + "documentation":"The ID of the KMS key that should be used to encrypt this component.
" }, "tags":{ "shape":"TagMap", - "documentation":"The tags of the component.
" + "documentation":"The tags of the component.
" }, "clientToken":{ "shape":"ClientToken", - "documentation":"The idempotency token of the component.
", + "documentation":"The idempotency token of the component.
", "idempotencyToken":true } } @@ -2539,15 +2567,15 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "clientToken":{ "shape":"ClientToken", - "documentation":"The idempotency token used to make this request idempotent.
" + "documentation":"The idempotency token used to make this request idempotent.
" }, "componentBuildVersionArn":{ "shape":"ComponentBuildVersionArn", - "documentation":"The Amazon Resource Name (ARN) of the imported component.
" + "documentation":"The Amazon Resource Name (ARN) of the imported component.
" } } }, @@ -2746,7 +2774,7 @@ "members":{ "userIds":{ "shape":"AccountList", - "documentation":"The AWS account ID.
" + "documentation":"The AWS account ID.
" }, "userGroups":{ "shape":"StringList", @@ -2761,16 +2789,16 @@ "members":{ "componentVersionArn":{ "shape":"ComponentVersionArn", - "documentation":"The component version Amazon Resource Name (ARN) whose versions you want to list.
" + "documentation":"The component version Amazon Resource Name (ARN) whose versions you want to list.
" }, "maxResults":{ "shape":"RestrictedInteger", - "documentation":"The maximum items to return in a request.
", + "documentation":"The maximum items to return in a request.
", "box":true }, "nextToken":{ "shape":"NonEmptyString", - "documentation":"A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + "documentation":"A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" } } }, @@ -2779,15 +2807,15 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "componentSummaryList":{ "shape":"ComponentSummaryList", - "documentation":"The list of component summaries for the specified semantic version.
" + "documentation":"The list of component summaries for the specified semantic version.
" }, "nextToken":{ "shape":"NonEmptyString", - "documentation":"The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
" + "documentation":"The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -2796,20 +2824,20 @@ "members":{ "owner":{ "shape":"Ownership", - "documentation":"The owner defines which components you want to list. By default, this request will only show components owned by your account. You can use this field to specify if you want to view components owned by yourself, by Amazon, or those components that have been shared with you by other customers.
" + "documentation":"The owner defines which components you want to list. By default, this request will only show components owned by your account. You can use this field to specify if you want to view components owned by yourself, by Amazon, or those components that have been shared with you by other customers.
" }, "filters":{ "shape":"FilterList", - "documentation":"The filters.
" + "documentation":"The filters.
" }, "maxResults":{ "shape":"RestrictedInteger", - "documentation":"The maximum items to return in a request.
", + "documentation":"The maximum items to return in a request.
", "box":true }, "nextToken":{ "shape":"NonEmptyString", - "documentation":"A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + "documentation":"A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" } } }, @@ -2818,15 +2846,15 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "componentVersionList":{ "shape":"ComponentVersionList", - "documentation":"The list of component semantic versions.
" + "documentation":"The list of component semantic versions.
" }, "nextToken":{ "shape":"NonEmptyString", - "documentation":"The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
" + "documentation":"The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -2835,16 +2863,16 @@ "members":{ "filters":{ "shape":"FilterList", - "documentation":"The filters.
" + "documentation":"The filters.
" }, "maxResults":{ "shape":"RestrictedInteger", - "documentation":"The maximum items to return in a request.
", + "documentation":"The maximum items to return in a request.
", "box":true }, "nextToken":{ "shape":"NonEmptyString", - "documentation":"A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + "documentation":"A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" } } }, @@ -2853,15 +2881,15 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "distributionConfigurationSummaryList":{ "shape":"DistributionConfigurationSummaryList", - "documentation":"The list of distributions.
" + "documentation":"The list of distributions.
" }, "nextToken":{ "shape":"NonEmptyString", - "documentation":"The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
" + "documentation":"The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -2871,20 +2899,20 @@ "members":{ "imageVersionArn":{ "shape":"ImageVersionArn", - "documentation":"The Amazon Resource Name (ARN) of the image whose build versions you want to retrieve.
" + "documentation":"The Amazon Resource Name (ARN) of the image whose build versions you want to retrieve.
" }, "filters":{ "shape":"FilterList", - "documentation":"The filters.
" + "documentation":"The filters.
" }, "maxResults":{ "shape":"RestrictedInteger", - "documentation":"The maximum items to return in a request.
", + "documentation":"The maximum items to return in a request.
", "box":true }, "nextToken":{ "shape":"NonEmptyString", - "documentation":"A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + "documentation":"A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" } } }, @@ -2893,15 +2921,15 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "imageSummaryList":{ "shape":"ImageSummaryList", - "documentation":"The list of image build versions.
" + "documentation":"The list of image build versions.
" }, "nextToken":{ "shape":"NonEmptyString", - "documentation":"The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
" + "documentation":"The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -2911,20 +2939,20 @@ "members":{ "imagePipelineArn":{ "shape":"ImagePipelineArn", - "documentation":"The Amazon Resource Name (ARN) of the image pipeline whose images you want to view.
" + "documentation":"The Amazon Resource Name (ARN) of the image pipeline whose images you want to view.
" }, "filters":{ "shape":"FilterList", - "documentation":"The filters.
" + "documentation":"The filters.
" }, "maxResults":{ "shape":"RestrictedInteger", - "documentation":"The maximum items to return in a request.
", + "documentation":"The maximum items to return in a request.
", "box":true }, "nextToken":{ "shape":"NonEmptyString", - "documentation":"A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + "documentation":"A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" } } }, @@ -2933,15 +2961,15 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "imageSummaryList":{ "shape":"ImageSummaryList", - "documentation":"The list of images built by this pipeline.
" + "documentation":"The list of images built by this pipeline.
" }, "nextToken":{ "shape":"NonEmptyString", - "documentation":"The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
" + "documentation":"The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -2950,16 +2978,16 @@ "members":{ "filters":{ "shape":"FilterList", - "documentation":"The filters.
" + "documentation":"The filters.
" }, "maxResults":{ "shape":"RestrictedInteger", - "documentation":"The maximum items to return in a request.
", + "documentation":"The maximum items to return in a request.
", "box":true }, "nextToken":{ "shape":"NonEmptyString", - "documentation":"A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + "documentation":"A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" } } }, @@ -2968,15 +2996,15 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "imagePipelineList":{ "shape":"ImagePipelineList", - "documentation":"The list of image pipelines.
" + "documentation":"The list of image pipelines.
" }, "nextToken":{ "shape":"NonEmptyString", - "documentation":"The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
" + "documentation":"The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -2985,20 +3013,20 @@ "members":{ "owner":{ "shape":"Ownership", - "documentation":"The owner defines which image recipes you want to list. By default, this request will only show image recipes owned by your account. You can use this field to specify if you want to view image recipes owned by yourself, by Amazon, or those image recipes that have been shared with you by other customers.
" + "documentation":"The owner defines which image recipes you want to list. By default, this request will only show image recipes owned by your account. You can use this field to specify if you want to view image recipes owned by yourself, by Amazon, or those image recipes that have been shared with you by other customers.
" }, "filters":{ "shape":"FilterList", - "documentation":"The filters.
" + "documentation":"The filters.
" }, "maxResults":{ "shape":"RestrictedInteger", - "documentation":"The maximum items to return in a request.
", + "documentation":"The maximum items to return in a request.
", "box":true }, "nextToken":{ "shape":"NonEmptyString", - "documentation":"A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + "documentation":"A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" } } }, @@ -3007,15 +3035,15 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "imageRecipeSummaryList":{ "shape":"ImageRecipeSummaryList", - "documentation":"The list of image pipelines.
" + "documentation":"The list of image pipelines.
" }, "nextToken":{ "shape":"NonEmptyString", - "documentation":"The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
" + "documentation":"The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -3024,20 +3052,20 @@ "members":{ "owner":{ "shape":"Ownership", - "documentation":"The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.
" + "documentation":"The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.
" }, "filters":{ "shape":"FilterList", - "documentation":"The filters.
" + "documentation":"The filters.
" }, "maxResults":{ "shape":"RestrictedInteger", - "documentation":"The maximum items to return in a request.
", + "documentation":"The maximum items to return in a request.
", "box":true }, "nextToken":{ "shape":"NonEmptyString", - "documentation":"A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + "documentation":"A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" } } }, @@ -3046,15 +3074,15 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "imageVersionList":{ "shape":"ImageVersionList", - "documentation":"The list of image semantic versions.
" + "documentation":"The list of image semantic versions.
" }, "nextToken":{ "shape":"NonEmptyString", - "documentation":"The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
" + "documentation":"The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -3063,16 +3091,16 @@ "members":{ "filters":{ "shape":"FilterList", - "documentation":"The filters.
" + "documentation":"The filters.
" }, "maxResults":{ "shape":"RestrictedInteger", - "documentation":"The maximum items to return in a request.
", + "documentation":"The maximum items to return in a request.
", "box":true }, "nextToken":{ "shape":"NonEmptyString", - "documentation":"A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + "documentation":"A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" } } }, @@ -3081,15 +3109,15 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "infrastructureConfigurationSummaryList":{ "shape":"InfrastructureConfigurationSummaryList", - "documentation":"The list of infrastructure configurations.
" + "documentation":"The list of infrastructure configurations.
" }, "nextToken":{ "shape":"NonEmptyString", - "documentation":"The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
" + "documentation":"The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -3099,7 +3127,7 @@ "members":{ "resourceArn":{ "shape":"ImageBuilderArn", - "documentation":"The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
", + "documentation":"The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
", "location":"uri", "locationName":"resourceArn" } @@ -3110,7 +3138,7 @@ "members":{ "tags":{ "shape":"TagMap", - "documentation":"The tags for the specified resource.
" + "documentation":"The tags for the specified resource.
" } } }, @@ -3130,6 +3158,10 @@ "min":1 }, "NullableBoolean":{"type":"boolean"}, + "OsVersion":{ + "type":"string", + "min":1 + }, "OutputResources":{ "type":"structure", "members":{ @@ -3178,11 +3210,11 @@ "members":{ "componentArn":{ "shape":"ComponentBuildVersionArn", - "documentation":"The Amazon Resource Name (ARN) of the component that this policy should be applied to.
" + "documentation":"The Amazon Resource Name (ARN) of the component that this policy should be applied to.
" }, "policy":{ "shape":"ResourcePolicyDocument", - "documentation":"The policy to apply.
" + "documentation":"The policy to apply.
" } } }, @@ -3191,11 +3223,11 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "componentArn":{ "shape":"ComponentBuildVersionArn", - "documentation":"The Amazon Resource Name (ARN) of the component that this policy was applied to.
" + "documentation":"The Amazon Resource Name (ARN) of the component that this policy was applied to.
" } } }, @@ -3208,11 +3240,11 @@ "members":{ "imageArn":{ "shape":"ImageBuildVersionArn", - "documentation":"The Amazon Resource Name (ARN) of the image that this policy should be applied to.
" + "documentation":"The Amazon Resource Name (ARN) of the image that this policy should be applied to.
" }, "policy":{ "shape":"ResourcePolicyDocument", - "documentation":"The policy to apply.
" + "documentation":"The policy to apply.
" } } }, @@ -3221,11 +3253,11 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "imageArn":{ "shape":"ImageBuildVersionArn", - "documentation":"The Amazon Resource Name (ARN) of the image that this policy was applied to.
" + "documentation":"The Amazon Resource Name (ARN) of the image that this policy was applied to.
" } } }, @@ -3238,11 +3270,11 @@ "members":{ "imageRecipeArn":{ "shape":"ImageRecipeArn", - "documentation":"The Amazon Resource Name (ARN) of the image recipe that this policy should be applied to.
" + "documentation":"The Amazon Resource Name (ARN) of the image recipe that this policy should be applied to.
" }, "policy":{ "shape":"ResourcePolicyDocument", - "documentation":"The policy to apply.
" + "documentation":"The policy to apply.
" } } }, @@ -3251,11 +3283,11 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "imageRecipeArn":{ "shape":"ImageRecipeArn", - "documentation":"The Amazon Resource Name (ARN) of the image recipe that this policy was applied to.
" + "documentation":"The Amazon Resource Name (ARN) of the image recipe that this policy was applied to.
" } } }, @@ -3328,14 +3360,14 @@ "members":{ "scheduleExpression":{ "shape":"NonEmptyString", - "documentation":" The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
The condition configures when the pipeline should trigger a new image build. When the pipelineExecutionStartCondition is set to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, EC2 Image Builder will build a new image only when there are known changes pending. When it is set to EXPRESSION_MATCH_ONLY, it will build a new image every time the CRON expression matches the current time.
The condition configures when the pipeline should trigger a new image build. When the pipelineExecutionStartCondition is set to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, EC2 Image Builder will build a new image only when there are known changes pending. When it is set to EXPRESSION_MATCH_ONLY, it will build a new image every time the CRON expression matches the current time.
A schedule configures how often and when a pipeline will automatically create a new image.
" + "documentation":"A schedule configures how often and when a pipeline will automatically create a new image.
" }, "SecurityGroupIds":{ "type":"list", @@ -3372,11 +3404,11 @@ "members":{ "imagePipelineArn":{ "shape":"ImagePipelineArn", - "documentation":"The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke.
" + "documentation":"The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke.
" }, "clientToken":{ "shape":"ClientToken", - "documentation":"The idempotency token used to make this request idempotent.
", + "documentation":"The idempotency token used to make this request idempotent.
", "idempotencyToken":true } } @@ -3386,15 +3418,15 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "clientToken":{ "shape":"ClientToken", - "documentation":"The idempotency token used to make this request idempotent.
" + "documentation":"The idempotency token used to make this request idempotent.
" }, "imageBuildVersionArn":{ "shape":"ImageBuildVersionArn", - "documentation":"The Amazon Resource Name (ARN) of the image that was created by this request.
" + "documentation":"The Amazon Resource Name (ARN) of the image that was created by this request.
" } } }, @@ -3430,13 +3462,13 @@ "members":{ "resourceArn":{ "shape":"ImageBuilderArn", - "documentation":"The Amazon Resource Name (ARN) of the resource that you want to tag.
", + "documentation":"The Amazon Resource Name (ARN) of the resource that you want to tag.
", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"TagMap", - "documentation":"The tags to apply to the resource.
" + "documentation":"The tags to apply to the resource.
" } } }, @@ -3458,13 +3490,13 @@ "members":{ "resourceArn":{ "shape":"ImageBuilderArn", - "documentation":"The Amazon Resource Name (ARN) of the resource that you want to untag.
", + "documentation":"The Amazon Resource Name (ARN) of the resource that you want to untag.
", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeyList", - "documentation":"The tag keys to remove from the resource.
", + "documentation":"The tag keys to remove from the resource.
", "location":"querystring", "locationName":"tagKeys" } @@ -3485,19 +3517,19 @@ "members":{ "distributionConfigurationArn":{ "shape":"DistributionConfigurationArn", - "documentation":"The Amazon Resource Name (ARN) of the distribution configuration that you want to update.
" + "documentation":"The Amazon Resource Name (ARN) of the distribution configuration that you want to update.
" }, "description":{ "shape":"NonEmptyString", - "documentation":"The description of the distribution configuration.
" + "documentation":"The description of the distribution configuration.
" }, "distributions":{ "shape":"DistributionList", - "documentation":"The distributions of the distribution configuration.
" + "documentation":"The distributions of the distribution configuration.
" }, "clientToken":{ "shape":"ClientToken", - "documentation":"The idempotency token of the distribution configuration.
", + "documentation":"The idempotency token of the distribution configuration.
", "idempotencyToken":true } } @@ -3507,15 +3539,15 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "clientToken":{ "shape":"ClientToken", - "documentation":"The idempotency token used to make this request idempotent.
" + "documentation":"The idempotency token used to make this request idempotent.
" }, "distributionConfigurationArn":{ "shape":"DistributionConfigurationArn", - "documentation":"The Amazon Resource Name (ARN) of the distribution configuration that was updated by this request.
" + "documentation":"The Amazon Resource Name (ARN) of the distribution configuration that was updated by this request.
" } } }, @@ -3530,39 +3562,43 @@ "members":{ "imagePipelineArn":{ "shape":"ImagePipelineArn", - "documentation":"The Amazon Resource Name (ARN) of the image pipeline that you want to update.
" + "documentation":"The Amazon Resource Name (ARN) of the image pipeline that you want to update.
" }, "description":{ "shape":"NonEmptyString", - "documentation":"The description of the image pipeline.
" + "documentation":"The description of the image pipeline.
" }, "imageRecipeArn":{ "shape":"ImageRecipeArn", - "documentation":"The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.
" + "documentation":"The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.
" }, "infrastructureConfigurationArn":{ "shape":"InfrastructureConfigurationArn", - "documentation":"The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images updated by this image pipeline.
" + "documentation":"The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images updated by this image pipeline.
" }, "distributionConfigurationArn":{ "shape":"DistributionConfigurationArn", - "documentation":"The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images updated by this image pipeline.
" + "documentation":"The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images updated by this image pipeline.
" }, "imageTestsConfiguration":{ "shape":"ImageTestsConfiguration", - "documentation":"The image test configuration of the image pipeline.
" + "documentation":"The image test configuration of the image pipeline.
" + }, + "enhancedImageMetadataEnabled":{ + "shape":"NullableBoolean", + "documentation":"Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
" }, "schedule":{ "shape":"Schedule", - "documentation":"The schedule of the image pipeline.
" + "documentation":"The schedule of the image pipeline.
" }, "status":{ "shape":"PipelineStatus", - "documentation":"The status of the image pipeline.
" + "documentation":"The status of the image pipeline.
" }, "clientToken":{ "shape":"ClientToken", - "documentation":"The idempotency token used to make this request idempotent.
", + "documentation":"The idempotency token used to make this request idempotent.
", "idempotencyToken":true } } @@ -3572,15 +3608,15 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "clientToken":{ "shape":"ClientToken", - "documentation":"The idempotency token used to make this request idempotent.
" + "documentation":"The idempotency token used to make this request idempotent.
" }, "imagePipelineArn":{ "shape":"ImagePipelineArn", - "documentation":"The Amazon Resource Name (ARN) of the image pipeline that was updated by this request.
" + "documentation":"The Amazon Resource Name (ARN) of the image pipeline that was updated by this request.
" } } }, @@ -3594,47 +3630,47 @@ "members":{ "infrastructureConfigurationArn":{ "shape":"InfrastructureConfigurationArn", - "documentation":"The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.
" + "documentation":"The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.
" }, "description":{ "shape":"NonEmptyString", - "documentation":"The description of the infrastructure configuration.
" + "documentation":"The description of the infrastructure configuration.
" }, "instanceTypes":{ "shape":"InstanceTypeList", - "documentation":"The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.
" + "documentation":"The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.
" }, "instanceProfileName":{ "shape":"NonEmptyString", - "documentation":"The instance profile to associate with the instance used to customize your EC2 AMI.
" + "documentation":"The instance profile to associate with the instance used to customize your EC2 AMI.
" }, "securityGroupIds":{ "shape":"SecurityGroupIds", - "documentation":"The security group IDs to associate with the instance used to customize your EC2 AMI.
" + "documentation":"The security group IDs to associate with the instance used to customize your EC2 AMI.
" }, "subnetId":{ "shape":"NonEmptyString", - "documentation":"The subnet ID to place the instance used to customize your EC2 AMI in.
" + "documentation":"The subnet ID to place the instance used to customize your EC2 AMI in.
" }, "logging":{ "shape":"Logging", - "documentation":"The logging configuration of the infrastructure configuration.
" + "documentation":"The logging configuration of the infrastructure configuration.
" }, "keyPair":{ "shape":"NonEmptyString", - "documentation":"The key pair of the infrastructure configuration. This can be used to log on to and debug the instance used to create your image.
" + "documentation":"The key pair of the infrastructure configuration. This can be used to log on to and debug the instance used to create your image.
" }, "terminateInstanceOnFailure":{ "shape":"NullableBoolean", - "documentation":"The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.
" + "documentation":"The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.
" }, "snsTopicArn":{ "shape":"SnsTopicArn", - "documentation":"The SNS topic on which to send image build events.
" + "documentation":"The SNS topic on which to send image build events.
" }, "clientToken":{ "shape":"ClientToken", - "documentation":"The idempotency token used to make this request idempotent.
", + "documentation":"The idempotency token used to make this request idempotent.
", "idempotencyToken":true } } @@ -3644,15 +3680,15 @@ "members":{ "requestId":{ "shape":"NonEmptyString", - "documentation":"The request ID that uniquely identifies this request.
" + "documentation":"The request ID that uniquely identifies this request.
" }, "clientToken":{ "shape":"ClientToken", - "documentation":"The idempotency token used to make this request idempotent.
" + "documentation":"The idempotency token used to make this request idempotent.
" }, "infrastructureConfigurationArn":{ "shape":"InfrastructureConfigurationArn", - "documentation":"The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by this request.
" + "documentation":"The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by this request.
" } } }, diff --git a/botocore/data/inspector/2016-02-16/examples-1.json b/botocore/data/inspector/2016-02-16/examples-1.json index 24fcb7a9..05b541f0 100644 --- a/botocore/data/inspector/2016-02-16/examples-1.json +++ b/botocore/data/inspector/2016-02-16/examples-1.json @@ -168,6 +168,13 @@ "createdAt": "1458680170.035", "dataCollected": true, "durationInSeconds": 3600, + "findingCounts": { + "High": 14, + "Informational": 0, + "Low": 0, + "Medium": 2, + "Undefined": 0 + }, "notifications": [ ], @@ -273,6 +280,7 @@ { "name": "ExampleAssessmentTemplate", "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw", + "assessmentRunCount": 0, "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq", "createdAt": "1458074191.844", "durationInSeconds": 3600, diff --git a/botocore/data/iot-jobs-data/2017-09-29/examples-1.json b/botocore/data/iot-jobs-data/2017-09-29/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/iot-jobs-data/2017-09-29/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/iot/2015-05-28/examples-1.json b/botocore/data/iot/2015-05-28/examples-1.json index faff7689..0ea7e3b0 100644 --- a/botocore/data/iot/2015-05-28/examples-1.json +++ b/botocore/data/iot/2015-05-28/examples-1.json @@ -1,5 +1,5 @@ { - "version":"1.0", - "examples":{ + "version": "1.0", + "examples": { } } diff --git a/botocore/data/iot/2015-05-28/service-2.json b/botocore/data/iot/2015-05-28/service-2.json index 1fae5f1d..75c23ab1 100644 --- a/botocore/data/iot/2015-05-28/service-2.json +++ b/botocore/data/iot/2015-05-28/service-2.json @@ -321,6 +321,23 @@ ], "documentation":"Creates an X.509 certificate using the specified certificate signing request.
Note: The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves.
Note: Reusing the same certificate signing request (CSR) results in a distinct certificate.
You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs.
Assuming a set of CSRs are located inside of the directory my-csr-directory:
On Linux and OS X, the command is:
$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR.
The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process:
$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:
> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}
On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:
> forfiles /p my-csr-directory /c \"cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path\"
" }, + "CreateDimension":{ + "name":"CreateDimension", + "http":{ + "method":"POST", + "requestUri":"/dimensions/{name}" + }, + "input":{"shape":"CreateDimensionRequest"}, + "output":{"shape":"CreateDimensionResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Create a dimension that you can use to limit the scope of a metric used in a security profile for AWS IoT Device Defender. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.
Deletes the specified certificate.
A certificate cannot be deleted if it has a policy or IoT thing attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.
" }, + "DeleteDimension":{ + "name":"DeleteDimension", + "http":{ + "method":"DELETE", + "requestUri":"/dimensions/{name}" + }, + "input":{"shape":"DeleteDimensionRequest"}, + "output":{"shape":"DeleteDimensionResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Removes the specified dimension from your AWS account.
" + }, "DeleteDomainConfiguration":{ "name":"DeleteDomainConfiguration", "http":{ @@ -1302,6 +1334,22 @@ ], "documentation":"Describes the default authorizer.
" }, + "DescribeDimension":{ + "name":"DescribeDimension", + "http":{ + "method":"GET", + "requestUri":"/dimensions/{name}" + }, + "input":{"shape":"DescribeDimensionRequest"}, + "output":{"shape":"DescribeDimensionResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Provides details about a dimension that is defined in your AWS account.
" + }, "DescribeDomainConfiguration":{ "name":"DescribeDomainConfiguration", "http":{ @@ -2114,6 +2162,21 @@ ], "documentation":"List the device certificates signed by the specified CA certificate.
" }, + "ListDimensions":{ + "name":"ListDimensions", + "http":{ + "method":"GET", + "requestUri":"/dimensions" + }, + "input":{"shape":"ListDimensionsRequest"}, + "output":{"shape":"ListDimensionsResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"List the set of dimensions that are defined for your AWS account.
" + }, "ListDomainConfigurations":{ "name":"ListDomainConfigurations", "http":{ @@ -2412,7 +2475,8 @@ "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"}, - {"shape":"InternalFailureException"} + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} ], "documentation":"Lists the Device Defender security profiles you have created. You can use filters to list only those security profiles associated with a thing group or only those associated with your account.
" }, @@ -2916,7 +2980,8 @@ {"shape":"InternalException"}, {"shape":"NotConfiguredException"}, {"shape":"InvalidRequestException"}, - {"shape":"ServiceUnavailableException"} + {"shape":"ServiceUnavailableException"}, + {"shape":"LimitExceededException"} ], "documentation":"Sets the logging level.
" }, @@ -3177,6 +3242,22 @@ ], "documentation":"Updates the status of the specified certificate. This operation is idempotent.
Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect.
The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.
" }, + "UpdateDimension":{ + "name":"UpdateDimension", + "http":{ + "method":"PATCH", + "requestUri":"/dimensions/{name}" + }, + "input":{"shape":"UpdateDimensionRequest"}, + "output":{"shape":"UpdateDimensionResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and re-create it).
" + }, "UpdateDomainConfiguration":{ "name":"UpdateDomainConfiguration", "http":{ @@ -3575,7 +3656,7 @@ }, "cloudwatchLogs":{ "shape":"CloudwatchLogsAction", - "documentation":"Send data to CloudWatch logs.
" + "documentation":"Send data to CloudWatch Logs.
" }, "elasticsearch":{ "shape":"ElasticsearchAction", @@ -3736,6 +3817,10 @@ "type":"list", "member":{"shape":"BehaviorMetric"} }, + "AdditionalMetricsToRetainV2List":{ + "type":"list", + "member":{"shape":"MetricToRetain"} + }, "AdditionalParameterMap":{ "type":"map", "key":{"shape":"AttributeKey"}, @@ -4571,6 +4656,10 @@ "shape":"BehaviorMetric", "documentation":"What is measured by the behavior.
" }, + "metricDimension":{ + "shape":"MetricDimension", + "documentation":"The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.
The criteria that determine if a device is behaving normally in regard to the metric.
The CloudWatch log group to which the action sends data.
" } }, - "documentation":"Describes an action that sends data to CloudWatch logs.
" + "documentation":"Describes an action that sends data to CloudWatch Logs.
" }, "CloudwatchMetricAction":{ "type":"structure", @@ -5408,6 +5497,53 @@ }, "documentation":"The output from the CreateCertificateFromCsr operation.
" }, + "CreateDimensionRequest":{ + "type":"structure", + "required":[ + "name", + "type", + "stringValues", + "clientRequestToken" + ], + "members":{ + "name":{ + "shape":"DimensionName", + "documentation":"A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.
", + "location":"uri", + "locationName":"name" + }, + "type":{ + "shape":"DimensionType", + "documentation":"Specifies the type of dimension. Supported types: TOPIC_FILTER.
Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, \"admin/#\").
Metadata that can be used to manage the dimension.
" + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
", + "idempotencyToken":true + } + } + }, + "CreateDimensionResponse":{ + "type":"structure", + "members":{ + "name":{ + "shape":"DimensionName", + "documentation":"A unique identifier for the dimension.
" + }, + "arn":{ + "shape":"DimensionArn", + "documentation":"The ARN (Amazon resource name) of the created dimension.
" + } + } + }, "CreateDomainConfigurationRequest":{ "type":"structure", "required":["domainConfigurationName"], @@ -6071,6 +6207,12 @@ }, "additionalMetricsToRetain":{ "shape":"AdditionalMetricsToRetainList", + "documentation":"A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
Note: This API field is deprecated. Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
", + "deprecated":true, + "deprecatedMessage":"Use additionalMetricsToRetainV2." + }, + "additionalMetricsToRetainV2":{ + "shape":"AdditionalMetricsToRetainV2List", "documentation":"A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
The unique identifier for the dimension that you want to delete.
", + "location":"uri", + "locationName":"name" + } + } + }, + "DeleteDimensionResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteDomainConfigurationRequest":{ "type":"structure", "required":["domainConfigurationName"], @@ -7186,6 +7345,47 @@ } } }, + "DescribeDimensionRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"DimensionName", + "documentation":"The unique identifier for the dimension.
", + "location":"uri", + "locationName":"name" + } + } + }, + "DescribeDimensionResponse":{ + "type":"structure", + "members":{ + "name":{ + "shape":"DimensionName", + "documentation":"The unique identifier for the dimension.
" + }, + "arn":{ + "shape":"DimensionArn", + "documentation":"The ARN (Amazon resource name) for the dimension.
" + }, + "type":{ + "shape":"DimensionType", + "documentation":"The type of the dimension.
" + }, + "stringValues":{ + "shape":"DimensionStringValues", + "documentation":"The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.
" + }, + "creationDate":{ + "shape":"Timestamp", + "documentation":"The date the dimension was created.
" + }, + "lastModifiedDate":{ + "shape":"Timestamp", + "documentation":"The date the dimension was last modified.
" + } + } + }, "DescribeDomainConfigurationRequest":{ "type":"structure", "required":["domainConfigurationName"], @@ -7612,7 +7812,13 @@ }, "additionalMetricsToRetain":{ "shape":"AdditionalMetricsToRetainList", - "documentation":"A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
Note: This API field is deprecated. Please use DescribeSecurityProfileResponse$additionalMetricsToRetainV2 instead.
", + "deprecated":true, + "deprecatedMessage":"Use additionalMetricsToRetainV2." + }, + "additionalMetricsToRetainV2":{ + "shape":"AdditionalMetricsToRetainV2List", + "documentation":"A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
" }, "version":{ "shape":"Version", @@ -7993,6 +8199,39 @@ "max":128, "min":1 }, + "DimensionArn":{"type":"string"}, + "DimensionName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9:_-]+" + }, + "DimensionNames":{ + "type":"list", + "member":{"shape":"DimensionName"} + }, + "DimensionStringValue":{ + "type":"string", + "max":256, + "min":1 + }, + "DimensionStringValues":{ + "type":"list", + "member":{"shape":"DimensionStringValue"}, + "max":100, + "min":1 + }, + "DimensionType":{ + "type":"string", + "enum":["TOPIC_FILTER"] + }, + "DimensionValueOperator":{ + "type":"string", + "enum":[ + "IN", + "NOT_IN" + ] + }, "DisableAllLogs":{"type":"boolean"}, "DisableTopicRuleRequest":{ "type":"structure", @@ -8860,7 +9099,7 @@ }, "confirmationUrl":{ "shape":"Url", - "documentation":"The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substituion template before traffic is allowed to your endpoint URL.
" + "documentation":"The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.
" }, "headers":{ "shape":"HeaderList", @@ -10097,6 +10336,36 @@ }, "documentation":"The output of the ListCertificates operation.
" }, + "ListDimensionsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to retrieve at one time.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListDimensionsResponse":{ + "type":"structure", + "members":{ + "dimensionNames":{ + "shape":"DimensionNames", + "documentation":"A list of the names of the defined dimensions. Use DescribeDimension to get details for a dimension.
A token that can be used to retrieve the next set of results, or null if there are no additional results.
The maximum number of results to return at one time.
", "location":"querystring", "locationName":"maxResults" + }, + "dimensionName":{ + "shape":"DimensionName", + "documentation":"A filter to limit results to the security profiles that use the defined dimension.
", + "location":"querystring", + "locationName":"dimensionName" } } }, @@ -11593,6 +11868,36 @@ "type":"string", "max":128 }, + "MetricDimension":{ + "type":"structure", + "required":["dimensionName"], + "members":{ + "dimensionName":{ + "shape":"DimensionName", + "documentation":"A unique identifier for the dimension.
" + }, + "operator":{ + "shape":"DimensionValueOperator", + "documentation":"Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null), it will be interpreted as IN.
The dimension of a metric.
" + }, + "MetricToRetain":{ + "type":"structure", + "required":["metric"], + "members":{ + "metric":{ + "shape":"BehaviorMetric", + "documentation":"What is measured by the behavior.
" + }, + "metricDimension":{ + "shape":"MetricDimension", + "documentation":"The dimension of a metric.
" + } + }, + "documentation":"The metric you want to retain. Dimensions are optional.
" + }, "MetricValue":{ "type":"structure", "members":{ @@ -14818,6 +15123,54 @@ }, "documentation":"Parameters to define a mitigation action that changes the state of the device certificate to inactive.
" }, + "UpdateDimensionRequest":{ + "type":"structure", + "required":[ + "name", + "stringValues" + ], + "members":{ + "name":{ + "shape":"DimensionName", + "documentation":"A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.
", + "location":"uri", + "locationName":"name" + }, + "stringValues":{ + "shape":"DimensionStringValues", + "documentation":"Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, \"admin/#\").
A unique identifier for the dimension.
" + }, + "arn":{ + "shape":"DimensionArn", + "documentation":"The ARN (Amazon resource name) of the created dimension.
" + }, + "type":{ + "shape":"DimensionType", + "documentation":"The type of the dimension.
" + }, + "stringValues":{ + "shape":"DimensionStringValues", + "documentation":"The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.
" + }, + "creationDate":{ + "shape":"Timestamp", + "documentation":"The date and time, in milliseconds since epoch, when the dimension was initially created.
" + }, + "lastModifiedDate":{ + "shape":"Timestamp", + "documentation":"The date and time, in milliseconds since epoch, when the dimension was most recently updated.
" + } + } + }, "UpdateDomainConfigurationRequest":{ "type":"structure", "required":["domainConfigurationName"], @@ -15123,7 +15476,13 @@ }, "additionalMetricsToRetain":{ "shape":"AdditionalMetricsToRetainList", - "documentation":"A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
Note: This API field is deprecated. Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
", + "deprecated":true, + "deprecatedMessage":"Use additionalMetricsToRetainV2." + }, + "additionalMetricsToRetainV2":{ + "shape":"AdditionalMetricsToRetainV2List", + "documentation":"A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
" }, "deleteBehaviors":{ "shape":"DeleteBehaviors", @@ -15170,7 +15529,13 @@ }, "additionalMetricsToRetain":{ "shape":"AdditionalMetricsToRetainList", - "documentation":"A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the security profile's behaviors, but it is also retained for any metric specified here.
A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the security profile's behaviors, but it is also retained for any metric specified here.
Note: This API field is deprecated. Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2 instead.
", + "deprecated":true, + "deprecatedMessage":"Use additionalMetricsToRetainV2." + }, + "additionalMetricsToRetainV2":{ + "shape":"AdditionalMetricsToRetainV2List", + "documentation":"A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
" }, "version":{ "shape":"Version", @@ -15474,5 +15839,5 @@ "resourceArn":{"type":"string"}, "resourceId":{"type":"string"} }, - "documentation":"AWS IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.
For more information about how AWS IoT works, see the Developer Guide.
For information about how to use the credentials provider for AWS IoT, see Authorizing Direct Calls to AWS Services.
" + "documentation":"AWS IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.
The service endpoints that expose this API are listed in AWS IoT Core Endpoints and Quotas. You must use the endpoint for the region that has the resources you want to access.
The service name used by AWS Signature Version 4 to sign the request is: execute-api.
For more information about how AWS IoT works, see the Developer Guide.
For information about how to use the credentials provider for AWS IoT, see Authorizing Direct Calls to AWS Services.
" } diff --git a/botocore/data/iot1click-projects/2018-05-14/examples-1.json b/botocore/data/iot1click-projects/2018-05-14/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/iot1click-projects/2018-05-14/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/iotanalytics/2017-11-27/examples-1.json b/botocore/data/iotanalytics/2017-11-27/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/iotanalytics/2017-11-27/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/iotevents/2018-07-27/service-2.json b/botocore/data/iotevents/2018-07-27/service-2.json index 58e83492..729e6d07 100644 --- a/botocore/data/iotevents/2018-07-27/service-2.json +++ b/botocore/data/iotevents/2018-07-27/service-2.json @@ -290,6 +290,24 @@ {"shape":"ResourceInUseException"} ], "documentation":"Updates an input.
" + }, + "VerifyResourcesExistForTagris":{ + "name":"VerifyResourcesExistForTagris", + "http":{ + "method":"GET", + "requestUri":"/internal/tags/resource-status" + }, + "input":{"shape":"TagrisVerifyResourcesExistInput"}, + "output":{"shape":"TagrisVerifyResourcesExistOutput"}, + "errors":[ + {"shape":"TagrisAccessDeniedException"}, + {"shape":"TagrisInternalServiceException"}, + {"shape":"TagrisInvalidArnException"}, + {"shape":"TagrisInvalidParameterException"}, + {"shape":"TagrisPartialResourcesExistResultsException"}, + {"shape":"TagrisThrottledException"} + ], + "internalonly":true } }, "shapes":{ @@ -326,7 +344,7 @@ }, "iotEvents":{ "shape":"IotEventsAction", - "documentation":"Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
" + "documentation":"Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action.
" }, "sqs":{ "shape":"SqsAction", @@ -335,6 +353,18 @@ "firehose":{ "shape":"FirehoseAction", "documentation":"Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
" + }, + "dynamoDB":{ + "shape":"DynamoDBAction", + "documentation":"Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide.
" + }, + "dynamoDBv2":{ + "shape":"DynamoDBv2Action", + "documentation":"Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide.
" + }, + "iotSiteWise":{ + "shape":"IotSiteWiseAction", + "documentation":"Sends information about the detector model instance and the event that triggered the action to an AWS IoT SiteWise asset property.
" } }, "documentation":"An action to be performed when the condition is TRUE.
The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199. You can also specify an expression.
" + }, + "offsetInNanos":{ + "shape":"AssetPropertyOffsetInNanos", + "documentation":"The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999. You can also specify an expression.
A structure that contains timestamp information. For more information, see TimeInNanos in the AWS IoT SiteWise API Reference.
For parameters that are string data type, you can specify the following options:
Use a string. For example, the timeInSeconds value can be '1586400675'.
Use an expression. For example, the timeInSeconds value can be '${$input.TemperatureInput.sensorData.timestamp/1000}'.
For more information, see Expressions in the AWS IoT Events Developer Guide.
The value to send to an asset property.
" + }, + "timestamp":{ + "shape":"AssetPropertyTimestamp", + "documentation":"The timestamp associated with the asset property value. The default is the current event time.
" + }, + "quality":{ + "shape":"AssetPropertyQuality", + "documentation":"The quality of the asset property value. The value must be GOOD, BAD, or UNCERTAIN. You can also specify an expression.
A structure that contains value information. For more information, see AssetPropertyValue in the AWS IoT SiteWise API Reference.
For parameters that are string data type, you can specify the following options:
Use a string. For example, the quality value can be 'GOOD'.
Use an expression. For example, the quality value can be $input.TemperatureInput.sensorData.quality .
For more information, see Expressions in the AWS IoT Events Developer Guide.
The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string.
" + }, + "integerValue":{ + "shape":"AssetPropertyIntegerValue", + "documentation":"The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer.
" + }, + "doubleValue":{ + "shape":"AssetPropertyDoubleValue", + "documentation":"The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double.
" + }, + "booleanValue":{ + "shape":"AssetPropertyBooleanValue", + "documentation":"The asset property value is a Boolean value that must be TRUE or FALSE. You can also specify an expression. If you use an expression, the evaluated result should be a Boolean value.
A structure that contains an asset property value. For more information, see Variant in the AWS IoT SiteWise API Reference.
You must specify one of the following value types, depending on the dataType of the specified asset property. For more information, see AssetProperty in the AWS IoT SiteWise API Reference.
For parameters that are string data type, you can specify the following options:
Use a string. For example, the doubleValue value can be '47.9'.
Use an expression. For example, the doubleValue value can be $input.TemperatureInput.sensorData.temperature.
For more information, see Expressions in the AWS IoT Events Developer Guide.
The input attribute key used to identify a device or system to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression in the message payload of each input to specify the attribute-value pair that is used to identify the device associated with the input.
" + "documentation":"The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information.
This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.
" }, "evaluationMethod":{ "shape":"EvaluationMethod", @@ -754,6 +855,71 @@ }, "documentation":"Information about the detector model version.
" }, + "DynamoDBAction":{ + "type":"structure", + "required":[ + "hashKeyField", + "hashKeyValue", + "tableName" + ], + "members":{ + "hashKeyType":{ + "shape":"DynamoKeyType", + "documentation":"The data type for the hash key (also called the partition key). You can specify the following values:
STRING - The hash key is a string.
NUMBER - The hash key is a number.
If you don't specify hashKeyType, the default value is STRING.
The name of the hash key (also called the partition key).
" + }, + "hashKeyValue":{ + "shape":"DynamoKeyValue", + "documentation":"The value of the hash key (also called the partition key).
" + }, + "rangeKeyType":{ + "shape":"DynamoKeyType", + "documentation":"The data type for the range key (also called the sort key), You can specify the following values:
STRING - The range key is a string.
NUMBER - The range key is number.
If you don't specify rangeKeyField, the default value is STRING.
The name of the range key (also called the sort key).
" + }, + "rangeKeyValue":{ + "shape":"DynamoKeyValue", + "documentation":"The value of the range key (also called the sort key).
" + }, + "operation":{ + "shape":"DynamoOperation", + "documentation":"The type of operation to perform. You can specify the following values:
INSERT - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.
UPDATE - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
DELETE - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
If you don't specify this parameter, AWS IoT Events triggers the INSERT operation.
The name of the DynamoDB column that receives the action payload.
If you don't specify this parameter, the name of the DynamoDB column is payload.
The name of the DynamoDB table.
" + }, + "payload":{"shape":"Payload"} + }, + "documentation":"Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.
The tableName and hashKeyField values must match the table name and the partition key of the DynamoDB table.
If the DynamoDB table also has a sort key, you must specify rangeKeyField. The rangeKeyField value must match the sort key.
The hashKeyValue and rangeKeyValue use substitution templates. These templates provide data at runtime. The syntax is ${sql-expression}.
You can use expressions for parameters that are string data type. For more information, see Expressions in the AWS IoT Events Developer Guide.
If the defined payload type is a string, DynamoDBAction writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The payloadField is <payload-field>_raw.
The name of the DynamoDB table.
" + }, + "payload":{"shape":"Payload"} + }, + "documentation":"Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.
The type value for Payload must be JSON.
You can use expressions for parameters that are strings. For more information, see Expressions in the AWS IoT Events Developer Guide.
" + }, + "DynamoKeyField":{"type":"string"}, + "DynamoKeyType":{"type":"string"}, + "DynamoKeyValue":{"type":"string"}, + "DynamoOperation":{"type":"string"}, + "DynamoTableName":{"type":"string"}, "EvaluationMethod":{ "type":"string", "enum":[ @@ -799,6 +965,10 @@ "separator":{ "shape":"FirehoseSeparator", "documentation":"A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma).
" + }, + "payload":{ + "shape":"Payload", + "documentation":"You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream.
" } }, "documentation":"Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
" @@ -955,10 +1125,41 @@ "inputName":{ "shape":"InputName", "documentation":"The name of the AWS IoT Events input where the data is sent.
" + }, + "payload":{ + "shape":"Payload", + "documentation":"You can configure the action payload when you send a message to an AWS IoT Events input.
" } }, "documentation":"Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
" }, + "IotSiteWiseAction":{ + "type":"structure", + "required":["propertyValue"], + "members":{ + "entryId":{ + "shape":"AssetPropertyEntryId", + "documentation":"A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier. You can also specify an expression.
" + }, + "assetId":{ + "shape":"AssetId", + "documentation":"The ID of the asset that has the specified property. You can specify an expression.
" + }, + "propertyId":{ + "shape":"AssetPropertyId", + "documentation":"The ID of the asset property. You can specify an expression.
" + }, + "propertyAlias":{ + "shape":"AssetPropertyAlias", + "documentation":"The alias of the asset property. You can also specify an expression.
" + }, + "propertyValue":{ + "shape":"AssetPropertyValue", + "documentation":"The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
" + } + }, + "documentation":"Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.
You must specify either propertyAlias or both assetId and propertyId to identify the target asset property in AWS IoT SiteWise.
For parameters that are string data type, you can specify the following options:
Use a string. For example, the propertyAlias value can be '/company/windfarm/3/turbine/7/temperature'.
Use an expression. For example, the propertyAlias value can be 'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/${$input.TemperatureInput.sensorData.turbineID}/temperature'.
For more information, see Expressions in the AWS IoT Events Developer Guide.
The MQTT topic of the message. You can use a string expression that includes variables ($variable.<variable-name>) and input values ($input.<input-name>.<path-to-datum>) as the topic string.
You can configure the action payload when you publish a message to an AWS IoT Core topic.
" } }, "documentation":"Information required to publish the MQTT message through the AWS IoT message broker.
" @@ -983,6 +1188,10 @@ "functionArn":{ "shape":"AmazonResourceName", "documentation":"The ARN of the Lambda function that is executed.
" + }, + "payload":{ + "shape":"Payload", + "documentation":"You can configure the action payload when you send a message to a Lambda function.
" } }, "documentation":"Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
" @@ -1169,7 +1378,7 @@ "members":{ "events":{ "shape":"Events", - "documentation":"Specifies the actions that are performed when the state is entered and the condition is TRUE.
Specifies the actions that are performed when the state is entered and the condition is TRUE.
When entering this state, perform these actions if the condition is TRUE.
Specifies the actions that are performed when the state is exited and the condition is TRUE.
Specifies the actions that are performed when the state is exited and the condition is TRUE.
When exiting this state, perform these actions if the specified condition is TRUE.
When exiting this state, perform these actions if the specified condition is TRUE.
Specifies the actions performed when the condition evaluates to TRUE.
The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
The value of the payload type can be either STRING or JSON.
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.
The name of the timer to reset.
" } }, - "documentation":"Information required to reset the timer. The timer is reset to the previously evaluated result of the duration.
" + "documentation":"Information required to reset the timer. The timer is reset to the previously evaluated result of the duration. The duration expression isn't reevaluated when you reset the timer.
" }, "ResourceAlreadyExistsException":{ "type":"structure", @@ -1271,6 +1505,10 @@ "targetArn":{ "shape":"AmazonResourceName", "documentation":"The ARN of the Amazon SNS target where the message is sent.
" + }, + "payload":{ + "shape":"Payload", + "documentation":"You can configure the action payload when you send a message as an Amazon SNS push notification.
" } }, "documentation":"Information required to publish the Amazon SNS message.
" @@ -1303,7 +1541,7 @@ }, "seconds":{ "shape":"Seconds", - "documentation":"The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy.
", + "documentation":"The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds.
", "deprecated":true, "deprecatedMessage":"seconds is deprecated. You can use durationExpression for SetTimerAction. The value of seconds can be used as a string expression for durationExpression." }, @@ -1342,7 +1580,11 @@ }, "useBase64":{ "shape":"UseBase64", - "documentation":"Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue.
" + "documentation":"Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to FALSE.
" + }, + "payload":{ + "shape":"Payload", + "documentation":"You can configure the action payload when you send a message to an Amazon SQS queue.
" } }, "documentation":"Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
" @@ -1365,7 +1607,7 @@ }, "onExit":{ "shape":"OnExitLifecycle", - "documentation":"When exiting this state, perform these actions if the specified condition is TRUE.
When exiting this state, perform these actions if the specified condition is TRUE.
Information that defines a state of a detector.
" @@ -1436,6 +1678,111 @@ "max":256, "min":0 }, + "TagrisAccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"TagrisExceptionMessage"} + }, + "exception":true + }, + "TagrisAccountId":{ + "type":"string", + "max":12, + "min":12 + }, + "TagrisAmazonResourceName":{ + "type":"string", + "max":1011, + "min":1 + }, + "TagrisExceptionMessage":{ + "type":"string", + "max":2048, + "min":0 + }, + "TagrisInternalId":{ + "type":"string", + "max":64, + "min":0 + }, + "TagrisInternalServiceException":{ + "type":"structure", + "members":{ + "message":{"shape":"TagrisExceptionMessage"} + }, + "exception":true, + "fault":true + }, + "TagrisInvalidArnException":{ + "type":"structure", + "members":{ + "message":{"shape":"TagrisExceptionMessage"}, + "sweepListItem":{"shape":"TagrisSweepListItem"} + }, + "exception":true + }, + "TagrisInvalidParameterException":{ + "type":"structure", + "members":{ + "message":{"shape":"TagrisExceptionMessage"} + }, + "exception":true + }, + "TagrisPartialResourcesExistResultsException":{ + "type":"structure", + "members":{ + "message":{"shape":"TagrisExceptionMessage"}, + "resourceExistenceInformation":{"shape":"TagrisSweepListResult"} + }, + "exception":true + }, + "TagrisStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "NOT_ACTIVE" + ] + }, + "TagrisSweepList":{ + "type":"list", + "member":{"shape":"TagrisSweepListItem"} + }, + "TagrisSweepListItem":{ + "type":"structure", + "members":{ + "TagrisAccountId":{"shape":"TagrisAccountId"}, + "TagrisAmazonResourceName":{"shape":"TagrisAmazonResourceName"}, + "TagrisInternalId":{"shape":"TagrisInternalId"}, + "TagrisVersion":{"shape":"TagrisVersion"} + } + }, + "TagrisSweepListResult":{ + "type":"map", + "key":{"shape":"TagrisAmazonResourceName"}, + "value":{"shape":"TagrisStatus"} + }, + "TagrisThrottledException":{ + "type":"structure", + "members":{ + "message":{"shape":"TagrisExceptionMessage"} + }, + "exception":true + }, + "TagrisVerifyResourcesExistInput":{ + "type":"structure", + "required":["TagrisSweepList"], + "members":{ + "TagrisSweepList":{"shape":"TagrisSweepList"} + } + }, + "TagrisVerifyResourcesExistOutput":{ + "type":"structure", + "required":["TagrisSweepListResult"], + "members":{ + "TagrisSweepListResult":{"shape":"TagrisSweepListResult"} + } + }, + "TagrisVersion":{"type":"long"}, "Tags":{ "type":"list", "member":{"shape":"Tag"} @@ -1617,5 +1964,5 @@ "resourceArn":{"type":"string"}, "resourceId":{"type":"string"} }, - "documentation":"AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use AWS IoT Events API commands to create, read, update, and delete inputs and detector models, and to list their versions.
" + "documentation":"AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use AWS IoT Events API operations to create, read, update, and delete inputs and detector models, and to list their versions.
" } diff --git a/botocore/data/kendra/2019-02-03/service-2.json b/botocore/data/kendra/2019-02-03/service-2.json index a1d41930..889b81c8 100644 --- a/botocore/data/kendra/2019-02-03/service-2.json +++ b/botocore/data/kendra/2019-02-03/service-2.json @@ -104,6 +104,7 @@ {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, {"shape":"InternalServerException"} ], "documentation":"Creates a new Amazon Kendra index. Index creation is an asynchronous operation. To determine if index creation has completed, check the Status field returned from a call to . The Status field is set to ACTIVE when the index is ready to use.
Once the index is active you can index your documents using the operation or using one of the supported data sources.
" @@ -481,7 +482,7 @@ "documentation":"Performs a less than or equals operation on two document attributes. Use with a document attribute of type Integer or Long.
Provides filtering the query results based on document attributes.
" + "documentation":"Provides filtering the query results based on document attributes.
When you use the AndAllFilters or OrAllFilters, filters you can use a total of 3 layers. For example, you can use:
<AndAllFilters>
<OrAllFilters>
<EqualTo>
A description for the index.
" + }, + "ClientToken":{ + "shape":"ClientTokenName", + "documentation":"A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex operation with the same client token will create only one index.”
The contents of the document as a base-64 encoded string.
" + "documentation":"The contents of the document.
Documents passed to the Blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an AWS SDK to call Amazon Kendra operations. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.
TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE.
Set to TRUE to use the Microsoft SharePoint change log to determine the documents that need to be updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler.
A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.
The regex is applied to the display URL of the SharePoint document.
" + }, + "ExclusionPatterns":{ + "shape":"DataSourceInclusionsExclusionsStrings", + "documentation":"A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.
The regex is applied to the display URL of the SharePoint document.
" + }, "VpcConfiguration":{"shape":"DataSourceVpcConfiguration"}, "FieldMappings":{ "shape":"DataSourceToIndexFieldMappingList", diff --git a/botocore/data/kinesis-video-archived-media/2017-09-30/examples-1.json b/botocore/data/kinesis-video-archived-media/2017-09-30/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/kinesis-video-archived-media/2017-09-30/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/kinesis-video-media/2017-09-30/examples-1.json b/botocore/data/kinesis-video-media/2017-09-30/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/kinesis-video-media/2017-09-30/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/kinesisvideo/2017-09-30/examples-1.json b/botocore/data/kinesisvideo/2017-09-30/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/kinesisvideo/2017-09-30/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/kms/2014-11-01/examples-1.json b/botocore/data/kms/2014-11-01/examples-1.json index feafe0b1..b0a17a5b 100644 --- a/botocore/data/kms/2014-11-01/examples-1.json +++ b/botocore/data/kms/2014-11-01/examples-1.json @@ -71,20 +71,32 @@ ], "CreateKey": [ { + "input": { + "Tags": [ + { + "TagKey": "CreatedBy", + "TagValue": "ExampleUser" + } + ] + }, "output": { "KeyMetadata": { "AWSAccountId": "111122223333", "Arn": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", - "CreationDate": "2016-11-01T10:15:42-07:00", + "CreationDate": "2017-07-05T14:04:55-07:00", "Description": "", "Enabled": true, "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "KeyManager": "CUSTOMER", "KeyState": "Enabled", "KeyUsage": "ENCRYPT_DECRYPT", "Origin": "AWS_KMS" } }, "comments": { + "input": { + "Tags": "One or more tags. Each tag consists of a tag key and a tag value." + }, "output": { "KeyMetadata": "An object that contains information about the CMK created by this operation." } @@ -155,11 +167,12 @@ "output": { "KeyMetadata": { "AWSAccountId": "111122223333", - "Arn": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", - "CreationDate": "2015-10-12T11:45:07-07:00", + "Arn": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "CreationDate": "2017-07-05T14:04:55-07:00", "Description": "", "Enabled": true, "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "KeyManager": "CUSTOMER", "KeyState": "Enabled", "KeyUsage": "ENCRYPT_DECRYPT", "Origin": "AWS_KMS" @@ -636,6 +649,42 @@ "title": "To list customer master keys (CMKs)" } ], + "ListResourceTags": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "output": { + "Tags": [ + { + "TagKey": "CostCenter", + "TagValue": "87654" + }, + { + "TagKey": "CreatedBy", + "TagValue": "ExampleUser" + }, + { + "TagKey": "Purpose", + "TagValue": "Test" + } + ], + "Truncated": false + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK whose tags you are listing. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + }, + "output": { + "Tags": "A list of tags.", + "Truncated": "A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not." + } + }, + "description": "The following example lists tags for a CMK.", + "id": "to-list-tags-for-a-cmk-1483996855796", + "title": "To list tags for a customer master key (CMK)" + } + ], "ListRetirableGrants": [ { "input": { @@ -777,6 +826,48 @@ "title": "To schedule a customer master key (CMK) for deletion" } ], + "TagResource": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "Tags": [ + { + "TagKey": "Purpose", + "TagValue": "Test" + } + ] + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK you are tagging. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.", + "Tags": "A list of tags." + } + }, + "description": "The following example tags a CMK.", + "id": "to-tag-a-cmk-1483997246518", + "title": "To tag a customer master key (CMK)" + } + ], + "UntagResource": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "TagKeys": [ + "Purpose", + "CostCenter" + ] + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK whose tags you are removing.", + "TagKeys": "A list of tag keys. Provide only the tag keys, not the tag values." + } + }, + "description": "The following example removes tags from a CMK.", + "id": "to-remove-tags-from-a-cmk-1483997590962", + "title": "To remove tags from a customer master key (CMK)" + } + ], "UpdateAlias": [ { "input": { diff --git a/botocore/data/lambda/2015-03-31/examples-1.json b/botocore/data/lambda/2015-03-31/examples-1.json index 9aea28ad..c5a45d3f 100644 --- a/botocore/data/lambda/2015-03-31/examples-1.json +++ b/botocore/data/lambda/2015-03-31/examples-1.json @@ -438,7 +438,7 @@ "CodeSha256": "", "CodeSize": 123, "Description": "", - "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction:1", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction", "FunctionName": "myFunction", "Handler": "index.handler", "LastModified": "2016-11-21T19:49:20.006+0000", diff --git a/botocore/data/lambda/2015-03-31/service-2.json b/botocore/data/lambda/2015-03-31/service-2.json index a7a97c28..c7cb7fb7 100644 --- a/botocore/data/lambda/2015-03-31/service-2.json +++ b/botocore/data/lambda/2015-03-31/service-2.json @@ -48,7 +48,7 @@ {"shape":"TooManyRequestsException"}, {"shape":"PreconditionFailedException"} ], - "documentation":"Grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function.
To grant permission to another account, specify the account ID as the Principal. For AWS services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com or sns.amazonaws.com. For AWS services, you can also specify the ARN or owning account of the associated resource as the SourceArn or SourceAccount. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.
This action adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Lambda Function Policies.
" + "documentation":"Grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function.
To grant permission to another account, specify the account ID as the Principal. For AWS services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com or sns.amazonaws.com. For AWS services, you can also specify the ARN of the associated resource as the SourceArn. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.
This action adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Lambda Function Policies.
" }, "CreateAlias":{ "name":"CreateAlias", @@ -455,7 +455,7 @@ {"shape":"ResourceConflictException"}, {"shape":"ResourceNotReadyException"} ], - "documentation":"Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or asynchronously. To invoke a function asynchronously, set InvocationType to Event.
For synchronous invocation, details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the execution log and trace.
When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type, client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an error, Lambda executes the function up to two more times. For more information, see Retry Behavior.
For asynchronous invocation, Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple times, even if no error occurs. To retain events that were not processed, configure your function with a dead-letter queue.
The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your function from executing, such as permissions errors, limit errors, or issues with your function's code and configuration. For example, Lambda returns TooManyRequestsException if executing the function would cause you to exceed a concurrency limit at either the account level (ConcurrentInvocationLimitExceeded) or function level (ReservedFunctionConcurrentInvocationLimitExceeded).
For functions with a long timeout, your client might be disconnected during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.
This operation requires permission for the lambda:InvokeFunction action.
Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or asynchronously. To invoke a function asynchronously, set InvocationType to Event.
For synchronous invocation, details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the execution log and trace.
When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type, client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an error, Lambda executes the function up to two more times. For more information, see Retry Behavior.
For asynchronous invocation, Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple times, even if no error occurs. To retain events that were not processed, configure your function with a dead-letter queue.
The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your function from executing, such as permissions errors, limit errors, or issues with your function's code and configuration. For example, Lambda returns TooManyRequestsException if executing the function would cause you to exceed a concurrency limit at either the account level (ConcurrentInvocationLimitExceeded) or function level (ReservedFunctionConcurrentInvocationLimitExceeded).
For functions with a long timeout, your client might be disconnected during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.
This operation requires permission for the lambda:InvokeFunction action.
" }, "InvokeAsync":{ "name":"InvokeAsync", @@ -1017,7 +1017,7 @@ }, "SourceAccount":{ "shape":"SourceOwner", - "documentation":"For AWS services, the ID of the account that owns the resource. Use this instead of SourceArn to grant permission to resources that are owned by another account (for example, all of an account's Amazon S3 buckets). Or use it together with SourceArn to ensure that the resource is owned by the specified account. For example, an Amazon S3 bucket could be deleted by its owner and recreated by another account.
For Amazon S3, the ID of the account that owns the resource. Use this together with SourceArn to ensure that the resource is owned by the specified account. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.
The maximum amount of time to gather records before invoking the function, in seconds.
" + "documentation":"(Streams) The maximum amount of time to gather records before invoking the function, in seconds.
" }, "ParallelizationFactor":{ "shape":"ParallelizationFactor", @@ -1583,7 +1583,7 @@ }, "MaximumBatchingWindowInSeconds":{ "shape":"MaximumBatchingWindowInSeconds", - "documentation":"The maximum amount of time to gather records before invoking the function, in seconds.
" + "documentation":"(Streams) The maximum amount of time to gather records before invoking the function, in seconds.
" }, "ParallelizationFactor":{ "shape":"ParallelizationFactor", @@ -3484,6 +3484,7 @@ "dotnetcore1.0", "dotnetcore2.0", "dotnetcore2.1", + "dotnetcore3.1", "nodejs4.3-edge", "go1.x", "ruby2.5", @@ -3764,7 +3765,7 @@ }, "MaximumBatchingWindowInSeconds":{ "shape":"MaximumBatchingWindowInSeconds", - "documentation":"The maximum amount of time to gather records before invoking the function, in seconds.
" + "documentation":"(Streams) The maximum amount of time to gather records before invoking the function, in seconds.
" }, "DestinationConfig":{ "shape":"DestinationConfig", diff --git a/botocore/data/lex-models/2017-04-19/examples-1.json b/botocore/data/lex-models/2017-04-19/examples-1.json new file mode 100644 index 00000000..4a56e6e1 --- /dev/null +++ b/botocore/data/lex-models/2017-04-19/examples-1.json @@ -0,0 +1,758 @@ +{ + "version": "1.0", + "examples": { + "GetBot": [ + { + "input": { + "name": "DocOrderPizza", + "versionOrAlias": "$LATEST" + }, + "output": { + "version": "$LATEST", + "name": "DocOrderPizzaBot", + "abortStatement": { + "messages": [ + { + "content": "I don't understand. Can you try again?", + "contentType": "PlainText" + }, + { + "content": "I'm sorry, I don't understand.", + "contentType": "PlainText" + } + ] + }, + "checksum": "20172ee3-fa06-49b2-bbc5-667c090303e9", + "childDirected": true, + "clarificationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "I'm sorry, I didn't hear that. Can you repeate what you just said?", + "contentType": "PlainText" + }, + { + "content": "Can you say that again?", + "contentType": "PlainText" + } + ] + }, + "createdDate": 1494360160.133, + "description": "Orders a pizza from a local pizzeria.", + "idleSessionTTLInSeconds": 300, + "intents": [ + { + "intentName": "DocOrderPizza", + "intentVersion": "$LATEST" + } + ], + "lastUpdatedDate": 1494360160.133, + "locale": "en-US", + "status": "NOT_BUILT" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows how to get configuration information for a bot.", + "id": "to-get-information-about-a-bot-1494431724188", + "title": "To get information about a bot" + } + ], + "GetBots": [ + { + "input": { + "maxResults": 5, + "nextToken": "" + }, + "output": { + "bots": [ + { + "version": "$LATEST", + "name": "DocOrderPizzaBot", + "createdDate": 1494360160.133, + "description": "Orders a pizza from a local pizzeria.", + "lastUpdatedDate": 1494360160.133, + "status": "NOT_BUILT" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows how to get a list of all of the bots in your account.", + "id": "to-get-a-list-of-bots-1494432220036", + "title": "To get a list of bots" + } + ], + "GetIntent": [ + { + "input": { + "version": "$LATEST", + "name": "DocOrderPizza" + }, + "output": { + "version": "$LATEST", + "name": "DocOrderPizza", + "checksum": "ca9bc13d-afc8-4706-bbaf-091f7a5935d6", + "conclusionStatement": { + "messages": [ + { + "content": "All right, I ordered you a {Crust} crust {Type} pizza with {Sauce} sauce.", + "contentType": "PlainText" + }, + { + "content": "OK, your {Crust} crust {Type} pizza with {Sauce} sauce is on the way.", + "contentType": "PlainText" + } + ], + "responseCard": "foo" + }, + "confirmationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "Should I order your {Crust} crust {Type} pizza with {Sauce} sauce?", + "contentType": "PlainText" + } + ] + }, + "createdDate": 1494359783.453, + "description": "Order a pizza from a local pizzeria.", + "fulfillmentActivity": { + "type": "ReturnIntent" + }, + "lastUpdatedDate": 1494359783.453, + "rejectionStatement": { + "messages": [ + { + "content": "Ok, I'll cancel your order.", + "contentType": "PlainText" + }, + { + "content": "I cancelled your order.", + "contentType": "PlainText" + } + ] + }, + "sampleUtterances": [ + "Order me a pizza.", + "Order me a {Type} pizza.", + "I want a {Crust} crust {Type} pizza", + "I want a {Crust} crust {Type} pizza with {Sauce} sauce." + ], + "slots": [ + { + "name": "Type", + "description": "The type of pizza to order.", + "priority": 1, + "sampleUtterances": [ + "Get me a {Type} pizza.", + "A {Type} pizza please.", + "I'd like a {Type} pizza." + ], + "slotConstraint": "Required", + "slotType": "DocPizzaType", + "slotTypeVersion": "$LATEST", + "valueElicitationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "What type of pizza would you like?", + "contentType": "PlainText" + }, + { + "content": "Vegie or cheese pizza?", + "contentType": "PlainText" + }, + { + "content": "I can get you a vegie or a cheese pizza.", + "contentType": "PlainText" + } + ] + } + }, + { + "name": "Crust", + "description": "The type of pizza crust to order.", + "priority": 2, + "sampleUtterances": [ + "Make it a {Crust} crust.", + "I'd like a {Crust} crust." + ], + "slotConstraint": "Required", + "slotType": "DocPizzaCrustType", + "slotTypeVersion": "$LATEST", + "valueElicitationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "What type of crust would you like?", + "contentType": "PlainText" + }, + { + "content": "Thick or thin crust?", + "contentType": "PlainText" + } + ] + } + }, + { + "name": "Sauce", + "description": "The type of sauce to use on the pizza.", + "priority": 3, + "sampleUtterances": [ + "Make it {Sauce} sauce.", + "I'd like {Sauce} sauce." + ], + "slotConstraint": "Required", + "slotType": "DocPizzaSauceType", + "slotTypeVersion": "$LATEST", + "valueElicitationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "White or red sauce?", + "contentType": "PlainText" + }, + { + "content": "Garlic or tomato sauce?", + "contentType": "PlainText" + } + ] + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows how to get information about an intent.", + "id": "to-get-a-information-about-an-intent-1494432574147", + "title": "To get a information about an intent" + } + ], + "GetIntents": [ + { + "input": { + "maxResults": 10, + "nextToken": "" + }, + "output": { + "intents": [ + { + "version": "$LATEST", + "name": "DocOrderPizza", + "createdDate": 1494359783.453, + "description": "Order a pizza from a local pizzeria.", + "lastUpdatedDate": 1494359783.453 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows how to get a list of all of the intents in your account.", + "id": "to-get-a-list-of-intents-1494432416363", + "title": "To get a list of intents" + } + ], + "GetSlotType": [ + { + "input": { + "version": "$LATEST", + "name": "DocPizzaCrustType" + }, + "output": { + "version": "$LATEST", + "name": "DocPizzaCrustType", + "checksum": "210b3d5a-90a3-4b22-ac7e-f50c2c71095f", + "createdDate": 1494359274.403, + "description": "Available crust types", + "enumerationValues": [ + { + "value": "thick" + }, + { + "value": "thin" + } + ], + "lastUpdatedDate": 1494359274.403 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows how to get information about a slot type.", + "id": "to-get-information-about-a-slot-type-1494432961004", + "title": "To get information about a slot type" + } + ], + "GetSlotTypes": [ + { + "input": { + "maxResults": 10, + "nextToken": "" + }, + "output": { + "slotTypes": [ + { + "version": "$LATEST", + "name": "DocPizzaCrustType", + "createdDate": 1494359274.403, + "description": "Available crust types", + "lastUpdatedDate": 1494359274.403 + }, + { + "version": "$LATEST", + "name": "DocPizzaSauceType", + "createdDate": 1494356442.23, + "description": "Available pizza sauces", + "lastUpdatedDate": 1494356442.23 + }, + { + "version": "$LATEST", + "name": "DocPizzaType", + "createdDate": 1494359198.656, + "description": "Available pizzas", + "lastUpdatedDate": 1494359198.656 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows how to get a list of all of the slot types in your account.", + "id": "to-get-a-list-of-slot-types-1494432757458", + "title": "To get a list of slot types" + } + ], + "PutBot": [ + { + "input": { + "name": "DocOrderPizzaBot", + "abortStatement": { + "messages": [ + { + "content": "I don't understand. Can you try again?", + "contentType": "PlainText" + }, + { + "content": "I'm sorry, I don't understand.", + "contentType": "PlainText" + } + ] + }, + "childDirected": true, + "clarificationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "I'm sorry, I didn't hear that. Can you repeate what you just said?", + "contentType": "PlainText" + }, + { + "content": "Can you say that again?", + "contentType": "PlainText" + } + ] + }, + "description": "Orders a pizza from a local pizzeria.", + "idleSessionTTLInSeconds": 300, + "intents": [ + { + "intentName": "DocOrderPizza", + "intentVersion": "$LATEST" + } + ], + "locale": "en-US", + "processBehavior": "SAVE" + }, + "output": { + "version": "$LATEST", + "name": "DocOrderPizzaBot", + "abortStatement": { + "messages": [ + { + "content": "I don't understand. Can you try again?", + "contentType": "PlainText" + }, + { + "content": "I'm sorry, I don't understand.", + "contentType": "PlainText" + } + ] + }, + "checksum": "20172ee3-fa06-49b2-bbc5-667c090303e9", + "childDirected": true, + "clarificationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "I'm sorry, I didn't hear that. Can you repeate what you just said?", + "contentType": "PlainText" + }, + { + "content": "Can you say that again?", + "contentType": "PlainText" + } + ] + }, + "createdDate": 1494360160.133, + "description": "Orders a pizza from a local pizzeria.", + "idleSessionTTLInSeconds": 300, + "intents": [ + { + "intentName": "DocOrderPizza", + "intentVersion": "$LATEST" + } + ], + "lastUpdatedDate": 1494360160.133, + "locale": "en-US", + "status": "NOT_BUILT" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows how to create a bot for ordering pizzas.", + "id": "to-create-a-bot-1494360003886", + "title": "To create a bot" + } + ], + "PutIntent": [ + { + "input": { + "name": "DocOrderPizza", + "conclusionStatement": { + "messages": [ + { + "content": "All right, I ordered you a {Crust} crust {Type} pizza with {Sauce} sauce.", + "contentType": "PlainText" + }, + { + "content": "OK, your {Crust} crust {Type} pizza with {Sauce} sauce is on the way.", + "contentType": "PlainText" + } + ], + "responseCard": "foo" + }, + "confirmationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "Should I order your {Crust} crust {Type} pizza with {Sauce} sauce?", + "contentType": "PlainText" + } + ] + }, + "description": "Order a pizza from a local pizzeria.", + "fulfillmentActivity": { + "type": "ReturnIntent" + }, + "rejectionStatement": { + "messages": [ + { + "content": "Ok, I'll cancel your order.", + "contentType": "PlainText" + }, + { + "content": "I cancelled your order.", + "contentType": "PlainText" + } + ] + }, + "sampleUtterances": [ + "Order me a pizza.", + "Order me a {Type} pizza.", + "I want a {Crust} crust {Type} pizza", + "I want a {Crust} crust {Type} pizza with {Sauce} sauce." + ], + "slots": [ + { + "name": "Type", + "description": "The type of pizza to order.", + "priority": 1, + "sampleUtterances": [ + "Get me a {Type} pizza.", + "A {Type} pizza please.", + "I'd like a {Type} pizza." + ], + "slotConstraint": "Required", + "slotType": "DocPizzaType", + "slotTypeVersion": "$LATEST", + "valueElicitationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "What type of pizza would you like?", + "contentType": "PlainText" + }, + { + "content": "Vegie or cheese pizza?", + "contentType": "PlainText" + }, + { + "content": "I can get you a vegie or a cheese pizza.", + "contentType": "PlainText" + } + ] + } + }, + { + "name": "Crust", + "description": "The type of pizza crust to order.", + "priority": 2, + "sampleUtterances": [ + "Make it a {Crust} crust.", + "I'd like a {Crust} crust." + ], + "slotConstraint": "Required", + "slotType": "DocPizzaCrustType", + "slotTypeVersion": "$LATEST", + "valueElicitationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "What type of crust would you like?", + "contentType": "PlainText" + }, + { + "content": "Thick or thin crust?", + "contentType": "PlainText" + } + ] + } + }, + { + "name": "Sauce", + "description": "The type of sauce to use on the pizza.", + "priority": 3, + "sampleUtterances": [ + "Make it {Sauce} sauce.", + "I'd like {Sauce} sauce." + ], + "slotConstraint": "Required", + "slotType": "DocPizzaSauceType", + "slotTypeVersion": "$LATEST", + "valueElicitationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "White or red sauce?", + "contentType": "PlainText" + }, + { + "content": "Garlic or tomato sauce?", + "contentType": "PlainText" + } + ] + } + } + ] + }, + "output": { + "version": "$LATEST", + "name": "DocOrderPizza", + "checksum": "ca9bc13d-afc8-4706-bbaf-091f7a5935d6", + "conclusionStatement": { + "messages": [ + { + "content": "All right, I ordered you a {Crust} crust {Type} pizza with {Sauce} sauce.", + "contentType": "PlainText" + }, + { + "content": "OK, your {Crust} crust {Type} pizza with {Sauce} sauce is on the way.", + "contentType": "PlainText" + } + ], + "responseCard": "foo" + }, + "confirmationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "Should I order your {Crust} crust {Type} pizza with {Sauce} sauce?", + "contentType": "PlainText" + } + ] + }, + "createdDate": 1494359783.453, + "description": "Order a pizza from a local pizzeria.", + "fulfillmentActivity": { + "type": "ReturnIntent" + }, + "lastUpdatedDate": 1494359783.453, + "rejectionStatement": { + "messages": [ + { + "content": "Ok, I'll cancel your order.", + "contentType": "PlainText" + }, + { + "content": "I cancelled your order.", + "contentType": "PlainText" + } + ] + }, + "sampleUtterances": [ + "Order me a pizza.", + "Order me a {Type} pizza.", + "I want a {Crust} crust {Type} pizza", + "I want a {Crust} crust {Type} pizza with {Sauce} sauce." + ], + "slots": [ + { + "name": "Sauce", + "description": "The type of sauce to use on the pizza.", + "priority": 3, + "sampleUtterances": [ + "Make it {Sauce} sauce.", + "I'd like {Sauce} sauce." + ], + "slotConstraint": "Required", + "slotType": "DocPizzaSauceType", + "slotTypeVersion": "$LATEST", + "valueElicitationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "White or red sauce?", + "contentType": "PlainText" + }, + { + "content": "Garlic or tomato sauce?", + "contentType": "PlainText" + } + ] + } + }, + { + "name": "Type", + "description": "The type of pizza to order.", + "priority": 1, + "sampleUtterances": [ + "Get me a {Type} pizza.", + "A {Type} pizza please.", + "I'd like a {Type} pizza." + ], + "slotConstraint": "Required", + "slotType": "DocPizzaType", + "slotTypeVersion": "$LATEST", + "valueElicitationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "What type of pizza would you like?", + "contentType": "PlainText" + }, + { + "content": "Vegie or cheese pizza?", + "contentType": "PlainText" + }, + { + "content": "I can get you a vegie or a cheese pizza.", + "contentType": "PlainText" + } + ] + } + }, + { + "name": "Crust", + "description": "The type of pizza crust to order.", + "priority": 2, + "sampleUtterances": [ + "Make it a {Crust} crust.", + "I'd like a {Crust} crust." + ], + "slotConstraint": "Required", + "slotType": "DocPizzaCrustType", + "slotTypeVersion": "$LATEST", + "valueElicitationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "What type of crust would you like?", + "contentType": "PlainText" + }, + { + "content": "Thick or thin crust?", + "contentType": "PlainText" + } + ] + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows how to create an intent for ordering pizzas.", + "id": "to-create-an-intent-1494358144659", + "title": "To create an intent" + } + ], + "PutSlotType": [ + { + "input": { + "name": "PizzaSauceType", + "description": "Available pizza sauces", + "enumerationValues": [ + { + "value": "red" + }, + { + "value": "white" + } + ] + }, + "output": { + "version": "$LATEST", + "name": "DocPizzaSauceType", + "checksum": "cfd00ed1-775d-4357-947c-aca7e73b44ba", + "createdDate": 1494356442.23, + "description": "Available pizza sauces", + "enumerationValues": [ + { + "value": "red" + }, + { + "value": "white" + } + ], + "lastUpdatedDate": 1494356442.23 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows how to create a slot type that describes pizza sauces.", + "id": "to-create-a-slot-type-1494357262258", + "title": "To Create a Slot Type" + } + ] + } +} diff --git a/botocore/data/lex-runtime/2016-11-28/examples-1.json b/botocore/data/lex-runtime/2016-11-28/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/lex-runtime/2016-11-28/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/macie/2017-12-19/examples-1.json b/botocore/data/macie/2017-12-19/examples-1.json new file mode 100644 index 00000000..faff7689 --- /dev/null +++ b/botocore/data/macie/2017-12-19/examples-1.json @@ -0,0 +1,5 @@ +{ + "version":"1.0", + "examples":{ + } +} diff --git a/botocore/data/managedblockchain/2018-09-24/service-2.json b/botocore/data/managedblockchain/2018-09-24/service-2.json index 36523922..8996a8c3 100644 --- a/botocore/data/managedblockchain/2018-09-24/service-2.json +++ b/botocore/data/managedblockchain/2018-09-24/service-2.json @@ -310,6 +310,40 @@ ], "documentation":"Rejects an invitation to join a network. This action can be called by a principal in an AWS account that has received an invitation to create a member and join a network.
" }, + "UpdateMember":{ + "name":"UpdateMember", + "http":{ + "method":"PATCH", + "requestUri":"/networks/{networkId}/members/{memberId}" + }, + "input":{"shape":"UpdateMemberInput"}, + "output":{"shape":"UpdateMemberOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"Updates a member configuration with new parameters.
" + }, + "UpdateNode":{ + "name":"UpdateNode", + "http":{ + "method":"PATCH", + "requestUri":"/networks/{networkId}/members/{memberId}/nodes/{nodeId}" + }, + "input":{"shape":"UpdateNodeInput"}, + "output":{"shape":"UpdateNodeOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"Updates a node configuration with new parameters.
" + }, "VoteOnProposal":{ "name":"VoteOnProposal", "http":{ @@ -614,6 +648,10 @@ "STANDARD" ] }, + "Enabled":{ + "type":"boolean", + "box":true + }, "Framework":{ "type":"string", "enum":["HYPERLEDGER_FABRIC"] @@ -1092,6 +1130,26 @@ } } }, + "LogConfiguration":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Enabled", + "documentation":"Indicates whether logging is enabled.
" + } + }, + "documentation":"A configuration for logging events.
" + }, + "LogConfigurations":{ + "type":"structure", + "members":{ + "Cloudwatch":{ + "shape":"LogConfiguration", + "documentation":"Parameters for publishing logs to Amazon CloudWatch Logs.
" + } + }, + "documentation":"A collection of log configurations.
" + }, "Member":{ "type":"structure", "members":{ @@ -1115,6 +1173,10 @@ "shape":"MemberFrameworkAttributes", "documentation":"Attributes relevant to a member for the blockchain framework that the Managed Blockchain network uses.
" }, + "LogPublishingConfiguration":{ + "shape":"MemberLogPublishingConfiguration", + "documentation":"Configuration properties for logging events associated with a member.
" + }, "Status":{ "shape":"MemberStatus", "documentation":"The status of a member.
CREATING - The AWS account is in the process of creating a member.
AVAILABLE - The member has been created and can participate in the network.
CREATE_FAILED - The AWS account attempted to create a member and creation failed.
DELETING - The member and all associated resources are in the process of being deleted. Either the AWS account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.
DELETED - The member can no longer participate on the network and all associated resources are deleted. Either the AWS account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.
Configuration properties of the blockchain framework relevant to the member.
" + }, + "LogPublishingConfiguration":{ + "shape":"MemberLogPublishingConfiguration", + "documentation":"" } }, "documentation":"Configuration properties of the member.
" @@ -1180,6 +1246,16 @@ }, "documentation":"Configuration properties for Hyperledger Fabric for a member in a Managed Blockchain network using the Hyperledger Fabric framework.
" }, + "MemberFabricLogPublishingConfiguration":{ + "type":"structure", + "members":{ + "CaLogs":{ + "shape":"LogConfigurations", + "documentation":"Configuration properties for logging events associated with a member's Certificate Authority (CA). CA logs help you determine when a member in your account joins the network, or when new peers register with a member CA.
" + } + }, + "documentation":"Configuration properties for logging events associated with a member of a Managed Blockchain network using the Hyperledger Fabric framework.
" + }, "MemberFrameworkAttributes":{ "type":"structure", "members":{ @@ -1206,12 +1282,23 @@ "max":20, "min":1 }, + "MemberLogPublishingConfiguration":{ + "type":"structure", + "members":{ + "Fabric":{ + "shape":"MemberFabricLogPublishingConfiguration", + "documentation":"Configuration properties for logging events associated with a member of a Managed Blockchain network using the Hyperledger Fabric framework.
" + } + }, + "documentation":"Configuration properties for logging events associated with a member of a Managed Blockchain network.
" + }, "MemberStatus":{ "type":"string", "enum":[ "CREATING", "AVAILABLE", "CREATE_FAILED", + "UPDATING", "DELETING", "DELETED" ] @@ -1311,7 +1398,7 @@ }, "Edition":{ "shape":"Edition", - "documentation":"The edition of Amazon Managed Blockchain that Hyperledger Fabric uses. For more information, see Amazon Managed Blockchain Pricing.
" + "documentation":"The edition of Amazon Managed Blockchain that Hyperledger Fabric uses. For more information, see Amazon Managed Blockchain Pricing.
" } }, "documentation":"Attributes of Hyperledger Fabric for a network.
" @@ -1322,7 +1409,7 @@ "members":{ "Edition":{ "shape":"Edition", - "documentation":"The edition of Amazon Managed Blockchain that the network uses. For more information, see Amazon Managed Blockchain Pricing.
" + "documentation":"The edition of Amazon Managed Blockchain that the network uses. For more information, see Amazon Managed Blockchain Pricing.
" } }, "documentation":"Hyperledger Fabric configuration properties for the network.
" @@ -1434,6 +1521,10 @@ "shape":"NodeFrameworkAttributes", "documentation":"Attributes of the blockchain framework being used.
" }, + "LogPublishingConfiguration":{ + "shape":"NodeLogPublishingConfiguration", + "documentation":"" + }, "Status":{ "shape":"NodeStatus", "documentation":"The status of the node.
" @@ -1459,6 +1550,10 @@ "AvailabilityZone":{ "shape":"AvailabilityZoneString", "documentation":"The Availability Zone in which the node exists.
" + }, + "LogPublishingConfiguration":{ + "shape":"NodeLogPublishingConfiguration", + "documentation":"" } }, "documentation":"Configuration properties of a peer node.
" @@ -1477,6 +1572,20 @@ }, "documentation":"Attributes of Hyperledger Fabric for a peer node on a Managed Blockchain network that uses Hyperledger Fabric.
" }, + "NodeFabricLogPublishingConfiguration":{ + "type":"structure", + "members":{ + "ChaincodeLogs":{ + "shape":"LogConfigurations", + "documentation":"Configuration properties for logging events associated with chaincode execution on a peer node. Chaincode logs contain the results of instantiating, invoking, and querying the chaincode. A peer can run multiple instances of chaincode. When enabled, a log stream is created for all chaincodes, with an individual log stream for each chaincode.
" + }, + "PeerLogs":{ + "shape":"LogConfigurations", + "documentation":"Configuration properties for a peer node log. Peer node logs contain messages generated when your client submits transaction proposals to peer nodes, requests to join channels, enrolls an admin peer, and lists the chaincode instances on a peer node.
" + } + }, + "documentation":"Configuration properties for logging events associated with a peer node owned by a member in a Managed Blockchain network.
" + }, "NodeFrameworkAttributes":{ "type":"structure", "members":{ @@ -1493,12 +1602,23 @@ "max":20, "min":1 }, + "NodeLogPublishingConfiguration":{ + "type":"structure", + "members":{ + "Fabric":{ + "shape":"NodeFabricLogPublishingConfiguration", + "documentation":"Configuration properties for logging events associated with a node that is owned by a member of a Managed Blockchain network using the Hyperledger Fabric framework.
" + } + }, + "documentation":"Configuration properties for logging events associated with a peer node owned by a member in a Managed Blockchain network.
" + }, "NodeStatus":{ "type":"string", "enum":[ "CREATING", "AVAILABLE", "CREATE_FAILED", + "UPDATING", "DELETING", "DELETED", "FAILED" @@ -1575,7 +1695,7 @@ }, "Status":{ "shape":"ProposalStatus", - "documentation":"The status of the proposal. Values are as follows:
IN_PROGRESS - The proposal is active and open for member voting.
APPROVED - The proposal was approved with sufficient YES votes among members according to the VotingPolicy specified for the Network. The specified proposal actions are carried out.
REJECTED - The proposal was rejected with insufficient YES votes among members according to the VotingPolicy specified for the Network. The specified ProposalActions are not carried out.
EXPIRED - Members did not cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions are not carried out.
ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved could not be completed because of an error.
The status of the proposal. Values are as follows:
IN_PROGRESS - The proposal is active and open for member voting.
APPROVED - The proposal was approved with sufficient YES votes among members according to the VotingPolicy specified for the Network. The specified proposal actions are carried out.
REJECTED - The proposal was rejected with insufficient YES votes among members according to the VotingPolicy specified for the Network. The specified ProposalActions are not carried out.
EXPIRED - Members did not cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions are not carried out.
ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved could not be completed because of an error. The ACTION_FAILED status occurs even if only one ProposalAction fails and other actions are successful.
The unique ID of the Managed Blockchain network to which the member belongs.
", + "location":"uri", + "locationName":"networkId" + }, + "MemberId":{ + "shape":"ResourceIdString", + "documentation":"The unique ID of the member.
", + "location":"uri", + "locationName":"memberId" + }, + "LogPublishingConfiguration":{ + "shape":"MemberLogPublishingConfiguration", + "documentation":"Configuration properties for publishing to Amazon CloudWatch Logs.
" + } + } + }, + "UpdateMemberOutput":{ + "type":"structure", + "members":{ + } + }, + "UpdateNodeInput":{ + "type":"structure", + "required":[ + "NetworkId", + "MemberId", + "NodeId" + ], + "members":{ + "NetworkId":{ + "shape":"ResourceIdString", + "documentation":"The unique ID of the Managed Blockchain network to which the node belongs.
", + "location":"uri", + "locationName":"networkId" + }, + "MemberId":{ + "shape":"ResourceIdString", + "documentation":"The unique ID of the member that owns the node.
", + "location":"uri", + "locationName":"memberId" + }, + "NodeId":{ + "shape":"ResourceIdString", + "documentation":"The unique ID of the node.
", + "location":"uri", + "locationName":"nodeId" + }, + "LogPublishingConfiguration":{ + "shape":"NodeLogPublishingConfiguration", + "documentation":"Configuration properties for publishing to Amazon CloudWatch Logs.
" + } + } + }, + "UpdateNodeOutput":{ + "type":"structure", + "members":{ + } + }, "UsernameString":{ "type":"string", "max":16, diff --git a/botocore/data/marketplace-entitlement/2017-01-11/examples-1.json b/botocore/data/marketplace-entitlement/2017-01-11/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/marketplace-entitlement/2017-01-11/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/mediaconnect/2018-11-14/service-2.json b/botocore/data/mediaconnect/2018-11-14/service-2.json index c55acdb3..910ab221 100644 --- a/botocore/data/mediaconnect/2018-11-14/service-2.json +++ b/botocore/data/mediaconnect/2018-11-14/service-2.json @@ -99,6 +99,48 @@ ], "documentation": "Adds Sources to flow" }, + "AddFlowVpcInterfaces": { + "name": "AddFlowVpcInterfaces", + "http": { + "method": "POST", + "requestUri": "/v1/flows/{flowArn}/vpcInterfaces", + "responseCode": 201 + }, + "input": { + "shape": "AddFlowVpcInterfacesRequest" + }, + "output": { + "shape": "AddFlowVpcInterfacesResponse", + "documentation": "The following VPC interface was added to the Flow configuration." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The request that you submitted is not valid." + }, + { + "shape": "InternalServerErrorException", + "documentation": "AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have the required permissions to perform this operation." + }, + { + "shape": "NotFoundException", + "documentation": "AWS Elemental MediaConnect did not find the resource that you specified in the request." + }, + { + "shape": "ServiceUnavailableException", + "documentation": "AWS Elemental MediaConnect is currently unavailable. Try again later." + }, + { + "shape": "TooManyRequestsException", + "documentation": "You have exceeded the service request rate limit for your AWS Elemental MediaConnect account." + } + ], + "documentation": "Adds VPC interfaces to flow" + }, "CreateFlow": { "name": "CreateFlow", "http": { @@ -453,6 +495,48 @@ ], "documentation": "Removes a source from an existing flow. This request can be made only if there is more than one source on the flow." }, + "RemoveFlowVpcInterface": { + "name": "RemoveFlowVpcInterface", + "http": { + "method": "DELETE", + "requestUri": "/v1/flows/{flowArn}/vpcInterfaces/{vpcInterfaceName}", + "responseCode": 200 + }, + "input": { + "shape": "RemoveFlowVpcInterfaceRequest" + }, + "output": { + "shape": "RemoveFlowVpcInterfaceResponse", + "documentation": "VPC interface successfully removed from flow configuration." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The request that you submitted is not valid." + }, + { + "shape": "InternalServerErrorException", + "documentation": "AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have the required permissions to perform this operation." + }, + { + "shape": "NotFoundException", + "documentation": "AWS Elemental MediaConnect did not find the resource that you specified in the request." + }, + { + "shape": "ServiceUnavailableException", + "documentation": "AWS Elemental MediaConnect is currently unavailable. Try again later." + }, + { + "shape": "TooManyRequestsException", + "documentation": "You have exceeded the service request rate limit for your AWS Elemental MediaConnect account." + } + ], + "documentation": "Removes a VPC Interface from an existing flow. This request can be made only on a VPC interface that does not have a Source or Output associated with it. If the VPC interface is referenced by a Source or Output, you must first delete or update the Source or Output to no longer reference the VPC interface." + }, "RevokeFlowEntitlement": { "name": "RevokeFlowEntitlement", "http": { @@ -891,6 +975,42 @@ } } }, + "AddFlowVpcInterfacesRequest": { + "type": "structure", + "members": { + "FlowArn": { + "shape": "__string", + "location": "uri", + "locationName": "flowArn", + "documentation": "The flow that you want to mutate." + }, + "VpcInterfaces": { + "shape": "__listOfVpcInterfaceRequest", + "locationName": "vpcInterfaces", + "documentation": "A list of VPC interfaces that you want to add." + } + }, + "documentation": "A request to add VPC interfaces to the flow.", + "required": [ + "FlowArn", + "VpcInterfaces" + ] + }, + "AddFlowVpcInterfacesResponse": { + "type": "structure", + "members": { + "FlowArn": { + "shape": "__string", + "locationName": "flowArn", + "documentation": "The ARN of the flow that these VPC interfaces were added to." + }, + "VpcInterfaces": { + "shape": "__listOfVpcInterface", + "locationName": "vpcInterfaces", + "documentation": "The details of the newly added VPC interfaces." + } + } + }, "AddOutputRequest": { "type": "structure", "members": { @@ -948,6 +1068,11 @@ "shape": "__string", "locationName": "streamId", "documentation": "The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams." + }, + "VpcInterfaceAttachment": { + "shape": "VpcInterfaceAttachment", + "locationName": "vpcInterfaceAttachment", + "documentation": "The name of the VPC interface attachment to use for this output." } }, "documentation": "The output that you want to add to this flow.", @@ -1033,6 +1158,11 @@ "Sources": { "shape": "__listOfSetSourceRequest", "locationName": "sources" + }, + "VpcInterfaces": { + "shape": "__listOfVpcInterfaceRequest", + "locationName": "vpcInterfaces", + "documentation": "The VPC interfaces you want on the flow." } }, "documentation": "Creates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50).", @@ -1270,6 +1400,11 @@ "shape": "Status", "locationName": "status", "documentation": "The current status of the flow." + }, + "VpcInterfaces": { + "shape": "__listOfVpcInterface", + "locationName": "vpcInterfaces", + "documentation": "The VPC Interfaces for this flow." } }, "documentation": "The settings for a flow, including its source, outputs, and entitlements.", @@ -1660,6 +1795,11 @@ "shape": "Transport", "locationName": "transport", "documentation": "Attributes related to the transport stream that are used in the output." + }, + "VpcInterfaceAttachment": { + "shape": "VpcInterfaceAttachment", + "locationName": "vpcInterfaceAttachment", + "documentation": "The name of the VPC interface attachment to use for this output." } }, "documentation": "The settings for an output.", @@ -1750,6 +1890,47 @@ } } }, + "RemoveFlowVpcInterfaceRequest": { + "type": "structure", + "members": { + "FlowArn": { + "shape": "__string", + "location": "uri", + "locationName": "flowArn", + "documentation": "The flow that you want to remove a VPC interface from." + }, + "VpcInterfaceName": { + "shape": "__string", + "location": "uri", + "locationName": "vpcInterfaceName", + "documentation": "The name of the VPC interface that you want to remove." + } + }, + "required": [ + "FlowArn", + "VpcInterfaceName" + ] + }, + "RemoveFlowVpcInterfaceResponse": { + "type": "structure", + "members": { + "FlowArn": { + "shape": "__string", + "locationName": "flowArn", + "documentation": "The ARN of the flow that is associated with the VPC interface you removed." + }, + "NonDeletedNetworkInterfaceIds": { + "shape": "__listOf__string", + "locationName": "nonDeletedNetworkInterfaceIds", + "documentation": "IDs of network interfaces associated with the removed VPC interface that Media Connect was unable to remove." + }, + "VpcInterfaceName": { + "shape": "__string", + "locationName": "vpcInterfaceName", + "documentation": "The name of the VPC interface that was removed." + } + } + }, "ResponseError": { "type": "structure", "members": { @@ -1866,6 +2047,11 @@ "locationName": "streamId", "documentation": "The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams." }, + "VpcInterfaceName": { + "shape": "__string", + "locationName": "vpcInterfaceName", + "documentation": "The name of the VPC interface to use for this source." + }, "WhitelistCidr": { "shape": "__string", "locationName": "whitelistCidr", @@ -1922,6 +2108,11 @@ "locationName": "transport", "documentation": "Attributes related to the transport stream that are used in the source." }, + "VpcInterfaceName": { + "shape": "__string", + "locationName": "vpcInterfaceName", + "documentation": "The name of the VPC Interface this Source is configured with." + }, "WhitelistCidr": { "shape": "__string", "locationName": "whitelistCidr", @@ -2303,6 +2494,11 @@ "shape": "__string", "locationName": "streamId", "documentation": "The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams." + }, + "VpcInterfaceAttachment": { + "shape": "VpcInterfaceAttachment", + "locationName": "vpcInterfaceAttachment", + "documentation": "The name of the VPC interface attachment to use for this output." } }, "documentation": "The fields that you want to update in the output.", @@ -2408,6 +2604,11 @@ "locationName": "streamId", "documentation": "The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams." }, + "VpcInterfaceName": { + "shape": "__string", + "locationName": "vpcInterfaceName", + "documentation": "The name of the VPC Interface to configure this Source with." + }, "WhitelistCidr": { "shape": "__string", "locationName": "whitelistCidr", @@ -2435,6 +2636,87 @@ } } }, + "VpcInterface": { + "type": "structure", + "members": { + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "Immutable and has to be a unique against other VpcInterfaces in this Flow" + }, + "NetworkInterfaceIds": { + "shape": "__listOf__string", + "locationName": "networkInterfaceIds", + "documentation": "IDs of the network interfaces created in customer's account by MediaConnect." + }, + "RoleArn": { + "shape": "__string", + "locationName": "roleArn", + "documentation": "Role Arn MediaConnect can assumes to create ENIs in customer's account" + }, + "SecurityGroupIds": { + "shape": "__listOf__string", + "locationName": "securityGroupIds", + "documentation": "Security Group IDs to be used on ENI." + }, + "SubnetId": { + "shape": "__string", + "locationName": "subnetId", + "documentation": "Subnet must be in the AZ of the Flow" + } + }, + "documentation": "The settings for a VPC Source.", + "required": [ + "NetworkInterfaceIds", + "SubnetId", + "SecurityGroupIds", + "RoleArn", + "Name" + ] + }, + "VpcInterfaceAttachment": { + "type": "structure", + "members": { + "VpcInterfaceName": { + "shape": "__string", + "locationName": "vpcInterfaceName", + "documentation": "The name of the VPC interface to use for this output." + } + }, + "documentation": "The settings for attaching a VPC interface to an output." + }, + "VpcInterfaceRequest": { + "type": "structure", + "members": { + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the VPC Interface. This value must be unique within the current flow." + }, + "RoleArn": { + "shape": "__string", + "locationName": "roleArn", + "documentation": "Role Arn MediaConnect can assumes to create ENIs in customer's account" + }, + "SecurityGroupIds": { + "shape": "__listOf__string", + "locationName": "securityGroupIds", + "documentation": "Security Group IDs to be used on ENI." + }, + "SubnetId": { + "shape": "__string", + "locationName": "subnetId", + "documentation": "Subnet must be in the AZ of the Flow" + } + }, + "documentation": "Desired VPC Interface for a Flow", + "required": [ + "SubnetId", + "SecurityGroupIds", + "RoleArn", + "Name" + ] + }, "__boolean": { "type": "boolean" }, @@ -2492,6 +2774,18 @@ "shape": "Source" } }, + "__listOfVpcInterface": { + "type": "list", + "member": { + "shape": "VpcInterface" + } + }, + "__listOfVpcInterfaceRequest": { + "type": "list", + "member": { + "shape": "VpcInterfaceRequest" + } + }, "__listOf__integer": { "type": "list", "member": { @@ -2529,4 +2823,4 @@ } }, "documentation": "API for AWS Elemental MediaConnect" -} +} \ No newline at end of file diff --git a/botocore/data/mediaconvert/2017-08-29/service-2.json b/botocore/data/mediaconvert/2017-08-29/service-2.json index a131164b..cfe5f757 100644 --- a/botocore/data/mediaconvert/2017-08-29/service-2.json +++ b/botocore/data/mediaconvert/2017-08-29/service-2.json @@ -1264,7 +1264,7 @@ "documentation": "Specify the conditions when the service will run your job with accelerated transcoding." } }, - "documentation": "Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide.", + "documentation": "Accelerated transcoding can significantly speed up jobs with long, visually complex content.", "required": [ "Mode" ] @@ -1824,7 +1824,7 @@ }, "BillingTagsSource": { "type": "string", - "documentation": "Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted.", + "documentation": "The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up.", "enum": [ "QUEUE", "PRESET", @@ -2142,6 +2142,22 @@ }, "documentation": "Set up captions in your outputs by first selecting them from your input here." }, + "CaptionSourceFramerate": { + "type": "structure", + "members": { + "FramerateDenominator": { + "shape": "__integerMin1Max1001", + "locationName": "framerateDenominator", + "documentation": "Specify the denominator of the fraction that represents the framerate for the setting Caption source framerate (CaptionSourceFramerate). Use this setting along with the setting Framerate numerator (framerateNumerator)." + }, + "FramerateNumerator": { + "shape": "__integerMin1Max60000", + "locationName": "framerateNumerator", + "documentation": "Specify the numerator of the fraction that represents the framerate for the setting Caption source framerate (CaptionSourceFramerate). Use this setting along with the setting Framerate denominator (framerateDenominator)." + } + }, + "documentation": "Ignore this setting unless your input captions format is SCC. To have the service compensate for differing framerates between your input captions and input video, specify the framerate of the captions file. Specify this value as a fraction, using the settings Framerate numerator (framerateNumerator) and Framerate denominator (framerateDenominator). For example, you might specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for 23.976 fps, or 30000 / 1001 for 29.97 fps." + }, "CaptionSourceSettings": { "type": "structure", "members": { @@ -2664,7 +2680,7 @@ "AccelerationSettings": { "shape": "AccelerationSettings", "locationName": "accelerationSettings", - "documentation": "Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide." + "documentation": "Optional. Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide." }, "BillingTagsSource": { "shape": "BillingTagsSource", @@ -2674,18 +2690,23 @@ "ClientRequestToken": { "shape": "__string", "locationName": "clientRequestToken", - "documentation": "Idempotency token for CreateJob operation.", + "documentation": "Optional. Idempotency token for CreateJob operation.", "idempotencyToken": true }, + "HopDestinations": { + "shape": "__listOfHopDestination", + "locationName": "hopDestinations", + "documentation": "Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide." + }, "JobTemplate": { "shape": "__string", "locationName": "jobTemplate", - "documentation": "When you create a job, you can either specify a job template or specify the transcoding settings individually" + "documentation": "Optional. When you create a job, you can either specify a job template or specify the transcoding settings individually." }, "Priority": { "shape": "__integerMinNegative50Max50", "locationName": "priority", - "documentation": "Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0." + "documentation": "Optional. Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0." }, "Queue": { "shape": "__string", @@ -2705,22 +2726,22 @@ "SimulateReservedQueue": { "shape": "SimulateReservedQueue", "locationName": "simulateReservedQueue", - "documentation": "Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default." + "documentation": "Optional. Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default." }, "StatusUpdateInterval": { "shape": "StatusUpdateInterval", "locationName": "statusUpdateInterval", - "documentation": "Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error." + "documentation": "Optional. Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error." }, "Tags": { "shape": "__mapOf__string", "locationName": "tags", - "documentation": "The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key." + "documentation": "Optional. The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key." }, "UserMetadata": { "shape": "__mapOf__string", "locationName": "userMetadata", - "documentation": "User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs." + "documentation": "Optional. User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs." } }, "required": [ @@ -2756,6 +2777,11 @@ "locationName": "description", "documentation": "Optional. A description of the job template you are creating." }, + "HopDestinations": { + "shape": "__listOfHopDestination", + "locationName": "hopDestinations", + "documentation": "Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide." + }, "Name": { "shape": "__string", "locationName": "name", @@ -4080,6 +4106,11 @@ "locationName": "convert608To708", "documentation": "Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708." }, + "Framerate": { + "shape": "CaptionSourceFramerate", + "locationName": "framerate", + "documentation": "Ignore this setting unless your input captions format is SCC. To have the service compensate for differing framerates between your input captions and input video, specify the framerate of the captions file. Specify this value as a fraction, using the settings Framerate numerator (framerateNumerator) and Framerate denominator (framerateDenominator). For example, you might specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for 23.976 fps, or 30000 / 1001 for 29.97 fps." + }, "SourceFile": { "shape": "__stringMin14PatternS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMIHttpsSccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMI", "locationName": "sourceFile", @@ -5589,6 +5620,27 @@ "TDRL" ] }, + "HopDestination": { + "type": "structure", + "members": { + "Priority": { + "shape": "__integerMinNegative50Max50", + "locationName": "priority", + "documentation": "Optional. When you set up a job to use queue hopping, you can specify a different relative priority for the job in the destination queue. If you don't specify, the relative priority will remain the same as in the previous queue." + }, + "Queue": { + "shape": "__string", + "locationName": "queue", + "documentation": "Optional unless the job is submitted on the default queue. When you set up a job to use queue hopping, you can specify a destination queue. This queue cannot be the original queue to which the job is submitted. If the original queue isn't the default queue and you don't specify the destination queue, the job will move to the default queue." + }, + "WaitMinutes": { + "shape": "__integer", + "locationName": "waitMinutes", + "documentation": "Required for setting up a job to use queue hopping. Minimum wait time in minutes until the job can hop to the destination queue. Valid range is 1 to 1440 minutes, inclusive." + } + }, + "documentation": "Optional. Configuration for a destination queue to which the job can hop once a customer-defined minimum wait time has passed." + }, "Id3Insertion": { "type": "structure", "members": { @@ -6013,7 +6065,7 @@ "BillingTagsSource": { "shape": "BillingTagsSource", "locationName": "billingTagsSource", - "documentation": "Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted." + "documentation": "The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up." }, "CreatedAt": { "shape": "__timestampUnix", @@ -6035,6 +6087,11 @@ "locationName": "errorMessage", "documentation": "Error message of Job" }, + "HopDestinations": { + "shape": "__listOfHopDestination", + "locationName": "hopDestinations", + "documentation": "Optional list of hop destinations." + }, "Id": { "shape": "__string", "locationName": "id", @@ -6068,7 +6125,12 @@ "Queue": { "shape": "__string", "locationName": "queue", - "documentation": "Optional. When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html" + "documentation": "When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html" + }, + "QueueTransitions": { + "shape": "__listOfQueueTransition", + "locationName": "queueTransitions", + "documentation": "The job's queue hopping history." }, "RetryCount": { "shape": "__integer", @@ -6232,6 +6294,11 @@ "locationName": "description", "documentation": "An optional description you create for each job template." }, + "HopDestinations": { + "shape": "__listOfHopDestination", + "locationName": "hopDestinations", + "documentation": "Optional list of hop destinations." + }, "LastUpdated": { "shape": "__timestampUnix", "locationName": "lastUpdated", @@ -6561,7 +6628,7 @@ "Order": { "shape": "Order", "locationName": "order", - "documentation": "When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.", + "documentation": "Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.", "location": "querystring" } } @@ -6593,25 +6660,25 @@ "NextToken": { "shape": "__string", "locationName": "nextToken", - "documentation": "Use this string, provided with the response to a previous request, to request the next batch of jobs.", + "documentation": "Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.", "location": "querystring" }, "Order": { "shape": "Order", "locationName": "order", - "documentation": "When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.", + "documentation": "Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.", "location": "querystring" }, "Queue": { "shape": "__string", "locationName": "queue", - "documentation": "Provide a queue name to get back only jobs from that queue.", + "documentation": "Optional. Provide a queue name to get back only jobs from that queue.", "location": "querystring" }, "Status": { "shape": "JobStatus", "locationName": "status", - "documentation": "A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.", + "documentation": "Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.", "location": "querystring" } } @@ -6661,7 +6728,7 @@ "Order": { "shape": "Order", "locationName": "order", - "documentation": "When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.", + "documentation": "Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.", "location": "querystring" } } @@ -6705,7 +6772,7 @@ "Order": { "shape": "Order", "locationName": "order", - "documentation": "When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.", + "documentation": "Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.", "location": "querystring" } } @@ -7997,7 +8064,7 @@ }, "Order": { "type": "string", - "documentation": "When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.", + "documentation": "Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.", "enum": [ "ASCENDING", "DESCENDING" @@ -8476,6 +8543,27 @@ "PAUSED" ] }, + "QueueTransition": { + "type": "structure", + "members": { + "DestinationQueue": { + "shape": "__string", + "locationName": "destinationQueue", + "documentation": "The queue that the job was on after the transition." + }, + "SourceQueue": { + "shape": "__string", + "locationName": "sourceQueue", + "documentation": "The queue that the job was on before the transition." + }, + "Timestamp": { + "shape": "__timestampUnix", + "locationName": "timestamp", + "documentation": "The time, in Unix epoch format, that the job moved from the source queue to the destination queue." + } + }, + "documentation": "Description of the source and destination queues between which the job has moved, along with the timestamp of the move" + }, "Rectangle": { "type": "structure", "members": { @@ -9095,6 +9183,11 @@ "locationName": "description", "documentation": "The new description for the job template, if you are changing it." }, + "HopDestinations": { + "shape": "__listOfHopDestination", + "locationName": "hopDestinations", + "documentation": "Optional list of hop destinations." + }, "Name": { "shape": "__string", "locationName": "name", @@ -9758,6 +9851,11 @@ "min": 1, "max": 6 }, + "__integerMin1Max60000": { + "type": "integer", + "min": 1, + "max": 60000 + }, "__integerMin1Max64": { "type": "integer", "min": 1, @@ -9947,6 +10045,12 @@ "shape": "HlsCaptionLanguageMapping" } }, + "__listOfHopDestination": { + "type": "list", + "member": { + "shape": "HopDestination" + } + }, "__listOfId3Insertion": { "type": "list", "member": { @@ -10037,6 +10141,12 @@ "shape": "Queue" } }, + "__listOfQueueTransition": { + "type": "list", + "member": { + "shape": "QueueTransition" + } + }, "__listOfTeletextPageType": { "type": "list", "member": { @@ -10306,4 +10416,4 @@ } }, "documentation": "AWS Elemental MediaConvert" -} \ No newline at end of file +} diff --git a/botocore/data/medialive/2017-10-14/service-2.json b/botocore/data/medialive/2017-10-14/service-2.json index e55be090..f80eb035 100644 --- a/botocore/data/medialive/2017-10-14/service-2.json +++ b/botocore/data/medialive/2017-10-14/service-2.json @@ -2572,6 +2572,25 @@ "COMMON" ] }, + "AutomaticInputFailoverSettings": { + "type": "structure", + "members": { + "InputPreference": { + "shape": "InputPreference", + "locationName": "inputPreference", + "documentation": "Input preference when deciding which input to make active when a previously failed input has recovered." + }, + "SecondaryInputId": { + "shape": "__string", + "locationName": "secondaryInputId", + "documentation": "The input ID of the secondary input in the automatic input failover pair." + } + }, + "documentation": "The settings for Automatic Input Failover.", + "required": [ + "SecondaryInputId" + ] + }, "AvailBlanking": { "type": "structure", "members": { @@ -5727,6 +5746,14 @@ "ENABLED" ] }, + "H264ForceFieldPictures": { + "type": "string", + "documentation": "H264 Force Field Pictures", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, "H264FramerateControl": { "type": "string", "documentation": "H264 Framerate Control", @@ -5882,6 +5909,11 @@ "locationName": "flickerAq", "documentation": "If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames." }, + "ForceFieldPictures": { + "shape": "H264ForceFieldPictures", + "locationName": "forceFieldPictures", + "documentation": "This setting applies only when scan type is \"interlaced.\" It controls whether coding is on a field basis or a frame basis. (When the video is progressive, the coding is always on a frame basis.)\nenabled: Always code on a field basis, so that odd and even sets of fields are coded separately.\ndisabled: Code the two sets of fields separately (on a field basis) or together (on a frame basis, using PAFF or MBAFF), depending on what is most appropriate for the content." + }, "FramerateControl": { "shape": "H264FramerateControl", "locationName": "framerateControl", @@ -7112,6 +7144,11 @@ "InputAttachment": { "type": "structure", "members": { + "AutomaticInputFailoverSettings": { + "shape": "AutomaticInputFailoverSettings", + "locationName": "automaticInputFailoverSettings", + "documentation": "User-specified settings for defining what the conditions are for declaring the input unhealthy and failing over to a different input." + }, "InputAttachmentName": { "shape": "__string", "locationName": "inputAttachmentName", @@ -7373,6 +7410,14 @@ "MAX_50_MBPS" ] }, + "InputPreference": { + "type": "string", + "documentation": "Input preference when deciding which input to make active when a previously failed input has recovered.\nIf \\\"EQUAL_INPUT_PREFERENCE\\\", then the active input will stay active as long as it is healthy.\nIf \\\"PRIMARY_INPUT_PREFERRED\\\", then always switch back to the primary input when it is healthy.\n", + "enum": [ + "EQUAL_INPUT_PREFERENCE", + "PRIMARY_INPUT_PREFERRED" + ] + }, "InputResolution": { "type": "string", "documentation": "Input resolution based on lines of vertical resolution in the input; SD is less than 720 lines, HD is 720 to 1080 lines, UHD is greater than 1080 lines\n", diff --git a/botocore/data/medialive/2017-10-14/waiters-2.json b/botocore/data/medialive/2017-10-14/waiters-2.json index 6b9f74cb..4af16a8c 100644 --- a/botocore/data/medialive/2017-10-14/waiters-2.json +++ b/botocore/data/medialive/2017-10-14/waiters-2.json @@ -61,7 +61,7 @@ "description": "Wait until a channel has is stopped", "operation": "DescribeChannel", "delay": 5, - "maxAttempts": 28, + "maxAttempts": 60, "acceptors": [ { "state": "success", @@ -86,7 +86,7 @@ "description": "Wait until a channel has been deleted", "operation": "DescribeChannel", "delay": 5, - "maxAttempts": 20, + "maxAttempts": 84, "acceptors": [ { "state": "success", diff --git a/botocore/data/mediapackage-vod/2018-11-07/service-2.json b/botocore/data/mediapackage-vod/2018-11-07/service-2.json index 78475393..8e99301c 100644 --- a/botocore/data/mediapackage-vod/2018-11-07/service-2.json +++ b/botocore/data/mediapackage-vod/2018-11-07/service-2.json @@ -444,6 +444,49 @@ "documentation": "A collection of MediaPackage VOD PackagingGroup resources.", "shape": "ListPackagingGroupsResponse" } + }, + "ListTagsForResource": { + "documentation": "List tags for a given MediaPackage VOD resource", + "errors": [], + "http": { + "method": "GET", + "requestUri": "/tags/{resource-arn}", + "responseCode": 200 + }, + "input": { + "shape": "ListTagsForResourceRequest" + }, + "name": "ListTagsForResource", + "output": { + "documentation": "200 response", + "shape": "ListTagsForResourceResponse" + } + }, + "TagResource": { + "documentation": "Set tags for a given MediaPackage VOD resource", + "errors": [], + "http": { + "method": "POST", + "requestUri": "/tags/{resource-arn}", + "responseCode": 204 + }, + "input": { + "shape": "TagResourceRequest" + }, + "name": "TagResource" + }, + "UntagResource": { + "documentation": "Delete tags for a given MediaPackage VOD resource", + "errors": [], + "http": { + "method": "DELETE", + "requestUri": "/tags/{resource-arn}", + "responseCode": 204 + }, + "input": { + "shape": "UntagResourceRequest" + }, + "name": "UntagResource" } }, "shapes": { @@ -497,6 +540,10 @@ "documentation": "The IAM role_arn used to access the source S3 bucket.", "locationName": "sourceRoleArn", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "type": "structure" @@ -528,6 +575,10 @@ "documentation": "The IAM role ARN used to access the source S3 bucket.", "locationName": "sourceRoleArn", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "required": [ @@ -591,6 +642,10 @@ "documentation": "The IAM role ARN used to access the source S3 bucket.", "locationName": "sourceRoleArn", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "type": "structure" @@ -658,6 +713,10 @@ "documentation": "The IAM role ARN used to access the source S3 bucket.", "locationName": "sourceRoleArn", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "required": [ @@ -709,6 +768,10 @@ "documentation": "The IAM role_arn used to access the source S3 bucket.", "locationName": "sourceRoleArn", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "type": "structure" @@ -741,6 +804,10 @@ "documentation": "The ID of a PackagingGroup.", "locationName": "packagingGroupId", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "required": [ @@ -781,6 +848,10 @@ "documentation": "The ID of a PackagingGroup.", "locationName": "packagingGroupId", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "type": "structure" @@ -792,6 +863,10 @@ "documentation": "The ID of the PackagingGroup.", "locationName": "id", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "required": [ @@ -815,6 +890,10 @@ "documentation": "The ID of the PackagingGroup.", "locationName": "id", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "type": "structure" @@ -1004,6 +1083,10 @@ "documentation": "The IAM role_arn used to access the source S3 bucket.", "locationName": "sourceRoleArn", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "type": "structure" @@ -1054,6 +1137,10 @@ "documentation": "The ID of a PackagingGroup.", "locationName": "packagingGroupId", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "type": "structure" @@ -1088,6 +1175,10 @@ "documentation": "The ID of the PackagingGroup.", "locationName": "id", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "type": "structure" @@ -1337,6 +1428,28 @@ }, "type": "structure" }, + "ListTagsForResourceRequest": { + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn", + "shape": "__string" + } + }, + "required": [ + "ResourceArn" + ], + "type": "structure" + }, + "ListTagsForResourceResponse": { + "members": { + "Tags": { + "locationName": "tags", + "shape": "__mapOf__string" + } + }, + "type": "structure" + }, "ManifestLayout": { "enum": [ "FULL", @@ -1447,6 +1560,10 @@ "documentation": "The ID of a PackagingGroup.", "locationName": "packagingGroupId", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "type": "structure" @@ -1479,6 +1596,10 @@ "documentation": "The ID of a PackagingGroup.", "locationName": "packagingGroupId", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "required": [ @@ -1520,6 +1641,10 @@ "documentation": "The ID of the PackagingGroup.", "locationName": "id", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "type": "structure" @@ -1531,6 +1656,10 @@ "documentation": "The ID of the PackagingGroup.", "locationName": "id", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "required": [ @@ -1638,6 +1767,46 @@ }, "type": "structure" }, + "TagResourceRequest": { + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn", + "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "__mapOf__string" + } + }, + "required": [ + "ResourceArn", + "Tags" + ], + "type": "structure" + }, + "Tags": { + "documentation": "A collection of tags associated with a resource", + "key": { + "shape": "__string" + }, + "type": "map", + "value": { + "shape": "__string" + } + }, + "TagsModel": { + "members": { + "Tags": { + "locationName": "tags", + "shape": "__mapOf__string" + } + }, + "required": [ + "Tags" + ], + "type": "structure" + }, "TooManyRequestsException": { "documentation": "The client has exceeded their resource or throttling limits.", "error": { @@ -1666,6 +1835,26 @@ }, "type": "structure" }, + "UntagResourceRequest": { + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn", + "shape": "__string" + }, + "TagKeys": { + "documentation": "The key(s) of tag to be deleted", + "location": "querystring", + "locationName": "tagKeys", + "shape": "__listOf__string" + } + }, + "required": [ + "TagKeys", + "ResourceArn" + ], + "type": "structure" + }, "__PeriodTriggersElement": { "enum": [ "ADS" @@ -1738,6 +1927,15 @@ "__long": { "type": "long" }, + "__mapOf__string": { + "key": { + "shape": "__string" + }, + "type": "map", + "value": { + "shape": "__string" + } + }, "__string": { "type": "string" } diff --git a/botocore/data/mediastore-data/2017-09-01/examples-1.json b/botocore/data/mediastore-data/2017-09-01/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/mediastore-data/2017-09-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/mediastore/2017-09-01/examples-1.json b/botocore/data/mediastore/2017-09-01/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/mediastore/2017-09-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/mediastore/2017-09-01/service-2.json b/botocore/data/mediastore/2017-09-01/service-2.json index e1adfa83..f401828a 100644 --- a/botocore/data/mediastore/2017-09-01/service-2.json +++ b/botocore/data/mediastore/2017-09-01/service-2.json @@ -92,6 +92,22 @@ ], "documentation":"Removes an object lifecycle policy from a container. It takes up to 20 minutes for the change to take effect.
" }, + "DeleteMetricPolicy":{ + "name":"DeleteMetricPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteMetricPolicyInput"}, + "output":{"shape":"DeleteMetricPolicyOutput"}, + "errors":[ + {"shape":"ContainerInUseException"}, + {"shape":"ContainerNotFoundException"}, + {"shape":"PolicyNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"Deletes the metric policy that is associated with the specified container. If there is no metric policy associated with the container, MediaStore doesn't send metrics to CloudWatch.
" + }, "DescribeContainer":{ "name":"DescribeContainer", "http":{ @@ -154,6 +170,22 @@ ], "documentation":"Retrieves the object lifecycle policy that is assigned to a container.
" }, + "GetMetricPolicy":{ + "name":"GetMetricPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMetricPolicyInput"}, + "output":{"shape":"GetMetricPolicyOutput"}, + "errors":[ + {"shape":"ContainerNotFoundException"}, + {"shape":"PolicyNotFoundException"}, + {"shape":"ContainerInUseException"}, + {"shape":"InternalServerError"} + ], + "documentation":"Returns the metric policy for the specified container.
" + }, "ListContainers":{ "name":"ListContainers", "http":{ @@ -227,6 +259,21 @@ ], "documentation":"Writes an object lifecycle policy to a container. If the container already has an object lifecycle policy, the service replaces the existing policy with the new policy. It takes up to 20 minutes for the change to take effect.
For information about how to construct an object lifecycle policy, see Components of an Object Lifecycle Policy.
" }, + "PutMetricPolicy":{ + "name":"PutMetricPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutMetricPolicyInput"}, + "output":{"shape":"PutMetricPolicyOutput"}, + "errors":[ + {"shape":"ContainerInUseException"}, + {"shape":"ContainerNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"The metric policy that you want to add to the container. A metric policy allows AWS Elemental MediaStore to send metrics to Amazon CloudWatch. It takes up to 20 minutes for the new policy to take effect.
" + }, "StartAccessLogging":{ "name":"StartAccessLogging", "http":{ @@ -352,6 +399,13 @@ "documentation":"The container that you specified in the request already exists or is being updated.
", "exception":true }, + "ContainerLevelMetrics":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, "ContainerList":{ "type":"list", "member":{"shape":"Container"} @@ -520,6 +574,21 @@ "members":{ } }, + "DeleteMetricPolicyInput":{ + "type":"structure", + "required":["ContainerName"], + "members":{ + "ContainerName":{ + "shape":"ContainerName", + "documentation":"The name of the container that is associated with the metric policy that you want to delete.
" + } + } + }, + "DeleteMetricPolicyOutput":{ + "type":"structure", + "members":{ + } + }, "DescribeContainerInput":{ "type":"structure", "members":{ @@ -616,6 +685,26 @@ } } }, + "GetMetricPolicyInput":{ + "type":"structure", + "required":["ContainerName"], + "members":{ + "ContainerName":{ + "shape":"ContainerName", + "documentation":"The name of the container that is associated with the metric policy.
" + } + } + }, + "GetMetricPolicyOutput":{ + "type":"structure", + "required":["MetricPolicy"], + "members":{ + "MetricPolicy":{ + "shape":"MetricPolicy", + "documentation":"The metric policy that is associated with the specific container.
" + } + } + }, "Header":{ "type":"string", "max":8192, @@ -705,6 +794,57 @@ "HEAD" ] }, + "MetricPolicy":{ + "type":"structure", + "required":["ContainerLevelMetrics"], + "members":{ + "ContainerLevelMetrics":{ + "shape":"ContainerLevelMetrics", + "documentation":"A setting to enable or disable metrics at the container level.
" + }, + "MetricPolicyRules":{ + "shape":"MetricPolicyRules", + "documentation":"A parameter that holds an array of rules that enable metrics at the object level. This parameter is optional, but if you choose to include it, you must also include at least one rule. By default, you can include up to five rules. You can also request a quota increase to allow up to 300 rules per policy.
" + } + }, + "documentation":"The metric policy that is associated with the container. A metric policy allows AWS Elemental MediaStore to send metrics to Amazon CloudWatch. In the policy, you must indicate whether you want MediaStore to send container-level metrics. You can also include rules to define groups of objects that you want MediaStore to send object-level metrics for.
To view examples of how to construct a metric policy for your use case, see Example Metric Policies.
" + }, + "MetricPolicyRule":{ + "type":"structure", + "required":[ + "ObjectGroup", + "ObjectGroupName" + ], + "members":{ + "ObjectGroup":{ + "shape":"ObjectGroup", + "documentation":"A path or file name that defines which objects to include in the group. Wildcards (*) are acceptable.
" + }, + "ObjectGroupName":{ + "shape":"ObjectGroupName", + "documentation":"A name that allows you to refer to the object group.
" + } + }, + "documentation":"A setting that enables metrics at the object level. Each rule contains an object group and an object group name. If the policy includes the MetricPolicyRules parameter, you must include at least one rule. Each metric policy can include up to five rules by default. You can also request a quota increase to allow up to 300 rules per policy.
" + }, + "MetricPolicyRules":{ + "type":"list", + "member":{"shape":"MetricPolicyRule"}, + "max":300, + "min":1 + }, + "ObjectGroup":{ + "type":"string", + "max":900, + "min":1, + "pattern":"/?(?:[A-Za-z0-9_=:\\.\\-\\~\\*]+/){0,10}(?:[A-Za-z0-9_=:\\.\\-\\~\\*]+)?/?" + }, + "ObjectGroupName":{ + "type":"string", + "max":30, + "min":1, + "pattern":"[a-zA-Z0-9_]+" + }, "Origin":{ "type":"string", "max":2048, @@ -791,6 +931,28 @@ "members":{ } }, + "PutMetricPolicyInput":{ + "type":"structure", + "required":[ + "ContainerName", + "MetricPolicy" + ], + "members":{ + "ContainerName":{ + "shape":"ContainerName", + "documentation":"The name of the container that you want to add the metric policy to.
" + }, + "MetricPolicy":{ + "shape":"MetricPolicy", + "documentation":"The metric policy that you want to associate with the container. In the policy, you must indicate whether you want MediaStore to send container-level metrics. You can also include up to five rules to define groups of objects that you want MediaStore to send object-level metrics for. If you include rules in the policy, construct each rule with both of the following:
An object group that defines which objects to include in the group. The definition can be a path or a file name, but it can't have more than 900 characters. Valid characters are: a-z, A-Z, 0-9, _ (underscore), = (equal), : (colon), . (period), - (hyphen), ~ (tilde), / (forward slash), and * (asterisk). Wildcards (*) are acceptable.
An object group name that allows you to refer to the object group. The name can't have more than 30 characters. Valid characters are: a-z, A-Z, 0-9, and _ (underscore).
The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.
", + "members" : { + "Mode" : { + "documentation" : "Sets the mode for avail suppression, also known as ad suppression. By default, ad suppression is off and all ad breaks are filled by MediaTailor with ads or slate.", + "shape" : "Mode" + }, + "Value" : { + "documentation" : "The avail suppression value is a live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. ", + "shape" : "__string" + } + } + }, "BadRequestException": { "documentation": "Invalid request parameters.
", "error": { @@ -242,6 +256,10 @@ "documentation": "The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.
", "shape": "__string" }, + "AvailSuppression" : { + "shape" : "AvailSuppression", + "documentation": "The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.
" + }, "CdnConfiguration": { "documentation": "The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
", "shape": "CdnConfiguration" @@ -368,14 +386,25 @@ "MULTI_PERIOD" ], "type": "string" - }, + }, + "Mode": { + "enum": [ + "OFF", + "BEHIND_LIVE_EDGE" + ], + "type": "string" + }, "PlaybackConfiguration": { "documentation": "The AWSMediaTailor configuration.
", "members": { "AdDecisionServerUrl": { "documentation": "The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.
", "shape": "__string" - }, + }, + "AvailSuppression":{ + "documentation": "The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.
", + "shape": "AvailSuppression" + }, "CdnConfiguration": { "documentation": "The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
", "shape": "CdnConfiguration" @@ -447,7 +476,11 @@ "AdDecisionServerUrl": { "documentation": "The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.
", "shape": "__string" - }, + }, + "AvailSuppression" : { + "shape" : "AvailSuppression", + "documentation": "The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.
" + }, "CdnConfiguration": { "documentation": "The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
", "shape": "CdnConfiguration" @@ -493,7 +526,11 @@ "AdDecisionServerUrl": { "documentation": "The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.
", "shape": "__string" - }, + }, + "AvailSuppression" : { + "shape" : "AvailSuppression", + "documentation": "The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.
" + }, "CdnConfiguration": { "documentation": "The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
", "shape": "CdnConfiguration" diff --git a/botocore/data/mgh/2017-05-31/examples-1.json b/botocore/data/mgh/2017-05-31/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/mgh/2017-05-31/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/mgh/2017-05-31/service-2.json b/botocore/data/mgh/2017-05-31/service-2.json index b744e2f7..ba8a9207 100644 --- a/botocore/data/mgh/2017-05-31/service-2.json +++ b/botocore/data/mgh/2017-05-31/service-2.json @@ -22,6 +22,7 @@ "output":{"shape":"AssociateCreatedArtifactResult"}, "errors":[ {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, {"shape":"InternalServerError"}, {"shape":"ServiceUnavailableException"}, {"shape":"DryRunOperation"}, @@ -42,6 +43,7 @@ "output":{"shape":"AssociateDiscoveredResourceResult"}, "errors":[ {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, {"shape":"InternalServerError"}, {"shape":"ServiceUnavailableException"}, {"shape":"DryRunOperation"}, @@ -63,6 +65,7 @@ "output":{"shape":"CreateProgressUpdateStreamResult"}, "errors":[ {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, {"shape":"InternalServerError"}, {"shape":"ServiceUnavailableException"}, {"shape":"DryRunOperation"}, @@ -82,6 +85,7 @@ "output":{"shape":"DeleteProgressUpdateStreamResult"}, "errors":[ {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, {"shape":"InternalServerError"}, {"shape":"ServiceUnavailableException"}, {"shape":"DryRunOperation"}, @@ -102,6 +106,7 @@ "output":{"shape":"DescribeApplicationStateResult"}, "errors":[ {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, {"shape":"InternalServerError"}, {"shape":"ServiceUnavailableException"}, {"shape":"InvalidInputException"}, @@ -121,6 +126,7 @@ "output":{"shape":"DescribeMigrationTaskResult"}, "errors":[ {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, {"shape":"InternalServerError"}, {"shape":"ServiceUnavailableException"}, {"shape":"InvalidInputException"}, @@ -139,6 +145,7 @@ "output":{"shape":"DisassociateCreatedArtifactResult"}, "errors":[ {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, {"shape":"InternalServerError"}, {"shape":"ServiceUnavailableException"}, {"shape":"DryRunOperation"}, @@ -159,6 +166,7 @@ "output":{"shape":"DisassociateDiscoveredResourceResult"}, "errors":[ {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, {"shape":"InternalServerError"}, {"shape":"ServiceUnavailableException"}, {"shape":"DryRunOperation"}, @@ -179,6 +187,7 @@ "output":{"shape":"ImportMigrationTaskResult"}, "errors":[ {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, {"shape":"InternalServerError"}, {"shape":"ServiceUnavailableException"}, {"shape":"DryRunOperation"}, @@ -199,6 +208,7 @@ "output":{"shape":"ListApplicationStatesResult"}, "errors":[ {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, {"shape":"InternalServerError"}, {"shape":"ServiceUnavailableException"}, {"shape":"InvalidInputException"}, @@ -216,6 +226,7 @@ "output":{"shape":"ListCreatedArtifactsResult"}, "errors":[ {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, {"shape":"InternalServerError"}, {"shape":"ServiceUnavailableException"}, {"shape":"InvalidInputException"}, @@ -234,6 +245,7 @@ "output":{"shape":"ListDiscoveredResourcesResult"}, "errors":[ {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, {"shape":"InternalServerError"}, {"shape":"ServiceUnavailableException"}, {"shape":"InvalidInputException"}, @@ -252,6 +264,7 @@ "output":{"shape":"ListMigrationTasksResult"}, "errors":[ {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, {"shape":"InternalServerError"}, {"shape":"ServiceUnavailableException"}, {"shape":"InvalidInputException"}, @@ -271,6 +284,7 @@ "output":{"shape":"ListProgressUpdateStreamsResult"}, "errors":[ {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, {"shape":"InternalServerError"}, {"shape":"ServiceUnavailableException"}, {"shape":"InvalidInputException"}, @@ -288,6 +302,7 @@ "output":{"shape":"NotifyApplicationStateResult"}, "errors":[ {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, {"shape":"InternalServerError"}, {"shape":"ServiceUnavailableException"}, {"shape":"DryRunOperation"}, @@ -309,6 +324,7 @@ "output":{"shape":"NotifyMigrationTaskStateResult"}, "errors":[ {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, {"shape":"InternalServerError"}, {"shape":"ServiceUnavailableException"}, {"shape":"DryRunOperation"}, @@ -329,6 +345,7 @@ "output":{"shape":"PutResourceAttributesResult"}, "errors":[ {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, {"shape":"InternalServerError"}, {"shape":"ServiceUnavailableException"}, {"shape":"DryRunOperation"}, @@ -352,7 +369,8 @@ "ApplicationId":{ "type":"string", "max":1600, - "min":1 + "min":1, + "pattern":"^.{1,1600}$" }, "ApplicationIds":{ "type":"list", @@ -456,7 +474,9 @@ }, "ConfigurationId":{ "type":"string", - "min":1 + "max":1600, + "min":1, + "pattern":"^.{1,1600}$" }, "CreateProgressUpdateStreamRequest":{ "type":"structure", @@ -495,7 +515,8 @@ "CreatedArtifactDescription":{ "type":"string", "max":500, - "min":0 + "min":0, + "pattern":"^.{0,500}$" }, "CreatedArtifactList":{ "type":"list", @@ -655,7 +676,8 @@ "DiscoveredResourceDescription":{ "type":"string", "max":500, - "min":0 + "min":0, + "pattern":"^.{0,500}$" }, "DiscoveredResourceList":{ "type":"list", @@ -1156,12 +1178,14 @@ "ResourceAttributeValue":{ "type":"string", "max":256, - "min":1 + "min":1, + "pattern":"^.{1,256}$" }, "ResourceName":{ "type":"string", "max":1600, - "min":1 + "min":1, + "pattern":"^.{1,1600}$" }, "ResourceNotFoundException":{ "type":"structure", @@ -1171,6 +1195,7 @@ "documentation":"Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
", "exception":true }, + "RetryAfterSeconds":{"type":"integer"}, "ServiceUnavailableException":{ "type":"structure", "members":{ @@ -1192,7 +1217,8 @@ "StatusDetail":{ "type":"string", "max":500, - "min":0 + "min":0, + "pattern":"^.{0,500}$" }, "Task":{ "type":"structure", @@ -1213,7 +1239,28 @@ }, "documentation":"Task object encapsulating task information.
" }, - "Token":{"type":"string"}, + "ThrottlingException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{ + "shape":"ErrorMessage", + "documentation":"A message that provides information about the exception.
" + }, + "RetryAfterSeconds":{ + "shape":"RetryAfterSeconds", + "documentation":"The number of seconds the caller should wait before retrying.
" + } + }, + "documentation":"The request was denied due to request throttling.
", + "exception":true + }, + "Token":{ + "type":"string", + "max":2048, + "min":0, + "pattern":"^[a-zA-Z0-9\\/\\+\\=]{0,2048}$" + }, "UnauthorizedOperation":{ "type":"structure", "members":{ diff --git a/botocore/data/migrationhub-config/2019-06-30/service-2.json b/botocore/data/migrationhub-config/2019-06-30/service-2.json index 7534a706..10e600c0 100644 --- a/botocore/data/migrationhub-config/2019-06-30/service-2.json +++ b/botocore/data/migrationhub-config/2019-06-30/service-2.json @@ -25,6 +25,7 @@ {"shape":"InternalServerError"}, {"shape":"ServiceUnavailableException"}, {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, {"shape":"DryRunOperation"}, {"shape":"InvalidInputException"} ], @@ -42,9 +43,10 @@ {"shape":"InternalServerError"}, {"shape":"ServiceUnavailableException"}, {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, {"shape":"InvalidInputException"} ], - "documentation":"This API permits filtering on the ControlId, HomeRegion, and RegionControlScope fields.
This API permits filtering on the ControlId and HomeRegion fields.
Returns the calling account’s home region, if configured. This API is used by other AWS services to determine the regional endpoint for calling AWS Application Discovery Service and Migration Hub. You must call GetHomeRegion at least once before you call any other AWS Application Discovery Service and AWS Migration Hub APIs, to obtain the account's Migration Hub home region.
The number of seconds the caller should wait before retrying.
" + } + }, + "documentation":"The request was denied due to request throttling.
", + "exception":true + }, "Token":{ "type":"string", "max":2048, @@ -268,5 +285,5 @@ "pattern":"^[a-zA-Z0-9\\/\\+\\=]{0,2048}$" } }, - "documentation":"The AWS Migration Hub home region APIs are available specifically for working with your Migration Hub home region. You can use these APIs to determine a home region, as well as to create and work with controls that describe the home region.
You can use these APIs within your home region only. If you call these APIs from outside your home region, your calls are rejected, except for the ability to register your agents and connectors.
You must call GetHomeRegion at least once before you call any other AWS Application Discovery Service and AWS Migration Hub APIs, to obtain the account's Migration Hub home region.
The StartDataCollection API call in AWS Application Discovery Service allows your agents and connectors to begin collecting data that flows directly into the home region, and it will prevent you from enabling data collection information to be sent outside the home region.
For specific API usage, see the sections that follow in this AWS Migration Hub Home Region API reference.
The Migration Hub Home Region APIs do not support AWS Organizations.
The AWS Migration Hub home region APIs are available specifically for working with your Migration Hub home region. You can use these APIs to determine a home region, as well as to create and work with controls that describe the home region.
You must make API calls for write actions (create, notify, associate, disassociate, import, or put) while in your home region, or a HomeRegionNotSetException error is returned.
API calls for read actions (list, describe, stop, and delete) are permitted outside of your home region.
If you call a write API outside the home region, an InvalidInputException is returned.
You can call GetHomeRegion action to obtain the account's Migration Hub home region.
For specific API usage, see the sections that follow in this AWS Migration Hub Home Region API reference.
" } diff --git a/botocore/data/mobile/2017-07-01/examples-1.json b/botocore/data/mobile/2017-07-01/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/mobile/2017-07-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/mturk/2017-01-17/examples-1.json b/botocore/data/mturk/2017-01-17/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/mturk/2017-01-17/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/neptune/2014-10-31/examples-1.json b/botocore/data/neptune/2014-10-31/examples-1.json new file mode 100644 index 00000000..faff7689 --- /dev/null +++ b/botocore/data/neptune/2014-10-31/examples-1.json @@ -0,0 +1,5 @@ +{ + "version":"1.0", + "examples":{ + } +} diff --git a/botocore/data/opsworkscm/2016-11-01/paginators-1.json b/botocore/data/opsworkscm/2016-11-01/paginators-1.json index 3324f85e..e714aab1 100644 --- a/botocore/data/opsworkscm/2016-11-01/paginators-1.json +++ b/botocore/data/opsworkscm/2016-11-01/paginators-1.json @@ -17,6 +17,12 @@ "limit_key": "MaxResults", "output_token": "NextToken", "result_key": "Servers" + }, + "ListTagsForResource": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Tags" } } } diff --git a/botocore/data/opsworkscm/2016-11-01/service-2.json b/botocore/data/opsworkscm/2016-11-01/service-2.json index 911d67d4..280d3ebd 100644 --- a/botocore/data/opsworkscm/2016-11-01/service-2.json +++ b/botocore/data/opsworkscm/2016-11-01/service-2.json @@ -541,15 +541,15 @@ }, "CustomDomain":{ "shape":"CustomDomain", - "documentation":"Supported on servers running Chef Automate 2. An optional public endpoint of a server, such as https://aws.my-company.com. To access the server, create a CNAME DNS record in your preferred DNS service that points the custom domain to the endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the server by using the generated Endpoint value if the server is using a custom domain. If you specify a custom domain, you must also specify values for CustomCertificate and CustomPrivateKey.
An optional public endpoint of a server, such as https://aws.my-company.com. To access the server, create a CNAME DNS record in your preferred DNS service that points the custom domain to the endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the server by using the generated Endpoint value if the server is using a custom domain. If you specify a custom domain, you must also specify values for CustomCertificate and CustomPrivateKey.
Supported on servers running Chef Automate 2. A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a custom certificate, you must also specify values for CustomDomain and CustomPrivateKey. The following are requirements for the CustomCertificate value:
You can provide either a self-signed, custom certificate, or the full certificate chain.
The certificate must be a valid X509 certificate, or a certificate chain in PEM format.
The certificate must be valid at the time of upload. A certificate can't be used before its validity period begins (the certificate's NotBefore date), or after it expires (the certificate's NotAfter date).
The certificate’s common name or subject alternative names (SANs), if present, must match the value of CustomDomain.
The certificate must match the value of CustomPrivateKey.
A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a custom certificate, you must also specify values for CustomDomain and CustomPrivateKey. The following are requirements for the CustomCertificate value:
You can provide either a self-signed, custom certificate, or the full certificate chain.
The certificate must be a valid X509 certificate, or a certificate chain in PEM format.
The certificate must be valid at the time of upload. A certificate can't be used before its validity period begins (the certificate's NotBefore date), or after it expires (the certificate's NotAfter date).
The certificate’s common name or subject alternative names (SANs), if present, must match the value of CustomDomain.
The certificate must match the value of CustomPrivateKey.
Supported on servers running Chef Automate 2. A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. If you specify a custom private key, you must also specify values for CustomDomain and CustomCertificate.
A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. If you specify a custom private key, you must also specify values for CustomDomain and CustomCertificate.
A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server.
The key cannot be empty.
The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
Leading and trailing white spaces are trimmed from both the key and value.
A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server.
A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server.
The key cannot be empty.
The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @
The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @
Leading and trailing white spaces are trimmed from both the key and value.
A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server.
Attaches a policy to a root, an organizational unit (OU), or an individual account.
How the policy affects accounts depends on the type of policy:
For more information about attaching SCPs, see How SCPs Work in the AWS Organizations User Guide.
For information about attaching tag policies, see How Policy Inheritance Works in the AWS Organizations User Guide.
This operation can be called only from the organization's master account.
" + "documentation":"Attaches a policy to a root, an organizational unit (OU), or an individual account. How the policy affects accounts depends on the type of policy:
Service control policy (SCP) - An SCP specifies what permissions can be delegated to users in affected member accounts. The scope of influence for a policy depends on what you attach the policy to:
If you attach an SCP to a root, it affects all accounts in the organization.
If you attach an SCP to an OU, it affects all accounts in that OU and in any child OUs.
If you attach the policy directly to an account, it affects only that account.
SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU). You can attach one SCP to a higher level root or OU, and a different SCP to a child OU or to an account. The child policy can further restrict only the permissions that pass through the parent filter and are available to the child. An SCP that is attached to a child can't grant a permission that the parent hasn't already granted. For example, imagine that the parent SCP allows permissions A, B, C, D, and E. The child SCP allows C, D, E, F, and G. The result is that the accounts affected by the child SCP are allowed to use only C, D, and E. They can't use A or B because the child OU filtered them out. They also can't use F and G because the parent OU filtered them out. They can't be granted back by the child SCP; child SCPs can only filter the permissions they receive from the parent SCP.
AWS Organizations attaches a default SCP named \"FullAWSAccess to every root, OU, and account. This default SCP allows all services and actions, enabling any new child OU or account to inherit the permissions of the parent root or OU. If you detach the default policy, you must replace it with a policy that specifies the permissions that you want to allow in that OU or account.
For more information about how AWS Organizations policies permissions work, see Using Service Control Policies in the AWS Organizations User Guide.
This operation can be called only from the organization's master account.
" }, "CancelHandshake":{ "name":"CancelHandshake", @@ -99,7 +99,7 @@ {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"} ], - "documentation":"Creates an AWS account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that AWS performs in the background. Because CreateAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:
Use the OperationId response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.
Check the AWS CloudTrail log for the CreateAccountResult event. For information on using AWS CloudTrail with AWS Organizations, see Monitoring the Activity in Your Organization in the AWS Organizations User Guide.
The user who calls the API to create an account must have the organizations:CreateAccount permission. If you enabled all features in the organization, AWS Organizations creates the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide.
AWS Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) that grants users in the master account administrator permissions in the new member account. Principals in the master account can assume the role. AWS Organizations clones the company name and address information for the new account from the organization's master account.
This operation can be called only from the organization's master account.
For more information about creating accounts, see Creating an AWS Account in Your Organization in the AWS Organizations User Guide.
When you create an account in an organization, the information required for the account to operate as a standalone account is not automatically collected. For example, information about the payment method and signing the end user license agreement (EULA) is not collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at To leave an organization as a member account in the AWS Organizations User Guide.
If you get an exception that indicates that you exceeded your account limits for the organization, contact AWS Support.
If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact AWS Support.
Using CreateAccount to create multiple temporary accounts isn't recommended. You can only close an account from the Billing and Cost Management Console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see Closing an AWS Account in the AWS Organizations User Guide.
When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting Access to Your Billing Information and Tools.
Creates an AWS account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that AWS performs in the background. Because CreateAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:
Use the OperationId response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.
Check the AWS CloudTrail log for the CreateAccountResult event. For information on using AWS CloudTrail with AWS Organizations, see Monitoring the Activity in Your Organization in the AWS Organizations User Guide.
The user who calls the API to create an account must have the organizations:CreateAccount permission. If you enabled all features in the organization, AWS Organizations creates the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide.
AWS Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) that grants users in the master account administrator permissions in the new member account. Principals in the master account can assume the role. AWS Organizations clones the company name and address information for the new account from the organization's master account.
This operation can be called only from the organization's master account.
For more information about creating accounts, see Creating an AWS Account in Your Organization in the AWS Organizations User Guide.
When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method and signing the end user license agreement (EULA) is not automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at To leave an organization as a member account in the AWS Organizations User Guide.
If you get an exception that indicates that you exceeded your account limits for the organization, contact AWS Support.
If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact AWS Support.
Using CreateAccount to create multiple temporary accounts isn't recommended. You can only close an account from the Billing and Cost Management Console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see Closing an AWS Account in the AWS Organizations User Guide.
When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting Access to Your Billing Information and Tools.
This action is available if all of the following are true:
You're authorized to create accounts in the AWS GovCloud (US) Region. For more information on the AWS GovCloud (US) Region, see the AWS GovCloud User Guide.
You already have an account in the AWS GovCloud (US) Region that is associated with your master account in the commercial Region.
You call this action from the master account of your organization in the commercial Region.
You have the organizations:CreateGovCloudAccount permission. AWS Organizations creates the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide.
AWS automatically enables AWS CloudTrail for AWS GovCloud (US) accounts, but you should also do the following:
Verify that AWS CloudTrail is enabled to store logs.
Create an S3 bucket for AWS CloudTrail log storage.
For more information, see Verifying AWS CloudTrail Is Enabled in the AWS GovCloud User Guide.
You call this action from the master account of your organization in the commercial Region to create a standalone AWS account in the AWS GovCloud (US) Region. After the account is created, the master account of an organization in the AWS GovCloud (US) Region can invite it to that organization. For more information on inviting standalone accounts in the AWS GovCloud (US) to join an organization, see AWS Organizations in the AWS GovCloud User Guide.
Calling CreateGovCloudAccount is an asynchronous request that AWS performs in the background. Because CreateGovCloudAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:
Use the OperationId response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.
Check the AWS CloudTrail log for the CreateAccountResult event. For information on using AWS CloudTrail with Organizations, see Monitoring the Activity in Your Organization in the AWS Organizations User Guide.
When you call the CreateGovCloudAccount action, you create two accounts: a standalone account in the AWS GovCloud (US) Region and an associated account in the commercial Region for billing and support purposes. The account in the commercial Region is automatically a member of the organization whose credentials made the request. Both accounts are associated with the same email address.
A role is created in the new account in the commercial Region that allows the master account in the organization in the commercial Region to assume it. An AWS GovCloud (US) account is then created and associated with the commercial account that you just created. A role is created in the new AWS GovCloud (US) account. This role can be assumed by the AWS GovCloud (US) account that is associated with the master account of the commercial organization. For more information and to view a diagram that explains how account access works, see AWS Organizations in the AWS GovCloud User Guide.
For more information about creating accounts, see Creating an AWS Account in Your Organization in the AWS Organizations User Guide.
You can create an account in an organization using the AWS Organizations console, API, or CLI commands. When you do, the information required for the account to operate as a standalone account, such as a payment method, is not automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at To leave an organization as a member account in the AWS Organizations User Guide.
If you get an exception that indicates that you exceeded your account limits for the organization, contact AWS Support.
If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact AWS Support.
Using CreateGovCloudAccount to create multiple temporary accounts isn't recommended. You can only close an account from the AWS Billing and Cost Management console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see Closing an AWS Account in the AWS Organizations User Guide.
When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting Access to Your Billing Information and Tools.
This action is available if all of the following are true:
You're authorized to create accounts in the AWS GovCloud (US) Region. For more information on the AWS GovCloud (US) Region, see the AWS GovCloud User Guide.
You already have an account in the AWS GovCloud (US) Region that is associated with your master account in the commercial Region.
You call this action from the master account of your organization in the commercial Region.
You have the organizations:CreateGovCloudAccount permission. AWS Organizations creates the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide.
AWS automatically enables AWS CloudTrail for AWS GovCloud (US) accounts, but you should also do the following:
Verify that AWS CloudTrail is enabled to store logs.
Create an S3 bucket for AWS CloudTrail log storage.
For more information, see Verifying AWS CloudTrail Is Enabled in the AWS GovCloud User Guide.
You call this action from the master account of your organization in the commercial Region to create a standalone AWS account in the AWS GovCloud (US) Region. After the account is created, the master account of an organization in the AWS GovCloud (US) Region can invite it to that organization. For more information on inviting standalone accounts in the AWS GovCloud (US) to join an organization, see AWS Organizations in the AWS GovCloud User Guide.
Calling CreateGovCloudAccount is an asynchronous request that AWS performs in the background. Because CreateGovCloudAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:
Use the OperationId response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.
Check the AWS CloudTrail log for the CreateAccountResult event. For information on using AWS CloudTrail with Organizations, see Monitoring the Activity in Your Organization in the AWS Organizations User Guide.
When you call the CreateGovCloudAccount action, you create two accounts: a standalone account in the AWS GovCloud (US) Region and an associated account in the commercial Region for billing and support purposes. The account in the commercial Region is automatically a member of the organization whose credentials made the request. Both accounts are associated with the same email address.
A role is created in the new account in the commercial Region that allows the master account in the organization in the commercial Region to assume it. An AWS GovCloud (US) account is then created and associated with the commercial account that you just created. A role is created in the new AWS GovCloud (US) account that can be assumed by the AWS GovCloud (US) account that is associated with the master account of the commercial organization. For more information and to view a diagram that explains how account access works, see AWS Organizations in the AWS GovCloud User Guide.
For more information about creating accounts, see Creating an AWS Account in Your Organization in the AWS Organizations User Guide.
When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method and signing the end user license agreement (EULA) is not automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at To leave an organization as a member account in the AWS Organizations User Guide.
If you get an exception that indicates that you exceeded your account limits for the organization, contact AWS Support.
If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact AWS Support.
Using CreateGovCloudAccount to create multiple temporary accounts isn't recommended. You can only close an account from the AWS Billing and Cost Management console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see Closing an AWS Account in the AWS Organizations User Guide.
When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting Access to Your Billing Information and Tools.
Creates an AWS organization. The account whose user is calling the CreateOrganization operation automatically becomes the master account of the new organization.
This operation must be called using credentials from the account that is to become the new organization's master account. The principal must also have the relevant IAM permissions.
By default (or if you set the FeatureSet parameter to ALL), the new organization is created with all features enabled. In addition, service control policies are automatically enabled in the root. If you instead create the organization supporting only the consolidated billing features, no policy types are enabled by default, and you can't use organization policies.
Creates an AWS organization. The account whose user is calling the CreateOrganization operation automatically becomes the master account of the new organization.
This operation must be called using credentials from the account that is to become the new organization's master account. The principal must also have the relevant IAM permissions.
By default (or if you set the FeatureSet parameter to ALL), the new organization is created with all features enabled and service control policies automatically enabled in the root. If you instead choose to create the organization supporting only the consolidated billing features by setting the FeatureSet parameter to CONSOLIDATED_BILLING\", no policy types are enabled by default, and you can't use organization policies
Declines a handshake request. This sets the handshake state to DECLINED and effectively deactivates the request.
This operation can be called only from the account that received the handshake. The originator of the handshake can use CancelHandshake instead. The originator can't reactivate a declined request, but can reinitiate the process with a new handshake request.
After you decline a handshake, it continues to appear in the results of relevant API operations for only 30 days. After that, it's deleted.
" + "documentation":"Declines a handshake request. This sets the handshake state to DECLINED and effectively deactivates the request.
This operation can be called only from the account that received the handshake. The originator of the handshake can use CancelHandshake instead. The originator can't reactivate a declined request, but can reinitiate the process with a new handshake request.
After you decline a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that, it's deleted.
" }, "DeleteOrganization":{ "name":"DeleteOrganization", @@ -262,6 +262,27 @@ ], "documentation":"Deletes the specified policy from your organization. Before you perform this operation, you must first detach the policy from all organizational units (OUs), roots, and accounts.
This operation can be called only from the organization's master account.
" }, + "DeregisterDelegatedAdministrator":{ + "name":"DeregisterDelegatedAdministrator", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterDelegatedAdministratorRequest"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AccountNotFoundException"}, + {"shape":"AccountNotRegisteredException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ConstraintViolationException"}, + {"shape":"InvalidInputException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ServiceException"}, + {"shape":"UnsupportedAPIEndpointException"} + ], + "documentation":"Removes the specified member AWS account as a delegated administrator for the specified AWS service.
You can run this action only for AWS services that support this feature. For a current list of services that support it, see the column Supports Delegated Administrator in the table at AWS Services that you can use with AWS Organizations in the AWS Organizations User Guide.
This operation can be called only from the organization's master account.
" + }, "DescribeAccount":{ "name":"DescribeAccount", "http":{ @@ -278,7 +299,7 @@ {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], - "documentation":"Retrieves AWS Organizations related information about the specified account.
This operation can be called only from the organization's master account.
" + "documentation":"Retrieves AWS Organizations-related information about the specified account.
This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.
" }, "DescribeCreateAccountStatus":{ "name":"DescribeCreateAccountStatus", @@ -297,7 +318,7 @@ {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"} ], - "documentation":"Retrieves the current status of an asynchronous request to create an account.
This operation can be called only from the organization's master account.
" + "documentation":"Retrieves the current status of an asynchronous request to create an account.
This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.
" }, "DescribeEffectivePolicy":{ "name":"DescribeEffectivePolicy", @@ -318,7 +339,7 @@ {"shape":"InvalidInputException"}, {"shape":"UnsupportedAPIEndpointException"} ], - "documentation":"Returns the contents of the effective tag policy for the account. The effective tag policy is the aggregation of any tag policies the account inherits, plus any policy directly that is attached to the account.
This action returns information on tag policies only.
For more information on policy inheritance, see How Policy Inheritance Works in the AWS Organizations User Guide.
This operation can be called from any account in the organization.
" + "documentation":"Returns the contents of the effective tag policy for the account. The effective tag policy is the aggregation of any tag policies the account inherits, plus any policy directly that is attached to the account.
This action returns information on tag policies only.
For more information on policy inheritance, see How Policy Inheritance Works in the AWS Organizations User Guide.
This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.
" }, "DescribeHandshake":{ "name":"DescribeHandshake", @@ -370,7 +391,7 @@ {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], - "documentation":"Retrieves information about an organizational unit (OU).
This operation can be called only from the organization's master account.
" + "documentation":"Retrieves information about an organizational unit (OU).
This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.
" }, "DescribePolicy":{ "name":"DescribePolicy", @@ -389,7 +410,7 @@ {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"} ], - "documentation":"Retrieves information about a policy.
This operation can be called only from the organization's master account.
" + "documentation":"Retrieves information about a policy.
This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.
" }, "DetachPolicy":{ "name":"DetachPolicy", @@ -412,7 +433,7 @@ {"shape":"UnsupportedAPIEndpointException"}, {"shape":"PolicyChangesInProgressException"} ], - "documentation":"Detaches a policy from a target root, organizational unit (OU), or account. If the policy being detached is a service control policy (SCP), the changes to permissions for IAM users and roles in affected accounts are immediate.
Note: Every root, OU, and account must have at least one SCP attached. You can replace the default FullAWSAccess policy with one that limits the permissions that can be delegated. To do that, you must attach the replacement policy before you can remove the default one. This is the authorization strategy of using an allow list. You could instead attach a second SCP and leave the FullAWSAccess SCP still attached. You could then specify \"Effect\": \"Deny\" in the second SCP to override the \"Effect\": \"Allow\" in the FullAWSAccess policy (or any other attached SCP). If you take these steps, you're using the authorization strategy of a deny list.
This operation can be called only from the organization's master account.
" + "documentation":"Detaches a policy from a target root, organizational unit (OU), or account. If the policy being detached is a service control policy (SCP), the changes to permissions for IAM users and roles in affected accounts are immediate.
Note: Every root, OU, and account must have at least one SCP attached. If you want to replace the default FullAWSAccess policy with one that limits the permissions that can be delegated, you must attach the replacement policy before you can remove the default one. This is the authorization strategy of an \"allow list\". If you instead attach a second SCP and leave the FullAWSAccess SCP still attached, and specify \"Effect\": \"Deny\" in the second SCP to override the \"Effect\": \"Allow\" in the FullAWSAccess policy (or any other attached SCP), you're using the authorization strategy of a \"deny list\".
This operation can be called only from the organization's master account.
" }, "DisableAWSServiceAccess":{ "name":"DisableAWSServiceAccess", @@ -430,7 +451,7 @@ {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], - "documentation":"Disables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS Organizations. When you disable integration, the specified service no longer can create a service-linked role in new accounts in your organization. This means the service can't perform operations on your behalf on any new accounts in your organization. The service can still perform operations in older accounts until the service completes its clean-up from AWS Organizations.
We recommend that you disable integration between AWS Organizations and the specified AWS service by using the console or commands that are provided by the specified service. Doing so ensures that the other service is aware that it can clean up any resources that are required only for the integration. How the service cleans up its resources in the organization's accounts depends on that service. For more information, see the documentation for the other AWS service.
After you perform the DisableAWSServiceAccess operation, the specified service can no longer perform operations in your organization's accounts. The only exception is when the operations are explicitly permitted by IAM policies that are attached to your roles.
For more information about integrating other services with AWS Organizations, including the list of services that work with Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide.
This operation can be called only from the organization's master account.
" + "documentation":"Disables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS Organizations. When you disable integration, the specified service no longer can create a service-linked role in new accounts in your organization. This means the service can't perform operations on your behalf on any new accounts in your organization. The service can still perform operations in older accounts until the service completes its clean-up from AWS Organizations.
We recommend that you disable integration between AWS Organizations and the specified AWS service by using the console or commands that are provided by the specified service. Doing so ensures that the other service is aware that it can clean up any resources that are required only for the integration. How the service cleans up its resources in the organization's accounts depends on that service. For more information, see the documentation for the other AWS service.
After you perform the DisableAWSServiceAccess operation, the specified service can no longer perform operations in your organization's accounts unless the operations are explicitly permitted by the IAM policies that are attached to your roles.
For more information about integrating other services with AWS Organizations, including the list of services that work with Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide.
This operation can be called only from the organization's master account.
" }, "DisablePolicyType":{ "name":"DisablePolicyType", @@ -453,7 +474,7 @@ {"shape":"UnsupportedAPIEndpointException"}, {"shape":"PolicyChangesInProgressException"} ], - "documentation":"Disables an organizational control policy type in a root and detaches all policies of that type from the organization root, OUs, and accounts. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any organizational unit (OU) or account in that root. You can undo this by using the EnablePolicyType operation.
This is an asynchronous request that AWS performs in the background. If you disable a policy for a root, it still appears enabled for the organization if all features are enabled for the organization. AWS recommends that you first use ListRoots to see the status of policy types for a specified root, and then use this operation.
This operation can be called only from the organization's master account.
To view the status of available policy types in the organization, use DescribeOrganization.
" + "documentation":"Disables an organizational control policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any organizational unit (OU) or account in that root. You can undo this by using the EnablePolicyType operation.
This is an asynchronous request that AWS performs in the background. If you disable a policy for a root, it still appears enabled for the organization if all features are enabled for the organization. AWS recommends that you first use ListRoots to see the status of policy types for a specified root, and then use this operation.
This operation can be called only from the organization's master account.
To view the status of available policy types in the organization, use DescribeOrganization.
" }, "EnableAWSServiceAccess":{ "name":"EnableAWSServiceAccess", @@ -490,7 +511,7 @@ {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], - "documentation":"Enables all features in an organization. This enables the use of organization policies that can restrict the services and actions that can be called in each account. Until you enable all features, you have access only to consolidated billing. You can't use any of the advanced account administration features that AWS Organizations supports. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide.
This operation is required only for organizations that were created explicitly with only the consolidated billing features enabled. Calling this operation sends a handshake to every invited account in the organization. The feature set change can be finalized and the additional features enabled only after all administrators in the invited accounts approve the change. Accepting the handshake approves the change.
After you enable all features, you can separately enable or disable individual policy types in a root using EnablePolicyType and DisablePolicyType. To see the status of policy types in a root, use ListRoots.
After all invited member accounts accept the handshake, you finalize the feature set change by accepting the handshake that contains \"Action\": \"ENABLE_ALL_FEATURES\". This completes the change.
After you enable all features in your organization, the master account in the organization can apply policies on all member accounts. These policies can restrict what users and even administrators in those accounts can do. The master account can apply policies that prevent accounts from leaving the organization. Ensure that your account administrators are aware of this.
This operation can be called only from the organization's master account.
" + "documentation":"Enables all features in an organization. This enables the use of organization policies that can restrict the services and actions that can be called in each account. Until you enable all features, you have access only to consolidated billing, and you can't use any of the advanced account administration features that AWS Organizations supports. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide.
This operation is required only for organizations that were created explicitly with only the consolidated billing features enabled. Calling this operation sends a handshake to every invited account in the organization. The feature set change can be finalized and the additional features enabled only after all administrators in the invited accounts approve the change by accepting the handshake.
After you enable all features, you can separately enable or disable individual policy types in a root using EnablePolicyType and DisablePolicyType. To see the status of policy types in a root, use ListRoots.
After all invited member accounts accept the handshake, you finalize the feature set change by accepting the handshake that contains \"Action\": \"ENABLE_ALL_FEATURES\". This completes the change.
After you enable all features in your organization, the master account in the organization can apply policies on all member accounts. These policies can restrict what users and even administrators in those accounts can do. The master account can apply policies that prevent accounts from leaving the organization. Ensure that your account administrators are aware of this.
This operation can be called only from the organization's master account.
" }, "EnablePolicyType":{ "name":"EnablePolicyType", @@ -536,7 +557,7 @@ {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], - "documentation":"Sends an invitation to another account to join your organization as a member account. AWS Organizations sends email on your behalf to the email address that is associated with the other account's owner. The invitation is implemented as a Handshake whose details are in the response.
You can invite AWS accounts only from the same seller as the master account. For example, assume that your organization's master account was created by Amazon Internet Services Pvt. Ltd (AISPL), an AWS seller in India. You can invite only other AISPL accounts to your organization. You can't combine accounts from AISPL and AWS or from any other AWS seller. For more information, see Consolidated Billing in India.
You might receive an exception that indicates that you exceeded your account limits for the organization or that the operation failed because your organization is still initializing. If so, wait one hour and then try again. If the error persists after an hour, contact AWS Support.
This operation can be called only from the organization's master account.
" + "documentation":"Sends an invitation to another account to join your organization as a member account. AWS Organizations sends email on your behalf to the email address that is associated with the other account's owner. The invitation is implemented as a Handshake whose details are in the response.
You can invite AWS accounts only from the same seller as the master account. For example, if your organization's master account was created by Amazon Internet Services Pvt. Ltd (AISPL), an AWS seller in India, you can invite only other AISPL accounts to your organization. You can't combine accounts from AISPL and AWS or from any other AWS seller. For more information, see Consolidated Billing in India.
If you receive an exception that indicates that you exceeded your account limits for the organization or that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists after an hour, contact AWS Support.
This operation can be called only from the organization's master account.
" }, "LeaveOrganization":{ "name":"LeaveOrganization", @@ -555,7 +576,7 @@ {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], - "documentation":"Removes a member account from its parent organization. This version of the operation is performed by the account that wants to leave. To remove a member account as a user in the master account, use RemoveAccountFromOrganization instead.
This operation can be called only from a member account in the organization.
The master account in an organization with all features enabled can set service control policies (SCPs) that can restrict what administrators of member accounts can do. These restrictions can include preventing member accounts from successfully calling LeaveOrganization.
You can leave an organization as a member account only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI, the information required of standalone accounts is not automatically collected. For each account that you want to make standalone, you must accept the end user license agreement (EULA). You must also choose a support plan, provide and verify the required contact information, and provide a current payment method. AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account isn't attached to an organization. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
You can leave an organization only after you enable IAM user access to billing in your account. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User Guide.
Removes a member account from its parent organization. This version of the operation is performed by the account that wants to leave. To remove a member account as a user in the master account, use RemoveAccountFromOrganization instead.
This operation can be called only from a member account in the organization.
The master account in an organization with all features enabled can set service control policies (SCPs) that can restrict what administrators of member accounts can do. This includes preventing them from successfully calling LeaveOrganization and leaving the organization.
You can leave an organization as a member account only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For each account that you want to make standalone, you must do the following steps:
Accept the end user license agreement (EULA)
Choose a support plan
Provide and verify the required contact information
Provide a current payment method
AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account isn't attached to an organization. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
You can leave an organization only after you enable IAM user access to billing in your account. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User Guide.
Returns a list of the AWS services that you enabled to integrate with your organization. After a service on this list creates the resources that it requires for the integration, it can perform operations on your organization and its accounts.
For more information about integrating other services with AWS Organizations, including the list of services that currently work with Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide.
This operation can be called only from the organization's master account.
" + "documentation":"Returns a list of the AWS services that you enabled to integrate with your organization. After a service on this list creates the resources that it requires for the integration, it can perform operations on your organization and its accounts.
For more information about integrating other services with AWS Organizations, including the list of services that currently work with Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide.
This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.
" }, "ListAccounts":{ "name":"ListAccounts", @@ -590,7 +611,7 @@ {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], - "documentation":"Lists all the accounts in the organization. To request only the accounts in a specified root or organizational unit (OU), use the ListAccountsForParent operation instead.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account.
" + "documentation":"Lists all the accounts in the organization. To request only the accounts in a specified root or organizational unit (OU), use the ListAccountsForParent operation instead.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.
" }, "ListAccountsForParent":{ "name":"ListAccountsForParent", @@ -608,7 +629,7 @@ {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], - "documentation":"Lists the accounts in an organization that are contained by the specified target root or organizational unit (OU). If you specify the root, you get a list of all the accounts that aren't in any OU. If you specify an OU, you get a list of all the accounts in only that OU and not in any child OUs. To get a list of all accounts in the organization, use the ListAccounts operation.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account.
" + "documentation":"Lists the accounts in an organization that are contained by the specified target root or organizational unit (OU). If you specify the root, you get a list of all the accounts that aren't in any OU. If you specify an OU, you get a list of all the accounts in only that OU and not in any child OUs. To get a list of all accounts in the organization, use the ListAccounts operation.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.
" }, "ListChildren":{ "name":"ListChildren", @@ -626,7 +647,7 @@ {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], - "documentation":"Lists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root. This operation, along with ListParents enables you to traverse the tree structure that makes up this root.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account.
" + "documentation":"Lists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root. This operation, along with ListParents enables you to traverse the tree structure that makes up this root.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.
" }, "ListCreateAccountStatus":{ "name":"ListCreateAccountStatus", @@ -644,7 +665,47 @@ {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"} ], - "documentation":"Lists the account creation requests that match the specified status that is currently being tracked for the organization.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account.
" + "documentation":"Lists the account creation requests that match the specified status that is currently being tracked for the organization.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.
" + }, + "ListDelegatedAdministrators":{ + "name":"ListDelegatedAdministrators", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDelegatedAdministratorsRequest"}, + "output":{"shape":"ListDelegatedAdministratorsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConstraintViolationException"}, + {"shape":"InvalidInputException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ServiceException"}, + {"shape":"UnsupportedAPIEndpointException"} + ], + "documentation":"Lists the AWS accounts that are designated as delegated administrators in this organization.
This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.
" + }, + "ListDelegatedServicesForAccount":{ + "name":"ListDelegatedServicesForAccount", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDelegatedServicesForAccountRequest"}, + "output":{"shape":"ListDelegatedServicesForAccountResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AccountNotFoundException"}, + {"shape":"AccountNotRegisteredException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConstraintViolationException"}, + {"shape":"InvalidInputException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ServiceException"}, + {"shape":"UnsupportedAPIEndpointException"} + ], + "documentation":"List the AWS services for which the specified account is a delegated administrator.
This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.
" }, "ListHandshakesForAccount":{ "name":"ListHandshakesForAccount", @@ -661,7 +722,7 @@ {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], - "documentation":"Lists the current handshakes that are associated with the account of the requesting user.
Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that, they're deleted and no longer accessible.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called from any account in the organization.
" + "documentation":"Lists the current handshakes that are associated with the account of the requesting user.
Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that, they're deleted and no longer accessible.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.
" }, "ListHandshakesForOrganization":{ "name":"ListHandshakesForOrganization", @@ -679,7 +740,7 @@ {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], - "documentation":"Lists the handshakes that are associated with the organization that the requesting user is part of. The ListHandshakesForOrganization operation returns a list of handshake structures. Each structure contains details and status about a handshake.
Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that, they're deleted and no longer accessible.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account.
" + "documentation":"Lists the handshakes that are associated with the organization that the requesting user is part of. The ListHandshakesForOrganization operation returns a list of handshake structures. Each structure contains details and status about a handshake.
Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that, they're deleted and no longer accessible.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.
" }, "ListOrganizationalUnitsForParent":{ "name":"ListOrganizationalUnitsForParent", @@ -697,7 +758,7 @@ {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], - "documentation":"Lists the organizational units (OUs) in a parent organizational unit or root.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account.
" + "documentation":"Lists the organizational units (OUs) in a parent organizational unit or root.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.
" }, "ListParents":{ "name":"ListParents", @@ -715,7 +776,7 @@ {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], - "documentation":"Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or account. This operation, along with ListChildren enables you to traverse the tree structure that makes up this root.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account.
In the current release, a child can have only a single parent.
Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or account. This operation, along with ListChildren enables you to traverse the tree structure that makes up this root.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.
In the current release, a child can have only a single parent.
Retrieves the list of all policies in an organization of a specified type.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account.
" + "documentation":"Retrieves the list of all policies in an organization of a specified type.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.
" }, "ListPoliciesForTarget":{ "name":"ListPoliciesForTarget", @@ -752,7 +813,7 @@ {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"} ], - "documentation":"Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account. You must specify the policy type that you want included in the returned list.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account.
" + "documentation":"Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account. You must specify the policy type that you want included in the returned list.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.
" }, "ListRoots":{ "name":"ListRoots", @@ -769,7 +830,7 @@ {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], - "documentation":"Lists the roots that are defined in the current organization.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account.
Policy types can be enabled and disabled in roots. This is distinct from whether they're available in the organization. When you enable all features, you make policy types available for use in that organization. Individual policy types can then be enabled and disabled in a root. To see the availability of a policy type in an organization, use DescribeOrganization.
Lists the roots that are defined in the current organization.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.
Policy types can be enabled and disabled in roots. This is distinct from whether they're available in the organization. When you enable all features, you make policy types available for use in that organization. Individual policy types can then be enabled and disabled in a root. To see the availability of a policy type in an organization, use DescribeOrganization.
Lists tags for the specified resource.
Currently, you can list tags on an account in AWS Organizations.
This operation can be called only from the organization's master account.
" + "documentation":"Lists tags for the specified resource.
Currently, you can list tags on an account in AWS Organizations.
This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.
" }, "ListTargetsForPolicy":{ "name":"ListTargetsForPolicy", @@ -806,7 +867,7 @@ {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"} ], - "documentation":"Lists all the roots, organizational units (OUs), and accounts that the specified policy is attached to.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account.
" + "documentation":"Lists all the roots, organizational units (OUs), and accounts that the specified policy is attached to.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.
" }, "MoveAccount":{ "name":"MoveAccount", @@ -829,6 +890,27 @@ ], "documentation":"Moves an account from its current source parent root or organizational unit (OU) to the specified destination parent root or OU.
This operation can be called only from the organization's master account.
" }, + "RegisterDelegatedAdministrator":{ + "name":"RegisterDelegatedAdministrator", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterDelegatedAdministratorRequest"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AccountAlreadyRegisteredException"}, + {"shape":"AccountNotFoundException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ConstraintViolationException"}, + {"shape":"InvalidInputException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ServiceException"}, + {"shape":"UnsupportedAPIEndpointException"} + ], + "documentation":"Enables the specified member account to administer the Organizations features of the specified AWS service. It grants read-only access to AWS Organizations service data. The account still requires IAM permissions to access and administer the AWS service.
You can run this action only for AWS services that support this feature. For a current list of services that support it, see the column Supports Delegated Administrator in the table at AWS Services that you can use with AWS Organizations in the AWS Organizations User Guide.
This operation can be called only from the organization's master account.
" + }, "RemoveAccountFromOrganization":{ "name":"RemoveAccountFromOrganization", "http":{ @@ -847,7 +929,7 @@ {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], - "documentation":"Removes the specified account from the organization.
The removed account becomes a standalone account that isn't a member of any organization. It's no longer subject to any policies and is responsible for its own bill payments. The organization's master account is no longer charged for any expenses accrued by the member account after it's removed from the organization.
This operation can be called only from the organization's master account. Member accounts can remove themselves with LeaveOrganization instead.
You can remove an account from your organization only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI, the information required of standalone accounts is not automatically collected. For an account that you want to make standalone, you must accept the end user license agreement (EULA). You must also choose a support plan, provide and verify the required contact information, and provide a current payment method. AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account isn't attached to an organization. To remove an account that doesn't yet have this information, you must sign in as the member account. Then follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
Removes the specified account from the organization.
The removed account becomes a standalone account that isn't a member of any organization. It's no longer subject to any policies and is responsible for its own bill payments. The organization's master account is no longer charged for any expenses accrued by the member account after it's removed from the organization.
This operation can be called only from the organization's master account. Member accounts can remove themselves with LeaveOrganization instead.
You can remove an account from your organization only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For an account that you want to make standalone, you must accept the end user license agreement (EULA), choose a support plan, provide and verify the required contact information, and provide a current payment method. AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account isn't attached to an organization. To remove an account that doesn't yet have this information, you must sign in as the member account and follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
Contains information about an AWS account that is a member of an organization.
" }, + "AccountAlreadyRegisteredException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"The specified account is already a delegated administrator for this AWS service.
", + "exception":true + }, "AccountArn":{ "type":"string", "pattern":"^arn:aws:organizations::\\d{12}:account\\/o-[a-z0-9]{10,32}\\/\\d{12}" @@ -1042,7 +1132,15 @@ "members":{ "Message":{"shape":"ExceptionMessage"} }, - "documentation":" We can't find an AWS account with the AccountId that you specified. Or the account whose credentials you used to make this request isn't a member of an organization.
We can't find an AWS account with the AccountId that you specified, or the account whose credentials you used to make this request isn't a member of an organization.
The specified account is not a delegated administrator for this AWS service.
", "exception":true }, "AccountOwnerNotVerifiedException":{ @@ -1169,7 +1267,7 @@ "Message":{"shape":"ExceptionMessage"}, "Reason":{"shape":"ConstraintViolationExceptionReason"} }, - "documentation":"Performing this operation violates a minimum or maximum value limit. Examples include attempting to remove the last service control policy (SCP) from an OU or root, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit.
Some of the reasons in the following list might not be applicable to this specific API or operation:
ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone account. This account requires you to first agree to the AWS Customer Agreement. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone account. This account requires you to first complete phone verification. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.
ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact AWS Support to request an increase in your limit.
Or the number of invitations that you tried to send would cause you to exceed the limit of accounts in your organization. Send fewer invitations or contact AWS Support to request an increase in the number of accounts.
Deleted and closed accounts still count toward your limit.
If you get receive this exception when running a command immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.
HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send in one day.
MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's master account to the marketplace that corresponds to the master account's address. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be associated with the same marketplace.
MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide contact a valid address and phone number for the master account. Then try the operation again.
MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the master account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.
MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this master account, you first must associate a valid payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number of policies of a certain type that can be attached to an entity at one time.
MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource.
MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity, which would cause the entity to have fewer than the minimum number of policies of the required type.
OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.
ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.
OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.
POLICY_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of policies that you can have in an organization.
TAG_POLICY_VIOLATION: Tags associated with the resource must be compliant with the tag policy that’s in effect for the account. For more information, see Tag Policies in the AWS Organizations User Guide.
Performing this operation violates a minimum or maximum value limit. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit.
Some of the reasons in the following list might not be applicable to this specific API or operation:
ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone account. This account requires you to first agree to the AWS Customer Agreement. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone account. This account requires you to first complete phone verification. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.
ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact AWS Support to request an increase in your limit.
Or the number of invitations that you tried to send would cause you to exceed the limit of accounts in your organization. Send fewer invitations or contact AWS Support to request an increase in the number of accounts.
Deleted and closed accounts still count toward your limit.
If you get receive this exception when running a command immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.
CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You can designate only a member account as a delegated administrator.
CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: To complete this operation, you must first deregister this account as a delegated administrator.
DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: To complete this operation, you must first deregister all delegated administrators for this service.
HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send in one day.
MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's master account to the marketplace that corresponds to the master account's address. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be associated with the same marketplace.
MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide contact a valid address and phone number for the master account. Then try the operation again.
MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the master account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.
MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this master account, you first must associate a valid payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal.
MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number of policies of a certain type that can be attached to an entity at one time.
MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource.
MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity that would cause the entity to have fewer than the minimum number of policies of a certain type required.
OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.
ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.
OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.
POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in an organization.
(Optional)
The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. This role trusts the master account, allowing users in the master account to assume the role, as permitted by the master account administrator. The role has administrator permissions in the new member account.
If you don't specify this parameter, the role name defaults to OrganizationAccountAccessRole.
For more information about how to use this role to access the member account, see Accessing and Administering the Member Accounts in Your Organization in the AWS Organizations User Guide. Also see steps 2 and 3 in Tutorial: Delegate Access Across AWS Accounts Using IAM Roles in the IAM User Guide.
The regex pattern that is used to validate this parameter. The pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-
" + "documentation":"(Optional)
The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. This role trusts the master account, allowing users in the master account to assume the role, as permitted by the master account administrator. The role has administrator permissions in the new member account.
If you don't specify this parameter, the role name defaults to OrganizationAccountAccessRole.
For more information about how to use this role to access the member account, see the following links:
Accessing and Administering the Member Accounts in Your Organization in the AWS Organizations User Guide
Steps 2 and 3 in Tutorial: Delegate Access Across AWS Accounts Using IAM Roles in the IAM User Guide
The regex pattern that is used to validate this parameter. The pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-
" }, "IamUserAccessToBilling":{ "shape":"IAMUserAccessToBilling", - "documentation":"If set to ALLOW, the new account enables IAM users to access account billing information if they have the required permissions. If set to DENY, only the root user of the new account can access account billing information. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User Guide.
If you don't specify this parameter, the value defaults to ALLOW. This value allows IAM users and roles with the required permissions to access billing information for the new account.
If set to ALLOW, the new account enables IAM users to access account billing information if they have the required permissions. If set to DENY, only the root user of the new account can access account billing information. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User Guide.
If you don't specify this parameter, the value defaults to ALLOW, and IAM users and roles with the required permissions can access billing information for the new account.
If the request failed, a description of the reason for the failure.
ACCOUNT_LIMIT_EXCEEDED: The account could not be created because you have reached the limit on the number of accounts in your organization.
EMAIL_ALREADY_EXISTS: The account could not be created because another AWS account with that email address already exists.
GOVCLOUD_ACCOUNT_ALREADY_EXISTS: The account in the AWS GovCloud (US) Region could not be created because this Region already includes an account with that email address.
INVALID_ADDRESS: The account could not be created because the address you provided is not valid.
INVALID_EMAIL: The account could not be created because the email address you provided is not valid.
INTERNAL_FAILURE: The account could not be created because of an internal failure. Try again later. If the problem persists, contact AWS Support.
If the request failed, a description of the reason for the failure.
ACCOUNT_LIMIT_EXCEEDED: The account could not be created because you have reached the limit on the number of accounts in your organization.
EMAIL_ALREADY_EXISTS: The account could not be created because another AWS account with that email address already exists.
GOVCLOUD_ACCOUNT_ALREADY_EXISTS: The account in the AWS GovCloud (US) Region could not be created because this Region already includes an account with that email address.
INVALID_ADDRESS: The account could not be created because the address you provided is not valid.
INVALID_EMAIL: The account could not be created because the email address you provided is not valid.
INTERNAL_FAILURE: The account could not be created because of an internal failure. Try again later. If the problem persists, contact Customer Support.
Contains the status about a CreateAccount or CreateGovCloudAccount request to create an AWS account or an AWS GovCloud (US) account in an organization.
" @@ -1305,7 +1407,7 @@ "members":{ "Message":{"shape":"ExceptionMessage"} }, - "documentation":"We can't find a create account request with the CreateAccountRequestId that you specified.
We can't find an create account request with the CreateAccountRequestId that you specified.
The email address of the owner to assign to the new member account in the commercial Region. This email address must not already be associated with another AWS account. You must use a valid email address to complete account creation. You can't access the root user of the account or remove an account that was created with an invalid email address. Like all request parameters for CreateGovCloudAccount, the request for the email address for the AWS GovCloud (US) account originates from the commercial Region. It does not come from the AWS GovCloud (US) Region.
The email address of the owner to assign to the new member account in the commercial Region. This email address must not already be associated with another AWS account. You must use a valid email address to complete account creation. You can't access the root user of the account or remove an account that was created with an invalid email address. Like all request parameters for CreateGovCloudAccount, the request for the email address for the AWS GovCloud (US) account originates from the commercial Region, not from the AWS GovCloud (US) Region.
(Optional)
The name of an IAM role that AWS Organizations automatically preconfigures in the new member accounts in both the AWS GovCloud (US) Region and in the commercial Region. This role trusts the master account, allowing users in the master account to assume the role, as permitted by the master account administrator. The role has administrator permissions in the new member account.
If you don't specify this parameter, the role name defaults to OrganizationAccountAccessRole.
For more information about how to use this role to access the member account, see Accessing and Administering the Member Accounts in Your Organization in the AWS Organizations User Guide. See also steps 2 and 3 in Tutorial: Delegate Access Across AWS Accounts Using IAM Roles in the IAM User Guide.
The regex pattern that is used to validate this parameter. The pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-
" + "documentation":"(Optional)
The name of an IAM role that AWS Organizations automatically preconfigures in the new member accounts in both the AWS GovCloud (US) Region and in the commercial Region. This role trusts the master account, allowing users in the master account to assume the role, as permitted by the master account administrator. The role has administrator permissions in the new member account.
If you don't specify this parameter, the role name defaults to OrganizationAccountAccessRole.
For more information about how to use this role to access the member account, see Accessing and Administering the Member Accounts in Your Organization in the AWS Organizations User Guide and steps 2 and 3 in Tutorial: Delegate Access Across AWS Accounts Using IAM Roles in the IAM User Guide.
The regex pattern that is used to validate this parameter. The pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-
" }, "IamUserAccessToBilling":{ "shape":"IAMUserAccessToBilling", @@ -1348,7 +1450,7 @@ "members":{ "FeatureSet":{ "shape":"OrganizationFeatureSet", - "documentation":"Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.
CONSOLIDATED_BILLING: All member accounts have their bills consolidated to and paid by the master account. For more information, see Consolidated billing in the AWS Organizations User Guide.
The consolidated billing feature subset isn't available for organizations in the AWS GovCloud (US) Region.
ALL: In addition to all the features that consolidated billing feature set supports, the master account can also apply any policy type to any member account in the organization. For more information, see All features in the AWS Organizations User Guide.
Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.
CONSOLIDATED_BILLING: All member accounts have their bills consolidated to and paid by the master account. For more information, see Consolidated billing in the AWS Organizations User Guide.
The consolidated billing feature subset isn't available for organizations in the AWS GovCloud (US) Region.
ALL: In addition to all the features supported by the consolidated billing feature set, the master account can also apply any policy type to any member account in the organization. For more information, see All features in the AWS Organizations User Guide.
The policy content to add to the new policy. For example, you could create a service control policy (SCP) that specifies the permissions that administrators in attached accounts can delegate to their users, groups, and roles. The string for this SCP must be JSON text. For more information about the SCP syntax, see Service Control Policy Syntax in the AWS Organizations User Guide.
" + "documentation":"The policy content to add to the new policy. For example, if you create a service control policy (SCP), this string must be JSON text that specifies the permissions that admins in attached accounts can delegate to their users, groups, and roles. For more information about the SCP syntax, see Service Control Policy Syntax in the AWS Organizations User Guide.
" }, "Description":{ "shape":"PolicyDescription", @@ -1410,7 +1512,7 @@ }, "Type":{ "shape":"PolicyType", - "documentation":"The type of policy to create.
" + "documentation":"The type of policy to create.
In the current release, the only type of policy that you can create is a service control policy (SCP).
The unique identifier (ID) of the delegated administrator's account.
" + }, + "Arn":{ + "shape":"AccountArn", + "documentation":"The Amazon Resource Name (ARN) of the delegated administrator's account.
" + }, + "Email":{ + "shape":"Email", + "documentation":"The email address that is associated with the delegated administrator's AWS account.
" + }, + "Name":{ + "shape":"AccountName", + "documentation":"The friendly name of the delegated administrator's account.
" + }, + "Status":{ + "shape":"AccountStatus", + "documentation":"The status of the delegated administrator's account in the organization.
" + }, + "JoinedMethod":{ + "shape":"AccountJoinedMethod", + "documentation":"The method by which the delegated administrator's account joined the organization.
" + }, + "JoinedTimestamp":{ + "shape":"Timestamp", + "documentation":"The date when the delegated administrator's account became a part of the organization.
" + }, + "DelegationEnabledDate":{ + "shape":"Timestamp", + "documentation":"The date when the account was made a delegated administrator.
" + } + }, + "documentation":"Contains information about the delegated administrator.
" + }, + "DelegatedAdministrators":{ + "type":"list", + "member":{"shape":"DelegatedAdministrator"} + }, + "DelegatedService":{ + "type":"structure", + "members":{ + "ServicePrincipal":{ + "shape":"ServicePrincipal", + "documentation":"The name of a service that can request an operation for the specified service. This is typically in the form of a URL, such as: servicename.amazonaws.com.
The date that the account became a delegated administrator for this service.
" + } + }, + "documentation":"Contains information about the AWS service for which the account is a delegated administrator.
" + }, + "DelegatedServices":{ + "type":"list", + "member":{"shape":"DelegatedService"} + }, "DeleteOrganizationalUnitRequest":{ "type":"structure", "required":["OrganizationalUnitId"], @@ -1462,6 +1624,23 @@ } } }, + "DeregisterDelegatedAdministratorRequest":{ + "type":"structure", + "required":[ + "AccountId", + "ServicePrincipal" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"The account ID number of the member account in the organization that you want to deregister as a delegated administrator.
" + }, + "ServicePrincipal":{ + "shape":"ServicePrincipal", + "documentation":"The service principal name of an AWS service for which the account is a delegated administrator.
Delegated administrator privileges are revoked for only the specified AWS service from the member account. If the specified service is the only service for which the member account is a delegated administrator, the operation also revokes Organizations read action permissions.
" + } + } + }, "DescribeAccountRequest":{ "type":"structure", "required":["AccountId"], @@ -1793,7 +1972,7 @@ "documentation":"The date that the service principal was enabled for integration with AWS Organizations.
" } }, - "documentation":"A structure that contains details of a service principal that is enabled to integrate with AWS Organizations.
" + "documentation":"A structure that contains details of a service principal that represents an AWS service that is enabled to integrate with AWS Organizations.
" }, "EnabledServicePrincipals":{ "type":"list", @@ -1849,7 +2028,7 @@ "documentation":"Additional information that is needed to process the handshake.
" } }, - "documentation":"Contains information that must be exchanged to securely establish a relationship between two accounts (an originator and a recipient). For example, assume that a master account (the originator) invites another account (the recipient) to join its organization. In that case, the two accounts exchange information as a series of handshake requests and responses.
Note: Handshakes that are CANCELED, ACCEPTED, or DECLINED show up in lists for only 30 days after entering that state. After that, they are deleted.
" + "documentation":"Contains information that must be exchanged to securely establish a relationship between two accounts (an originator and a recipient). For example, when a master account (the originator) invites another account (the recipient) to join its organization, the two accounts exchange information as a series of handshake requests and responses.
Note: Handshakes that are CANCELED, ACCEPTED, or DECLINED show up in lists for only 30 days after entering that state After that they are deleted.
" }, "HandshakeAlreadyInStateException":{ "type":"structure", @@ -2027,7 +2206,7 @@ "Message":{"shape":"ExceptionMessage"}, "Reason":{"shape":"InvalidInputExceptionReason"} }, - "documentation":"The requested operation failed because you provided invalid values for one or more of the request parameters. This exception includes a reason that contains additional information about the violated limit:
Some of the reasons in the following list might not be applicable to this specific API or operation:
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_ENUM: You specified an invalid value.
INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
The requested operation failed because you provided invalid values for one or more of the request parameters. This exception includes a reason that contains additional information about the violated limit:
Some of the reasons in the following list might not be applicable to this specific API or operation:
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_ENUM: You specified an invalid value.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
Specifies a service principal name. If specified, then the operation lists the delegated administrators only for the specified service.
If you don't specify a service principal, the operation lists all delegated administrators for all services in your organization.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The list of delegated administrators in your organization.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
The account ID number of a delegated administrator account in the organization.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The services for which the account is a delegated administrator.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
Filters the handshakes that you want included in the response. The default is all types. Use the ActionType element to limit the output to only a specified type, such as INVITE, ENABLE_ALL_FEATURES, or APPROVE_ALL_FEATURES. Alternatively, you can specify the ENABLE_ALL_FEATURES handshake, which generates a separate child handshake for each member account. When you do specify ParentHandshakeId to see only the handshakes that were generated by that parent request.
Filters the handshakes that you want included in the response. The default is all types. Use the ActionType element to limit the output to only a specified type, such as INVITE, ENABLE_ALL_FEATURES, or APPROVE_ALL_FEATURES. Alternatively, for the ENABLE_ALL_FEATURES handshake that generates a separate child handshake for each member account, you can specify ParentHandshakeId to see only the handshakes that were generated by that parent request.
Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
A filter of the handshakes that you want included in the response. The default is all types. Use the ActionType element to limit the output to only a specified type, such as INVITE, ENABLE-ALL-FEATURES, or APPROVE-ALL-FEATURES. Alternatively, you can specify the ENABLE-ALL-FEATURES handshake, which generates a separate child handshake for each member account. When you do, specify the ParentHandshakeId to see only the handshakes that were generated by that parent request.
A filter of the handshakes that you want included in the response. The default is all types. Use the ActionType element to limit the output to only a specified type, such as INVITE, ENABLE-ALL-FEATURES, or APPROVE-ALL-FEATURES. Alternatively, for the ENABLE-ALL-FEATURES handshake that generates a separate child handshake for each member account, you can specify the ParentHandshakeId to see only the handshakes that were generated by that parent request.
Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
A list of policy types that are enabled for this organization. For example, if your organization has all features enabled, then service control policies (SCPs) are included in the list.
Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use ListRoots to see the status of a policy type in that root.
Contains details about an organization. An organization is a collection of accounts that are centrally managed together using consolidated billing, organized hierarchically with organizational units (OUs), and controlled with policies.
" + "documentation":"Contains details about an organization. An organization is a collection of accounts that are centrally managed together using consolidated billing, organized hierarchically with organizational units (OUs), and controlled with policies .
" }, "OrganizationArn":{ "type":"string", @@ -2793,7 +3033,7 @@ }, "AwsManaged":{ "shape":"AwsManagedPolicy", - "documentation":"A Boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
" + "documentation":"A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
" } }, "documentation":"Contains information about a policy, but does not include the content. To see the content of a policy, see DescribePolicy.
" @@ -2876,7 +3116,7 @@ }, "Status":{ "shape":"PolicyTypeStatus", - "documentation":"The status of the policy type as it relates to the associated root. You can attach a policy of the specified type to a root or to an OU or account in that root. To do so, the policy must be available in the organization and enabled for that root.
" + "documentation":"The status of the policy type as it relates to the associated root. To attach a policy of the specified type to a root or to an OU or account in that root, it must be available in the organization and enabled for that root.
" } }, "documentation":"Contains information about a policy type and its status in the associated root.
" @@ -2885,6 +3125,23 @@ "type":"list", "member":{"shape":"PolicyTypeSummary"} }, + "RegisterDelegatedAdministratorRequest":{ + "type":"structure", + "required":[ + "AccountId", + "ServicePrincipal" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"The account ID number of the member account in the organization to register as a delegated administrator.
" + }, + "ServicePrincipal":{ + "shape":"ServicePrincipal", + "documentation":"The service principal of the AWS service for which you want to make the member account a delegated administrator.
" + } + } + }, "RemoveAccountFromOrganizationRequest":{ "type":"structure", "required":["AccountId"], diff --git a/botocore/data/personalize-runtime/2018-05-22/service-2.json b/botocore/data/personalize-runtime/2018-05-22/service-2.json index bee26269..6e9b32c4 100644 --- a/botocore/data/personalize-runtime/2018-05-22/service-2.json +++ b/botocore/data/personalize-runtime/2018-05-22/service-2.json @@ -88,7 +88,7 @@ }, "context":{ "shape":"Context", - "documentation":"The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type. For more information, see Contextual Metadata.
" + "documentation":"The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.
" } } }, @@ -123,7 +123,7 @@ }, "context":{ "shape":"Context", - "documentation":"The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type. For more information, see Contextual Metadata.
" + "documentation":"The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.
" } } }, @@ -167,6 +167,10 @@ "itemId":{ "shape":"ItemID", "documentation":"The recommended item ID.
" + }, + "score":{ + "shape":"Score", + "documentation":"A numeric representation of the model's certainty in the item's suitability. For more information on scoring logic, see how-scores-work.
" } }, "documentation":"An object that identifies an item.
The and APIs return a list of PredictedItems.
The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
" } ], - "documentation": "Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes (Attributes, Metrics, and UserAttributes properties) for an endpoint.
" + "documentation": "Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.
" }, "UpdateEndpointsBatch": { "name": "UpdateEndpointsBatch", @@ -4521,7 +4521,7 @@ "documentation": "The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
" } ], - "documentation": "Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes (Attributes, Metrics, and UserAttributes properties) for a batch of endpoints.
" + "documentation": "Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.
" }, "UpdateGcmChannel": { "name": "UpdateGcmChannel", @@ -5871,7 +5871,7 @@ }, "KpiName": { "shape": "__string", - "documentation": "The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
" + "documentation": "The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
" }, "KpiResult": { "shape": "BaseKpiResult", @@ -5932,7 +5932,7 @@ }, "CampaignHook": { "shape": "CampaignHook", - "documentation": "The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application.
" + "documentation": "The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.
" }, "LastModifiedDate": { "shape": "__string", @@ -5940,7 +5940,7 @@ }, "Limits": { "shape": "CampaignLimits", - "documentation": "The default sending limits for campaigns in the application.
" + "documentation": "The default sending limits for campaigns and journeys in the application.
" }, "QuietTime": { "shape": "QuietTime", @@ -6181,6 +6181,16 @@ "Rows" ] }, + "CampaignCustomMessage": { + "type": "structure", + "members": { + "Data": { + "shape": "__string", + "documentation": "The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
" + } + }, + "documentation": "Specifies the contents of a message that's sent through a custom channel to recipients of a campaign.
" + }, "CampaignDateRangeKpiResponse": { "type": "structure", "members": { @@ -6198,7 +6208,7 @@ }, "KpiName": { "shape": "__string", - "documentation": "The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
" + "documentation": "The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
" }, "KpiResult": { "shape": "BaseKpiResult", @@ -6268,25 +6278,25 @@ "members": { "LambdaFunctionName": { "shape": "__string", - "documentation": "The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
" + "documentation": "The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
" }, "Mode": { "shape": "Mode", - "documentation": "Specifies which Lambda mode to use when invoking the AWS Lambda function.
" + "documentation": "The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
FILTER - Invoke the function to customize the segment that's used by a campaign.
DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
" } }, - "documentation": "Specifies the AWS Lambda function to use as a code hook for a campaign.
" + "documentation": "Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign.
" }, "CampaignLimits": { "type": "structure", "members": { "Daily": { "shape": "__integer", - "documentation": "The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
" + "documentation": "The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.
" }, "MaximumDuration": { "shape": "__integer", @@ -6294,14 +6304,14 @@ }, "MessagesPerSecond": { "shape": "__integer", - "documentation": "The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
" + "documentation": "The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send each second. The minimum value is 50. The maximum value is 20,000.
" }, "Total": { "shape": "__integer", - "documentation": "The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.
" + "documentation": "The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
" } }, - "documentation": "Specifies limits on the messages that a campaign can send.
" + "documentation": "For a campaign, specifies limits on the messages that the campaign can send. For an application, specifies the default limits for messages that campaigns and journeys in the application can send.
" }, "CampaignResponse": { "type": "structure", @@ -6322,9 +6332,13 @@ "shape": "__string", "documentation": "The date, in ISO 8601 format, when the campaign was created.
" }, + "CustomDeliveryConfiguration": { + "shape": "CustomDeliveryConfiguration", + "documentation": "The delivery configuration settings for sending the campaign through a custom channel.
" + }, "DefaultState": { "shape": "CampaignState", - "documentation": "The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.
" + "documentation": "The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
" }, "Description": { "shape": "__string", @@ -6336,7 +6350,7 @@ }, "Hook": { "shape": "CampaignHook", - "documentation": "The settings for the AWS Lambda function to use as a code hook for the campaign.
" + "documentation": "The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
" }, "Id": { "shape": "__string", @@ -6389,11 +6403,11 @@ }, "TreatmentDescription": { "shape": "__string", - "documentation": "The custom description of a variation of the campaign that's used for A/B testing.
" + "documentation": "The custom description of the default treatment for the campaign.
" }, "TreatmentName": { "shape": "__string", - "documentation": "The custom name of a variation of the campaign that's used for A/B testing.
" + "documentation": "The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
" }, "Version": { "shape": "__integer", @@ -6434,7 +6448,7 @@ "members": { "CampaignStatus": { "shape": "CampaignStatus", - "documentation": "The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED.
" + "documentation": "The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
" } }, "documentation": "Provides information about the status of a campaign.
" @@ -6807,11 +6821,11 @@ "members": { "Attributes": { "shape": "MapOf__string", - "documentation": "A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommenderUserIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.
In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder pane of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:
An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.
An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
This object is required if the configuration invokes an AWS Lambda function (LambdaFunctionArn) to process recommendation data. Otherwise, don't include this object in your request.
" + "documentation": "A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.
In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:
An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.
An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.
" }, "Description": { "shape": "__string", - "documentation": "A custom description of the configuration for the recommender model. The description can contain up to 128 characters.
" + "documentation": "A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.
" }, "Name": { "shape": "__string", @@ -6819,7 +6833,7 @@ }, "RecommendationProviderIdType": { "shape": "__string", - "documentation": "The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:
PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify a both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:
PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores a recommended item for each endpoint or user, depending on the value for the RecommenderUserIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (LambdaFunctionArn) to perform additional processing of recommendation data.
This name appears in the Attribute finder pane of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.
" + "documentation": "A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.
" }, "RecommendationsPerMessage": { "shape": "__integer", - "documentation": "The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommenderUserIdType property. This number determines how many recommended attributes are available for use as message variables in message templates. The minimum value is 1. The maximum value is 5. The default value is 5.
To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (LambdaFunctionArn) to perform additional processing of recommendation data.
" + "documentation": "The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.
To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
" } }, "documentation": "Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.
", @@ -6983,6 +6997,23 @@ ], "payload": "CreateTemplateMessageBody" }, + "CustomDeliveryConfiguration": { + "type": "structure", + "members": { + "DeliveryUri": { + "shape": "__string", + "documentation": "The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
" + } + }, + "documentation": "Specifies the delivery configuration settings for sending a campaign or campaign treatment through a custom channel. This object is required if you use the CampaignCustomMessage object to define the message to send for the campaign or campaign treatment.
", + "required": [ + "DeliveryUri" + ] + }, "DefaultMessage": { "type": "structure", "members": { @@ -7763,7 +7794,7 @@ "members": { "ConfigurationSet": { "shape": "__string", - "documentation": "The configuration set that you want to apply to email that you send through the channel by using the Amazon Pinpoint Email API.
" + "documentation": "The Amazon SES configuration set that you want to apply to messages that you send through the channel.
" }, "Enabled": { "shape": "__boolean", @@ -7797,7 +7828,7 @@ }, "ConfigurationSet": { "shape": "__string", - "documentation": "The configuration set that's applied to email that's sent through the channel by using the Amazon Pinpoint Email API.
" + "documentation": "The Amazon SES configuration set that's applied to messages that are sent through the channel.
" }, "CreationDate": { "shape": "__string", @@ -7809,7 +7840,7 @@ }, "FromAddress": { "shape": "__string", - "documentation": "The verified email address that you send email from when you send email through the channel.
" + "documentation": "The verified email address that email is sent from when you send email through the channel.
" }, "HasCredential": { "shape": "__boolean", @@ -7821,7 +7852,7 @@ }, "Identity": { "shape": "__string", - "documentation": "The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you use when you send email through the channel.
" + "documentation": "The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.
" }, "IsArchived": { "shape": "__boolean", @@ -7837,7 +7868,7 @@ }, "MessagesPerSecond": { "shape": "__integer", - "documentation": "The maximum number of emails that you can send through the channel each second.
" + "documentation": "The maximum number of emails that can be sent through the channel each second.
" }, "Platform": { "shape": "__string", @@ -8062,7 +8093,7 @@ }, "User": { "shape": "EndpointUser", - "documentation": "One or more custom user attributes that describe the user who's associated with the endpoint.
" + "documentation": "One or more custom attributes that describe the user who's associated with the endpoint.
" } }, "documentation": "Specifies an endpoint to create or update and the settings and attributes to set or change for the endpoint.
" @@ -8241,7 +8272,7 @@ }, "User": { "shape": "EndpointUser", - "documentation": "One or more custom user attributes that describe the user who's associated with the endpoint.
" + "documentation": "One or more custom attributes that describe the user who's associated with the endpoint.
" } }, "documentation": "Specifies the channel type and other settings for an endpoint.
" @@ -8427,10 +8458,7 @@ "documentation": "The message identifier (message_id) for the message to use when determining whether message events meet the condition.
" } }, - "documentation": "Specifies the conditions to evaluate for an event that applies to an activity in a journey.
", - "required": [ - "Dimensions" - ] + "documentation": "Specifies the conditions to evaluate for an event that applies to an activity in a journey.
" }, "EventDimensions": { "type": "structure", @@ -9073,19 +9101,19 @@ "shape": "__string", "location": "uri", "locationName": "kpi-name", - "documentation": "The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.
" + "documentation": "The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.
" }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "next-token", - "documentation": "The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" }, "PageSize": { "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" }, "StartTime": { "shape": "__timestampIso8601", @@ -9144,7 +9172,7 @@ "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" }, "Token": { "shape": "__string", @@ -9211,7 +9239,7 @@ "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" }, "Token": { "shape": "__string", @@ -9262,19 +9290,19 @@ "shape": "__string", "location": "uri", "locationName": "kpi-name", - "documentation": "The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.
" + "documentation": "The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.
" }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "next-token", - "documentation": "The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" }, "PageSize": { "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" }, "StartTime": { "shape": "__timestampIso8601", @@ -9393,7 +9421,7 @@ "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" }, "Token": { "shape": "__string", @@ -9432,7 +9460,7 @@ "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" }, "Token": { "shape": "__string", @@ -9646,7 +9674,7 @@ "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" }, "Token": { "shape": "__string", @@ -9743,7 +9771,7 @@ "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" }, "Token": { "shape": "__string", @@ -9793,19 +9821,19 @@ "shape": "__string", "location": "uri", "locationName": "kpi-name", - "documentation": "The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.
" + "documentation": "The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.
" }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "next-token", - "documentation": "The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" }, "PageSize": { "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" }, "StartTime": { "shape": "__timestampIso8601", @@ -9857,13 +9885,13 @@ "shape": "__string", "location": "querystring", "locationName": "next-token", - "documentation": "The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" }, "PageSize": { "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" } }, "required": [ @@ -9903,13 +9931,13 @@ "shape": "__string", "location": "querystring", "locationName": "next-token", - "documentation": "The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" }, "PageSize": { "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" } }, "required": [ @@ -10027,7 +10055,7 @@ "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" }, "Token": { "shape": "__string", @@ -10062,7 +10090,7 @@ "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" }, "SegmentId": { "shape": "__string", @@ -10107,7 +10135,7 @@ "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" }, "SegmentId": { "shape": "__string", @@ -10225,7 +10253,7 @@ "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" }, "SegmentId": { "shape": "__string", @@ -10270,7 +10298,7 @@ "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" }, "Token": { "shape": "__string", @@ -10701,7 +10729,7 @@ }, "KpiName": { "shape": "__string", - "documentation": "The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
" + "documentation": "The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
" }, "KpiResult": { "shape": "BaseKpiResult", @@ -10761,7 +10789,7 @@ }, "Metrics": { "shape": "MapOf__string", - "documentation": "A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.
" + "documentation": "A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.
" } }, "documentation": "Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity, and provides information about that query.
", @@ -10791,7 +10819,7 @@ }, "Metrics": { "shape": "MapOf__string", - "documentation": "A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.
" + "documentation": "A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.
" } }, "documentation": "Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey, and provides information about that query.
", @@ -10950,7 +10978,7 @@ "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" }, "Token": { "shape": "__string", @@ -11025,13 +11053,13 @@ "shape": "__string", "location": "querystring", "locationName": "next-token", - "documentation": "The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" }, "PageSize": { "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" }, "TemplateName": { "shape": "__string", @@ -11070,13 +11098,13 @@ "shape": "__string", "location": "querystring", "locationName": "next-token", - "documentation": "The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" }, "PageSize": { "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
" + "documentation": "The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
" }, "Prefix": { "shape": "__string", @@ -11177,15 +11205,19 @@ "members": { "ADMMessage": { "shape": "Message", - "documentation": "The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
" + "documentation": "The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
" }, "APNSMessage": { "shape": "Message", - "documentation": "The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
" + "documentation": "The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
" }, "BaiduMessage": { "shape": "Message", - "documentation": "The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
" + "documentation": "The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
" + }, + "CustomMessage": { + "shape": "CampaignCustomMessage", + "documentation": "The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
" }, "DefaultMessage": { "shape": "Message", @@ -11193,15 +11225,15 @@ }, "EmailMessage": { "shape": "CampaignEmailMessage", - "documentation": "The message that the campaign sends through the email channel.
" + "documentation": "The message that the campaign sends through the email channel. If specified, this message overrides the default message.
" }, "GCMMessage": { "shape": "Message", - "documentation": "The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
" + "documentation": "The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.
" }, "SMSMessage": { "shape": "CampaignSmsMessage", - "documentation": "The message that the campaign sends through the SMS channel.
" + "documentation": "The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
" } }, "documentation": "Specifies the message configuration settings for a campaign.
" @@ -11828,7 +11860,7 @@ "members": { "Attributes": { "shape": "MapOf__string", - "documentation": "A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommenderUserIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.
This value is null if the configuration doesn't invoke an AWS Lambda function (LambdaFunctionArn) to perform additional processing of recommendation data.
" + "documentation": "A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.
This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
" }, "CreationDate": { "shape": "__string", @@ -11868,11 +11900,11 @@ }, "RecommendationsDisplayName": { "shape": "__string", - "documentation": "The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores a recommended item for each endpoint or user, depending on the value for the RecommenderUserIdType property. This name appears in the Attribute finder pane of the template editor on the Amazon Pinpoint console.
This value is null if the configuration doesn't invoke an AWS Lambda function (LambdaFunctionArn) to perform additional processing of recommendation data.
" + "documentation": "The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console.
This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
" }, "RecommendationsPerMessage": { "shape": "__integer", - "documentation": "The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommenderUserIdType property. This number determines how many recommended attributes are available for use as message variables in message templates.
" + "documentation": "The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables.
" } }, "documentation": "Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.
", @@ -12057,6 +12089,10 @@ "shape": "__string", "documentation": "The SMS program name that you provided to AWS Support when you requested your dedicated number.
" }, + "MediaUrl": { + "shape": "__string", + "documentation": "The URL of an image or video to display in the SMS message.
" + }, "MessageType": { "shape": "MessageType", "documentation": "The SMS message type. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message is not critical or time-sensitive, such as a marketing message.
" @@ -12949,6 +12985,10 @@ "TreatmentResource": { "type": "structure", "members": { + "CustomDeliveryConfiguration": { + "shape": "CustomDeliveryConfiguration", + "documentation": "The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
" + }, "Id": { "shape": "__string", "documentation": "The unique identifier for the treatment.
" @@ -12979,10 +13019,10 @@ }, "TreatmentName": { "shape": "__string", - "documentation": "The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
" + "documentation": "The custom name of the treatment.
" } }, - "documentation": "Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
", + "documentation": "Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
", "required": [ "Id", "SizePercent" @@ -13580,11 +13620,11 @@ "members": { "Attributes": { "shape": "MapOf__string", - "documentation": "A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommenderUserIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.
In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder pane of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:
An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.
An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
This object is required if the configuration invokes an AWS Lambda function (LambdaFunctionArn) to process recommendation data. Otherwise, don't include this object in your request.
" + "documentation": "A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.
In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:
An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.
An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.
" }, "Description": { "shape": "__string", - "documentation": "A custom description of the configuration for the recommender model. The description can contain up to 128 characters.
" + "documentation": "A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.
" }, "Name": { "shape": "__string", @@ -13592,7 +13632,7 @@ }, "RecommendationProviderIdType": { "shape": "__string", - "documentation": "The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:
PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify a both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:
PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores a recommended item for each endpoint or user, depending on the value for the RecommenderUserIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (LambdaFunctionArn) to perform additional processing of recommendation data.
This name appears in the Attribute finder pane of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.
" + "documentation": "A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.
" }, "RecommendationsPerMessage": { "shape": "__integer", - "documentation": "The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommenderUserIdType property. This number determines how many recommended attributes are available for use as message variables in message templates. The minimum value is 1. The maximum value is 5. The default value is 5.
To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (LambdaFunctionArn) to perform additional processing of recommendation data.
" + "documentation": "The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.
To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
" } }, "documentation": "Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.
", @@ -14086,7 +14126,7 @@ "members": { "CampaignHook": { "shape": "CampaignHook", - "documentation": "The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application. To override these settings for a specific campaign, use the Campaign resource to define custom Lambda function settings for the campaign.
" + "documentation": "The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.
To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.
" }, "CloudWatchMetricsEnabled": { "shape": "__boolean", @@ -14094,7 +14134,7 @@ }, "Limits": { "shape": "CampaignLimits", - "documentation": "The default sending limits for campaigns in the application. To override these limits for a specific campaign, use the Campaign resource to define custom limits for the campaign.
" + "documentation": "The default sending limits for campaigns and journeys in the application. To override these limits and define custom limits for a specific campaign or journey, use the Campaign resource or the Journey resource, respectively.
" }, "QuietTime": { "shape": "QuietTime", @@ -14110,6 +14150,10 @@ "shape": "ListOfWriteTreatmentResource", "documentation": "An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
" }, + "CustomDeliveryConfiguration": { + "shape": "CustomDeliveryConfiguration", + "documentation": "The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.
" + }, "Description": { "shape": "__string", "documentation": "A custom description of the campaign.
" @@ -14120,11 +14164,11 @@ }, "Hook": { "shape": "CampaignHook", - "documentation": "The settings for the AWS Lambda function to use as a code hook for the campaign.
" + "documentation": "The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
" }, "IsPaused": { "shape": "__boolean", - "documentation": "Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false.
" + "documentation": "Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.
" }, "Limits": { "shape": "CampaignLimits", @@ -14161,11 +14205,11 @@ }, "TreatmentDescription": { "shape": "__string", - "documentation": "A custom description of a variation of the campaign to use for A/B testing.
" + "documentation": "A custom description of the default treatment for the campaign.
" }, "TreatmentName": { "shape": "__string", - "documentation": "A custom name for a variation of the campaign to use for A/B testing.
" + "documentation": "A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
" } }, "documentation": "Specifies the configuration and other settings for a campaign.
" @@ -14271,6 +14315,10 @@ "WriteTreatmentResource": { "type": "structure", "members": { + "CustomDeliveryConfiguration": { + "shape": "CustomDeliveryConfiguration", + "documentation": "The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
" + }, "MessageConfiguration": { "shape": "MessageConfiguration", "documentation": "The message configuration settings for the treatment.
" @@ -14293,14 +14341,30 @@ }, "TreatmentName": { "shape": "__string", - "documentation": "A custom name for the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
" + "documentation": "A custom name for the treatment.
" } }, - "documentation": "Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
", + "documentation": "Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
", "required": [ "SizePercent" ] }, + "__EndpointTypesElement": { + "type": "string", + "enum": [ + "GCM", + "APNS", + "APNS_SANDBOX", + "APNS_VOIP", + "APNS_VOIP_SANDBOX", + "ADM", + "SMS", + "VOICE", + "EMAIL", + "BAIDU", + "CUSTOM" + ] + }, "__boolean": { "type": "boolean" }, @@ -14442,6 +14506,12 @@ "shape": "WriteTreatmentResource" } }, + "ListOf__EndpointTypesElement": { + "type": "list", + "member": { + "shape": "__EndpointTypesElement" + } + }, "ListOf__string": { "type": "list", "member": { diff --git a/botocore/data/pricing/2017-10-15/examples-1.json b/botocore/data/pricing/2017-10-15/examples-1.json new file mode 100644 index 00000000..90aa3ef0 --- /dev/null +++ b/botocore/data/pricing/2017-10-15/examples-1.json @@ -0,0 +1,103 @@ +{ + "version": "1.0", + "examples": { + "DescribeServices": [ + { + "input": { + "FormatVersion": "aws_v1", + "MaxResults": 1, + "ServiceCode": "AmazonEC2" + }, + "output": { + "FormatVersion": "aws_v1", + "NextToken": "abcdefg123", + "Services": [ + { + "AttributeNames": [ + "volumeType", + "maxIopsvolume", + "instanceCapacity10xlarge", + "locationType", + "operation" + ], + "ServiceCode": "AmazonEC2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "id": "to-retrieve-service-metadata", + "title": "To retrieve a list of services and service codes" + } + ], + "GetAttributeValues": [ + { + "input": { + "AttributeName": "volumeType", + "MaxResults": 2, + "ServiceCode": "AmazonEC2" + }, + "output": { + "AttributeValues": [ + { + "Value": "Throughput Optimized HDD" + }, + { + "Value": "Provisioned IOPS" + } + ], + "NextToken": "GpgauEXAMPLEezucl5LV0w==:7GzYJ0nw0DBTJ2J66EoTIIynE6O1uXwQtTRqioJzQadBnDVgHPzI1en4BUQnPCLpzeBk9RQQAWaFieA4+DapFAGLgk+Z/9/cTw9GldnPOHN98+FdmJP7wKU3QQpQ8MQr5KOeBkIsAqvAQYdL0DkL7tHwPtE5iCEByAmg9gcC/yBU1vAOsf7R3VaNN4M5jMDv3woSWqASSIlBVB6tgW78YL22KhssoItM/jWW+aP6Jqtq4mldxp/ct6DWAl+xLFwHU/CbketimPPXyqHF3/UXDw==" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation returns a list of values available for the given attribute.", + "id": "to-retreive-attribute-values", + "title": "To retrieve a list of attribute values" + } + ], + "GetProducts": [ + { + "input": { + "Filters": [ + { + "Field": "ServiceCode", + "Type": "TERM_MATCH", + "Value": "AmazonEC2" + }, + { + "Field": "volumeType", + "Type": "TERM_MATCH", + "Value": "Provisioned IOPS" + } + ], + "FormatVersion": "aws_v1", + "MaxResults": 1 + }, + "output": { + "FormatVersion": "aws_v1", + "NextToken": "57r3EXAMPLEujbzWfHF7Ciw==:ywSmZsD3mtpQmQLQ5XfOsIMkYybSj+vAT+kGmwMFq+K9DGmIoJkz7lunVeamiOPgthdWSO2a7YKojCO+zY4dJmuNl2QvbNhXs+AJ2Ufn7xGmJncNI2TsEuAsVCUfTAvAQNcwwamtk6XuZ4YdNnooV62FjkV3ZAn40d9+wAxV7+FImvhUHi/+f8afgZdGh2zPUlH8jlV9uUtj0oHp8+DhPUuHXh+WBII1E/aoKpPSm3c=", + "PriceList": [ + "{\"product\":{\"productFamily\":\"Storage\",\"attributes\":{\"storageMedia\":\"SSD-backed\",\"maxThroughputvolume\":\"320 MB/sec\",\"volumeType\":\"Provisioned IOPS\",\"maxIopsvolume\":\"20000\",\"servicecode\":\"AmazonEC2\",\"usagetype\":\"CAN1-EBS:VolumeUsage.piops\",\"locationType\":\"AWS Region\",\"location\":\"Canada (Central)\",\"servicename\":\"Amazon Elastic Compute Cloud\",\"maxVolumeSize\":\"16 TiB\",\"operation\":\"\"},\"sku\":\"WQGC34PB2AWS8R4U\"},\"serviceCode\":\"AmazonEC2\",\"terms\":{\"OnDemand\":{\"WQGC34PB2AWS8R4U.JRTCKXETXF\":{\"priceDimensions\":{\"WQGC34PB2AWS8R4U.JRTCKXETXF.6YS6EN2CT7\":{\"unit\":\"GB-Mo\",\"endRange\":\"Inf\",\"description\":\"$0.138 per GB-month of Provisioned IOPS SSD (io1) provisioned storage - Canada (Central)\",\"appliesTo\":[],\"rateCode\":\"WQGC34PB2AWS8R4U.JRTCKXETXF.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.1380000000\"}}},\"sku\":\"WQGC34PB2AWS8R4U\",\"effectiveDate\":\"2017-08-01T00:00:00Z\",\"offerTermCode\":\"JRTCKXETXF\",\"termAttributes\":{}}}},\"version\":\"20170901182201\",\"publicationDate\":\"2017-09-01T18:22:01Z\"}" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation returns a list of products that match the given criteria.", + "id": "to-retrieve-available products", + "title": "To retrieve a list of products" + } + ] + } +} diff --git a/botocore/data/ram/2018-01-04/service-2.json b/botocore/data/ram/2018-01-04/service-2.json index b3b4ce42..3f222398 100644 --- a/botocore/data/ram/2018-01-04/service-2.json +++ b/botocore/data/ram/2018-01-04/service-2.json @@ -207,6 +207,7 @@ {"shape":"MalformedArnException"}, {"shape":"InvalidNextTokenException"}, {"shape":"InvalidParameterException"}, + {"shape":"ResourceArnNotFoundException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"} ], @@ -243,6 +244,7 @@ {"shape":"ResourceShareInvitationArnNotFoundException"}, {"shape":"InvalidMaxResultsException"}, {"shape":"MalformedArnException"}, + {"shape":"UnknownResourceException"}, {"shape":"InvalidNextTokenException"}, {"shape":"InvalidParameterException"}, {"shape":"ServerInternalException"}, @@ -343,6 +345,22 @@ ], "documentation":"Lists the AWS RAM permissions that are associated with a resource share.
" }, + "ListResourceTypes":{ + "name":"ListResourceTypes", + "http":{ + "method":"POST", + "requestUri":"/listresourcetypes" + }, + "input":{"shape":"ListResourceTypesRequest"}, + "output":{"shape":"ListResourceTypesResponse"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ServerInternalException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Lists the shareable resource types supported by AWS RAM.
" + }, "ListResources":{ "name":"ListResources", "http":{ @@ -376,7 +394,8 @@ {"shape":"InvalidParameterException"}, {"shape":"MissingRequiredParameterException"}, {"shape":"ServerInternalException"}, - {"shape":"ServiceUnavailableException"} + {"shape":"ServiceUnavailableException"}, + {"shape":"UnknownResourceException"} ], "documentation":"Resource shares that were created by attaching a policy to a resource are visible only to the resource share owner, and the resource share cannot be modified in AWS RAM.
Use this API action to promote the resource share. When you promote the resource share, it becomes:
Visible to all principals that it is shared with.
Modifiable in AWS RAM.
The resource type.
Valid values: ec2:CapacityReservation | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | license-manager:LicenseConfiguration | rds:Cluster | route53resolver:ResolverRule I resource-groups:Group
The resource type.
Valid values: codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | license-manager:LicenseConfiguration I resource-groups:Group | rds:Cluster | route53resolver:ResolverRule
The token for the next page of results.
" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The shareable resource types supported by AWS RAM.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The resource type.
Valid values: ec2:CapacityReservation | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | license-manager:LicenseConfiguration | rds:Cluster | route53resolver:ResolverRule | resource-groups:Group
The resource type.
Valid values: codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | license-manager:LicenseConfiguration I resource-groups:Group | rds:Cluster | route53resolver:ResolverRule
The shareable resource types.
" + }, + "serviceName":{ + "shape":"String", + "documentation":"The name of the AWS services to which the resources belong.
" + } + }, + "documentation":"Information about the shareable resource types and the AWS services to which they belong.
" + }, + "ServiceNameAndResourceTypeList":{ + "type":"list", + "member":{"shape":"ServiceNameAndResourceType"} + }, "ServiceUnavailableException":{ "type":"structure", "required":["message"], diff --git a/botocore/data/rds-data/2018-08-01/service-2.json b/botocore/data/rds-data/2018-08-01/service-2.json index 867652bb..294450a6 100644 --- a/botocore/data/rds-data/2018-08-01/service-2.json +++ b/botocore/data/rds-data/2018-08-01/service-2.json @@ -102,7 +102,7 @@ {"shape":"ForbiddenException"}, {"shape":"ServiceUnavailableError"} ], - "documentation":"Runs a SQL statement against a database.
If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically.
The response size limit is 1 MB or 1,000 records. If the call returns more than 1 MB of response data or over 1,000 records, the call is terminated.
" + "documentation":"Runs a SQL statement against a database.
If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically.
The response size limit is 1 MB. If the call returns more than 1 MB of response data, the call is terminated.
" }, "RollbackTransaction":{ "name":"RollbackTransaction", @@ -194,7 +194,7 @@ }, "parameterSets":{ "shape":"SqlParameterSets", - "documentation":"The parameter set for the batch operation.
The maximum number of parameters in a parameter set is 1,000.
" + "documentation":"The parameter set for the batch operation.
The SQL statement is executed as many times as the number of parameter sets provided. To execute a SQL statement with no parameters, use one of the following options:
Specify one or more empty parameter sets.
Use the ExecuteStatement operation instead of the BatchExecuteStatement operation.
Array parameters are not supported.
The parameters for the SQL statement.
" + "documentation":"The parameters for the SQL statement.
Array parameters are not supported.
Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.
For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.
" }, @@ -288,7 +290,7 @@ {"shape":"InvalidGlobalClusterStateFault"}, {"shape":"DomainNotFoundFault"} ], - "documentation":"Creates a new Amazon Aurora DB cluster.
You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified by ReplicationSourceIdentifier is encrypted, you must also specify the PreSignedUrl parameter.
For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
Creates a new Amazon Aurora DB cluster.
You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a read replica of another DB cluster or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified by ReplicationSourceIdentifier is encrypted, you must also specify the PreSignedUrl parameter.
For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
Creates a new DB instance that acts as a Read Replica for an existing source DB instance. You can create a Read Replica for a DB instance running MySQL, MariaDB, Oracle, or PostgreSQL. For more information, see Working with Read Replicas in the Amazon RDS User Guide.
Amazon Aurora doesn't support this action. You must call the CreateDBInstance action to create a DB instance for an Aurora DB cluster.
All Read Replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified following.
Your source DB instance must have backup retention enabled.
Creates a new DB instance that acts as a read replica for an existing source DB instance. You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read Replicas in the Amazon RDS User Guide.
Amazon Aurora doesn't support this action. Call the CreateDBInstance action to create a DB instance for an Aurora DB cluster.
All read replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified.
Your source DB instance must have backup retention enabled.
The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.
If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.
When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.
If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:
The DB cluster is a Read Replica of another Amazon Aurora DB cluster.
The DB instance is the only instance in the DB cluster.
To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a Read Replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.
The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.
If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.
When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.
If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:
The DB cluster is a read replica of another Amazon Aurora DB cluster.
The DB instance is the only instance in the DB cluster.
To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a read replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.
Returns a list of the source AWS Regions where the current AWS Region can create a Read Replica or copy a DB snapshot from. This API action supports pagination.
" + "documentation":"Returns a list of the source AWS Regions where the current AWS Region can create a read replica or copy a DB snapshot from. This API action supports pagination.
" }, "DescribeValidDBInstanceModifications":{ "name":"DescribeValidDBInstanceModifications", @@ -1515,7 +1517,9 @@ "errors":[ {"shape":"DBInstanceNotFoundFault"}, {"shape":"DBSnapshotNotFoundFault"}, - {"shape":"DBClusterNotFoundFault"} + {"shape":"DBClusterNotFoundFault"}, + {"shape":"DBProxyNotFoundFault"}, + {"shape":"DBProxyTargetGroupNotFoundFault"} ], "documentation":"Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
" }, @@ -1734,7 +1738,7 @@ "errors":[ {"shape":"DBSnapshotNotFoundFault"} ], - "documentation":"Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version.
Amazon RDS supports upgrading DB snapshots for MySQL, Oracle, and PostgreSQL.
" + "documentation":"Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public.
Amazon RDS supports upgrading DB snapshots for MySQL, Oracle, and PostgreSQL.
" }, "ModifyDBSnapshotAttribute":{ "name":"ModifyDBSnapshotAttribute", @@ -1844,7 +1848,7 @@ {"shape":"InvalidDBInstanceStateFault"}, {"shape":"DBInstanceNotFoundFault"} ], - "documentation":"Promotes a Read Replica DB instance to a standalone DB instance.
Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a Read Replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a Read Replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your Read Replica, configure the automated backup window so that daily backups do not interfere with Read Replica promotion.
This command doesn't apply to Aurora MySQL and Aurora PostgreSQL.
Promotes a read replica DB instance to a standalone DB instance.
Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion.
This command doesn't apply to Aurora MySQL and Aurora PostgreSQL.
Promotes a Read Replica DB cluster to a standalone DB cluster.
This action only applies to Aurora DB clusters.
Promotes a read replica DB cluster to a standalone DB cluster.
This action only applies to Aurora DB clusters.
Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
" }, @@ -2059,7 +2065,7 @@ {"shape":"DomainNotFoundFault"}, {"shape":"InsufficientStorageClusterCapacityFault"} ], - "documentation":"Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data to an Amazon Aurora MySQL DB Cluster in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data to an Amazon Aurora MySQL DB Cluster in the Amazon Aurora User Guide.
This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromS3 action has completed and the DB cluster is available.
For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster. If you don't specify a security group, the new DB cluster is associated with the default security group.
For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
Creates a new DB cluster from a DB snapshot or DB cluster snapshot. This action only applies to Aurora DB clusters.
The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group.
This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromSnapshot action has completed and the DB cluster is available.
For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
The maximum allowed value for the quota.
" } }, - "documentation":"Describes a quota for an AWS account.
The following are account quotas:
AllocatedStorage - The total allocated storage per account, in GiB. The used value is the total allocated storage in the account, in GiB.
AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB security group. The used value is the highest number of ingress rules in a DB security group in the account. Other DB security groups in the account might have a lower number of ingress rules.
CustomEndpointsPerDBCluster - The number of custom endpoints per DB cluster. The used value is the highest number of custom endpoints in a DB clusters in the account. Other DB clusters in the account might have a lower number of custom endpoints.
DBClusterParameterGroups - The number of DB cluster parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB cluster parameter groups in the account.
DBClusterRoles - The number of associated AWS Identity and Access Management (IAM) roles per DB cluster. The used value is the highest number of associated IAM roles for a DB cluster in the account. Other DB clusters in the account might have a lower number of associated IAM roles.
DBClusters - The number of DB clusters per account. The used value is the count of DB clusters in the account.
DBInstanceRoles - The number of associated IAM roles per DB instance. The used value is the highest number of associated IAM roles for a DB instance in the account. Other DB instances in the account might have a lower number of associated IAM roles.
DBInstances - The number of DB instances per account. The used value is the count of the DB instances in the account.
Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune instances, and Amazon DocumentDB instances apply to this quota.
DBParameterGroups - The number of DB parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB parameter groups in the account.
DBSecurityGroups - The number of DB security groups (not VPC security groups) per account, excluding the default security group. The used value is the count of nondefault DB security groups in the account.
DBSubnetGroups - The number of DB subnet groups per account. The used value is the count of the DB subnet groups in the account.
EventSubscriptions - The number of event subscriptions per account. The used value is the count of the event subscriptions in the account.
ManualSnapshots - The number of manual DB snapshots per account. The used value is the count of the manual DB snapshots in the account.
OptionGroups - The number of DB option groups per account, excluding default option groups. The used value is the count of nondefault DB option groups in the account.
ReadReplicasPerMaster - The number of Read Replicas per DB instance. The used value is the highest number of Read Replicas for a DB instance in the account. Other DB instances in the account might have a lower number of Read Replicas.
ReservedDBInstances - The number of reserved DB instances per account. The used value is the count of the active reserved DB instances in the account.
SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. The used value is highest number of subnets for a DB subnet group in the account. Other DB subnet groups in the account might have a lower number of subnets.
For more information, see Quotas for Amazon RDS in the Amazon RDS User Guide and Quotas for Amazon Aurora in the Amazon Aurora User Guide.
", + "documentation":"Describes a quota for an AWS account.
The following are account quotas:
AllocatedStorage - The total allocated storage per account, in GiB. The used value is the total allocated storage in the account, in GiB.
AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB security group. The used value is the highest number of ingress rules in a DB security group in the account. Other DB security groups in the account might have a lower number of ingress rules.
CustomEndpointsPerDBCluster - The number of custom endpoints per DB cluster. The used value is the highest number of custom endpoints in a DB clusters in the account. Other DB clusters in the account might have a lower number of custom endpoints.
DBClusterParameterGroups - The number of DB cluster parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB cluster parameter groups in the account.
DBClusterRoles - The number of associated AWS Identity and Access Management (IAM) roles per DB cluster. The used value is the highest number of associated IAM roles for a DB cluster in the account. Other DB clusters in the account might have a lower number of associated IAM roles.
DBClusters - The number of DB clusters per account. The used value is the count of DB clusters in the account.
DBInstanceRoles - The number of associated IAM roles per DB instance. The used value is the highest number of associated IAM roles for a DB instance in the account. Other DB instances in the account might have a lower number of associated IAM roles.
DBInstances - The number of DB instances per account. The used value is the count of the DB instances in the account.
Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune instances, and Amazon DocumentDB instances apply to this quota.
DBParameterGroups - The number of DB parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB parameter groups in the account.
DBSecurityGroups - The number of DB security groups (not VPC security groups) per account, excluding the default security group. The used value is the count of nondefault DB security groups in the account.
DBSubnetGroups - The number of DB subnet groups per account. The used value is the count of the DB subnet groups in the account.
EventSubscriptions - The number of event subscriptions per account. The used value is the count of the event subscriptions in the account.
ManualSnapshots - The number of manual DB snapshots per account. The used value is the count of the manual DB snapshots in the account.
OptionGroups - The number of DB option groups per account, excluding default option groups. The used value is the count of nondefault DB option groups in the account.
ReadReplicasPerMaster - The number of read replicas per DB instance. The used value is the highest number of read replicas for a DB instance in the account. Other DB instances in the account might have a lower number of read replicas.
ReservedDBInstances - The number of reserved DB instances per account. The used value is the count of the active reserved DB instances in the account.
SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. The used value is highest number of subnets for a DB subnet group in the account. Other DB subnet groups in the account might have a lower number of subnets.
For more information, see Quotas for Amazon RDS in the Amazon RDS User Guide and Quotas for Amazon Aurora in the Amazon Aurora User Guide.
", "wrapper":true }, "AccountQuotaList":{ @@ -2874,7 +2880,7 @@ }, "InitQuery":{ "shape":"String", - "documentation":" One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.
Default: no initialization query
" + "documentation":" One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.
InitQuery is not currently supported for PostgreSQL.
Default: no initialization query
" } }, "documentation":"This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
Specifies the settings that control the size and behavior of the connection pool associated with a DBProxyTargetGroup.
One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.
One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.
InitQuery is not currently supported for PostgreSQL.
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget.
The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region. Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same AWS Region.
The pre-signed URL must be a valid request for the CopyDBSClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:
KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL.
DestinationRegion - The name of the AWS Region that the DB cluster snapshot is to be created in.
SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier 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 Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.
The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region. Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same AWS Region.
The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:
KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL.
DestinationRegion - The name of the AWS Region that the DB cluster snapshot is to be created in.
SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier 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 Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
" + "documentation":"The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
" }, "Tags":{ "shape":"TagList", @@ -3220,11 +3226,11 @@ }, "KmsKeyId":{ "shape":"String", - "documentation":"The AWS KMS key identifier for an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If an encryption key isn't specified in KmsKeyId:
If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the encryption key used to encrypt the source. Otherwise, Amazon RDS will use your default encryption key.
If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will use your default encryption key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that AWS Region.
The AWS KMS key identifier for an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If an encryption key isn't specified in KmsKeyId:
If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the encryption key used to encrypt the source. Otherwise, Amazon RDS will use your default encryption key.
If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will use your default encryption key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
If you create a read replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the read replica in that AWS Region.
A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.
The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.
The pre-signed URL request must contain the following parameter values:
KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same KMS key for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL.
DestinationRegion - The name of the AWS Region that Aurora Read Replica will be created in.
ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.
A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.
The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.
The pre-signed URL request must contain the following parameter values:
KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same KMS key for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL.
DestinationRegion - The name of the AWS Region that Aurora read replica will be created in.
ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.
The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:
The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
global engine mode only applies for global database clusters created with Aurora MySQL version 5.6.10a. For higher Aurora MySQL versions, the clusters in a global database use provisioned engine mode.
Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:
The Active Directory directory ID to create the DB cluster in.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Using Kerberos Authentication for Aurora MySQL in the Amazon Aurora User Guide.
" + "documentation":"The Active Directory directory ID to create the DB cluster in.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
" }, "DomainIAMRoleName":{ "shape":"String", @@ -3402,7 +3408,7 @@ }, "BackupRetentionPeriod":{ "shape":"IntegerOptional", - "documentation":"The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster.
Default: 1
Constraints:
Must be a value from 0 to 35
Can't be set to 0 if the DB instance is a source to Read Replicas
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster.
Default: 1
Constraints:
Must be a value from 0 to 35
Can't be set to 0 if the DB instance is a source to read replicas
The port number on which the database accepts connections.
MySQL
Default: 3306
Valid Values: 1150-65535
Type: Integer
MariaDB
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
Type: Integer
" + "documentation":"The port number on which the database accepts connections.
MySQL
Default: 3306
Valid values: 1150-65535
Type: Integer
MariaDB
Default: 3306
Valid values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid values: 1150-65535
SQL Server
Default: 1433
Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156.
Amazon Aurora
Default: 3306
Valid values: 1150-65535
Type: Integer
" }, "MultiAZ":{ "shape":"BooleanOptional", @@ -3474,7 +3480,7 @@ }, "Domain":{ "shape":"String", - "documentation":"The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.
For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.
For Oracle DB instance, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
" + "documentation":"The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.
For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.
For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
" }, "CopyTagsToSnapshot":{ "shape":"BooleanOptional", @@ -3544,19 +3550,19 @@ "members":{ "DBInstanceIdentifier":{ "shape":"String", - "documentation":"The DB instance identifier of the Read Replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
" + "documentation":"The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
" }, "SourceDBInstanceIdentifier":{ "shape":"String", - "documentation":"The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas.
Constraints:
Must be the identifier of an existing MySQL, MariaDB, Oracle, or PostgreSQL DB instance.
Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6 or later.
For the limitations of Oracle Read Replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide.
Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).
The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.
If the source DB instance is in the same AWS Region as the Read Replica, specify a valid DB instance identifier.
If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to five read replicas.
Constraints:
Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance.
Can specify a DB instance that is a MySQL read replica only if the source is running MySQL 5.6 or later.
For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide.
For the limitations of SQL Server read replicas, see Read Replica Limitations with Microsoft SQL Server in the Amazon RDS User Guide.
Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).
The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.
If the source DB instance is in the same AWS Region as the read replica, specify a valid DB instance identifier.
If the source DB instance is in a different AWS Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server, which doesn't support cross-region replicas.
The compute and memory capacity of the Read Replica, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: Inherits from the source DB instance.
" + "documentation":"The compute and memory capacity of the read replica, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: Inherits from the source DB instance.
" }, "AvailabilityZone":{ "shape":"String", - "documentation":"The Availability Zone (AZ) where the Read Replica will be created.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
The Availability Zone (AZ) where the read replica will be created.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
A value that indicates whether the Read Replica is in a Multi-AZ deployment.
You can create a Read Replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your Read Replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.
" + "documentation":"A value that indicates whether the read replica is in a Multi-AZ deployment.
You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.
" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", - "documentation":"A value that indicates whether minor engine upgrades are applied automatically to the Read Replica during the maintenance window.
Default: Inherits from the source DB instance
" + "documentation":"A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window.
Default: Inherits from the source DB instance
" }, "Iops":{ "shape":"IntegerOptional", @@ -3576,11 +3582,11 @@ }, "OptionGroupName":{ "shape":"String", - "documentation":"The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.
" + "documentation":"The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.
For SQL Server, you must use the option group associated with the source instance.
The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of source DB instance for a same region Read Replica, or the default DBParameterGroup for the specified DB engine for a cross region Read Replica.
Currently, specifying a parameter group for this operation is only supported for Oracle DB instances.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of source DB instance for a same region read replica, or the default DBParameterGroup for the specified DB engine for a cross region read replica.
Currently, specifying a parameter group for this operation is only supported for Oracle DB instances.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.
Constraints:
Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region.
If supplied, must match the name of an existing DBSubnetGroup.
The specified DB subnet group must be in the same AWS Region in which the operation is running.
All Read Replicas in one AWS Region that are created from the same source DB instance must either:>
Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC.
Not specify a DB subnet group. All these Read Replicas are created outside of any VPC.
Example: mySubnetgroup
Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.
Constraints:
Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region.
If supplied, must match the name of an existing DBSubnetGroup.
The specified DB subnet group must be in the same AWS Region in which the operation is running.
All read replicas in one AWS Region that are created from the same source DB instance must either:>
Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC.
Not specify a DB subnet group. All these read replicas are created outside of any VPC.
Example: mySubnetgroup
A list of EC2 VPC security groups to associate with the Read Replica.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
" + "documentation":"A list of EC2 VPC security groups to associate with the read replica.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
" }, "StorageType":{ "shape":"String", - "documentation":"Specifies the storage type to be associated with the Read Replica.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
Specifies the storage type to be associated with the read replica.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
A value that indicates whether to copy all tags from the Read Replica to snapshots of the Read Replica. By default, tags are not copied.
" + "documentation":"A value that indicates whether to copy all tags from the read replica to snapshots of the read replica. By default, tags are not copied.
" }, "MonitoringInterval":{ "shape":"IntegerOptional", - "documentation":"The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
The AWS KMS key ID for an encrypted Read Replica. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
If you create an encrypted Read Replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. The Read Replica is encrypted with the same KMS key as the source DB instance.
If you create an encrypted Read Replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.
You can't create an encrypted Read Replica from an unencrypted DB instance.
" + "documentation":"The AWS KMS key ID for an encrypted read replica. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
If you create an encrypted read replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. The read replica is encrypted with the same KMS key as the source DB instance.
If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.
You can't create an encrypted read replica from an unencrypted DB instance.
" }, "PreSignedUrl":{ "shape":"String", - "documentation":"The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source AWS Region that contains the source DB instance.
You must specify this parameter when you create an encrypted Read Replica from another AWS Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted Read Replica in the same AWS Region.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:
DestinationRegion - The AWS Region that the encrypted Read Replica is created in. This AWS Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL.
For example, if you create an encrypted DB instance in the us-west-1 AWS Region, from a source DB instance in the us-east-2 AWS Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.
KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the Read Replica in the destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination AWS Region, and the action contained in the presigned URL.
SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 AWS Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.
The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source AWS Region that contains the source DB instance.
You must specify this parameter when you create an encrypted read replica from another AWS Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same AWS Region.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:
DestinationRegion - The AWS Region that the encrypted read replica is created in. This AWS Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL.
For example, if you create an encrypted DB instance in the us-west-1 AWS Region, from a source DB instance in the us-east-2 AWS Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.
KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the read replica in the destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination AWS Region, and the action contained in the presigned URL.
SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 AWS Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can be executed in the source AWS Region.
SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS doesn't support cross-region read replicas.
A value that indicates whether to enable Performance Insights for the Read Replica.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
" + "documentation":"A value that indicates whether to enable Performance Insights for the read replica.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
" }, "PerformanceInsightsKMSKeyId":{ "shape":"String", @@ -3653,7 +3659,7 @@ }, "Domain":{ "shape":"String", - "documentation":"The Active Directory directory ID to create the DB instance in.
For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
" + "documentation":"The Active Directory directory ID to create the DB instance in.
For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.
" }, "DomainIAMRoleName":{ "shape":"String", @@ -3722,7 +3728,7 @@ }, "EngineFamily":{ "shape":"EngineFamily", - "documentation":"The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. Currently, this value is always MYSQL. The engine family applies to both RDS MySQL and Aurora MySQL.
The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.
" }, "Auth":{ "shape":"UserAuthConfigList", @@ -4147,11 +4153,11 @@ }, "ReplicationSourceIdentifier":{ "shape":"String", - "documentation":"Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
" + "documentation":"Contains the identifier of the source DB cluster if this DB cluster is a read replica.
" }, "ReadReplicaIdentifiers":{ "shape":"ReadReplicaIdentifierList", - "documentation":"Contains one or more identifiers of the Read Replicas associated with this DB cluster.
" + "documentation":"Contains one or more identifiers of the read replicas associated with this DB cluster.
" }, "DBClusterMembers":{ "shape":"DBClusterMemberList", @@ -4219,7 +4225,7 @@ }, "EngineMode":{ "shape":"String", - "documentation":"The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
global engine mode only applies for global database clusters created with Aurora MySQL version 5.6.10a. For higher Aurora MySQL versions, the clusters in a global database use provisioned engine mode. To check if a DB cluster is part of a global database, use DescribeGlobalClusters instead of checking the EngineMode return value from DescribeDBClusters.
Indicates whether the database engine version supports Read Replicas.
" + "documentation":"Indicates whether the database engine version supports read replicas.
" }, "SupportedEngineModes":{ "shape":"EngineModeList", - "documentation":"A list of the supported DB engine modes.
" + "documentation":"A list of the supported DB engine modes.
global engine mode only applies for global database clusters created with Aurora MySQL version 5.6.10a. For higher Aurora MySQL versions, the clusters in a global database use provisioned engine mode.
Specifies the current state of this database.
" + "documentation":"Specifies the current state of this database.
For information about DB instance statuses, see DB Instance Status in the Amazon RDS User Guide.
" }, "MasterUsername":{ "shape":"String", @@ -5049,15 +5055,15 @@ }, "ReadReplicaSourceDBInstanceIdentifier":{ "shape":"String", - "documentation":"Contains the identifier of the source DB instance if this DB instance is a Read Replica.
" + "documentation":"Contains the identifier of the source DB instance if this DB instance is a read replica.
" }, "ReadReplicaDBInstanceIdentifiers":{ "shape":"ReadReplicaDBInstanceIdentifierList", - "documentation":"Contains one or more identifiers of the Read Replicas associated with this DB instance.
" + "documentation":"Contains one or more identifiers of the read replicas associated with this DB instance.
" }, "ReadReplicaDBClusterIdentifiers":{ "shape":"ReadReplicaDBClusterIdentifierList", - "documentation":"Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a Read Replica. For example, when you create an Aurora Read Replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.
Currently, each RDS DB instance can have only one Aurora Read Replica.
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not contain information about cross region Aurora read replicas.
Currently, each RDS DB instance can have only one Aurora read replica.
The status of a Read Replica. If the instance isn't a Read Replica, this is blank.
" + "documentation":"The status of a read replica. If the instance isn't a read replica, this is blank.
" }, "StorageType":{ "shape":"String", @@ -5458,7 +5464,7 @@ }, "Status":{ "shape":"String", - "documentation":"Status of the DB instance. For a StatusType of Read Replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
" + "documentation":"Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
" }, "Message":{ "shape":"String", @@ -5628,7 +5634,7 @@ }, "EngineFamily":{ "shape":"String", - "documentation":"Currently, this value is always MYSQL. The engine family applies to both RDS MySQL and Aurora MySQL.
The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.
" }, "VpcSecurityGroupIds":{ "shape":"StringList", @@ -5721,7 +5727,10 @@ "incompatible-network", "insufficient-resource-limits", "creating", - "deleting" + "deleting", + "suspended", + "suspending", + "reactivating" ] }, "DBProxyTarget":{ @@ -5750,6 +5759,10 @@ "Type":{ "shape":"TargetType", "documentation":"Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.
" + }, + "TargetHealth":{ + "shape":"TargetHealth", + "documentation":"Information about the connection health of the RDS Proxy target.
" } }, "documentation":"This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.
This data type is used as a response element in the DescribeDBProxyTargets action.
A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted. If skip is specified, no DB snapshot is created. If skip isn't specified, a DB snapshot is created before the DB instance is deleted. By default, skip isn't specified, and the DB snapshot is created.
When a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when skip is specified.
Specify skip when deleting a Read Replica.
The FinalDBSnapshotIdentifier parameter must be specified if skip isn't specified.
A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted. If skip is specified, no DB snapshot is created. If skip isn't specified, a DB snapshot is created before the DB instance is deleted. By default, skip isn't specified, and the DB snapshot is created.
When a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when skip is specified.
Specify skip when deleting a read replica.
The FinalDBSnapshotIdentifier parameter must be specified if skip isn't specified.
The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.
Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.
Constraints:
Must be 1 to 255 letters or numbers.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Can't be specified when deleting a Read Replica.
The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.
Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.
Constraints:
Must be 1 to 255 letters or numbers.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Can't be specified when deleting a read replica.
The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
" }, + "AvailabilityZoneGroup":{ + "shape":"String", + "documentation":"The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.
Omit this parameter to show the available offerings in the specified AWS Region.
" + }, "Vpc":{ "shape":"BooleanOptional", "documentation":"A value that indicates whether to show only VPC or non-VPC offerings.
" @@ -7862,7 +7879,10 @@ }, "EngineFamily":{ "type":"string", - "enum":["MYSQL"] + "enum":[ + "MYSQL", + "POSTGRESQL" + ] }, "EngineModeList":{ "type":"list", @@ -8051,7 +8071,7 @@ }, "ExportOnly":{ "shape":"StringList", - "documentation":"The data exported from the snapshot. Valid values are the following:
database - Export all the data of the snapshot.
database.table [table-name] - Export a table of the snapshot.
database.schema [schema-name] - Export a database schema of the snapshot. This value isn't valid for RDS for MySQL, RDS for MariaDB, or Aurora MySQL.
database.schema.table [table-name] - Export a table of the database schema. This value isn't valid for RDS for MySQL, RDS for MariaDB, or Aurora MySQL.
The data exported from the snapshot. Valid values are the following:
database - Export all the data from a specified database.
database.table table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
database.schema schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
Constraints:
Must be a value from 0 to 35
Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6 or later
Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
Can't be set to 0 if the DB instance is a source to Read Replicas
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
Constraints:
Must be a value from 0 to 35
Can be specified for a MySQL read replica only if the source is running MySQL 5.6 or later
Can be specified for a PostgreSQL read replica only if the source is running PostgreSQL 9.3.5
Can't be set to 0 if the DB instance is a source to read replicas
The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Default: Uses existing setting
" + "documentation":"The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Default: Uses existing setting
" }, "OptionGroupName":{ "shape":"String", @@ -9203,7 +9223,7 @@ }, "StorageType":{ "shape":"String", - "documentation":"Specifies the storage type to be associated with the DB instance.
If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.
Valid values: standard | gp2 | io1
Default: io1 if the Iops parameter is specified, otherwise gp2
Specifies the storage type to be associated with the DB instance.
If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
Valid values: standard | gp2 | io1
Default: io1 if the Iops parameter is specified, otherwise gp2
The port number on which the database accepts connections.
The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.
Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.
MySQL
Default: 3306
Valid Values: 1150-65535
MariaDB
Default: 3306
Valid Values: 1150-65535
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
The port number on which the database accepts connections.
The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.
Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.
MySQL
Default: 3306
Valid values: 1150-65535
MariaDB
Default: 3306
Valid values: 1150-65535
PostgreSQL
Default: 5432
Valid values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid values: 1150-65535
SQL Server
Default: 1433
Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156.
Amazon Aurora
Default: 3306
Valid values: 1150-65535
The license model for a DB instance.
" }, + "AvailabilityZoneGroup":{ + "shape":"String", + "documentation":"The Availability Zone group for a DB instance.
" + }, "AvailabilityZones":{ "shape":"AvailabilityZoneList", "documentation":"A list of Availability Zones for a DB instance.
" @@ -10028,7 +10052,7 @@ }, "ReadReplicaCapable":{ "shape":"Boolean", - "documentation":"Indicates whether a DB instance can have a Read Replica.
" + "documentation":"Indicates whether a DB instance can have a read replica.
" }, "Vpc":{ "shape":"Boolean", @@ -10088,11 +10112,11 @@ }, "SupportedEngineModes":{ "shape":"EngineModeList", - "documentation":"A list of the supported DB engine modes.
" + "documentation":"A list of the supported DB engine modes.
global engine mode only applies for global database clusters created with Aurora MySQL version 5.6.10a. For higher Aurora MySQL versions, the clusters in a global database use provisioned engine mode.
Whether or not Amazon RDS can automatically scale storage for DB instances that use the specified instance class.
" + "documentation":"Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
" }, "SupportsKerberosAuthentication":{ "shape":"BooleanOptional", @@ -10354,7 +10378,7 @@ "members":{ "DBClusterIdentifier":{ "shape":"String", - "documentation":"The identifier of the DB cluster Read Replica to promote. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing DBCluster Read Replica.
Example: my-cluster-replica1
The identifier of the DB cluster read replica to promote. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing DB cluster read replica.
Example: my-cluster-replica1
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing Read Replica DB instance.
Example: mydbinstance
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing read replica DB instance.
Example: mydbinstance
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
Must be a value from 0 to 35.
Can't be set to 0 if the DB instance is a source to Read Replicas.
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
Must be a value from 0 to 35.
Can't be set to 0 if the DB instance is a source to read replicas.
Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Using Kerberos Authentication for Aurora MySQL in the Amazon Aurora User Guide.
" + "documentation":"Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
" }, "DomainIAMRoleName":{ "shape":"String", @@ -11250,7 +11274,7 @@ }, "Domain":{ "shape":"String", - "documentation":"Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Using Kerberos Authentication for Aurora MySQL in the Amazon Aurora User Guide.
" + "documentation":"Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
" }, "DomainIAMRoleName":{ "shape":"String", @@ -11928,7 +11952,7 @@ }, "SourceRegions":{ "shape":"SourceRegionList", - "documentation":"A list of SourceRegion instances that contains each source AWS Region that the current AWS Region can get a Read Replica or a DB snapshot from.
" + "documentation":"A list of SourceRegion instances that contains each source AWS Region that the current AWS Region can get a read replica or a DB snapshot from.
" } }, "documentation":"Contains the result of a successful invocation of the DescribeSourceRegions action.
The data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are the following:
database - Export all the data of the snapshot.
database.table [table-name] - Export a table of the snapshot.
database.schema [schema-name] - Export a database schema of the snapshot. This value isn't valid for RDS for MySQL, RDS for MariaDB, or Aurora MySQL.
database.schema.table [table-name] - Export a table of the database schema. This value isn't valid for RDS for MySQL, RDS for MariaDB, or Aurora MySQL.
The data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are the following:
database - Export all the data from a specified database.
database.table table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
database.schema schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:
registering > unavailable > available > unavailable > available
The reason for the current health State of the RDS Proxy target.
A description of the health of the RDS Proxy target. If the State is AVAILABLE, a description is not included.
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
Information about the connection health of an RDS Proxy target.
" + }, + "TargetHealthReason":{ + "type":"string", + "enum":[ + "UNREACHABLE", + "CONNECTION_FAILED", + "AUTH_FAILURE", + "PENDING_PROXY_CAPACITY" + ] + }, "TargetList":{ "type":"list", "member":{"shape":"DBProxyTarget"} }, + "TargetState":{ + "type":"string", + "enum":[ + "REGISTERING", + "AVAILABLE", + "UNAVAILABLE" + ] + }, "TargetType":{ "type":"string", "enum":[ diff --git a/botocore/data/redshift/2012-12-01/paginators-1.json b/botocore/data/redshift/2012-12-01/paginators-1.json index 7e429aec..099f5fd7 100644 --- a/botocore/data/redshift/2012-12-01/paginators-1.json +++ b/botocore/data/redshift/2012-12-01/paginators-1.json @@ -143,6 +143,12 @@ "limit_key": "MaxRecords", "output_token": "Marker", "result_key": "ScheduledActions" + }, + "DescribeUsageLimits": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "UsageLimits" } } } diff --git a/botocore/data/redshift/2012-12-01/service-2.json b/botocore/data/redshift/2012-12-01/service-2.json index e4340a85..c916838e 100644 --- a/botocore/data/redshift/2012-12-01/service-2.json +++ b/botocore/data/redshift/2012-12-01/service-2.json @@ -389,7 +389,7 @@ {"shape":"TagLimitExceededFault"}, {"shape":"ScheduleDefinitionTypeUnsupportedFault"} ], - "documentation":"Creates a snapshot schedule with the rate of every 12 hours.
" + "documentation":"Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.
" }, "CreateTags":{ "name":"CreateTags", @@ -405,6 +405,28 @@ ], "documentation":"Adds tags to a cluster.
A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, you will receive an error and the attempt will fail.
If you specify a key that already exists for the resource, the value for that key will be updated with the new value.
" }, + "CreateUsageLimit":{ + "name":"CreateUsageLimit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateUsageLimitMessage"}, + "output":{ + "shape":"UsageLimit", + "resultWrapper":"CreateUsageLimitResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"UsageLimitAlreadyExistsFault"}, + {"shape":"InvalidUsageLimitFault"}, + {"shape":"TagLimitExceededFault"}, + {"shape":"UnsupportedOperationFault"} + ], + "documentation":"Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier.
" + }, "DeleteCluster":{ "name":"DeleteCluster", "http":{ @@ -573,6 +595,19 @@ ], "documentation":"Deletes tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.
" }, + "DeleteUsageLimit":{ + "name":"DeleteUsageLimit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUsageLimitMessage"}, + "errors":[ + {"shape":"UsageLimitNotFoundFault"}, + {"shape":"UnsupportedOperationFault"} + ], + "documentation":"Deletes a usage limit from a cluster.
" + }, "DescribeAccountAttributes":{ "name":"DescribeAccountAttributes", "http":{ @@ -1018,6 +1053,23 @@ ], "documentation":"Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.
The following are limitations for DescribeTags:
You cannot specify an ARN and a resource-type value together in the same request.
You cannot use the MaxRecords and Marker parameters together with the ARN parameter.
The MaxRecords parameter can be a range from 10 to 50 results to return in a request.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all resources that have any combination of those values are returned.
If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
" }, + "DescribeUsageLimits":{ + "name":"DescribeUsageLimits", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeUsageLimitsMessage"}, + "output":{ + "shape":"UsageLimitList", + "resultWrapper":"DescribeUsageLimitsResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"UnsupportedOperationFault"} + ], + "documentation":"Shows usage limits on a cluster. Results are filtered based on the combination of input usage limit identifier, cluster identifier, and feature type parameters:
If usage limit identifier, cluster identifier, and feature type are not provided, then all usage limit objects for the current account in the current region are returned.
If usage limit identifier is provided, then the corresponding usage limit object is returned.
If cluster identifier is provided, then all usage limit objects for the specified cluster are returned.
If cluster identifier and feature type are provided, then all usage limit objects for the combination of cluster and feature are returned.
Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.
" }, + "ModifyUsageLimit":{ + "name":"ModifyUsageLimit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyUsageLimitMessage"}, + "output":{ + "shape":"UsageLimit", + "resultWrapper":"ModifyUsageLimitResult" + }, + "errors":[ + {"shape":"InvalidUsageLimitFault"}, + {"shape":"UsageLimitNotFoundFault"}, + {"shape":"UnsupportedOperationFault"} + ], + "documentation":"Modifies a usage limit in a cluster. You can't modify the feature type or period of a usage limit.
" + }, "PauseCluster":{ "name":"PauseCluster", "http":{ @@ -1468,7 +1538,7 @@ {"shape":"UnauthorizedOperation"}, {"shape":"LimitExceededFault"} ], - "documentation":"Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method.
Elastic resize operations have the following restrictions:
You can only resize clusters of the following types:
dc2.large
dc2.8xlarge
ds2.xlarge
ds2.8xlarge
ra3.16xlarge
The type of nodes that you add must match the node type for the cluster.
Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method.
Elastic resize operations have the following restrictions:
You can only resize clusters of the following types:
dc2.large
dc2.8xlarge
ds2.xlarge
ds2.8xlarge
ra3.4xlarge
ra3.16xlarge
The type of nodes that you add must match the node type for the cluster.
The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.16xlarge
The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge
Contains the output from the CreateTags action.
The identifier of the cluster that you want to limit usage.
" + }, + "FeatureType":{ + "shape":"UsageLimitFeatureType", + "documentation":"The Amazon Redshift feature that you want to limit.
" + }, + "LimitType":{ + "shape":"UsageLimitLimitType", + "documentation":"The type of limit. Depending on the feature type, this can be based on a time duration or data size. If FeatureType is spectrum, then LimitType must be data-scanned. If FeatureType is concurrency-scaling, then LimitType must be time.
The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB). The value must be a positive number.
" + }, + "Period":{ + "shape":"UsageLimitPeriod", + "documentation":"The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
The action that Amazon Redshift takes when the limit is reached. The default is log. For more information about this parameter, see UsageLimit.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"A list of tag instances.
" + } + } + }, "CustomerStorageMessage":{ "type":"structure", "members":{ @@ -3604,6 +3713,16 @@ }, "documentation":"Contains the output from the DeleteTags action.
The identifier of the usage limit to delete.
" + } + } + }, "DependentServiceRequestThrottlingFault":{ "type":"structure", "members":{ @@ -4293,6 +4412,39 @@ }, "documentation":"" }, + "DescribeUsageLimitsMessage":{ + "type":"structure", + "members":{ + "UsageLimitId":{ + "shape":"String", + "documentation":"The identifier of the usage limit to describe.
" + }, + "ClusterIdentifier":{ + "shape":"String", + "documentation":"The identifier of the cluster for which you want to describe usage limits.
" + }, + "FeatureType":{ + "shape":"UsageLimitFeatureType", + "documentation":"The feature type for which you want to describe usage limits.
" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
" + }, + "Marker":{ + "shape":"String", + "documentation":"An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeUsageLimits request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
A tag key or keys for which you want to return all matching usage limit objects that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the usage limit objects have either or both of these tag keys associated with them.
A tag value or values for which you want to return all matching usage limit objects that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the usage limit objects that have either or both of these tag values associated with them.
The usage limit is not valid.
", + "error":{ + "code":"InvalidUsageLimit", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, "InvalidVPCNetworkStateFault":{ "type":"structure", "members":{ @@ -5446,7 +5610,7 @@ }, "NodeType":{ "shape":"String", - "documentation":"The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.
For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.16xlarge
The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.
For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge
The identifier of the usage limit to modify.
" + }, + "Amount":{ + "shape":"LongOptional", + "documentation":"The new limit amount. For more information about this parameter, see UsageLimit.
" + }, + "BreachAction":{ + "shape":"UsageLimitBreachAction", + "documentation":"The new action that Amazon Redshift takes when the limit is reached. For more information about this parameter, see UsageLimit.
" + } + } + }, "NodeConfigurationOption":{ "type":"structure", "members":{ @@ -6557,7 +6739,7 @@ }, "NodeType":{ "shape":"String", - "documentation":"The node type that the restored cluster will be provisioned with.
Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds1.xlarge into ds2.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type or dc2.large instance type. You can't restore dc1.8xlarge to dc2.8xlarge. First restore to a dc1.8xlareg cluster, then resize to a dc2.8large cluster. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide.
" + "documentation":"The node type that the restored cluster will be provisioned with.
Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds1.xlarge into ds2.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type or dc2.large instance type. You can't restore dc1.8xlarge to dc2.8xlarge. First restore to a dc1.8xlarge cluster, then resize to a dc2.8large cluster. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide.
" }, "EnhancedVpcRouting":{ "shape":"BooleanOptional", @@ -7931,6 +8113,115 @@ }, "documentation":"A maintenance track that you can switch the current track to.
" }, + "UsageLimit":{ + "type":"structure", + "members":{ + "UsageLimitId":{ + "shape":"String", + "documentation":"The identifier of the usage limit.
" + }, + "ClusterIdentifier":{ + "shape":"String", + "documentation":"The identifier of the cluster with a usage limit.
" + }, + "FeatureType":{ + "shape":"UsageLimitFeatureType", + "documentation":"The Amazon Redshift feature to which the limit applies.
" + }, + "LimitType":{ + "shape":"UsageLimitLimitType", + "documentation":"The type of limit. Depending on the feature type, this can be based on a time duration or data size.
" + }, + "Amount":{ + "shape":"Long", + "documentation":"The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).
" + }, + "Period":{ + "shape":"UsageLimitPeriod", + "documentation":"The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
The action that Amazon Redshift takes when the limit is reached. Possible values are:
log - To log an event in a system table. The default is log.
emit-metric - To emit CloudWatch metrics.
disable - To disable the feature until the next usage period begins.
A list of tag instances.
" + } + }, + "documentation":"Describes a usage limit object for a cluster.
" + }, + "UsageLimitAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"The usage limit already exists.
", + "error":{ + "code":"UsageLimitAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "UsageLimitBreachAction":{ + "type":"string", + "enum":[ + "log", + "emit-metric", + "disable" + ] + }, + "UsageLimitFeatureType":{ + "type":"string", + "enum":[ + "spectrum", + "concurrency-scaling" + ] + }, + "UsageLimitLimitType":{ + "type":"string", + "enum":[ + "time", + "data-scanned" + ] + }, + "UsageLimitList":{ + "type":"structure", + "members":{ + "UsageLimits":{ + "shape":"UsageLimits", + "documentation":"Contains the output from the DescribeUsageLimits action.
" + }, + "Marker":{ + "shape":"String", + "documentation":"A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
The usage limit identifier can't be found.
", + "error":{ + "code":"UsageLimitNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "UsageLimitPeriod":{ + "type":"string", + "enum":[ + "daily", + "weekly", + "monthly" + ] + }, + "UsageLimits":{ + "type":"list", + "member":{"shape":"UsageLimit"} + }, "ValueStringList":{ "type":"list", "member":{ diff --git a/botocore/data/rekognition/2016-06-27/examples-1.json b/botocore/data/rekognition/2016-06-27/examples-1.json index 20b03280..039e04d6 100644 --- a/botocore/data/rekognition/2016-06-27/examples-1.json +++ b/botocore/data/rekognition/2016-06-27/examples-1.json @@ -139,27 +139,27 @@ "Confidence": 100, "Landmarks": [ { - "Type": "EYE_LEFT", + "Type": "eyeLeft", "X": 0.6394737362861633, "Y": 0.40819624066352844 }, { - "Type": "EYE_RIGHT", + "Type": "eyeRight", "X": 0.7266660928726196, "Y": 0.41039225459098816 }, { - "Type": "NOSE_LEFT", + "Type": "eyeRight", "X": 0.6912462115287781, "Y": 0.44240960478782654 }, { - "Type": "MOUTH_DOWN", + "Type": "mouthDown", "X": 0.6306198239326477, "Y": 0.46700039505958557 }, { - "Type": "MOUTH_UP", + "Type": "mouthUp", "X": 0.7215608954429626, "Y": 0.47114261984825134 } @@ -262,27 +262,27 @@ "Confidence": 99.9991226196289, "Landmarks": [ { - "Type": "EYE_LEFT", + "Type": "eyeLeft", "X": 0.3976764678955078, "Y": 0.6248345971107483 }, { - "Type": "EYE_RIGHT", + "Type": "eyeRight", "X": 0.4810936450958252, "Y": 0.6317117214202881 }, { - "Type": "NOSE_LEFT", + "Type": "noseLeft", "X": 0.41986238956451416, "Y": 0.7111940383911133 }, { - "Type": "MOUTH_DOWN", + "Type": "mouthDown", "X": 0.40525302290916443, "Y": 0.7497701048851013 }, { - "Type": "MOUTH_UP", + "Type": "mouthUp", "X": 0.4753248989582062, "Y": 0.7558549642562866 } @@ -320,27 +320,27 @@ "Confidence": 99.99950408935547, "Landmarks": [ { - "Type": "EYE_LEFT", + "Type": "eyeLeft", "X": 0.6006892323493958, "Y": 0.290842205286026 }, { - "Type": "EYE_RIGHT", + "Type": "eyeRight", "X": 0.6808141469955444, "Y": 0.29609042406082153 }, { - "Type": "NOSE_LEFT", + "Type": "noseLeft", "X": 0.6395332217216492, "Y": 0.3522595763206482 }, { - "Type": "MOUTH_DOWN", + "Type": "mouthDown", "X": 0.5892083048820496, "Y": 0.38689887523651123 }, { - "Type": "MOUTH_UP", + "Type": "mouthUp", "X": 0.674560010433197, "Y": 0.394125759601593 } diff --git a/botocore/data/rekognition/2016-06-27/service-2.json b/botocore/data/rekognition/2016-06-27/service-2.json index 448a9a44..0ed7861c 100644 --- a/botocore/data/rekognition/2016-06-27/service-2.json +++ b/botocore/data/rekognition/2016-06-27/service-2.json @@ -144,6 +144,44 @@ ], "documentation":"Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection.
This operation requires permissions to perform the rekognition:DeleteFaces action.
Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all versions of the model associated with the project. To delete a version of a model, see DeleteProjectVersion.
This operation requires permissions to perform the rekognition:DeleteProject action.
Deletes a version of a model.
You must first stop the model before you can delete it. To check if a model is running, use the Status field returned from DescribeProjectVersions. To stop a running model call StopProjectVersion.
This operation requires permissions to perform the rekognition:DeleteProjectVersion action.
The Amazon Resource Name (ARN) of the project that you want to delete.
" + } + } + }, + "DeleteProjectResponse":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"ProjectStatus", + "documentation":"The current status of the delete project operation.
" + } + } + }, + "DeleteProjectVersionRequest":{ + "type":"structure", + "required":["ProjectVersionArn"], + "members":{ + "ProjectVersionArn":{ + "shape":"ProjectVersionArn", + "documentation":"The Amazon Resource Name (ARN) of the model version that you want to delete.
" + } + } + }, + "DeleteProjectVersionResponse":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"ProjectVersionStatus", + "documentation":"The status of the deletion operation.
" + } + } + }, "DeleteStreamProcessorRequest":{ "type":"structure", "required":["Name"], diff --git a/botocore/data/resource-groups/2017-11-27/examples-1.json b/botocore/data/resource-groups/2017-11-27/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/resource-groups/2017-11-27/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/resourcegroupstaggingapi/2017-01-26/examples-1.json b/botocore/data/resourcegroupstaggingapi/2017-01-26/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/resourcegroupstaggingapi/2017-01-26/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/robomaker/2018-06-29/service-2.json b/botocore/data/robomaker/2018-06-29/service-2.json index bde7e0e5..0bac97f4 100644 --- a/botocore/data/robomaker/2018-06-29/service-2.json +++ b/botocore/data/robomaker/2018-06-29/service-2.json @@ -783,6 +783,26 @@ "min":1, "pattern":"[a-zA-Z0-9_.\\-]*" }, + "Compute":{ + "type":"structure", + "members":{ + "simulationUnitLimit":{ + "shape":"SimulationUnit", + "documentation":"The simulation unit limit. Your simulation is allocated CPU and memory proportional to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are only billed for the SU utilization you consume up to the maximim value provided.
" + } + }, + "documentation":"Compute information for the simulation job.
" + }, + "ComputeResponse":{ + "type":"structure", + "members":{ + "simulationUnitLimit":{ + "shape":"SimulationUnit", + "documentation":"The simulation unit limit. Your simulation is allocated CPU and memory proportional to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are only billed for the SU utilization you consume up to the maximim value provided.
" + } + }, + "documentation":"Compute information for the simulation job
" + }, "ConcurrentDeploymentException":{ "type":"structure", "members":{ @@ -1250,6 +1270,10 @@ "vpcConfig":{ "shape":"VPCConfig", "documentation":"If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.
" + }, + "compute":{ + "shape":"Compute", + "documentation":"Compute information for the simulation job.
" } } }, @@ -1328,6 +1352,10 @@ "vpcConfig":{ "shape":"VPCConfigResponse", "documentation":"Information about the vpc configuration.
" + }, + "compute":{ + "shape":"ComputeResponse", + "documentation":"Compute information for the simulation job.
" } } }, @@ -2075,6 +2103,10 @@ "networkInterface":{ "shape":"NetworkInterface", "documentation":"The network interface information for the simulation job.
" + }, + "compute":{ + "shape":"ComputeResponse", + "documentation":"Compute information for the simulation job.
" } } }, @@ -3191,6 +3223,10 @@ "networkInterface":{ "shape":"NetworkInterface", "documentation":"Information about a network interface.
" + }, + "compute":{ + "shape":"ComputeResponse", + "documentation":"Compute information for the simulation job
" } }, "documentation":"Information about a simulation job.
" @@ -3318,6 +3354,10 @@ "documentation":"Specify data sources to mount read-only files from S3 into your simulation. These files are available under /opt/robomaker/datasources/data_source_name.
There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.
Compute information for the simulation job
" + }, "tags":{ "shape":"TagMap", "documentation":"A map that contains tag keys and tag values that are attached to the simulation job request.
" @@ -3412,6 +3452,11 @@ "pattern":"7|9|Kinetic|Melodic|Dashing" }, "SimulationTimeMillis":{"type":"long"}, + "SimulationUnit":{ + "type":"integer", + "max":15, + "min":1 + }, "Source":{ "type":"structure", "members":{ diff --git a/botocore/data/route53/2013-04-01/examples-1.json b/botocore/data/route53/2013-04-01/examples-1.json index 0ea7e3b0..d757c2b9 100644 --- a/botocore/data/route53/2013-04-01/examples-1.json +++ b/botocore/data/route53/2013-04-01/examples-1.json @@ -1,5 +1,762 @@ { "version": "1.0", "examples": { + "AssociateVPCWithHostedZone": [ + { + "input": { + "Comment": "", + "HostedZoneId": "Z3M3LMPEXAMPLE", + "VPC": { + "VPCId": "vpc-1a2b3c4d", + "VPCRegion": "us-east-2" + } + }, + "output": { + "ChangeInfo": { + "Comment": "", + "Id": "/change/C3HC6WDB2UANE2", + "Status": "INSYNC", + "SubmittedAt": "2017-01-31T01:36:41.958Z" + } + }, + "comments": { + "input": { + }, + "output": { + "Status": "Valid values are PENDING and INSYNC.", + "SubmittedAt": "The date and time are in Coordinated Universal Time (UTC) and ISO 8601 format." + } + }, + "description": "The following example associates the VPC with ID vpc-1a2b3c4d with the hosted zone with ID Z3M3LMPEXAMPLE.", + "id": "to-associate-a-vpc-with-a-hosted-zone-1484069228699", + "title": "To associate a VPC with a hosted zone" + } + ], + "ChangeResourceRecordSets": [ + { + "input": { + "ChangeBatch": { + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "Name": "example.com", + "ResourceRecords": [ + { + "Value": "192.0.2.44" + } + ], + "TTL": 60, + "Type": "A" + } + } + ], + "Comment": "Web server for example.com" + }, + "HostedZoneId": "Z3M3LMPEXAMPLE" + }, + "output": { + "ChangeInfo": { + "Comment": "Web server for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + }, + "comments": { + "input": { + "Action": "Valid values: CREATE, DELETE, UPSERT", + "TTL": "The amount of time in seconds that you want DNS resolvers to cache the values in this resource record set before submitting another request to Route 53", + "Value": "The value that is applicable to the value of Type. For example, if Type is A, Value is an IPv4 address" + }, + "output": { + "SubmittedAt": "The date and time are in Coordinated Universal Time (UTC) and ISO 8601 format." + } + }, + "description": "The following example creates a resource record set that routes Internet traffic to a resource with an IP address of 192.0.2.44.", + "id": "to-create-update-or-delete-resource-record-sets-1484344703668", + "title": "To create a basic resource record set" + }, + { + "input": { + "ChangeBatch": { + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "HealthCheckId": "abcdef11-2222-3333-4444-555555fedcba", + "Name": "example.com", + "ResourceRecords": [ + { + "Value": "192.0.2.44" + } + ], + "SetIdentifier": "Seattle data center", + "TTL": 60, + "Type": "A", + "Weight": 100 + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "HealthCheckId": "abcdef66-7777-8888-9999-000000fedcba", + "Name": "example.com", + "ResourceRecords": [ + { + "Value": "192.0.2.45" + } + ], + "SetIdentifier": "Portland data center", + "TTL": 60, + "Type": "A", + "Weight": 200 + } + } + ], + "Comment": "Web servers for example.com" + }, + "HostedZoneId": "Z3M3LMPEXAMPLE" + }, + "output": { + "ChangeInfo": { + "Comment": "Web servers for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + }, + "comments": { + "input": { + "Action": "Valid values: CREATE, DELETE, UPSERT", + "TTL": "The amount of time in seconds that you want DNS resolvers to cache the values in this resource record set before submitting another request to Route 53. TTLs must be the same for all weighted resource record sets that have the same name and type.", + "Value": "The value that is applicable to the value of Type. For example, if Type is A, Value is an IPv4 address" + }, + "output": { + "SubmittedAt": "The date and time are in Coordinated Universal Time (UTC) and ISO 8601 format." + } + }, + "description": "The following example creates two weighted resource record sets. The resource with a Weight of 100 will get 1/3rd of traffic (100/100+200), and the other resource will get the rest of the traffic for example.com.", + "id": "to-create-weighted-resource-record-sets-1484348208522", + "title": "To create weighted resource record sets" + }, + { + "input": { + "ChangeBatch": { + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "AliasTarget": { + "DNSName": "d123rk29d0stfj.cloudfront.net", + "EvaluateTargetHealth": false, + "HostedZoneId": "Z2FDTNDATAQYW2" + }, + "Name": "example.com", + "Type": "A" + } + } + ], + "Comment": "CloudFront distribution for example.com" + }, + "HostedZoneId": "Z3M3LMPEXAMPLE" + }, + "output": { + "ChangeInfo": { + "Comment": "CloudFront distribution for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + }, + "comments": { + "input": { + "Action": "Valid values: CREATE, DELETE, UPSERT", + "DNSName": "The DNS name assigned to the resource", + "HostedZoneId": "Depends on the type of resource that you want to route traffic to", + "Type": "A or AAAA, depending on the type of resource that you want to route traffic to" + }, + "output": { + "SubmittedAt": "The date and time are in Coordinated Universal Time (UTC) and ISO 8601 format." + } + }, + "description": "The following example creates an alias resource record set that routes traffic to a CloudFront distribution.", + "id": "to-create-an-alias-resource-record-set-1484348404062", + "title": "To create an alias resource record set" + }, + { + "input": { + "ChangeBatch": { + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "AliasTarget": { + "DNSName": "example-com-123456789.us-east-2.elb.amazonaws.com ", + "EvaluateTargetHealth": true, + "HostedZoneId": "Z3AADJGX6KTTL2" + }, + "Name": "example.com", + "SetIdentifier": "Ohio region", + "Type": "A", + "Weight": 100 + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "AliasTarget": { + "DNSName": "example-com-987654321.us-west-2.elb.amazonaws.com ", + "EvaluateTargetHealth": true, + "HostedZoneId": "Z1H1FL5HABSF5" + }, + "Name": "example.com", + "SetIdentifier": "Oregon region", + "Type": "A", + "Weight": 200 + } + } + ], + "Comment": "ELB load balancers for example.com" + }, + "HostedZoneId": "Z3M3LMPEXAMPLE" + }, + "output": { + "ChangeInfo": { + "Comment": "ELB load balancers for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + }, + "comments": { + "input": { + "Action": "Valid values: CREATE, DELETE, UPSERT", + "DNSName": "The DNS name assigned to the resource", + "HostedZoneId": "Depends on the type of resource that you want to route traffic to", + "Type": "A or AAAA, depending on the type of resource that you want to route traffic to" + }, + "output": { + "SubmittedAt": "The date and time are in Coordinated Universal Time (UTC) and ISO 8601 format." + } + }, + "description": "The following example creates two weighted alias resource record sets that route traffic to ELB load balancers. The resource with a Weight of 100 will get 1/3rd of traffic (100/100+200), and the other resource will get the rest of the traffic for example.com.", + "id": "to-create-weighted-alias-resource-record-sets-1484349467416", + "title": "To create weighted alias resource record sets" + }, + { + "input": { + "ChangeBatch": { + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "HealthCheckId": "abcdef11-2222-3333-4444-555555fedcba", + "Name": "example.com", + "Region": "us-east-2", + "ResourceRecords": [ + { + "Value": "192.0.2.44" + } + ], + "SetIdentifier": "Ohio region", + "TTL": 60, + "Type": "A" + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "HealthCheckId": "abcdef66-7777-8888-9999-000000fedcba", + "Name": "example.com", + "Region": "us-west-2", + "ResourceRecords": [ + { + "Value": "192.0.2.45" + } + ], + "SetIdentifier": "Oregon region", + "TTL": 60, + "Type": "A" + } + } + ], + "Comment": "EC2 instances for example.com" + }, + "HostedZoneId": "Z3M3LMPEXAMPLE" + }, + "output": { + "ChangeInfo": { + "Comment": "EC2 instances for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + }, + "comments": { + "input": { + "Action": "Valid values: CREATE, DELETE, UPSERT", + "TTL": "The amount of time in seconds that you want DNS resolvers to cache the values in this resource record set before submitting another request to Route 53", + "Value": "The value that is applicable to the value of Type. For example, if Type is A, Value is an IPv4 address" + }, + "output": { + "SubmittedAt": "The date and time are in Coordinated Universal Time (UTC) and ISO 8601 format." + } + }, + "description": "The following example creates two latency resource record sets that route traffic to EC2 instances. Traffic for example.com is routed either to the Ohio region or the Oregon region, depending on the latency between the user and those regions.", + "id": "to-create-latency-resource-record-sets-1484350219917", + "title": "To create latency resource record sets" + }, + { + "input": { + "ChangeBatch": { + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "AliasTarget": { + "DNSName": "example-com-123456789.us-east-2.elb.amazonaws.com ", + "EvaluateTargetHealth": true, + "HostedZoneId": "Z3AADJGX6KTTL2" + }, + "Name": "example.com", + "Region": "us-east-2", + "SetIdentifier": "Ohio region", + "Type": "A" + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "AliasTarget": { + "DNSName": "example-com-987654321.us-west-2.elb.amazonaws.com ", + "EvaluateTargetHealth": true, + "HostedZoneId": "Z1H1FL5HABSF5" + }, + "Name": "example.com", + "Region": "us-west-2", + "SetIdentifier": "Oregon region", + "Type": "A" + } + } + ], + "Comment": "ELB load balancers for example.com" + }, + "HostedZoneId": "Z3M3LMPEXAMPLE" + }, + "output": { + "ChangeInfo": { + "Comment": "ELB load balancers for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + }, + "comments": { + "input": { + "Action": "Valid values: CREATE, DELETE, UPSERT", + "DNSName": "The DNS name assigned to the resource", + "HostedZoneId": "Depends on the type of resource that you want to route traffic to", + "Type": "A or AAAA, depending on the type of resource that you want to route traffic to" + }, + "output": { + "SubmittedAt": "The date and time are in Coordinated Universal Time (UTC) and ISO 8601 format." + } + }, + "description": "The following example creates two latency alias resource record sets that route traffic for example.com to ELB load balancers. Requests are routed either to the Ohio region or the Oregon region, depending on the latency between the user and those regions.", + "id": "to-create-latency-alias-resource-record-sets-1484601774179", + "title": "To create latency alias resource record sets" + }, + { + "input": { + "ChangeBatch": { + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "Failover": "PRIMARY", + "HealthCheckId": "abcdef11-2222-3333-4444-555555fedcba", + "Name": "example.com", + "ResourceRecords": [ + { + "Value": "192.0.2.44" + } + ], + "SetIdentifier": "Ohio region", + "TTL": 60, + "Type": "A" + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "Failover": "SECONDARY", + "HealthCheckId": "abcdef66-7777-8888-9999-000000fedcba", + "Name": "example.com", + "ResourceRecords": [ + { + "Value": "192.0.2.45" + } + ], + "SetIdentifier": "Oregon region", + "TTL": 60, + "Type": "A" + } + } + ], + "Comment": "Failover configuration for example.com" + }, + "HostedZoneId": "Z3M3LMPEXAMPLE" + }, + "output": { + "ChangeInfo": { + "Comment": "Failover configuration for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + }, + "comments": { + "input": { + "Action": "Valid values: CREATE, DELETE, UPSERT", + "TTL": "The amount of time in seconds that you want DNS resolvers to cache the values in this resource record set before submitting another request to Route 53", + "Value": "The value that is applicable to the value of Type. For example, if Type is A, Value is an IPv4 address" + }, + "output": { + "SubmittedAt": "The date and time are in Coordinated Universal Time (UTC) and ISO 8601 format." + } + }, + "description": "The following example creates primary and secondary failover resource record sets that route traffic to EC2 instances. Traffic is generally routed to the primary resource, in the Ohio region. If that resource is unavailable, traffic is routed to the secondary resource, in the Oregon region.", + "id": "to-create-failover-resource-record-sets-1484604541740", + "title": "To create failover resource record sets" + }, + { + "input": { + "ChangeBatch": { + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "AliasTarget": { + "DNSName": "example-com-123456789.us-east-2.elb.amazonaws.com ", + "EvaluateTargetHealth": true, + "HostedZoneId": "Z3AADJGX6KTTL2" + }, + "Failover": "PRIMARY", + "Name": "example.com", + "SetIdentifier": "Ohio region", + "Type": "A" + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "AliasTarget": { + "DNSName": "example-com-987654321.us-west-2.elb.amazonaws.com ", + "EvaluateTargetHealth": true, + "HostedZoneId": "Z1H1FL5HABSF5" + }, + "Failover": "SECONDARY", + "Name": "example.com", + "SetIdentifier": "Oregon region", + "Type": "A" + } + } + ], + "Comment": "Failover alias configuration for example.com" + }, + "HostedZoneId": "Z3M3LMPEXAMPLE" + }, + "output": { + "ChangeInfo": { + "Comment": "Failover alias configuration for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + }, + "comments": { + "input": { + "Action": "Valid values: CREATE, DELETE, UPSERT", + "DNSName": "The DNS name assigned to the resource", + "HostedZoneId": "Depends on the type of resource that you want to route traffic to", + "Type": "A or AAAA, depending on the type of resource that you want to route traffic to" + }, + "output": { + "SubmittedAt": "The date and time are in Coordinated Universal Time (UTC) and ISO 8601 format." + } + }, + "description": "The following example creates primary and secondary failover alias resource record sets that route traffic to ELB load balancers. Traffic is generally routed to the primary resource, in the Ohio region. If that resource is unavailable, traffic is routed to the secondary resource, in the Oregon region.", + "id": "to-create-failover-alias-resource-record-sets-1484607497724", + "title": "To create failover alias resource record sets" + }, + { + "input": { + "ChangeBatch": { + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "GeoLocation": { + "ContinentCode": "NA" + }, + "Name": "example.com", + "ResourceRecords": [ + { + "Value": "192.0.2.44" + } + ], + "SetIdentifier": "North America", + "TTL": 60, + "Type": "A" + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "GeoLocation": { + "ContinentCode": "SA" + }, + "Name": "example.com", + "ResourceRecords": [ + { + "Value": "192.0.2.45" + } + ], + "SetIdentifier": "South America", + "TTL": 60, + "Type": "A" + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "GeoLocation": { + "ContinentCode": "EU" + }, + "Name": "example.com", + "ResourceRecords": [ + { + "Value": "192.0.2.46" + } + ], + "SetIdentifier": "Europe", + "TTL": 60, + "Type": "A" + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "GeoLocation": { + "CountryCode": "*" + }, + "Name": "example.com", + "ResourceRecords": [ + { + "Value": "192.0.2.47" + } + ], + "SetIdentifier": "Other locations", + "TTL": 60, + "Type": "A" + } + } + ], + "Comment": "Geolocation configuration for example.com" + }, + "HostedZoneId": "Z3M3LMPEXAMPLE" + }, + "output": { + "ChangeInfo": { + "Comment": "Geolocation configuration for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + }, + "comments": { + "input": { + "Action": "Valid values: CREATE, DELETE, UPSERT", + "TTL": "The amount of time in seconds that you want DNS resolvers to cache the values in this resource record set before submitting another request to Route 53", + "Value": "The value that is applicable to the value of Type. For example, if Type is A, Value is an IPv4 address" + }, + "output": { + "SubmittedAt": "The date and time are in Coordinated Universal Time (UTC) and ISO 8601 format." + } + }, + "description": "The following example creates four geolocation resource record sets that use IPv4 addresses to route traffic to resources such as web servers running on EC2 instances. Traffic is routed to one of four IP addresses, for North America (NA), for South America (SA), for Europe (EU), and for all other locations (*).", + "id": "to-create-geolocation-resource-record-sets-1484612462466", + "title": "To create geolocation resource record sets" + }, + { + "input": { + "ChangeBatch": { + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "AliasTarget": { + "DNSName": "example-com-123456789.us-east-2.elb.amazonaws.com ", + "EvaluateTargetHealth": true, + "HostedZoneId": "Z3AADJGX6KTTL2" + }, + "GeoLocation": { + "ContinentCode": "NA" + }, + "Name": "example.com", + "SetIdentifier": "North America", + "Type": "A" + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "AliasTarget": { + "DNSName": "example-com-234567890.sa-east-1.elb.amazonaws.com ", + "EvaluateTargetHealth": true, + "HostedZoneId": "Z2P70J7HTTTPLU" + }, + "GeoLocation": { + "ContinentCode": "SA" + }, + "Name": "example.com", + "SetIdentifier": "South America", + "Type": "A" + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "AliasTarget": { + "DNSName": "example-com-234567890.eu-central-1.elb.amazonaws.com ", + "EvaluateTargetHealth": true, + "HostedZoneId": "Z215JYRZR1TBD5" + }, + "GeoLocation": { + "ContinentCode": "EU" + }, + "Name": "example.com", + "SetIdentifier": "Europe", + "Type": "A" + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "AliasTarget": { + "DNSName": "example-com-234567890.ap-southeast-1.elb.amazonaws.com ", + "EvaluateTargetHealth": true, + "HostedZoneId": "Z1LMS91P8CMLE5" + }, + "GeoLocation": { + "CountryCode": "*" + }, + "Name": "example.com", + "SetIdentifier": "Other locations", + "Type": "A" + } + } + ], + "Comment": "Geolocation alias configuration for example.com" + }, + "HostedZoneId": "Z3M3LMPEXAMPLE" + }, + "output": { + "ChangeInfo": { + "Comment": "Geolocation alias configuration for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + }, + "comments": { + "input": { + "Action": "Valid values: CREATE, DELETE, UPSERT", + "DNSName": "The DNS name assigned to the resource", + "HostedZoneId": "Depends on the type of resource that you want to route traffic to", + "Type": "A or AAAA, depending on the type of resource that you want to route traffic to" + }, + "output": { + "SubmittedAt": "The date and time are in Coordinated Universal Time (UTC) and ISO 8601 format." + } + }, + "description": "The following example creates four geolocation alias resource record sets that route traffic to ELB load balancers. Traffic is routed to one of four IP addresses, for North America (NA), for South America (SA), for Europe (EU), and for all other locations (*).", + "id": "to-create-geolocation-alias-resource-record-sets-1484612871203", + "title": "To create geolocation alias resource record sets" + } + ], + "ChangeTagsForResource": [ + { + "input": { + "AddTags": [ + { + "Key": "apex", + "Value": "3874" + }, + { + "Key": "acme", + "Value": "4938" + } + ], + "RemoveTagKeys": [ + "Nadir" + ], + "ResourceId": "Z3M3LMPEXAMPLE", + "ResourceType": "hostedzone" + }, + "output": { + }, + "comments": { + "input": { + "ResourceType": "Valid values are healthcheck and hostedzone." + }, + "output": { + } + }, + "description": "The following example adds two tags and removes one tag from the hosted zone with ID Z3M3LMPEXAMPLE.", + "id": "to-add-or-remove-tags-from-a-hosted-zone-or-health-check-1484084752409", + "title": "To add or remove tags from a hosted zone or health check" + } + ], + "GetHostedZone": [ + { + "input": { + "Id": "Z3M3LMPEXAMPLE" + }, + "output": { + "DelegationSet": { + "NameServers": [ + "ns-2048.awsdns-64.com", + "ns-2049.awsdns-65.net", + "ns-2050.awsdns-66.org", + "ns-2051.awsdns-67.co.uk" + ] + }, + "HostedZone": { + "CallerReference": "C741617D-04E4-F8DE-B9D7-0D150FC61C2E", + "Config": { + "PrivateZone": false + }, + "Id": "/hostedzone/Z3M3LMPEXAMPLE", + "Name": "myawsbucket.com.", + "ResourceRecordSetCount": 8 + } + }, + "comments": { + "input": { + }, + "output": { + "Id": "The ID of the hosted zone that you specified in the GetHostedZone request.", + "Name": "The name of the hosted zone.", + "NameServers": "The servers that you specify in your domain configuration.", + "PrivateZone": "True if this is a private hosted zone, false if it's a public hosted zone." + } + }, + "description": "The following example gets information about the Z3M3LMPEXAMPLE hosted zone.", + "id": "to-get-information-about-a-hosted-zone-1481752361124", + "title": "To get information about a hosted zone" + } + ] } } diff --git a/botocore/data/route53/2013-04-01/service-2.json b/botocore/data/route53/2013-04-01/service-2.json index 5feb69ec..f3990786 100644 --- a/botocore/data/route53/2013-04-01/service-2.json +++ b/botocore/data/route53/2013-04-01/service-2.json @@ -33,7 +33,7 @@ {"shape":"ConflictingDomainExists"}, {"shape":"LimitsExceeded"} ], - "documentation":"Associates an Amazon VPC with a private hosted zone.
To perform the association, the VPC and the private hosted zone must already exist. You can't convert a public hosted zone into a private hosted zone.
If you want to associate a VPC that was created by using one AWS account with a private hosted zone that was created by using a different account, the AWS account that created the private hosted zone must first submit a CreateVPCAssociationAuthorization request. Then the account that created the VPC must submit an AssociateVPCWithHostedZone request.
Associates an Amazon VPC with a private hosted zone.
To perform the association, the VPC and the private hosted zone must already exist. Also, you can't convert a public hosted zone into a private hosted zone.
If you want to associate a VPC that was created by one AWS account with a private hosted zone that was created by a different account, do one of the following:
Use the AWS account that created the private hosted zone to submit a CreateVPCAssociationAuthorization request. Then use the account that created the VPC to submit an AssociateVPCWithHostedZone request.
If a subnet in the VPC was shared with another account, you can use the account that the subnet was shared with to submit an AssociateVPCWithHostedZone request. For more information about sharing subnets, see Working with Shared VPCs.
Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use ChangeResourceRecordSets to create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44.
Change Batches and Transactional Changes
The request body must include a document with a ChangeResourceRecordSetsRequest element. The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes. When using the Amazon Route 53 API to change resource record sets, Route 53 either makes all or none of the changes in a change batch request. This ensures that Route 53 never partially implements the intended changes to the resource record sets in a hosted zone.
For example, a change batch request that deletes the CNAME record for www.example.com and creates an alias resource record set for www.example.com. Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If either the DELETE or the CREATE action fails, then both changes (plus any other changes in the batch) fail, and the original CNAME record continues to exist.
Due to the nature of transactional changes, you can't delete the same resource record set more than once in a single change batch. If you attempt to delete the same change batch more than once, Route 53 returns an InvalidChangeBatch error.
Traffic Flow
To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn't performing as expected. For more information, see Using Traffic Flow to Route DNS Traffic in the Amazon Route 53 Developer Guide.
Create, Delete, and Upsert
Use ChangeResourceRecordsSetsRequest to perform the following actions:
CREATE: Creates a resource record set that has the specified values.
DELETE: Deletes an existing resource record set that has the specified values.
UPSERT: If a resource record set does not already exist, AWS creates it. If a resource set does exist, Route 53 updates it with the values in the request.
Syntaxes for Creating, Updating, and Deleting Resource Record Sets
The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as weighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax.
For an example for each type of resource record set, see \"Examples.\"
Don't refer to the syntax in the \"Parameter Syntax\" section, which includes all of the elements for every kind of resource record set that you can create, delete, or update by using ChangeResourceRecordSets.
Change Propagation to Route 53 DNS Servers
When you submit a ChangeResourceRecordSets request, Route 53 propagates your changes to all of the Route 53 authoritative DNS servers. While your changes are propagating, GetChange returns a status of PENDING. When propagation is complete, GetChange returns a status of INSYNC. Changes generally propagate to all Route 53 name servers within 60 seconds. For more information, see GetChange.
Limits on ChangeResourceRecordSets Requests
For information about the limits on a ChangeResourceRecordSets request, see Limits in the Amazon Route 53 Developer Guide.
Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use ChangeResourceRecordSets to create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44.
Change Batches and Transactional Changes
The request body must include a document with a ChangeResourceRecordSetsRequest element. The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes. When using the Amazon Route 53 API to change resource record sets, Route 53 either makes all or none of the changes in a change batch request. This ensures that Route 53 never partially implements the intended changes to the resource record sets in a hosted zone.
For example, a change batch request that deletes the CNAME record for www.example.com and creates an alias resource record set for www.example.com. Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If either the DELETE or the CREATE action fails, then both changes (plus any other changes in the batch) fail, and the original CNAME record continues to exist.
Due to the nature of transactional changes, you can't delete the same resource record set more than once in a single change batch. If you attempt to delete the same change batch more than once, Route 53 returns an InvalidChangeBatch error.
Traffic Flow
To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn't performing as expected. For more information, see Using Traffic Flow to Route DNS Traffic in the Amazon Route 53 Developer Guide.
Create, Delete, and Upsert
Use ChangeResourceRecordsSetsRequest to perform the following actions:
CREATE: Creates a resource record set that has the specified values.
DELETE: Deletes an existing resource record set that has the specified values.
UPSERT: If a resource record set does not already exist, AWS creates it. If a resource set does exist, Route 53 updates it with the values in the request.
Syntaxes for Creating, Updating, and Deleting Resource Record Sets
The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as weighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax.
For an example for each type of resource record set, see \"Examples.\"
Don't refer to the syntax in the \"Parameter Syntax\" section, which includes all of the elements for every kind of resource record set that you can create, delete, or update by using ChangeResourceRecordSets.
Change Propagation to Route 53 DNS Servers
When you submit a ChangeResourceRecordSets request, Route 53 propagates your changes to all of the Route 53 authoritative DNS servers. While your changes are propagating, GetChange returns a status of PENDING. When propagation is complete, GetChange returns a status of INSYNC. Changes generally propagate to all Route 53 name servers within 60 seconds. For more information, see GetChange.
Limits on ChangeResourceRecordSets Requests
For information about the limits on a ChangeResourceRecordSets request, see Limits in the Amazon Route 53 Developer Guide.
Creates a new health check.
For information about adding health checks to resource record sets, see HealthCheckId in ChangeResourceRecordSets.
ELB Load Balancers
If you're registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to a Route 53 health check.
Private Hosted Zones
You can associate health checks with failover resource record sets in a private hosted zone. Note the following:
Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC.
You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server.
You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 StatusCheckFailed metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the Amazon CloudWatch User Guide.
Creates a new health check.
For information about adding health checks to resource record sets, see HealthCheckId in ChangeResourceRecordSets.
ELB Load Balancers
If you're registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to a Route 53 health check.
Private Hosted Zones
You can associate health checks with failover resource record sets in a private hosted zone. Note the following:
Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC.
You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server.
You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 StatusCheckFailed metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the Amazon CloudWatch User Guide.
Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).
You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.
For more information about charges for hosted zones, see Amazon Route 53 Pricing.
Note the following:
You can't create a hosted zone for a top-level domain (TLD) such as .com.
For public hosted zones, Amazon Route 53 automatically creates a default SOA record and four NS records for the zone. For more information about SOA and NS records, see NS and SOA Records that Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide.
If you want to use the same name servers for multiple public hosted zones, you can optionally associate a reusable delegation set with the hosted zone. See the DelegationSetId element.
If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see Migrating DNS Service for an Existing Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.
When you submit a CreateHostedZone request, the initial status of the hosted zone is PENDING. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to INSYNC.
Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).
You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.
For more information about charges for hosted zones, see Amazon Route 53 Pricing.
Note the following:
You can't create a hosted zone for a top-level domain (TLD) such as .com.
For public hosted zones, Route 53 automatically creates a default SOA record and four NS records for the zone. For more information about SOA and NS records, see NS and SOA Records that Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide.
If you want to use the same name servers for multiple public hosted zones, you can optionally associate a reusable delegation set with the hosted zone. See the DelegationSetId element.
If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see Migrating DNS Service for an Existing Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.
When you submit a CreateHostedZone request, the initial status of the hosted zone is PENDING. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to INSYNC.
Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones. If a hosted zoned ID is specified, CreateReusableDelegationSet marks the delegation set associated with that zone as reusable.
You can't associate a reusable delegation set with a private hosted zone.
For information about using a reusable delegation set to configure white label name servers, see Configuring White Label Name Servers.
The process for migrating existing hosted zones to use a reusable delegation set is comparable to the process for configuring white label name servers. You need to perform the following steps:
Create a reusable delegation set.
Recreate hosted zones, and reduce the TTL to 60 seconds or less.
Recreate resource record sets in the new hosted zones.
Change the registrar's name servers to use the name servers for the new hosted zones.
Monitor traffic for the website or application.
Change TTLs back to their original values.
If you want to migrate existing hosted zones to use a reusable delegation set, the existing hosted zones can't use any of the name servers that are assigned to the reusable delegation set. If one or more hosted zones do use one or more name servers that are assigned to the reusable delegation set, you can do one of the following:
For small numbers of hosted zones—up to a few hundred—it's relatively easy to create reusable delegation sets until you get one that has four name servers that don't overlap with any of the name servers in your hosted zones.
For larger numbers of hosted zones, the easiest solution is to use more than one reusable delegation set.
For larger numbers of hosted zones, you can also migrate hosted zones that have overlapping name servers to hosted zones that don't have overlapping name servers, then migrate the hosted zones again to use the reusable delegation set.
Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones that were created by the same AWS account.
You can also create a reusable delegation set that uses the four name servers that are associated with an existing hosted zone. Specify the hosted zone ID in the CreateReusableDelegationSet request.
You can't associate a reusable delegation set with a private hosted zone.
For information about using a reusable delegation set to configure white label name servers, see Configuring White Label Name Servers.
The process for migrating existing hosted zones to use a reusable delegation set is comparable to the process for configuring white label name servers. You need to perform the following steps:
Create a reusable delegation set.
Recreate hosted zones, and reduce the TTL to 60 seconds or less.
Recreate resource record sets in the new hosted zones.
Change the registrar's name servers to use the name servers for the new hosted zones.
Monitor traffic for the website or application.
Change TTLs back to their original values.
If you want to migrate existing hosted zones to use a reusable delegation set, the existing hosted zones can't use any of the name servers that are assigned to the reusable delegation set. If one or more hosted zones do use one or more name servers that are assigned to the reusable delegation set, you can do one of the following:
For small numbers of hosted zones—up to a few hundred—it's relatively easy to create reusable delegation sets until you get one that has four name servers that don't overlap with any of the name servers in your hosted zones.
For larger numbers of hosted zones, the easiest solution is to use more than one reusable delegation set.
For larger numbers of hosted zones, you can also migrate hosted zones that have overlapping name servers to hosted zones that don't have overlapping name servers, then migrate the hosted zones again to use the reusable delegation set.
Deletes a health check.
Amazon Route 53 does not prevent you from deleting a health check even if the health check is associated with one or more resource record sets. If you delete a health check and you don't update the associated resource record sets, the future status of the health check can't be predicted and may change. This will affect the routing of DNS queries for your DNS failover configuration. For more information, see Replacing and Deleting Health Checks in the Amazon Route 53 Developer Guide.
Deletes a health check.
Amazon Route 53 does not prevent you from deleting a health check even if the health check is associated with one or more resource record sets. If you delete a health check and you don't update the associated resource record sets, the future status of the health check can't be predicted and may change. This will affect the routing of DNS queries for your DNS failover configuration. For more information, see Replacing and Deleting Health Checks in the Amazon Route 53 Developer Guide.
If you're using AWS Cloud Map and you configured Cloud Map to create a Route 53 health check when you register an instance, you can't use the Route 53 DeleteHealthCheck command to delete the health check. The health check is deleted automatically when you deregister the instance; there can be a delay of several hours before the health check is deleted from Route 53.
GetCheckerIpRanges still works, but we recommend that you download ip-ranges.json, which includes IP address ranges for all AWS services. For more information, see IP Address Ranges of Amazon Route 53 Servers in the Amazon Route 53 Developer Guide.
GetCheckerIpRanges still works, but we recommend that you download ip-ranges.json, which includes IP address ranges for all AWS services. For more information, see IP Address Ranges of Amazon Route 53 Servers in the Amazon Route 53 Developer Guide.
Retrieves a list of supported geographic locations.
Countries are listed first, and continents are listed last. If Amazon Route 53 supports subdivisions for a country (for example, states or provinces), the subdivisions for that country are listed in alphabetical order immediately after the corresponding country.
" + "documentation":"Retrieves a list of supported geographic locations.
Countries are listed first, and continents are listed last. If Amazon Route 53 supports subdivisions for a country (for example, states or provinces), the subdivisions for that country are listed in alphabetical order immediately after the corresponding country.
For a list of supported geolocation codes, see the GeoLocation data type.
" }, "ListHealthChecks":{ "name":"ListHealthChecks", @@ -673,7 +673,7 @@ {"shape":"InvalidInput"}, {"shape":"InvalidDomainName"} ], - "documentation":"Retrieves a list of your hosted zones in lexicographic order. The response includes a HostedZones child element for each hosted zone created by the current AWS account.
ListHostedZonesByName sorts hosted zones by name with the labels reversed. For example:
com.example.www.
Note the trailing dot, which can change the sort order in some circumstances.
If the domain name includes escape characters or Punycode, ListHostedZonesByName alphabetizes the domain name using the escaped or Punycoded value, which is the format that Amazon Route 53 saves in its database. For example, to create a hosted zone for exämple.com, you specify ex\\344mple.com for the domain name. ListHostedZonesByName alphabetizes it as:
com.ex\\344mple.
The labels are reversed and alphabetized using the escaped value. For more information about valid domain name formats, including internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.
Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, use the MaxItems parameter to list them in groups of up to 100. The response includes values that help navigate from one group of MaxItems hosted zones to the next:
The DNSName and HostedZoneId elements in the response contain the values, if any, specified for the dnsname and hostedzoneid parameters in the request that produced the current response.
The MaxItems element in the response contains the value, if any, that you specified for the maxitems parameter in the request that produced the current response.
If the value of IsTruncated in the response is true, there are more hosted zones associated with the current AWS account.
If IsTruncated is false, this response includes the last hosted zone that is associated with the current account. The NextDNSName element and NextHostedZoneId elements are omitted from the response.
The NextDNSName and NextHostedZoneId elements in the response contain the domain name and the hosted zone ID of the next hosted zone that is associated with the current AWS account. If you want to list more hosted zones, make another call to ListHostedZonesByName, and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.
Retrieves a list of your hosted zones in lexicographic order. The response includes a HostedZones child element for each hosted zone created by the current AWS account.
ListHostedZonesByName sorts hosted zones by name with the labels reversed. For example:
com.example.www.
Note the trailing dot, which can change the sort order in some circumstances.
If the domain name includes escape characters or Punycode, ListHostedZonesByName alphabetizes the domain name using the escaped or Punycoded value, which is the format that Amazon Route 53 saves in its database. For example, to create a hosted zone for exämple.com, you specify ex\\344mple.com for the domain name. ListHostedZonesByName alphabetizes it as:
com.ex\\344mple.
The labels are reversed and alphabetized using the escaped value. For more information about valid domain name formats, including internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.
Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, use the MaxItems parameter to list them in groups of up to 100. The response includes values that help navigate from one group of MaxItems hosted zones to the next:
The DNSName and HostedZoneId elements in the response contain the values, if any, specified for the dnsname and hostedzoneid parameters in the request that produced the current response.
The MaxItems element in the response contains the value, if any, that you specified for the maxitems parameter in the request that produced the current response.
If the value of IsTruncated in the response is true, there are more hosted zones associated with the current AWS account.
If IsTruncated is false, this response includes the last hosted zone that is associated with the current account. The NextDNSName element and NextHostedZoneId elements are omitted from the response.
The NextDNSName and NextHostedZoneId elements in the response contain the domain name and the hosted zone ID of the next hosted zone that is associated with the current AWS account. If you want to list more hosted zones, make another call to ListHostedZonesByName, and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.
Updates an existing health check. Note that some values can't be updated.
For more information about updating health checks, see Creating, Updating, and Deleting Health Checks in the Amazon Route 53 Developer Guide.
" + "documentation":"Updates an existing health check. Note that some values can't be updated.
For more information about updating health checks, see Creating, Updating, and Deleting Health Checks in the Amazon Route 53 Developer Guide.
" }, "UpdateHostedZoneComment":{ "name":"UpdateHostedZoneComment", @@ -971,11 +971,11 @@ "members":{ "Region":{ "shape":"CloudWatchRegion", - "documentation":"For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in.
For the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Regions and Endpoints chapter of the Amazon Web Services General Reference.
" + "documentation":"For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in.
For the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Service Endpoints chapter of the Amazon Web Services General Reference.
" }, "Name":{ "shape":"AlarmName", - "documentation":"The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
Route 53 supports CloudWatch alarms with the following features:
Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see High-Resolution Metrics in the Amazon CloudWatch User Guide.
Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported.
The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
Route 53 supports CloudWatch alarms with the following features:
Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see High-Resolution Metrics in the Amazon CloudWatch User Guide.
Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported.
A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.
" @@ -996,18 +996,18 @@ "members":{ "HostedZoneId":{ "shape":"ResourceId", - "documentation":"Alias resource records sets only: The value used depends on where you want to route traffic:
Specify the hosted zone ID for your API. You can get the applicable value using the AWS CLI command get-domain-names:
For regional APIs, specify the value of regionalHostedZoneId.
For edge-optimized APIs, specify the value of distributionHostedZoneId.
Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using the AWS CLI command describe-vpc-endpoints.
Specify Z2FDTNDATAQYW2.
Alias resource record sets for CloudFront can't be created in a private zone.
Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the \"AWS Regions and Endpoints\" chapter of the Amazon Web Services General Reference.
Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:
Elastic Load Balancing table in the \"AWS Regions and Endpoints\" chapter of the Amazon Web Services General Reference: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers.
AWS Management Console: Go to the Amazon EC2 page, choose Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab.
Elastic Load Balancing API: Use DescribeLoadBalancers to get the applicable value. For more information, see the applicable guide:
Classic Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneId.
AWS CLI: Use describe-load-balancers to get the applicable value. For more information, see the applicable guide:
Classic Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneId.
Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the Amazon Simple Storage Service Website Endpoints table in the \"AWS Regions and Endpoints\" chapter of the Amazon Web Services General Reference.
Specify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.)
Alias resource records sets only: The value used depends on where you want to route traffic:
Specify the hosted zone ID for your API. You can get the applicable value using the AWS CLI command get-domain-names:
For regional APIs, specify the value of regionalHostedZoneId.
For edge-optimized APIs, specify the value of distributionHostedZoneId.
Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using the AWS CLI command describe-vpc-endpoints.
Specify Z2FDTNDATAQYW2.
Alias resource record sets for CloudFront can't be created in a private zone.
Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the \"AWS Service Endpoints\" chapter of the Amazon Web Services General Reference.
Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:
Service Endpoints table in the \"Elastic Load Balancing Endpoints and Quotas\" topic in the Amazon Web Services General Reference: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers.
AWS Management Console: Go to the Amazon EC2 page, choose Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab.
Elastic Load Balancing API: Use DescribeLoadBalancers to get the applicable value. For more information, see the applicable guide:
Classic Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneId.
AWS CLI: Use describe-load-balancers to get the applicable value. For more information, see the applicable guide:
Classic Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneId.
Specify Z2BJ6XQ5FK7U4H.
Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference.
Specify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.)
Alias resource record sets only: The value that you specify depends on where you want to route queries:
Specify the applicable domain name for your API. You can get the applicable value using the AWS CLI command get-domain-names:
For regional APIs, specify the value of regionalDomainName.
For edge-optimized APIs, specify the value of distributionDomainName. This is the name of the associated CloudFront distribution, such as da1b2c3d4e5.cloudfront.net.
The name of the record that you're creating must match a custom domain name for your API, such as api.example.com.
Enter the API endpoint for the interface endpoint, such as vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com. For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of DnsName using the AWS CLI command describe-vpc-endpoints.
Specify the domain name that CloudFront assigned when you created your distribution.
Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is acme.example.com, your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide.
You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.
For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution.
If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name my-environment.us-west-2.elasticbeanstalk.com is a regionalized domain name.
For environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment.
For Elastic Beanstalk environments that have regionalized subdomains, specify the CNAME attribute for the environment. You can use the following methods to get the value of the CNAME attribute:
AWS Management Console: For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide.
Elastic Beanstalk API: Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments in the AWS Elastic Beanstalk API Reference.
AWS CLI: Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments in the AWS Command Line Interface Reference.
Specify the DNS name that is associated with the load balancer. Get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI.
AWS Management Console: Go to the EC2 page, choose Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS name field.
If you're routing traffic to a Classic Load Balancer, get the value that begins with dualstack. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.
Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of DNSName. For more information, see the applicable guide:
Classic Load Balancers: DescribeLoadBalancers
Application and Network Load Balancers: DescribeLoadBalancers
AWS CLI: Use describe-load-balancers to get the value of DNSName. For more information, see the applicable guide:
Classic Load Balancers: describe-load-balancers
Application and Network Load Balancers: describe-load-balancers
Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, s3-website.us-east-2.amazonaws.com. For more information about valid values, see the table Amazon Simple Storage Service (S3) Website Endpoints in the Amazon Web Services General Reference. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53 in the Amazon Route 53 Developer Guide.
Specify the value of the Name element for a resource record set in the current hosted zone.
If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't specify the domain name for a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.
Alias resource record sets only: The value that you specify depends on where you want to route queries:
Specify the applicable domain name for your API. You can get the applicable value using the AWS CLI command get-domain-names:
For regional APIs, specify the value of regionalDomainName.
For edge-optimized APIs, specify the value of distributionDomainName. This is the name of the associated CloudFront distribution, such as da1b2c3d4e5.cloudfront.net.
The name of the record that you're creating must match a custom domain name for your API, such as api.example.com.
Enter the API endpoint for the interface endpoint, such as vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com. For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of DnsName using the AWS CLI command describe-vpc-endpoints.
Specify the domain name that CloudFront assigned when you created your distribution.
Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is acme.example.com, your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide.
You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.
For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution.
If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name my-environment.us-west-2.elasticbeanstalk.com is a regionalized domain name.
For environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment.
For Elastic Beanstalk environments that have regionalized subdomains, specify the CNAME attribute for the environment. You can use the following methods to get the value of the CNAME attribute:
AWS Management Console: For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide.
Elastic Beanstalk API: Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments in the AWS Elastic Beanstalk API Reference.
AWS CLI: Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments in the AWS CLI Command Reference.
Specify the DNS name that is associated with the load balancer. Get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI.
AWS Management Console: Go to the EC2 page, choose Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS name field.
If you're routing traffic to a Classic Load Balancer, get the value that begins with dualstack. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.
Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of DNSName. For more information, see the applicable guide:
Classic Load Balancers: DescribeLoadBalancers
Application and Network Load Balancers: DescribeLoadBalancers
AWS CLI: Use describe-load-balancers to get the value of DNSName. For more information, see the applicable guide:
Classic Load Balancers: describe-load-balancers
Application and Network Load Balancers: describe-load-balancers
Specify the DNS name for your accelerator:
Global Accelerator API: To get the DNS name, use DescribeAccelerator.
AWS CLI: To get the DNS name, use describe-accelerator.
Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, s3-website.us-east-2.amazonaws.com. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53 in the Amazon Route 53 Developer Guide.
Specify the value of the Name element for a resource record set in the current hosted zone.
If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't specify the domain name for a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.
Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets: When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer or another resource record set in the hosted zone.
Note the following:
You can't set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.
If you specify an Elastic Beanstalk environment in DNSName and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set EvaluateTargetHealth to true and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any.
If the environment contains a single Amazon EC2 instance, there are no special requirements.
Health checking behavior depends on the type of load balancer:
Classic Load Balancers: If you specify an ELB Classic Load Balancer in DNSName, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources.
Application and Network Load Balancers: If you specify an ELB Application or Network Load Balancer and you set EvaluateTargetHealth to true, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:
For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources.
A target group that has no registered targets is considered unhealthy.
When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer.
There are no special requirements for setting EvaluateTargetHealth to true when the alias target is an S3 bucket.
If the AWS resource that you specify in DNSName is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.
For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
" + "documentation":" Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets: When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer or another resource record set in the hosted zone.
Note the following:
You can't set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.
If you specify an Elastic Beanstalk environment in DNSName and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set EvaluateTargetHealth to true and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any.
If the environment contains a single Amazon EC2 instance, there are no special requirements.
Health checking behavior depends on the type of load balancer:
Classic Load Balancers: If you specify an ELB Classic Load Balancer in DNSName, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources.
Application and Network Load Balancers: If you specify an ELB Application or Network Load Balancer and you set EvaluateTargetHealth to true, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:
For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources.
A target group that has no registered targets is considered unhealthy.
When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer.
There are no special requirements for setting EvaluateTargetHealth to true when the alias target is an S3 bucket.
If the AWS resource that you specify in DNSName is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.
For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
" } }, - "documentation":"Alias resource record sets only: Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.
When creating resource record sets for a private hosted zone, note the following:
Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.
For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone.
Alias resource record sets only: Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.
When creating resource record sets for a private hosted zone, note the following:
Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.
For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone.
The namespace of the metric that the alarm is associated with. For more information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.
" + "documentation":"The namespace of the metric that the alarm is associated with. For more information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.
" }, "Statistic":{ "shape":"Statistic", @@ -1249,7 +1249,7 @@ }, "Dimensions":{ "shape":"DimensionList", - "documentation":"For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric. For information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.
" + "documentation":"For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric. For information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.
" } }, "documentation":"A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.
" @@ -2013,15 +2013,15 @@ "members":{ "ContinentCode":{ "shape":"GeoLocationContinentCode", - "documentation":"The two-letter code for the continent.
Valid values: AF | AN | AS | EU | OC | NA | SA
Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.
The two-letter code for the continent.
Amazon Route 53 supports the following continent codes:
AF: Africa
AN: Antarctica
AS: Asia
EU: Europe
OC: Oceania
NA: North America
SA: South America
Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.
The two-letter code for the country.
" + "documentation":"For geolocation resource record sets, the two-letter code for a country.
Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.
" }, "SubdivisionCode":{ "shape":"GeoLocationSubdivisionCode", - "documentation":"The code for the subdivision. Route 53 currently supports only states in the United States.
" + "documentation":"For geolocation resource record sets, the two-letter code for a state of the United States. Route 53 doesn't support any other values for SubdivisionCode. For a list of state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website.
If you specify subdivisioncode, you must also specify US for CountryCode.
A complex type that contains information about a geographic location.
" @@ -2170,7 +2170,7 @@ "members":{ "ContinentCode":{ "shape":"GeoLocationContinentCode", - "documentation":"Amazon Route 53 supports the following continent codes:
AF: Africa
AN: Antarctica
AS: Asia
EU: Europe
OC: Oceania
NA: North America
SA: South America
For geolocation resource record sets, a two-letter abbreviation that identifies a continent. Amazon Route 53 supports the following continent codes:
AF: Africa
AN: Antarctica
AS: Asia
EU: Europe
OC: Oceania
NA: North America
SA: South America
Amazon Route 53 uses the one- to three-letter subdivision codes that are specified in ISO standard 3166-1 alpha-2. Route 53 doesn't support subdivision codes for all countries. If you specify subdivisioncode, you must also specify countrycode.
For SubdivisionCode, Amazon Route 53 supports only states of the United States. For a list of state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website.
If you specify subdivisioncode, you must also specify US for CountryCode.
The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for Port only when you specify a value for IPAddress.
The port on the endpoint that you want Amazon Route 53 to perform health checks on.
Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or CALCULATED.
If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy.
Route 53 considers case when searching for SearchString in the response body.
If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy.
Route 53 considers case when searching for SearchString in the response body.
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
If you don't specify a value for FailureThreshold, the default value is three health checks.
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
If you don't specify a value for FailureThreshold, the default value is three health checks.
The code for the country with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextCountryCode from the previous response has a value, enter that value in startcountrycode to return the next page of results.
Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.
", + "documentation":"The code for the country with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextCountryCode from the previous response has a value, enter that value in startcountrycode to return the next page of results.
The code for the subdivision (for example, state or province) with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextSubdivisionCode from the previous response has a value, enter that value in startsubdivisioncode to return the next page of results.
To list subdivisions of a country, you must include both startcountrycode and startsubdivisioncode.
The code for the state of the United States with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextSubdivisionCode from the previous response has a value, enter that value in startsubdivisioncode to return the next page of results.
To list subdivisions (U.S. states), you must include both startcountrycode and startsubdivisioncode.
The first name in the lexicographic ordering of resource record sets that you want to list.
", + "documentation":"The first name in the lexicographic ordering of resource record sets that you want to list. If the specified record name doesn't exist, the results begin with the first resource record set that has a name greater than the value of name.
The type of resource record set to begin the record listing from.
Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT
Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT
Values for alias resource record sets:
API Gateway custom regional API or edge-optimized API: A
CloudFront distribution: A or AAAA
Elastic Beanstalk environment that has a regionalized subdomain: A
Elastic Load Balancing load balancer: A | AAAA
Amazon S3 bucket: A
Amazon VPC interface VPC endpoint: A
Another resource record set in this hosted zone: The type of the resource record set that the alias references.
Constraint: Specifying type without specifying name returns an InvalidInput error.
The type of resource record set to begin the record listing from.
Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT
Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT
Values for alias resource record sets:
API Gateway custom regional API or edge-optimized API: A
CloudFront distribution: A or AAAA
Elastic Beanstalk environment that has a regionalized subdomain: A
Elastic Load Balancing load balancer: A | AAAA
S3 bucket: A
VPC interface VPC endpoint: A
Another resource record set in this hosted zone: The type of the resource record set that the alias references.
Constraint: Specifying type without specifying name returns an InvalidInput error.
Descriptive message for the error response.
" } }, - "documentation":"Amazon Route 53 doesn't support the specified geographic location.
", + "documentation":"Amazon Route 53 doesn't support the specified geographic location. For a list of supported geolocation codes, see the GeoLocation data type.
", "error":{"httpStatusCode":404}, "exception":true }, @@ -4174,11 +4174,11 @@ "members":{ "Name":{ "shape":"DNSName", - "documentation":"For ChangeResourceRecordSets requests, the name of the record that you want to create, update, or delete. For ListResourceRecordSets responses, the name of a record in the specified hosted zone.
ChangeResourceRecordSets Only
Enter a fully qualified domain name, for example, www.example.com. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.
You can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, *.example.com. Note the following:
The * must replace the entire label. For example, you can't specify *prod.example.com or prod*.example.com.
The * can't replace any of the middle labels, for example, marketing.*.example.com.
If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.
You can't use the * wildcard for resource records sets that have a type of NS.
You can use the * wildcard as the leftmost label in a domain name, for example, *.example.com. You can't use an * for one of the middle labels, for example, marketing.*.example.com. In addition, the * must replace the entire label; for example, you can't specify prod*.example.com.
For ChangeResourceRecordSets requests, the name of the record that you want to create, update, or delete. For ListResourceRecordSets responses, the name of a record in the specified hosted zone.
ChangeResourceRecordSets Only
Enter a fully qualified domain name, for example, www.example.com. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.
You can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, *.example.com. Note the following:
The * must replace the entire label. For example, you can't specify *prod.example.com or prod*.example.com.
The * can't replace any of the middle labels, for example, marketing.*.example.com.
If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.
You can't use the * wildcard for resource records sets that have a type of NS.
You can use the * wildcard as the leftmost label in a domain name, for example, *.example.com. You can't use an * for one of the middle labels, for example, marketing.*.example.com. In addition, the * must replace the entire label; for example, you can't specify prod*.example.com.
The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.
Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT
Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.
Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR | PTR | SPF | SRV | TXT
SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of Type is SPF. RFC 7208, Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1, has been updated to say, \"...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it.\" In RFC 7208, see section 14.1, The SPF DNS Record Type.
Values for alias resource record sets:
Amazon API Gateway custom regional APIs and edge-optimized APIs: A
CloudFront distributions: A
If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of A and one with a value of AAAA.
AWS Elastic Beanstalk environment that has a regionalized subdomain: A
ELB load balancers: A | AAAA
Amazon S3 buckets: A
Amazon Virtual Private Cloud interface VPC endpoints A
Another resource record set in this hosted zone: Specify the type of the resource record set that you're creating the alias for. All values are supported except NS and SOA.
If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't route traffic to a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.
The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.
Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT
Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.
Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR | PTR | SPF | SRV | TXT
SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of Type is SPF. RFC 7208, Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1, has been updated to say, \"...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it.\" In RFC 7208, see section 14.1, The SPF DNS Record Type.
Values for alias resource record sets:
Amazon API Gateway custom regional APIs and edge-optimized APIs: A
CloudFront distributions: A
If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of A and one with a value of AAAA.
Amazon API Gateway environment that has a regionalized subdomain: A
ELB load balancers: A | AAAA
Amazon S3 buckets: A
Amazon Virtual Private Cloud interface VPC endpoints A
Another resource record set in this hosted zone: Specify the type of the resource record set that you're creating the alias for. All values are supported except NS and SOA.
If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't route traffic to a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.
Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:
You must specify a value for the Weight element for every weighted resource record set.
You can only specify one ResourceRecord per weighted resource record set.
You can't create latency, failover, or geolocation resource record sets that have the same values for the Name and Type elements as weighted resource record sets.
You can create a maximum of 100 weighted resource record sets that have the same values for the Name and Type elements.
For weighted (but not weighted alias) resource record sets, if you set Weight to 0 for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set Weight to 0 for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability.
The effect of setting Weight to 0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Route 53 Active-Active and Active-Passive Failover in the Amazon Route 53 Developer Guide.
Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:
You must specify a value for the Weight element for every weighted resource record set.
You can only specify one ResourceRecord per weighted resource record set.
You can't create latency, failover, or geolocation resource record sets that have the same values for the Name and Type elements as weighted resource record sets.
You can create a maximum of 100 weighted resource record sets that have the same values for the Name and Type elements.
For weighted (but not weighted alias) resource record sets, if you set Weight to 0 for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set Weight to 0 for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability.
The effect of setting Weight to 0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Route 53 Active-Active and Active-Passive Failover in the Amazon Route 53 Developer Guide.
Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.
Creating latency and latency alias resource record sets in private hosted zones is not supported.
When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.
Note the following:
You can only specify one ResourceRecord per latency resource record set.
You can only create one latency resource record set for each Amazon EC2 Region.
You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.
You can't create non-latency resource record sets that have the same values for the Name and Type elements as latency resource record sets.
Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.
Although creating latency and latency alias resource record sets in a private hosted zone is allowed, it's not supported.
When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.
Note the following:
You can only specify one ResourceRecord per latency resource record set.
You can only create one latency resource record set for each Amazon EC2 Region.
You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.
You can't create non-latency resource record sets that have the same values for the Name and Type elements as latency resource record sets.
Geolocation resource record sets only: A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of 192.0.2.111, create a resource record set with a Type of A and a ContinentCode of AF.
Creating geolocation and geolocation alias resource record sets in private hosted zones is not supported.
If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.
You can't create two geolocation resource record sets that specify the same geographic location.
The value * in the CountryCode element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the Name and Type elements.
Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of CountryCode is *, which handles both queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a * resource record set, Route 53 returns a \"no answer\" response for queries from those locations.
You can't create non-geolocation resource record sets that have the same values for the Name and Type elements as geolocation resource record sets.
Geolocation resource record sets only: A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of 192.0.2.111, create a resource record set with a Type of A and a ContinentCode of AF.
Although creating geolocation and geolocation alias resource record sets in a private hosted zone is allowed, it's not supported.
If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.
You can't create two geolocation resource record sets that specify the same geographic location.
The value * in the CountryCode element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the Name and Type elements.
Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of CountryCode is *. Two groups of queries are routed to the resource that you specify in this record: queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a * resource record set, Route 53 returns a \"no answer\" response for queries from those locations.
You can't create non-geolocation resource record sets that have the same values for the Name and Type elements as geolocation resource record sets.
Failover resource record sets only: To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.
Except where noted, the following failover behaviors assume that you have included the HealthCheckId element in both resource record sets:
When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.
When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set.
When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.
If you omit the HealthCheckId element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.
You can't create non-failover resource record sets that have the same values for the Name and Type elements as failover resource record sets.
For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true.
For more information about configuring failover for Route 53, see the following topics in the Amazon Route 53 Developer Guide:
" + "documentation":" Failover resource record sets only: To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.
Except where noted, the following failover behaviors assume that you have included the HealthCheckId element in both resource record sets:
When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.
When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set.
When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.
If you omit the HealthCheckId element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.
You can't create non-failover resource record sets that have the same values for the Name and Type elements as failover resource record sets.
For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true.
For more information about configuring failover for Route 53, see the following topics in the Amazon Route 53 Developer Guide:
" }, "MultiValueAnswer":{ "shape":"ResourceRecordSetMultiValueAnswer", @@ -4214,11 +4214,11 @@ }, "AliasTarget":{ "shape":"AliasTarget", - "documentation":"Alias resource record sets only: Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.
If you're creating resource records sets for a private hosted zone, note the following:
You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.
Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.
For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the Amazon Route 53 Developer Guide.
Alias resource record sets only: Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.
If you're creating resource records sets for a private hosted zone, note the following:
You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.
Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.
For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the Amazon Route 53 Developer Guide.
If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the HealthCheckId element and specify the ID of the applicable health check.
Route 53 determines whether a resource record set is healthy based on one of the following:
By periodically sending a request to the endpoint that is specified in the health check
By aggregating the status of a specified group of health checks (calculated health checks)
By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)
Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the Value element. When you add a HealthCheckId element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check.
For more information, see the following topics in the Amazon Route 53 Developer Guide:
When to Specify HealthCheckId
Specifying a value for HealthCheckId is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations:
Non-alias resource record sets: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets.
If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with.
If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set.
If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly.
Alias resource record sets: You specify the following settings:
You set EvaluateTargetHealth to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A).
You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.
You specify a health check ID for the non-alias resource record set.
If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with.
If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.
The alias resource record set can also route traffic to a group of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets.
Geolocation Routing
For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, for North America, and a resource record set that has * for CountryCode is *, which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource record set for which the endpoint is healthy:
The United States
North America
The default resource record set
Specifying the Health Check Endpoint by Domain Name
If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).
Health check results will be unpredictable if you do the following:
Create a health check that has the same value for FullyQualifiedDomainName as the name of a resource record set.
Associate that health check with the resource record set.
If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the HealthCheckId element and specify the ID of the applicable health check.
Route 53 determines whether a resource record set is healthy based on one of the following:
By periodically sending a request to the endpoint that is specified in the health check
By aggregating the status of a specified group of health checks (calculated health checks)
By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)
Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the Value element. When you add a HealthCheckId element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check.
For more information, see the following topics in the Amazon Route 53 Developer Guide:
When to Specify HealthCheckId
Specifying a value for HealthCheckId is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations:
Non-alias resource record sets: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets.
If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with.
If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set.
If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly.
Alias resource record sets: You specify the following settings:
You set EvaluateTargetHealth to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A).
You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.
You specify a health check ID for the non-alias resource record set.
If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with.
If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.
The alias resource record set can also route traffic to a group of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets.
Geolocation Routing
For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, for North America, and a resource record set that has * for CountryCode is *, which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource record set for which the endpoint is healthy:
The United States
North America
The default resource record set
Specifying the Health Check Endpoint by Domain Name
If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).
Health check results will be unpredictable if you do the following:
Create a health check that has the same value for FullyQualifiedDomainName as the name of a resource record set.
Associate that health check with the resource record set.
The port on the endpoint on which you want Amazon Route 53 to perform health checks.
" + "documentation":"The port on the endpoint that you want Amazon Route 53 to perform health checks on.
Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or CALCULATED.
If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. (You can't change the value of Type when you update a health check.)
If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. (You can't change the value of Type when you update a health check.)
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
If you don't specify a value for FailureThreshold, the default value is three health checks.
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
If you don't specify a value for FailureThreshold, the default value is three health checks.
Accepts the transfer of a domain from another AWS account to the current AWS account. You initiate a transfer between AWS accounts using TransferDomainToAnotherAwsAccount.
Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled.
Cancels the transfer of a domain from the current AWS account to another AWS account. You initiate a transfer between AWS accounts using TransferDomainToAnotherAwsAccount.
You must cancel the transfer before the other AWS account accepts the transfer using AcceptDomainTransferFromAnotherAwsAccount.
Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled.
This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is billed to your AWS account.
The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see \"Renewal, restoration, and deletion times\" on the website for our registrar associate, Gandi. Amazon Route 53 requires that you renew before the end of the renewal period that is listed on the Gandi website so we can complete processing before the deadline.
" + "documentation":"This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is billed to your AWS account.
The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see Domains That You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. Route 53 requires that you renew before the end of the renewal period so we can complete processing before the deadline.
" }, "EnableDomainTransferLock":{ "name":"EnableDomainTransferLock", @@ -159,7 +188,7 @@ {"shape":"InvalidInput"}, {"shape":"UnsupportedTLD"} ], - "documentation":"The GetDomainSuggestions operation returns a list of suggested domain names given a string, which can either be a domain name or simply a word or phrase (without spaces).
" + "documentation":"The GetDomainSuggestions operation returns a list of suggested domain names.
" }, "GetOperationDetail":{ "name":"GetOperationDetail", @@ -198,7 +227,7 @@ "errors":[ {"shape":"InvalidInput"} ], - "documentation":"This operation returns the operation IDs of operations that are not yet complete.
" + "documentation":"Returns information about all of the operations that return an operation ID and that have ever been performed on domains that were registered by the current account.
" }, "ListTagsForDomain":{ "name":"ListTagsForDomain", @@ -231,7 +260,21 @@ {"shape":"DomainLimitExceeded"}, {"shape":"OperationLimitExceeded"} ], - "documentation":"This operation registers a domain. Domains are registered either by Amazon Registrar (for .com, .net, and .org domains) or by our registrar associate, Gandi (for all other domains). For some top-level domains (TLDs), this operation requires extra parameters.
When you register a domain, Amazon Route 53 does the following:
Creates a Amazon Route 53 hosted zone that has the same name as the domain. Amazon Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers.
Enables autorenew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration.
Optionally enables privacy protection, so WHOIS queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you don't enable privacy protection, WHOIS queries return the information that you entered for the registrant, admin, and tech contacts.
If registration is successful, returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant is notified by email.
Charges your AWS account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing.
This operation registers a domain. Domains are registered either by Amazon Registrar (for .com, .net, and .org domains) or by our registrar associate, Gandi (for all other domains). For some top-level domains (TLDs), this operation requires extra parameters.
When you register a domain, Amazon Route 53 does the following:
Creates a Route 53 hosted zone that has the same name as the domain. Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers.
Enables autorenew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration.
Optionally enables privacy protection, so WHOIS queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you don't enable privacy protection, WHOIS queries return the information that you entered for the registrant, admin, and tech contacts.
If registration is successful, returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant is notified by email.
Charges your AWS account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing.
Rejects the transfer of a domain from another AWS account to the current AWS account. You initiate a transfer between AWS accounts using TransferDomainToAnotherAwsAccount.
Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled.
This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your AWS account.
We recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the expiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see Renewing Registration for a Domain in the Amazon Route 53 Developer Guide.
" + "documentation":"This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your AWS account.
We recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the expiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see Renewing Registration for a Domain in the Amazon Route 53 Developer Guide.
" }, "ResendContactReachabilityEmail":{ "name":"ResendContactReachabilityEmail", @@ -295,7 +338,22 @@ {"shape":"DomainLimitExceeded"}, {"shape":"OperationLimitExceeded"} ], - "documentation":"This operation transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered either with Amazon Registrar (for .com, .net, and .org domains) or with our registrar associate, Gandi (for all other TLDs).
For transfer requirements, a detailed procedure, and information about viewing the status of a domain transfer, see Transferring Registration for a Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.
If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you consider transferring your DNS service to Amazon Route 53 or to another DNS service provider before you transfer your registration. Some registrars provide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar will not renew your domain registration and could end your DNS service at any time.
If the registrar for your domain is also the DNS service provider for the domain and you don't transfer DNS service to another provider, your website, email, and the web applications associated with the domain might become unavailable.
If the transfer is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email.
" + "documentation":"Transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered either with Amazon Registrar (for .com, .net, and .org domains) or with our registrar associate, Gandi (for all other TLDs).
For more information about transferring domains, see the following topics:
For transfer requirements, a detailed procedure, and information about viewing the status of a domain that you're transferring to Route 53, see Transferring Registration for a Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.
For information about how to transfer a domain from one AWS account to another, see TransferDomainToAnotherAwsAccount.
For information about how to transfer a domain to another domain registrar, see Transferring a Domain from Amazon Route 53 to Another Registrar in the Amazon Route 53 Developer Guide.
If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you transfer your DNS service to Route 53 or to another DNS service provider before you transfer your registration. Some registrars provide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar will not renew your domain registration and could end your DNS service at any time.
If the registrar for your domain is also the DNS service provider for the domain and you don't transfer DNS service to another provider, your website, email, and the web applications associated with the domain might become unavailable.
If the transfer is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email.
" + }, + "TransferDomainToAnotherAwsAccount":{ + "name":"TransferDomainToAnotherAwsAccount", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TransferDomainToAnotherAwsAccountRequest"}, + "output":{"shape":"TransferDomainToAnotherAwsAccountResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"OperationLimitExceeded"}, + {"shape":"DuplicateRequest"} + ], + "documentation":"Transfers a domain from the current AWS account to another AWS account. Note the following:
The AWS account that you're transferring the domain to must accept the transfer. If the other account doesn't accept the transfer within 3 days, we cancel the transfer. See AcceptDomainTransferFromAnotherAwsAccount.
You can cancel the transfer before the other account accepts it. See CancelDomainTransferToAnotherAwsAccount.
The other account can reject the transfer. See RejectDomainTransferFromAnotherAwsAccount.
When you transfer a domain from one AWS account to another, Route 53 doesn't transfer the hosted zone that is associated with the domain. DNS resolution isn't affected if the domain and the hosted zone are owned by separate accounts, so transferring the hosted zone is optional. For information about transferring the hosted zone to another AWS account, see Migrating a Hosted Zone to a Different AWS Account in the Amazon Route 53 Developer Guide.
Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled.
This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, contact information such as email address is replaced either with contact information for Amazon Registrar (for .com, .net, and .org domains) or with contact information for our registrar associate, Gandi.
This operation affects only the contact information for the specified contact type (registrant, administrator, or tech). If the request succeeds, Amazon Route 53 returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request doesn't complete successfully, the domain registrant will be notified by email.
" + "documentation":"This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, contact information such as email address is replaced either with contact information for Amazon Registrar (for .com, .net, and .org domains) or with contact information for our registrar associate, Gandi.
This operation affects only the contact information for the specified contact type (registrant, administrator, or tech). If the request succeeds, Amazon Route 53 returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request doesn't complete successfully, the domain registrant will be notified by email.
By disabling the privacy service via API, you consent to the publication of the contact information provided for this domain via the public WHOIS database. You certify that you are the registrant of this domain name and have the authority to make this decision. You may withdraw your consent at any time by enabling privacy protection using either UpdateDomainContactPrivacy or the Route 53 console. Enabling privacy protection removes the contact information provided for this domain from the WHOIS database. For more information on our privacy practices, see https://aws.amazon.com/privacy/.
The name of the domain that was specified when another AWS account submitted a TransferDomainToAnotherAwsAccount request.
" + }, + "Password":{ + "shape":"String", + "documentation":"The password that was returned by the TransferDomainToAnotherAwsAccount request.
" + } + }, + "documentation":"The AcceptDomainTransferFromAnotherAwsAccount request includes the following elements.
" + }, + "AcceptDomainTransferFromAnotherAwsAccountResponse":{ + "type":"structure", + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"Identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail.
" + } + }, + "documentation":"The AcceptDomainTransferFromAnotherAwsAccount response includes the following element.
" + }, + "AccountId":{ + "type":"string", + "pattern":"^(\\d{12})$" + }, "AddressLine":{ "type":"string", "max":255 @@ -387,7 +477,7 @@ "members":{ "DomainName":{ "shape":"DomainName", - "documentation":"The name of the domain that the billing record applies to. If the domain name contains characters other than a-z, 0-9, and - (hyphen), such as an internationalized domain name, then this value is in Punycode. For more information, see DNS Domain Name Format in the Amazon Route 53 Developer Guidezzz.
" + "documentation":"The name of the domain that the billing record applies to. If the domain name contains characters other than a-z, 0-9, and - (hyphen), such as an internationalized domain name, then this value is in Punycode. For more information, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.
" }, "Operation":{ "shape":"OperationType", @@ -413,13 +503,34 @@ "member":{"shape":"BillingRecord"} }, "Boolean":{"type":"boolean"}, + "CancelDomainTransferToAnotherAwsAccountRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"The name of the domain for which you want to cancel the transfer to another AWS account.
" + } + }, + "documentation":"The CancelDomainTransferToAnotherAwsAccount request includes the following element.
" + }, + "CancelDomainTransferToAnotherAwsAccountResponse":{ + "type":"structure", + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"The identifier that TransferDomainToAnotherAwsAccount returned to track the progress of the request. Because the transfer request was canceled, the value is no longer valid, and you can't use GetOperationDetail to query the operation status.
The CancelDomainTransferToAnotherAwsAccount response includes the following element.
The name of the domain that you want to get availability for.
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
" + "documentation":"The name of the domain that you want to get availability for. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.
The domain name can contain only the following characters:
Letters a through z. Domain names are not case sensitive.
Numbers 0 through 9.
Hyphen (-). You can't specify a hyphen at the beginning or end of a label.
Period (.) to separate the labels in the name, such as the . in example.com.
Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports internationalized domain names, see Domains that You Can Register with Amazon Route 53. For more information, see Formatting Internationalized Domain Names.
" }, "IdnLangCode":{ "shape":"LangCode", @@ -434,7 +545,7 @@ "members":{ "Availability":{ "shape":"DomainAvailability", - "documentation":"Whether the domain name is available for registering.
You can register only domains designated as AVAILABLE.
Valid values:
The domain name is available.
The domain name is reserved under specific conditions.
The domain name is available and can be preordered.
The TLD registry didn't reply with a definitive answer about whether the domain name is available. Amazon Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later.
The TLD registry didn't return a response in the expected amount of time. When the response is delayed, it usually takes just a few extra seconds. You can resubmit the request immediately.
The domain name has been reserved for another person or organization.
The domain name is not available.
The domain name is not available.
The domain name is forbidden.
Whether the domain name is available for registering.
You can register only domains designated as AVAILABLE.
Valid values:
The domain name is available.
The domain name is reserved under specific conditions.
The domain name is available and can be preordered.
The TLD registry didn't reply with a definitive answer about whether the domain name is available. Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later.
The TLD registry didn't return a response in the expected amount of time. When the response is delayed, it usually takes just a few extra seconds. You can resubmit the request immediately.
The domain name has been reserved for another person or organization.
The domain name is not available.
The domain name is not available.
The domain name is forbidden.
The CheckDomainAvailability response includes the following elements.
" @@ -445,7 +556,7 @@ "members":{ "DomainName":{ "shape":"DomainName", - "documentation":"The name of the domain that you want to transfer to Amazon Route 53.
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
" + "documentation":"The name of the domain that you want to transfer to Route 53. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.
The domain name can contain only the following characters:
Letters a through z. Domain names are not case sensitive.
Numbers 0 through 9.
Hyphen (-). You can't specify a hyphen at the beginning or end of a label.
Period (.) to separate the labels in the name, such as the . in example.com.
A complex type that contains information about whether the specified domain can be transferred to Amazon Route 53.
" + "documentation":"A complex type that contains information about whether the specified domain can be transferred to Route 53.
" } }, "documentation":"The CheckDomainTransferability response includes the following elements.
" @@ -482,7 +593,7 @@ }, "ContactType":{ "shape":"ContactType", - "documentation":"Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.
Indicates whether the contact is a person, company, association, or public organization. Note the following:
If you specify a value other than PERSON, you must also specify a value for OrganizationName.
For some TLDs, the privacy protection available depends on the value that you specify for Contact Type. For the privacy protection settings for your TLD, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide
For .es domains, if you specify PERSON, you must specify INDIVIDUAL for the value of ES_LEGAL_FORM.
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
" + "documentation":"Identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail.
" } }, "documentation":"The DisableDomainTransferLock response includes the following element.
" @@ -893,7 +1004,7 @@ }, "Availability":{ "shape":"String", - "documentation":"Whether the domain name is available for registering.
You can register only the domains that are designated as AVAILABLE.
Valid values:
The domain name is available.
The domain name is reserved under specific conditions.
The domain name is available and can be preordered.
The TLD registry didn't reply with a definitive answer about whether the domain name is available. Amazon Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later.
The TLD registry didn't return a response in the expected amount of time. When the response is delayed, it usually takes just a few extra seconds. You can resubmit the request immediately.
The domain name has been reserved for another person or organization.
The domain name is not available.
The domain name is not available.
The domain name is forbidden.
Whether the domain name is available for registering.
You can register only the domains that are designated as AVAILABLE.
Valid values:
The domain name is available.
The domain name is reserved under specific conditions.
The domain name is available and can be preordered.
The TLD registry didn't reply with a definitive answer about whether the domain name is available. Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later.
The TLD registry didn't return a response in the expected amount of time. When the response is delayed, it usually takes just a few extra seconds. You can resubmit the request immediately.
The domain name has been reserved for another person or organization.
The domain name is not available.
The domain name is not available.
The domain name is forbidden.
Information about one suggested domain name.
" @@ -920,7 +1031,7 @@ }, "Expiry":{ "shape":"Timestamp", - "documentation":"Expiration date of the domain in Coordinated Universal Time (UTC).
" + "documentation":"Expiration date of the domain in Unix time format and Coordinated Universal Time (UTC).
" } }, "documentation":"Summary information about one domain.
" @@ -934,7 +1045,7 @@ "members":{ "Transferable":{"shape":"Transferable"} }, - "documentation":"A complex type that contains information about whether the specified domain can be transferred to Amazon Route 53.
" + "documentation":"A complex type that contains information about whether the specified domain can be transferred to Route 53.
" }, "DuplicateRequest":{ "type":"structure", @@ -1003,11 +1114,11 @@ "members":{ "Name":{ "shape":"ExtraParamName", - "documentation":"Name of the additional parameter required by the top-level domain. Here are the top-level domains that require additional parameters and which parameters they require:
.com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE
.ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE
.es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM
.fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE
.fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY
.it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE
.ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA
.se: BIRTH_COUNTRY and SE_ID_NUMBER
.sg: SG_ID_NUMBER
.co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER
In addition, many TLDs require VAT_NUMBER.
The name of an additional parameter that is required by a top-level domain. Here are the top-level domains that require additional parameters and the names of the parameters that they require:
AU_ID_NUMBER
AU_ID_TYPE
Valid values include the following:
ABN (Australian business number)
ACN (Australian company number)
TM (Trademark number)
BRAND_NUMBER
CA_BUSINESS_ENTITY_TYPE
Valid values include the following:
BANK (Bank)
COMMERCIAL_COMPANY (Commercial company)
COMPANY (Company)
COOPERATION (Cooperation)
COOPERATIVE (Cooperative)
COOPRIX (Cooprix)
CORP (Corporation)
CREDIT_UNION (Credit union)
FOMIA (Federation of mutual insurance associations)
INC (Incorporated)
LTD (Limited)
LTEE (Limitée)
LLC (Limited liability corporation)
LLP (Limited liability partnership)
LTE (Lte.)
MBA (Mutual benefit association)
MIC (Mutual insurance company)
NFP (Not-for-profit corporation)
SA (S.A.)
SAVINGS_COMPANY (Savings company)
SAVINGS_UNION (Savings union)
SARL (Société à responsabilité limitée)
TRUST (Trust)
ULC (Unlimited liability corporation)
CA_LEGAL_TYPE
When ContactType is PERSON, valid values include the following:
ABO (Aboriginal Peoples indigenous to Canada)
CCT (Canadian citizen)
LGR (Legal Representative of a Canadian Citizen or Permanent Resident)
RES (Permanent resident of Canada)
When ContactType is a value other than PERSON, valid values include the following:
ASS (Canadian unincorporated association)
CCO (Canadian corporation)
EDU (Canadian educational institution)
GOV (Government or government entity in Canada)
HOP (Canadian Hospital)
INB (Indian Band recognized by the Indian Act of Canada)
LAM (Canadian Library, Archive, or Museum)
MAJ (Her/His Majesty the Queen/King)
OMK (Official mark registered in Canada)
PLT (Canadian Political Party)
PRT (Partnership Registered in Canada)
TDM (Trademark registered in Canada)
TRD (Canadian Trade Union)
TRS (Trust established in Canada)
ES_IDENTIFICATION
Specify the applicable value:
For contacts inside Spain: Enter your passport ID.
For contacts outside of Spain: Enter the VAT identification number for the company.
For .es domains, the value of ContactType must be PERSON.
ES_IDENTIFICATION_TYPE
Valid values include the following:
DNI_AND_NIF (For Spanish contacts)
NIE (For foreigners with legal residence)
OTHER (For contacts outside of Spain)
ES_LEGAL_FORM
Valid values include the following:
ASSOCIATION
CENTRAL_GOVERNMENT_BODY
CIVIL_SOCIETY
COMMUNITY_OF_OWNERS
COMMUNITY_PROPERTY
CONSULATE
COOPERATIVE
DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL
ECONOMIC_INTEREST_GROUP
EMBASSY
ENTITY_MANAGING_NATURAL_AREAS
FARM_PARTNERSHIP
FOUNDATION
GENERAL_AND_LIMITED_PARTNERSHIP
GENERAL_PARTNERSHIP
INDIVIDUAL
LIMITED_COMPANY
LOCAL_AUTHORITY
LOCAL_PUBLIC_ENTITY
MUTUAL_INSURANCE_COMPANY
NATIONAL_PUBLIC_ENTITY
ORDER_OR_RELIGIOUS_INSTITUTION
OTHERS (Only for contacts outside of Spain)
POLITICAL_PARTY
PROFESSIONAL_ASSOCIATION
PUBLIC_LAW_ASSOCIATION
PUBLIC_LIMITED_COMPANY
REGIONAL_GOVERNMENT_BODY
REGIONAL_PUBLIC_ENTITY
SAVINGS_BANK
SPANISH_OFFICE
SPORTS_ASSOCIATION
SPORTS_FEDERATION
SPORTS_LIMITED_COMPANY
TEMPORARY_ALLIANCE_OF_ENTERPRISES
TRADE_UNION
WORKER_OWNED_COMPANY
WORKER_OWNED_LIMITED_COMPANY
BIRTH_DATE_IN_YYYY_MM_DD
FI_BUSINESS_NUMBER
FI_ID_NUMBER
FI_NATIONALITY
Valid values include the following:
FINNISH
NOT_FINNISH
FI_ORGANIZATION_TYPE
Valid values include the following:
COMPANY
CORPORATION
GOVERNMENT
INSTITUTION
POLITICAL_PARTY
PUBLIC_COMMUNITY
TOWNSHIP
BIRTH_CITY
BIRTH_COUNTRY
BIRTH_DATE_IN_YYYY_MM_DD
BIRTH_DEPARTMENT: Specify the INSEE code that corresponds with the department where the contact was born. If the contact was born somewhere other than France or its overseas departments, specify 99. For more information, including a list of departments and the corresponding INSEE numbers, see the Wikipedia entry Departments of France.
BRAND_NUMBER
IT_NATIONALITY
IT_PIN
IT_REGISTRANT_ENTITY_TYPE
Valid values include the following:
FOREIGNERS
FREELANCE_WORKERS (Freelance workers and professionals)
ITALIAN_COMPANIES (Italian companies and one-person companies)
NON_PROFIT_ORGANIZATIONS
OTHER_SUBJECTS
PUBLIC_ORGANIZATIONS
BIRTH_DATE_IN_YYYY_MM_DD
RU_PASSPORT_DATA
BIRTH_COUNTRY
SE_ID_NUMBER
SG_ID_NUMBER
UK_CONTACT_TYPE
Valid values include the following:
CRC (UK Corporation by Royal Charter)
FCORP (Non-UK Corporation)
FIND (Non-UK Individual, representing self)
FOTHER (Non-UK Entity that does not fit into any other category)
GOV (UK Government Body)
IND (UK Individual (representing self))
IP (UK Industrial/Provident Registered Company)
LLP (UK Limited Liability Partnership)
LTD (UK Limited Company)
OTHER (UK Entity that does not fit into any other category)
PLC (UK Public Limited Company)
PTNR (UK Partnership)
RCHAR (UK Registered Charity)
SCH (UK School)
STAT (UK Statutory Body)
STRA (UK Sole Trader)
UK_COMPANY_NUMBER
In addition, many TLDs require a VAT_NUMBER.
Values corresponding to the additional parameter names required by some top-level domains.
" + "documentation":"The value that corresponds with the name of an extra parameter.
" } }, "documentation":"ExtraParam includes the following elements.
" @@ -1030,6 +1141,8 @@ "AU_ID_TYPE", "CA_LEGAL_TYPE", "CA_BUSINESS_ENTITY_TYPE", + "CA_LEGAL_REPRESENTATIVE", + "CA_LEGAL_REPRESENTATIVE_CAPACITY", "ES_IDENTIFICATION", "ES_IDENTIFICATION_TYPE", "ES_LEGAL_FORM", @@ -1037,6 +1150,7 @@ "FI_ID_NUMBER", "FI_NATIONALITY", "FI_ORGANIZATION_TYPE", + "IT_NATIONALITY", "IT_PIN", "IT_REGISTRANT_ENTITY_TYPE", "RU_PASSPORT_DATA", @@ -1157,19 +1271,19 @@ }, "CreationDate":{ "shape":"Timestamp", - "documentation":"The date when the domain was created as found in the response to a WHOIS query. The date and time is in Coordinated Universal time (UTC).
" + "documentation":"The date when the domain was created as found in the response to a WHOIS query. The date and time is in Unix time format and Coordinated Universal time (UTC).
" }, "UpdatedDate":{ "shape":"Timestamp", - "documentation":"The last updated date of the domain as found in the response to a WHOIS query. The date and time is in Coordinated Universal time (UTC).
" + "documentation":"The last updated date of the domain as found in the response to a WHOIS query. The date and time is in Unix time format and Coordinated Universal time (UTC).
" }, "ExpirationDate":{ "shape":"Timestamp", - "documentation":"The date when the registration for the domain is set to expire. The date and time is in Coordinated Universal time (UTC).
" + "documentation":"The date when the registration for the domain is set to expire. The date and time is in Unix time format and Coordinated Universal time (UTC).
" }, "Reseller":{ "shape":"Reseller", - "documentation":"Reseller of the domain. Domains registered or transferred using Amazon Route 53 domains will have \"Amazon\" as the reseller.
Reseller of the domain. Domains registered or transferred using Route 53 domains will have \"Amazon\" as the reseller.
A domain name that you want to use as the basis for a list of possible domain names. The domain name must contain a top-level domain (TLD), such as .com, that Amazon Route 53 supports. For a list of TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.
" + "documentation":"A domain name that you want to use as the basis for a list of possible domain names. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.
The domain name can contain only the following characters:
Letters a through z. Domain names are not case sensitive.
Numbers 0 through 9.
Hyphen (-). You can't specify a hyphen at the beginning or end of a label.
Period (.) to separate the labels in the name, such as the . in example.com.
Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports internationalized domain names, see Domains that You Can Register with Amazon Route 53.
" }, "SuggestionCount":{ "shape":"Integer", - "documentation":"The number of suggested domain names that you want Amazon Route 53 to return.
" + "documentation":"The number of suggested domain names that you want Route 53 to return. Specify a value between 1 and 50.
" }, "OnlyAvailable":{ "shape":"Boolean", - "documentation":"If OnlyAvailable is true, Amazon Route 53 returns only domain names that are available. If OnlyAvailable is false, Amazon Route 53 returns domain names without checking whether they're available to be registered. To determine whether the domain is available, you can call checkDomainAvailability for each suggestion.
If OnlyAvailable is true, Route 53 returns only domain names that are available. If OnlyAvailable is false, Route 53 returns domain names without checking whether they're available to be registered. To determine whether the domain is available, you can call checkDomainAvailability for each suggestion.
The identifier for the operation for which you want to get the status. Amazon Route 53 returned the identifier in the response to the original request.
" + "documentation":"The identifier for the operation for which you want to get the status. Route 53 returned the identifier in the response to the original request.
" } }, - "documentation":"The GetOperationDetail request includes the following element.
" + "documentation":"The GetOperationDetail request includes the following element.
" }, "GetOperationDetailResponse":{ "type":"structure", @@ -1276,7 +1390,7 @@ "documentation":"The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.
" } }, - "documentation":"The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.
", + "documentation":"The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
An optional parameter that lets you get information about all the operations that you submitted after a specified date and time. Specify the date and time in Coordinated Universal time (UTC).
" + "documentation":"An optional parameter that lets you get information about all the operations that you submitted after a specified date and time. Specify the date and time in Unix time format and Coordinated Universal time (UTC).
" }, "Marker":{ "shape":"PageMarker", @@ -1462,7 +1576,9 @@ "TRANSFER_OUT_DOMAIN", "CHANGE_DOMAIN_OWNER", "RENEW_DOMAIN", - "PUSH_DOMAIN" + "PUSH_DOMAIN", + "INTERNAL_TRANSFER_OUT_DOMAIN", + "INTERNAL_TRANSFER_IN_DOMAIN" ] }, "PageMarker":{ @@ -1494,7 +1610,7 @@ "members":{ "DomainName":{ "shape":"DomainName", - "documentation":"The domain name that you want to register.
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
" + "documentation":"The domain name that you want to register. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.
The domain name can contain only the following characters:
Letters a through z. Domain names are not case sensitive.
Numbers 0 through 9.
Hyphen (-). You can't specify a hyphen at the beginning or end of a label.
Period (.) to separate the labels in the name, such as the . in example.com.
Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports internationalized domain names, see Domains that You Can Register with Amazon Route 53. For more information, see Formatting Internationalized Domain Names.
" }, "IdnLangCode":{ "shape":"LangCode", @@ -1502,7 +1618,7 @@ }, "DurationInYears":{ "shape":"DurationInYears", - "documentation":"The number of years that you want to register the domain for. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain. For the range of valid values for your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.
Default: 1
" + "documentation":"The number of years that you want to register the domain for. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain. For the range of valid values for your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.
Default: 1
" }, "AutoRenew":{ "shape":"Boolean", @@ -1510,15 +1626,15 @@ }, "AdminContact":{ "shape":"ContactDetail", - "documentation":"Provides detailed contact information.
" + "documentation":"Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.
" }, "RegistrantContact":{ "shape":"ContactDetail", - "documentation":"Provides detailed contact information.
" + "documentation":"Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.
" }, "TechContact":{ "shape":"ContactDetail", - "documentation":"Provides detailed contact information.
" + "documentation":"Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.
" }, "PrivacyProtectAdminContact":{ "shape":"Boolean", @@ -1541,7 +1657,7 @@ "members":{ "OperationId":{ "shape":"OperationId", - "documentation":"Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
" + "documentation":"Identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail.
" } }, "documentation":"The RegisterDomain response includes the following element.
" @@ -1550,6 +1666,27 @@ "RegistrarUrl":{"type":"string"}, "RegistrarWhoIsServer":{"type":"string"}, "RegistryDomainId":{"type":"string"}, + "RejectDomainTransferFromAnotherAwsAccountRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"The name of the domain that was specified when another AWS account submitted a TransferDomainToAnotherAwsAccount request.
" + } + }, + "documentation":"The RejectDomainTransferFromAnotherAwsAccount request includes the following element.
" + }, + "RejectDomainTransferFromAnotherAwsAccountResponse":{ + "type":"structure", + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"The identifier that TransferDomainToAnotherAwsAccount returned to track the progress of the request. Because the transfer request was rejected, the value is no longer valid, and you can't use GetOperationDetail to query the operation status.
The RejectDomainTransferFromAnotherAwsAccount response includes the following element.
" + }, "RenewDomainRequest":{ "type":"structure", "required":[ @@ -1563,7 +1700,7 @@ }, "DurationInYears":{ "shape":"DurationInYears", - "documentation":"The number of years that you want to renew the domain for. The maximum number of years depends on the top-level domain. For the range of valid values for your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.
Default: 1
" + "documentation":"The number of years that you want to renew the domain for. The maximum number of years depends on the top-level domain. For the range of valid values for your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.
Default: 1
" }, "CurrentExpiryYear":{ "shape":"CurrentExpiryYear", @@ -1578,7 +1715,7 @@ "members":{ "OperationId":{ "shape":"OperationId", - "documentation":"The identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
" + "documentation":"Identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail.
" } } }, @@ -1588,7 +1725,7 @@ "members":{ "domainName":{ "shape":"DomainName", - "documentation":"The name of the domain for which you want Amazon Route 53 to resend a confirmation email to the registrant contact.
" + "documentation":"The name of the domain for which you want Route 53 to resend a confirmation email to the registrant contact.
" } } }, @@ -1684,7 +1821,7 @@ "members":{ "DomainName":{ "shape":"DomainName", - "documentation":"The name of the domain that you want to transfer to Amazon Route 53.
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
" + "documentation":"The name of the domain that you want to transfer to Route 53. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.
The domain name can contain only the following characters:
Letters a through z. Domain names are not case sensitive.
Numbers 0 through 9.
Hyphen (-). You can't specify a hyphen at the beginning or end of a label.
Period (.) to separate the labels in the name, such as the . in example.com.
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
" + "documentation":"Identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail.
" } }, - "documentation":"The TranserDomain response includes the following element.
" + "documentation":"The TransferDomain response includes the following element.
" + }, + "TransferDomainToAnotherAwsAccountRequest":{ + "type":"structure", + "required":[ + "DomainName", + "AccountId" + ], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"The name of the domain that you want to transfer from the current AWS account to another account.
" + }, + "AccountId":{ + "shape":"AccountId", + "documentation":"The account ID of the AWS account that you want to transfer the domain to, for example, 111122223333.
The TransferDomainToAnotherAwsAccount request includes the following elements.
" + }, + "TransferDomainToAnotherAwsAccountResponse":{ + "type":"structure", + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"Identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail.
" + }, + "Password":{ + "shape":"String", + "documentation":"To finish transferring a domain to another AWS account, the account that the domain is being transferred to must submit an AcceptDomainTransferFromAnotherAwsAccount request. The request must include the value of the Password element that was returned in the TransferDomainToAnotherAwsAccount response.
The TransferDomainToAnotherAwsAccount response includes the following elements.
Whether the domain name can be transferred to Amazon Route 53.
You can transfer only domains that have a value of TRANSFERABLE for Transferable.
Valid values:
The domain name can be transferred to Amazon Route 53.
The domain name can't be transferred to Amazon Route 53.
Reserved for future use.
Whether the domain name can be transferred to Route 53.
You can transfer only domains that have a value of TRANSFERABLE for Transferable.
Valid values:
The domain name can be transferred to Route 53.
The domain name can't be transferred to Route 53.
Reserved for future use.
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
" + "documentation":"Identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail.
" } }, "documentation":"The UpdateDomainContact response includes the following element.
" @@ -1861,7 +2030,7 @@ "members":{ "OperationId":{ "shape":"OperationId", - "documentation":"Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
" + "documentation":"Identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail.
" } }, "documentation":"The UpdateDomainNameservers response includes the following element.
" @@ -1891,11 +2060,11 @@ "members":{ "Start":{ "shape":"Timestamp", - "documentation":"The beginning date and time for the time period for which you want a list of billing records. Specify the date and time in Coordinated Universal time (UTC).
" + "documentation":"The beginning date and time for the time period for which you want a list of billing records. Specify the date and time in Unix time format and Coordinated Universal time (UTC).
" }, "End":{ "shape":"Timestamp", - "documentation":"The end date and time for the time period for which you want a list of billing records. Specify the date and time in Coordinated Universal time (UTC).
" + "documentation":"The end date and time for the time period for which you want a list of billing records. Specify the date and time in Unix time format and Coordinated Universal time (UTC).
" }, "Marker":{ "shape":"PageMarker", diff --git a/botocore/data/s3/2006-03-01/examples-1.json b/botocore/data/s3/2006-03-01/examples-1.json index 0ea7e3b0..38a47bb3 100644 --- a/botocore/data/s3/2006-03-01/examples-1.json +++ b/botocore/data/s3/2006-03-01/examples-1.json @@ -1,5 +1,1843 @@ { "version": "1.0", "examples": { + "AbortMultipartUpload": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "bigobject", + "UploadId": "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example aborts a multipart upload.", + "id": "to-abort-a-multipart-upload-1481853354987", + "title": "To abort a multipart upload" + } + ], + "CompleteMultipartUpload": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "bigobject", + "MultipartUpload": { + "Parts": [ + { + "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"", + "PartNumber": "1" + }, + { + "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"", + "PartNumber": "2" + } + ] + }, + "UploadId": "7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--" + }, + "output": { + "Bucket": "acexamplebucket", + "ETag": "\"4d9031c7644d8081c2829f4ea23c55f7-2\"", + "Key": "bigobject", + "Location": "https://examplebucket.s3.amazonaws.com/bigobject" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example completes a multipart upload.", + "id": "to-complete-multipart-upload-1481851590483", + "title": "To complete multipart upload" + } + ], + "CopyObject": [ + { + "input": { + "Bucket": "destinationbucket", + "CopySource": "/sourcebucket/HappyFacejpg", + "Key": "HappyFaceCopyjpg" + }, + "output": { + "CopyObjectResult": { + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "LastModified": "2016-12-15T17:38:53.000Z" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example copies an object from one bucket to another.", + "id": "to-copy-an-object-1481823186878", + "title": "To copy an object" + } + ], + "CreateBucket": [ + { + "input": { + "Bucket": "examplebucket", + "CreateBucketConfiguration": { + "LocationConstraint": "eu-west-1" + } + }, + "output": { + "Location": "http://examplebucket.s3.amazonaws.com/" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a bucket. The request specifies an AWS region where to create the bucket.", + "id": "to-create-a-bucket-in-a-specific-region-1483399072992", + "title": "To create a bucket in a specific region" + }, + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "Location": "/examplebucket" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a bucket.", + "id": "to-create-a-bucket--1472851826060", + "title": "To create a bucket " + } + ], + "CreateMultipartUpload": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "largeobject" + }, + "output": { + "Bucket": "examplebucket", + "Key": "largeobject", + "UploadId": "ibZBv_75gd9r8lH_gqXatLdxMVpAlj6ZQjEs.OwyF3953YdwbcQnMA2BLGn8Lx12fQNICtMw5KyteFeHw.Sjng--" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example initiates a multipart upload.", + "id": "to-initiate-a-multipart-upload-1481836794513", + "title": "To initiate a multipart upload" + } + ], + "DeleteBucket": [ + { + "input": { + "Bucket": "forrandall2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes the specified bucket.", + "id": "to-delete-a-bucket-1473108514262", + "title": "To delete a bucket" + } + ], + "DeleteBucketCors": [ + { + "input": { + "Bucket": "examplebucket" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes CORS configuration on a bucket.", + "id": "to-delete-cors-configuration-on-a-bucket-1483042856112", + "title": "To delete cors configuration on a bucket." + } + ], + "DeleteBucketLifecycle": [ + { + "input": { + "Bucket": "examplebucket" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes lifecycle configuration on a bucket.", + "id": "to-delete-lifecycle-configuration-on-a-bucket-1483043310583", + "title": "To delete lifecycle configuration on a bucket." + } + ], + "DeleteBucketPolicy": [ + { + "input": { + "Bucket": "examplebucket" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes bucket policy on the specified bucket.", + "id": "to-delete-bucket-policy-1483043406577", + "title": "To delete bucket policy" + } + ], + "DeleteBucketReplication": [ + { + "input": { + "Bucket": "example" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes replication configuration set on bucket.", + "id": "to-delete-bucket-replication-configuration-1483043684668", + "title": "To delete bucket replication configuration" + } + ], + "DeleteBucketTagging": [ + { + "input": { + "Bucket": "examplebucket" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes bucket tags.", + "id": "to-delete-bucket-tags-1483043846509", + "title": "To delete bucket tags" + } + ], + "DeleteBucketWebsite": [ + { + "input": { + "Bucket": "examplebucket" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes bucket website configuration.", + "id": "to-delete-bucket-website-configuration-1483043937825", + "title": "To delete bucket website configuration" + } + ], + "DeleteObject": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "objectkey.jpg" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an object from an S3 bucket.", + "id": "to-delete-an-object-1472850136595", + "title": "To delete an object" + }, + { + "input": { + "Bucket": "ExampleBucket", + "Key": "HappyFace.jpg" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an object from a non-versioned bucket.", + "id": "to-delete-an-object-from-a-non-versioned-bucket-1481588533089", + "title": "To delete an object (from a non-versioned bucket)" + } + ], + "DeleteObjectTagging": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "HappyFace.jpg", + "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" + }, + "output": { + "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example removes tag set associated with the specified object version. The request specifies both the object key and object version.", + "id": "to-remove-tag-set-from-an-object-version-1483145285913", + "title": "To remove tag set from an object version" + }, + { + "input": { + "Bucket": "examplebucket", + "Key": "HappyFace.jpg" + }, + "output": { + "VersionId": "null" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the operation removes tag set from the latest object version.", + "id": "to-remove-tag-set-from-an-object-1483145342862", + "title": "To remove tag set from an object" + } + ], + "DeleteObjects": [ + { + "input": { + "Bucket": "examplebucket", + "Delete": { + "Objects": [ + { + "Key": "HappyFace.jpg", + "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b" + }, + { + "Key": "HappyFace.jpg", + "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd" + } + ], + "Quiet": false + } + }, + "output": { + "Deleted": [ + { + "Key": "HappyFace.jpg", + "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd" + }, + { + "Key": "HappyFace.jpg", + "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object versions and returns the key and versions of deleted objects in the response.", + "id": "to-delete-multiple-object-versions-from-a-versioned-bucket-1483147087737", + "title": "To delete multiple object versions from a versioned bucket" + }, + { + "input": { + "Bucket": "examplebucket", + "Delete": { + "Objects": [ + { + "Key": "objectkey1" + }, + { + "Key": "objectkey2" + } + ], + "Quiet": false + } + }, + "output": { + "Deleted": [ + { + "DeleteMarker": "true", + "DeleteMarkerVersionId": "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F", + "Key": "objectkey1" + }, + { + "DeleteMarker": "true", + "DeleteMarkerVersionId": "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt", + "Key": "objectkey2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.", + "id": "to-delete-multiple-objects-from-a-versioned-bucket-1483146248805", + "title": "To delete multiple objects from a versioned bucket" + } + ], + "GetBucketCors": [ + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "CORSRules": [ + { + "AllowedHeaders": [ + "Authorization" + ], + "AllowedMethods": [ + "GET" + ], + "AllowedOrigins": [ + "*" + ], + "MaxAgeSeconds": 3000 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns cross-origin resource sharing (CORS) configuration set on a bucket.", + "id": "to-get-cors-configuration-set-on-a-bucket-1481596855475", + "title": "To get cors configuration set on a bucket" + } + ], + "GetBucketLifecycle": [ + { + "input": { + "Bucket": "acl1" + }, + "output": { + "Rules": [ + { + "Expiration": { + "Days": 1 + }, + "ID": "delete logs", + "Prefix": "123/", + "Status": "Enabled" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example gets ACL on the specified bucket.", + "id": "to-get-a-bucket-acl-1474413606503", + "title": "To get a bucket acl" + } + ], + "GetBucketLifecycleConfiguration": [ + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "Rules": [ + { + "ID": "Rule for TaxDocs/", + "Prefix": "TaxDocs", + "Status": "Enabled", + "Transitions": [ + { + "Days": 365, + "StorageClass": "STANDARD_IA" + } + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves lifecycle configuration on set on a bucket. ", + "id": "to-get-lifecycle-configuration-on-a-bucket-1481666063200", + "title": "To get lifecycle configuration on a bucket" + } + ], + "GetBucketLocation": [ + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "LocationConstraint": "us-west-2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns bucket location.", + "id": "to-get-bucket-location-1481594573609", + "title": "To get bucket location" + } + ], + "GetBucketNotification": [ + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "QueueConfiguration": { + "Event": "s3:ObjectCreated:Put", + "Events": [ + "s3:ObjectCreated:Put" + ], + "Id": "MDQ2OGQ4NDEtOTBmNi00YTM4LTk0NzYtZDIwN2I3NWQ1NjIx", + "Queue": "arn:aws:sqs:us-east-1:acct-id:S3ObjectCreatedEventQueue" + }, + "TopicConfiguration": { + "Event": "s3:ObjectCreated:Copy", + "Events": [ + "s3:ObjectCreated:Copy" + ], + "Id": "YTVkMWEzZGUtNTY1NS00ZmE2LWJjYjktMmRlY2QwODFkNTJi", + "Topic": "arn:aws:sns:us-east-1:acct-id:S3ObjectCreatedEventTopic" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns notification configuration set on a bucket.", + "id": "to-get-notification-configuration-set-on-a-bucket-1481594028667", + "title": "To get notification configuration set on a bucket" + }, + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "QueueConfiguration": { + "Event": "s3:ObjectCreated:Put", + "Events": [ + "s3:ObjectCreated:Put" + ], + "Id": "MDQ2OGQ4NDEtOTBmNi00YTM4LTk0NzYtZDIwN2I3NWQ1NjIx", + "Queue": "arn:aws:sqs:us-east-1:acct-id:S3ObjectCreatedEventQueue" + }, + "TopicConfiguration": { + "Event": "s3:ObjectCreated:Copy", + "Events": [ + "s3:ObjectCreated:Copy" + ], + "Id": "YTVkMWEzZGUtNTY1NS00ZmE2LWJjYjktMmRlY2QwODFkNTJi", + "Topic": "arn:aws:sns:us-east-1:acct-id:S3ObjectCreatedEventTopic" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns notification configuration set on a bucket.", + "id": "to-get-notification-configuration-set-on-a-bucket-1481594028667", + "title": "To get notification configuration set on a bucket" + } + ], + "GetBucketPolicy": [ + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "Policy": "{\"Version\":\"2008-10-17\",\"Id\":\"LogPolicy\",\"Statement\":[{\"Sid\":\"Enables the log delivery group to publish logs to your bucket \",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"111122223333\"},\"Action\":[\"s3:GetBucketAcl\",\"s3:GetObjectAcl\",\"s3:PutObject\"],\"Resource\":[\"arn:aws:s3:::policytest1/*\",\"arn:aws:s3:::policytest1\"]}]}" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns bucket policy associated with a bucket.", + "id": "to-get-bucket-policy-1481595098424", + "title": "To get bucket policy" + } + ], + "GetBucketReplication": [ + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "ReplicationConfiguration": { + "Role": "arn:aws:iam::acct-id:role/example-role", + "Rules": [ + { + "Destination": { + "Bucket": "arn:aws:s3:::destination-bucket" + }, + "ID": "MWIwNTkwZmItMTE3MS00ZTc3LWJkZDEtNzRmODQwYzc1OTQy", + "Prefix": "Tax", + "Status": "Enabled" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns replication configuration set on a bucket.", + "id": "to-get-replication-configuration-set-on-a-bucket-1481593597175", + "title": "To get replication configuration set on a bucket" + } + ], + "GetBucketRequestPayment": [ + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "Payer": "BucketOwner" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves bucket versioning configuration.", + "id": "to-get-bucket-versioning-configuration-1483037183929", + "title": "To get bucket versioning configuration" + } + ], + "GetBucketTagging": [ + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "TagSet": [ + { + "Key": "key1", + "Value": "value1" + }, + { + "Key": "key2", + "Value": "value2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns tag set associated with a bucket", + "id": "to-get-tag-set-associated-with-a-bucket-1481593232107", + "title": "To get tag set associated with a bucket" + } + ], + "GetBucketVersioning": [ + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "MFADelete": "Disabled", + "Status": "Enabled" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves bucket versioning configuration.", + "id": "to-get-bucket-versioning-configuration-1483037183929", + "title": "To get bucket versioning configuration" + } + ], + "GetBucketWebsite": [ + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "ErrorDocument": { + "Key": "error.html" + }, + "IndexDocument": { + "Suffix": "index.html" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves website configuration of a bucket.", + "id": "to-get-bucket-website-configuration-1483037016926", + "title": "To get bucket website configuration" + } + ], + "GetObject": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "HappyFace.jpg" + }, + "output": { + "AcceptRanges": "bytes", + "ContentLength": "3191", + "ContentType": "image/jpeg", + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "LastModified": "Thu, 15 Dec 2016 01:19:41 GMT", + "Metadata": { + }, + "TagCount": 2, + "VersionId": "null" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves an object for an S3 bucket.", + "id": "to-retrieve-an-object-1481827837012", + "title": "To retrieve an object" + }, + { + "input": { + "Bucket": "examplebucket", + "Key": "SampleFile.txt", + "Range": "bytes=0-9" + }, + "output": { + "AcceptRanges": "bytes", + "ContentLength": "10", + "ContentRange": "bytes 0-9/43", + "ContentType": "text/plain", + "ETag": "\"0d94420ffd0bc68cd3d152506b97a9cc\"", + "LastModified": "Thu, 09 Oct 2014 22:57:28 GMT", + "Metadata": { + }, + "VersionId": "null" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.", + "id": "to-retrieve-a-byte-range-of-an-object--1481832674603", + "title": "To retrieve a byte range of an object " + } + ], + "GetObjectAcl": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "HappyFace.jpg" + }, + "output": { + "Grants": [ + { + "Grantee": { + "DisplayName": "owner-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc", + "Type": "CanonicalUser" + }, + "Permission": "WRITE" + }, + { + "Grantee": { + "DisplayName": "owner-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc", + "Type": "CanonicalUser" + }, + "Permission": "WRITE_ACP" + }, + { + "Grantee": { + "DisplayName": "owner-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc", + "Type": "CanonicalUser" + }, + "Permission": "READ" + }, + { + "Grantee": { + "DisplayName": "owner-display-name", + "ID": "852b113eexamplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc", + "Type": "CanonicalUser" + }, + "Permission": "READ_ACP" + } + ], + "Owner": { + "DisplayName": "owner-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves access control list (ACL) of an object.", + "id": "to-retrieve-object-acl-1481833557740", + "title": "To retrieve object ACL" + } + ], + "GetObjectTagging": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "HappyFace.jpg" + }, + "output": { + "TagSet": [ + { + "Key": "Key4", + "Value": "Value4" + }, + { + "Key": "Key3", + "Value": "Value3" + } + ], + "VersionId": "null" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves tag set of an object.", + "id": "to-retrieve-tag-set-of-an-object-1481833847896", + "title": "To retrieve tag set of an object" + }, + { + "input": { + "Bucket": "examplebucket", + "Key": "exampleobject", + "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" + }, + "output": { + "TagSet": [ + { + "Key": "Key1", + "Value": "Value1" + } + ], + "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves tag set of an object. The request specifies object version.", + "id": "to-retrieve-tag-set-of-a-specific-object-version-1483400283663", + "title": "To retrieve tag set of a specific object version" + } + ], + "GetObjectTorrent": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "HappyFace.jpg" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves torrent files of an object.", + "id": "to-retrieve-torrent-files-for-an-object-1481834115959", + "title": "To retrieve torrent files for an object" + } + ], + "HeadBucket": [ + { + "input": { + "Bucket": "acl1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation checks to see if a bucket exists.", + "id": "to-determine-if-bucket-exists-1473110292262", + "title": "To determine if bucket exists" + } + ], + "HeadObject": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "HappyFace.jpg" + }, + "output": { + "AcceptRanges": "bytes", + "ContentLength": "3191", + "ContentType": "image/jpeg", + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "LastModified": "Thu, 15 Dec 2016 01:19:41 GMT", + "Metadata": { + }, + "VersionId": "null" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves an object metadata.", + "id": "to-retrieve-metadata-of-an-object-without-returning-the-object-itself-1481834820480", + "title": "To retrieve metadata of an object without returning the object itself" + } + ], + "ListMultipartUploads": [ + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "Uploads": [ + { + "Initiated": "2014-05-01T05:40:58.000Z", + "Initiator": { + "DisplayName": "display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Key": "JavaFile", + "Owner": { + "DisplayName": "display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "StorageClass": "STANDARD", + "UploadId": "examplelUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--" + }, + { + "Initiated": "2014-05-01T05:41:27.000Z", + "Initiator": { + "DisplayName": "display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Key": "JavaFile", + "Owner": { + "DisplayName": "display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "StorageClass": "STANDARD", + "UploadId": "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example lists in-progress multipart uploads on a specific bucket.", + "id": "to-list-in-progress-multipart-uploads-on-a-bucket-1481852775260", + "title": "To list in-progress multipart uploads on a bucket" + }, + { + "input": { + "Bucket": "examplebucket", + "KeyMarker": "nextkeyfrompreviousresponse", + "MaxUploads": "2", + "UploadIdMarker": "valuefrompreviousresponse" + }, + "output": { + "Bucket": "acl1", + "IsTruncated": true, + "KeyMarker": "", + "MaxUploads": "2", + "NextKeyMarker": "someobjectkey", + "NextUploadIdMarker": "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--", + "UploadIdMarker": "", + "Uploads": [ + { + "Initiated": "2014-05-01T05:40:58.000Z", + "Initiator": { + "DisplayName": "ownder-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Key": "JavaFile", + "Owner": { + "DisplayName": "mohanataws", + "ID": "852b113e7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "StorageClass": "STANDARD", + "UploadId": "gZ30jIqlUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--" + }, + { + "Initiated": "2014-05-01T05:41:27.000Z", + "Initiator": { + "DisplayName": "ownder-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Key": "JavaFile", + "Owner": { + "DisplayName": "ownder-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "StorageClass": "STANDARD", + "UploadId": "b7tZSqIlo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example specifies the upload-id-marker and key-marker from previous truncated response to retrieve next setup of multipart uploads.", + "id": "list-next-set-of-multipart-uploads-when-previous-result-is-truncated-1482428106748", + "title": "List next set of multipart uploads when previous result is truncated" + } + ], + "ListObjectVersions": [ + { + "input": { + "Bucket": "examplebucket", + "Prefix": "HappyFace.jpg" + }, + "output": { + "Versions": [ + { + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "IsLatest": true, + "Key": "HappyFace.jpg", + "LastModified": "2016-12-15T01:19:41.000Z", + "Owner": { + "DisplayName": "owner-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Size": 3191, + "StorageClass": "STANDARD", + "VersionId": "null" + }, + { + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "IsLatest": false, + "Key": "HappyFace.jpg", + "LastModified": "2016-12-13T00:58:26.000Z", + "Owner": { + "DisplayName": "owner-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Size": 3191, + "StorageClass": "STANDARD", + "VersionId": "PHtexPGjH2y.zBgT8LmB7wwLI2mpbz.k" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example return versions of an object with specific key name prefix. The request limits the number of items returned to two. If there are are more than two object version, S3 returns NextToken in the response. You can specify this token value in your next request to fetch next set of object versions.", + "id": "to-list-object-versions-1481910996058", + "title": "To list object versions" + } + ], + "ListObjects": [ + { + "input": { + "Bucket": "examplebucket", + "MaxKeys": "2" + }, + "output": { + "Contents": [ + { + "ETag": "\"70ee1738b6b21e2c8a43f3a5ab0eee71\"", + "Key": "example1.jpg", + "LastModified": "2014-11-21T19:40:05.000Z", + "Owner": { + "DisplayName": "myname", + "ID": "12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Size": 11, + "StorageClass": "STANDARD" + }, + { + "ETag": "\"9c8af9a76df052144598c115ef33e511\"", + "Key": "example2.jpg", + "LastModified": "2013-11-15T01:10:49.000Z", + "Owner": { + "DisplayName": "myname", + "ID": "12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Size": 713193, + "StorageClass": "STANDARD" + } + ], + "NextMarker": "eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example list two objects in a bucket.", + "id": "to-list-objects-in-a-bucket-1473447646507", + "title": "To list objects in a bucket" + } + ], + "ListObjectsV2": [ + { + "input": { + "Bucket": "examplebucket", + "MaxKeys": "2" + }, + "output": { + "Contents": [ + { + "ETag": "\"70ee1738b6b21e2c8a43f3a5ab0eee71\"", + "Key": "happyface.jpg", + "LastModified": "2014-11-21T19:40:05.000Z", + "Size": 11, + "StorageClass": "STANDARD" + }, + { + "ETag": "\"becf17f89c30367a9a44495d62ed521a-1\"", + "Key": "test.jpg", + "LastModified": "2014-05-02T04:51:50.000Z", + "Size": 4192256, + "StorageClass": "STANDARD" + } + ], + "IsTruncated": true, + "KeyCount": "2", + "MaxKeys": "2", + "Name": "examplebucket", + "NextContinuationToken": "1w41l63U0xa8q7smH50vCxyTQqdxo69O3EmK28Bi5PcROI4wI/EyIJg==", + "Prefix": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves object list. The request specifies max keys to limit response to include only 2 object keys. ", + "id": "to-get-object-list", + "title": "To get object list" + } + ], + "ListParts": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "bigobject", + "UploadId": "example7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--" + }, + "output": { + "Initiator": { + "DisplayName": "owner-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Owner": { + "DisplayName": "owner-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Parts": [ + { + "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"", + "LastModified": "2016-12-16T00:11:42.000Z", + "PartNumber": "1", + "Size": 26246026 + }, + { + "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"", + "LastModified": "2016-12-16T00:15:01.000Z", + "PartNumber": "2", + "Size": 26246026 + } + ], + "StorageClass": "STANDARD" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example lists parts uploaded for a specific multipart upload.", + "id": "to-list-parts-of-a-multipart-upload-1481852006923", + "title": "To list parts of a multipart upload." + } + ], + "PutBucketAcl": [ + { + "input": { + "Bucket": "examplebucket", + "GrantFullControl": "id=examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484", + "GrantWrite": "uri=http://acs.amazonaws.com/groups/s3/LogDelivery" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example replaces existing ACL on a bucket. The ACL grants the bucket owner (specified using the owner ID) and write permission to the LogDelivery group. Because this is a replace operation, you must specify all the grants in your request. To incrementally add or remove ACL grants, you might use the console.", + "id": "put-bucket-acl-1482260397033", + "title": "Put bucket acl" + } + ], + "PutBucketCors": [ + { + "input": { + "Bucket": "", + "CORSConfiguration": { + "CORSRules": [ + { + "AllowedHeaders": [ + "*" + ], + "AllowedMethods": [ + "PUT", + "POST", + "DELETE" + ], + "AllowedOrigins": [ + "http://www.example.com" + ], + "ExposeHeaders": [ + "x-amz-server-side-encryption" + ], + "MaxAgeSeconds": 3000 + }, + { + "AllowedHeaders": [ + "Authorization" + ], + "AllowedMethods": [ + "GET" + ], + "AllowedOrigins": [ + "*" + ], + "MaxAgeSeconds": 3000 + } + ] + }, + "ContentMD5": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example enables PUT, POST, and DELETE requests from www.example.com, and enables GET requests from any domain.", + "id": "to-set-cors-configuration-on-a-bucket-1483037818805", + "title": "To set cors configuration on a bucket." + } + ], + "PutBucketLifecycleConfiguration": [ + { + "input": { + "Bucket": "examplebucket", + "LifecycleConfiguration": { + "Rules": [ + { + "Expiration": { + "Days": 3650 + }, + "Filter": { + "Prefix": "documents/" + }, + "ID": "TestOnly", + "Status": "Enabled", + "Transitions": [ + { + "Days": 365, + "StorageClass": "GLACIER" + } + ] + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example replaces existing lifecycle configuration, if any, on the specified bucket. ", + "id": "put-bucket-lifecycle-1482264533092", + "title": "Put bucket lifecycle" + } + ], + "PutBucketLogging": [ + { + "input": { + "Bucket": "sourcebucket", + "BucketLoggingStatus": { + "LoggingEnabled": { + "TargetBucket": "targetbucket", + "TargetGrants": [ + { + "Grantee": { + "Type": "Group", + "URI": "http://acs.amazonaws.com/groups/global/AllUsers" + }, + "Permission": "READ" + } + ], + "TargetPrefix": "MyBucketLogs/" + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example sets logging policy on a bucket. For the Log Delivery group to deliver logs to the destination bucket, it needs permission for the READ_ACP action which the policy grants.", + "id": "set-logging-configuration-for-a-bucket-1482269119909", + "title": "Set logging configuration for a bucket" + } + ], + "PutBucketNotificationConfiguration": [ + { + "input": { + "Bucket": "examplebucket", + "NotificationConfiguration": { + "TopicConfigurations": [ + { + "Events": [ + "s3:ObjectCreated:*" + ], + "TopicArn": "arn:aws:sns:us-west-2:123456789012:s3-notification-topic" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example sets notification configuration on a bucket to publish the object created events to an SNS topic.", + "id": "set-notification-configuration-for-a-bucket-1482270296426", + "title": "Set notification configuration for a bucket" + } + ], + "PutBucketPolicy": [ + { + "input": { + "Bucket": "examplebucket", + "Policy": "{\"Version\": \"2012-10-17\", \"Statement\": [{ \"Sid\": \"id-1\",\"Effect\": \"Allow\",\"Principal\": {\"AWS\": \"arn:aws:iam::123456789012:root\"}, \"Action\": [ \"s3:PutObject\",\"s3:PutObjectAcl\"], \"Resource\": [\"arn:aws:s3:::acl3/*\" ] } ]}" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example sets a permission policy on a bucket.", + "id": "set-bucket-policy-1482448903302", + "title": "Set bucket policy" + } + ], + "PutBucketReplication": [ + { + "input": { + "Bucket": "examplebucket", + "ReplicationConfiguration": { + "Role": "arn:aws:iam::123456789012:role/examplerole", + "Rules": [ + { + "Destination": { + "Bucket": "arn:aws:s3:::destinationbucket", + "StorageClass": "STANDARD" + }, + "Prefix": "", + "Status": "Enabled" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example sets replication configuration on a bucket.", + "id": "id-1", + "title": "Set replication configuration on a bucket" + } + ], + "PutBucketRequestPayment": [ + { + "input": { + "Bucket": "examplebucket", + "RequestPaymentConfiguration": { + "Payer": "Requester" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example sets request payment configuration on a bucket so that person requesting the download is charged.", + "id": "set-request-payment-configuration-on-a-bucket-1482343596680", + "title": "Set request payment configuration on a bucket." + } + ], + "PutBucketTagging": [ + { + "input": { + "Bucket": "examplebucket", + "Tagging": { + "TagSet": [ + { + "Key": "Key1", + "Value": "Value1" + }, + { + "Key": "Key2", + "Value": "Value2" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example sets tags on a bucket. Any existing tags are replaced.", + "id": "set-tags-on-a-bucket-1482346269066", + "title": "Set tags on a bucket" + } + ], + "PutBucketVersioning": [ + { + "input": { + "Bucket": "examplebucket", + "VersioningConfiguration": { + "MFADelete": "Disabled", + "Status": "Enabled" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example sets versioning configuration on bucket. The configuration enables versioning on the bucket.", + "id": "set-versioning-configuration-on-a-bucket-1482344186279", + "title": "Set versioning configuration on a bucket" + } + ], + "PutBucketWebsite": [ + { + "input": { + "Bucket": "examplebucket", + "ContentMD5": "", + "WebsiteConfiguration": { + "ErrorDocument": { + "Key": "error.html" + }, + "IndexDocument": { + "Suffix": "index.html" + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example adds website configuration to a bucket.", + "id": "set-website-configuration-on-a-bucket-1482346836261", + "title": "Set website configuration on a bucket" + } + ], + "PutObject": [ + { + "input": { + "Body": "filetoupload", + "Bucket": "examplebucket", + "Key": "objectkey" + }, + "output": { + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-create-an-object-1483147613675", + "title": "To create an object." + }, + { + "input": { + "Body": "HappyFace.jpg", + "Bucket": "examplebucket", + "Key": "HappyFace.jpg", + "ServerSideEncryption": "AES256", + "StorageClass": "STANDARD_IA" + }, + "output": { + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "ServerSideEncryption": "AES256", + "VersionId": "CG612hodqujkf8FaaNfp8U..FIhLROcp" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example uploads an object. The request specifies optional request headers to directs S3 to use specific storage class and use server-side encryption.", + "id": "to-upload-an-object-(specify-optional-headers)", + "title": "To upload an object (specify optional headers)" + }, + { + "input": { + "ACL": "authenticated-read", + "Body": "filetoupload", + "Bucket": "examplebucket", + "Key": "exampleobject" + }, + "output": { + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "VersionId": "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-upload-an-object-and-specify-canned-acl-1483397779571", + "title": "To upload an object and specify canned ACL." + }, + { + "input": { + "Body": "HappyFace.jpg", + "Bucket": "examplebucket", + "Key": "HappyFace.jpg" + }, + "output": { + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "VersionId": "tpf3zF08nBplQK1XLOefGskR7mGDwcDk" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file syntax. S3 returns VersionId of the newly created object.", + "id": "to-upload-an-object-1481760101010", + "title": "To upload an object" + }, + { + "input": { + "Body": "filetoupload", + "Bucket": "examplebucket", + "Key": "exampleobject", + "Metadata": { + "metadata1": "value1", + "metadata2": "value2" + } + }, + "output": { + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "VersionId": "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-upload-object-and-specify-user-defined-metadata-1483396974757", + "title": "To upload object and specify user-defined metadata" + }, + { + "input": { + "Body": "c:\\HappyFace.jpg", + "Bucket": "examplebucket", + "Key": "HappyFace.jpg", + "Tagging": "key1=value1&key2=value2" + }, + "output": { + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object.", + "id": "to-upload-an-object-and-specify-optional-tags-1481762310955", + "title": "To upload an object and specify optional tags" + }, + { + "input": { + "Body": "filetoupload", + "Bucket": "examplebucket", + "Key": "exampleobject", + "ServerSideEncryption": "AES256", + "Tagging": "key1=value1&key2=value2" + }, + "output": { + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "ServerSideEncryption": "AES256", + "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example uploads and object. The request specifies the optional server-side encryption option. The request also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-upload-an-object-and-specify-server-side-encryption-and-object-tags-1483398331831", + "title": "To upload an object and specify server-side encryption and object tags" + } + ], + "PutObjectAcl": [ + { + "input": { + "AccessControlPolicy": { + }, + "Bucket": "examplebucket", + "GrantFullControl": "emailaddress=user1@example.com,emailaddress=user2@example.com", + "GrantRead": "uri=http://acs.amazonaws.com/groups/global/AllUsers", + "Key": "HappyFace.jpg" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example adds grants to an object ACL. The first permission grants user1 and user2 FULL_CONTROL and the AllUsers group READ permission.", + "id": "to-grant-permissions-using-object-acl-1481835549285", + "title": "To grant permissions using object ACL" + } + ], + "PutObjectTagging": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "HappyFace.jpg", + "Tagging": { + "TagSet": [ + { + "Key": "Key3", + "Value": "Value3" + }, + { + "Key": "Key4", + "Value": "Value4" + } + ] + } + }, + "output": { + "VersionId": "null" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example adds tags to an existing object.", + "id": "to-add-tags-to-an-existing-object-1481764668793", + "title": "To add tags to an existing object" + } + ], + "RestoreObject": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "archivedobjectkey", + "RestoreRequest": { + "Days": 1, + "GlacierJobParameters": { + "Tier": "Expedited" + } + } + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example restores for one day an archived copy of an object back into Amazon S3 bucket.", + "id": "to-restore-an-archived-object-1483049329953", + "title": "To restore an archived object" + } + ], + "UploadPart": [ + { + "input": { + "Body": "fileToUpload", + "Bucket": "examplebucket", + "Key": "examplelargeobject", + "PartNumber": "1", + "UploadId": "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--" + }, + "output": { + "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example uploads part 1 of a multipart upload. The example specifies a file name for the part data. The Upload ID is same that is returned by the initiate multipart upload.", + "id": "to-upload-a-part-1481847914943", + "title": "To upload a part" + } + ], + "UploadPartCopy": [ + { + "input": { + "Bucket": "examplebucket", + "CopySource": "/bucketname/sourceobjectkey", + "Key": "examplelargeobject", + "PartNumber": "1", + "UploadId": "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--" + }, + "output": { + "CopyPartResult": { + "ETag": "\"b0c6f0e7e054ab8fa2536a2677f8734d\"", + "LastModified": "2016-12-29T21:24:43.000Z" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example uploads a part of a multipart upload by copying data from an existing object as data source.", + "id": "to-upload-a-part-by-copying-data-from-an-existing-object-as-data-source-1483046746348", + "title": "To upload a part by copying data from an existing object as data source" + }, + { + "input": { + "Bucket": "examplebucket", + "CopySource": "/bucketname/sourceobjectkey", + "CopySourceRange": "bytes=1-100000", + "Key": "examplelargeobject", + "PartNumber": "2", + "UploadId": "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--" + }, + "output": { + "CopyPartResult": { + "ETag": "\"65d16d19e65a7508a51f043180edcc36\"", + "LastModified": "2016-12-29T21:44:28.000Z" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as data source.", + "id": "to-upload-a-part-by-copying-byte-range-from-an-existing-object-as-data-source-1483048068594", + "title": "To upload a part by copying byte range from an existing object as data source" + } + ] } } diff --git a/botocore/data/sagemaker-a2i-runtime/2019-11-07/service-2.json b/botocore/data/sagemaker-a2i-runtime/2019-11-07/service-2.json index 701d101c..bc9ad98e 100644 --- a/botocore/data/sagemaker-a2i-runtime/2019-11-07/service-2.json +++ b/botocore/data/sagemaker-a2i-runtime/2019-11-07/service-2.json @@ -54,6 +54,7 @@ "output":{"shape":"ListHumanLoopsResponse"}, "errors":[ {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], @@ -121,7 +122,7 @@ "members":{ "HumanLoopName":{ "shape":"HumanLoopName", - "documentation":"The name of the human loop you want to delete.
", + "documentation":"The name of the human loop that you want to delete.
", "location":"uri", "locationName":"HumanLoopName" } @@ -138,7 +139,7 @@ "members":{ "HumanLoopName":{ "shape":"HumanLoopName", - "documentation":"The unique name of the human loop.
", + "documentation":"The name of the human loop that you want information about.
", "location":"uri", "locationName":"HumanLoopName" } @@ -160,19 +161,19 @@ }, "FailureReason":{ "shape":"String", - "documentation":"The reason why a human loop has failed. The failure reason is returned when the human loop status is Failed.
The reason why a human loop failed. The failure reason is returned when the status of the human loop is Failed.
A failure code denoting a specific type of failure.
" + "documentation":"A failure code that identifies the type of failure.
" }, "HumanLoopStatus":{ "shape":"HumanLoopStatus", - "documentation":"The status of the human loop. Valid values:
" + "documentation":"The status of the human loop.
" }, "HumanLoopName":{ "shape":"HumanLoopName", - "documentation":"The name of the human loop.
" + "documentation":"The name of the human loop. The name must be lowercase, unique within the Region in your account, and can have up to 63 characters. Valid characters: a-z, 0-9, and - (hyphen).
" }, "HumanLoopArn":{ "shape":"HumanLoopArn", @@ -184,7 +185,7 @@ }, "HumanLoopOutput":{ "shape":"HumanLoopOutput", - "documentation":"An object containing information about the output of the human loop.
" + "documentation":"An object that contains information about the output of the human loop.
" } } }, @@ -264,7 +265,7 @@ }, "HumanLoopStatus":{ "shape":"HumanLoopStatus", - "documentation":"The status of the human loop. Valid values:
" + "documentation":"The status of the human loop.
" }, "CreationTime":{ "shape":"Timestamp", @@ -272,25 +273,25 @@ }, "FailureReason":{ "shape":"FailureReason", - "documentation":"The reason why the human loop failed. A failure reason is returned only when the status of the human loop is Failed.
The reason why the human loop failed. A failure reason is returned when the status of the human loop is Failed.
The Amazon Resource Name (ARN) of the flow definition.
" + "documentation":"The Amazon Resource Name (ARN) of the flow definition used to configure the human loop.
" } }, "documentation":"Summary information about the human loop.
" }, "InputContent":{ "type":"string", - "max":4194304 + "max":3145728 }, "InternalServerException":{ "type":"structure", "members":{ "Message":{"shape":"FailureReason"} }, - "documentation":"Your request could not be processed.
", + "documentation":"We couldn't process your request because of an issue with the server. Try again later.
", "error":{"httpStatusCode":500}, "exception":true }, @@ -318,19 +319,19 @@ }, "SortOrder":{ "shape":"SortOrder", - "documentation":"An optional value that specifies whether you want the results sorted in Ascending or Descending order.
Optional. The order for displaying results. Valid values: Ascending and Descending.
A token to resume pagination.
", + "documentation":"A token to display the next page of results.
", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"MaxResults", - "documentation":"The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken is returned in the output. You can use this token to display the next page of results.
An array of objects containing information about the human loops.
" + "documentation":"An array of objects that contain information about the human loops.
" }, "NextToken":{ "shape":"NextToken", - "documentation":"A token to resume pagination.
" + "documentation":"A token to display the next page of results.
" } } }, @@ -366,7 +367,7 @@ "members":{ "Message":{"shape":"FailureReason"} }, - "documentation":"We were unable to find the requested resource.
", + "documentation":"We couldn't find the requested resource.
", "error":{"httpStatusCode":404}, "exception":true }, @@ -375,7 +376,7 @@ "members":{ "Message":{"shape":"FailureReason"} }, - "documentation":"You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or request a service quota increase.
", + "documentation":"You exceeded your service quota. Delete some resources or request an increase in your service quota.
", "error":{"httpStatusCode":402}, "exception":true }, @@ -400,15 +401,15 @@ }, "FlowDefinitionArn":{ "shape":"FlowDefinitionArn", - "documentation":"The Amazon Resource Name (ARN) of the flow definition.
" + "documentation":"The Amazon Resource Name (ARN) of the flow definition associated with this human loop.
" }, "HumanLoopInput":{ "shape":"HumanLoopInput", - "documentation":"An object containing information about the human loop.
" + "documentation":"An object that contains information about the human loop.
" }, "DataAttributes":{ "shape":"HumanLoopDataAttributes", - "documentation":"Attributes of the data specified by the customer.
" + "documentation":"Attributes of the specified data. Use DataAttributes to specify if your data is free of personally identifiable information and/or free of adult content.
The name of the human loop you want to stop.
" + "documentation":"The name of the human loop that you want to stop.
" } } }, @@ -442,7 +443,7 @@ "members":{ "Message":{"shape":"FailureReason"} }, - "documentation":"Your request has exceeded the allowed amount of requests.
", + "documentation":"You exceeded the maximum number of requests.
", "error":{"httpStatusCode":429}, "exception":true }, @@ -452,10 +453,10 @@ "members":{ "Message":{"shape":"FailureReason"} }, - "documentation":"Your request was not valid. Check the syntax and try again.
", + "documentation":"The request isn't valid. Check the syntax and try again.
", "error":{"httpStatusCode":400}, "exception":true } }, - "documentation":"Amazon Augmented AI (Augmented AI) (Preview) is a service that adds human judgment to any machine learning application. Human reviewers can take over when an AI application can't evaluate data with a high degree of confidence.
From fraudulent bank transaction identification to document processing to image analysis, machine learning models can be trained to make decisions as well as or better than a human. Nevertheless, some decisions require contextual interpretation, such as when you need to decide whether an image is appropriate for a given audience. Content moderation guidelines are nuanced and highly dependent on context, and they vary between countries. When trying to apply AI in these situations, you can be forced to choose between \"ML only\" systems with unacceptably high error rates or \"human only\" systems that are expensive and difficult to scale, and that slow down decision making.
This API reference includes information about API actions and data types you can use to interact with Augmented AI programmatically.
You can create a flow definition against the Augmented AI API. Provide the Amazon Resource Name (ARN) of a flow definition to integrate AI service APIs, such as Textract.AnalyzeDocument and Rekognition.DetectModerationLabels. These AI services, in turn, invoke the StartHumanLoop API, which evaluates conditions under which humans will be invoked. If humans are required, Augmented AI creates a human loop. Results of human work are available asynchronously in Amazon Simple Storage Service (Amazon S3). You can use Amazon CloudWatch Events to detect human work results.
You can find additional Augmented AI API documentation in the following reference guides: Amazon Rekognition, Amazon SageMaker, and Amazon Textract.
" + "documentation":"Amazon Augmented AI is in preview release and is subject to change. We do not recommend using this product in production environments.
Amazon Augmented AI (Amazon A2I) adds the benefit of human judgment to any machine learning application. When an AI application can't evaluate data with a high degree of confidence, human reviewers can take over. This human review is called a human review workflow. To create and start a human review workflow, you need three resources: a worker task template, a flow definition, and a human loop.
For information about these resources and prerequisites for using Amazon A2I, see Get Started with Amazon Augmented AI in the Amazon SageMaker Developer Guide.
This API reference includes information about API actions and data types that you can use to interact with Amazon A2I programmatically. Use this guide to:
Start a human loop with the StartHumanLoop operation when using Amazon A2I with a custom task type. To learn more about the difference between custom and built-in task types, see Use Task Types . To learn how to start a human loop using this API, see Create and Start a Human Loop for a Custom Task Type in the Amazon SageMaker Developer Guide.
Manage your human loops. You can list all human loops that you have created, describe individual human loops, and stop and delete human loops. To learn more, see Monitor and Manage Your Human Loop in the Amazon SageMaker Developer Guide.
Amazon A2I integrates APIs from various AWS services to create and start human review workflows for those services. To learn how Amazon A2I uses these APIs, see Use APIs in Amazon A2I in the Amazon SageMaker Developer Guide.
" } diff --git a/botocore/data/sagemaker-runtime/2017-05-13/examples-1.json b/botocore/data/sagemaker-runtime/2017-05-13/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/sagemaker-runtime/2017-05-13/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/sagemaker/2017-07-24/examples-1.json b/botocore/data/sagemaker/2017-07-24/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/sagemaker/2017-07-24/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/sagemaker/2017-07-24/service-2.json b/botocore/data/sagemaker/2017-07-24/service-2.json index bebfd2a2..c403c8e4 100644 --- a/botocore/data/sagemaker/2017-07-24/service-2.json +++ b/botocore/data/sagemaker/2017-07-24/service-2.json @@ -74,7 +74,7 @@ {"shape":"ResourceInUse"}, {"shape":"ResourceLimitExceeded"} ], - "documentation":"Creates an AutoPilot job.
" + "documentation":"Creates an AutoPilot job.
After you run an AutoPilot job, you can find the best performing model by calling , and then deploy that model by following the steps described in Step 6.1: Deploy the Model to Amazon SageMaker Hosting Services.
For information about how to use AutoPilot, see Use AutoPilot to Automate Model Development.
" }, "CreateCodeRepository":{ "name":"CreateCodeRepository", @@ -125,7 +125,7 @@ "errors":[ {"shape":"ResourceLimitExceeded"} ], - "documentation":"Creates an endpoint using the endpoint configuration specified in the request. Amazon SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.
Use this API to deploy models using Amazon SageMaker hosting services.
For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (AWS SDK for Python (Boto 3)).
You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.
The endpoint name must be unique within an AWS Region in your AWS account.
When it receives the request, Amazon SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.
When Amazon SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. Amazon SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.
If any of the models hosted at this endpoint get model data from an Amazon S3 location, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provided. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.
" + "documentation":"Creates an endpoint using the endpoint configuration specified in the request. Amazon SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.
Use this API to deploy models using Amazon SageMaker hosting services.
For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (AWS SDK for Python (Boto 3)).
You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.
The endpoint name must be unique within an AWS Region in your AWS account.
When it receives the request, Amazon SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.
When Amazon SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. Amazon SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.
If any of the models hosted at this endpoint get model data from an Amazon S3 location, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provided. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.
" }, "CreateEndpointConfig":{ "name":"CreateEndpointConfig", @@ -138,7 +138,7 @@ "errors":[ {"shape":"ResourceLimitExceeded"} ], - "documentation":"Creates an endpoint configuration that Amazon SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want Amazon SageMaker to provision. Then you call the CreateEndpoint API.
Use this API if you want to use Amazon SageMaker hosting services to deploy models into production.
In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want Amazon SageMaker to provision. This includes the number and type of ML compute instances to deploy.
If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. Amazon SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.
For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (AWS SDK for Python (Boto 3)).
" + "documentation":"Creates an endpoint configuration that Amazon SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want Amazon SageMaker to provision. Then you call the CreateEndpoint API.
Use this API if you want to use Amazon SageMaker hosting services to deploy models into production.
In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want Amazon SageMaker to provision. This includes the number and type of ML compute instances to deploy.
If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. Amazon SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.
For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (AWS SDK for Python (Boto 3)).
" }, "CreateExperiment":{ "name":"CreateExperiment", @@ -293,7 +293,7 @@ }, "input":{"shape":"CreatePresignedNotebookInstanceUrlInput"}, "output":{"shape":"CreatePresignedNotebookInstanceUrlOutput"}, - "documentation":"Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the Amazon SageMaker console, when you choose Open next to a notebook instance, Amazon SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page.
IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.For example, you can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.
The URL that you get from a call to is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the AWS console sign-in page.
Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the Amazon SageMaker console, when you choose Open next to a notebook instance, Amazon SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page.
IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.For example, you can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.
The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the AWS console sign-in page.
Deletes a model. The DeleteModel API deletes only the model entry that was created in Amazon SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model.
Deletes a model. The DeleteModel API deletes only the model entry that was created in Amazon SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model.
Lists models created with the CreateModel API.
" + "documentation":"Lists models created with the CreateModel API.
" }, "ListMonitoringExecutions":{ "name":"ListMonitoringExecutions", @@ -1277,7 +1277,7 @@ }, "input":{"shape":"SearchRequest"}, "output":{"shape":"SearchResponse"}, - "documentation":"Finds Amazon SageMaker resources that match a search query. Matching resource objects are returned as a list of SearchResult objects in the response. You can sort the search results by any resource property in a ascending or descending order.
You can query against the following value types: numeric, text, Boolean, and timestamp.
" + "documentation":"Finds Amazon SageMaker resources that match a search query. Matching resources are returned as a list of SearchRecord objects in the response. You can sort the search results by any resource property in a ascending or descending order.
You can query against the following value types: numeric, text, Boolean, and timestamp.
" }, "StartMonitoringSchedule":{ "name":"StartMonitoringSchedule", @@ -1444,7 +1444,7 @@ "errors":[ {"shape":"ResourceLimitExceeded"} ], - "documentation":"Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss).
When Amazon SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.
You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.
Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss).
When Amazon SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.
You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.
Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, Amazon SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.
Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, Amazon SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.
To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases:
You use one of the Amazon SageMaker built-in algorithms
You use one of the following Prebuilt Amazon SageMaker Docker Images:
Tensorflow (version >= 1.15)
MXNet (version >= 1.6)
PyTorch (version >= 1.3)
You specify at least one MetricDefinition
Specifies the training algorithm to use in a CreateTrainingJob request.
For more information about algorithms provided by Amazon SageMaker, see Algorithms. For information about using your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.
" + "documentation":"Specifies the training algorithm to use in a CreateTrainingJob request.
For more information about algorithms provided by Amazon SageMaker, see Algorithms. For information about using your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.
" }, "AlgorithmStatus":{ "type":"string", @@ -1804,7 +1804,7 @@ "members":{ "AnnotationConsolidationLambdaArn":{ "shape":"LambdaFunctionArn", - "documentation":"The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation.
For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions:
Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.
arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox
arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox
arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox
arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox
arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox
arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox
arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox
Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass
arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass
arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass
arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass
arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass
arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass
arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass
arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass
Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as \"votes\" for the correct label.
arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation
Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass
arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass
arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass
arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass
arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass
arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass
arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass
arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass
Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.
arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition
arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition
arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition
arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition
arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition
arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition
arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition
arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition
Bounding box verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox
arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox
arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox
arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox
arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox
arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox
arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox
Semantic segmentation verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation
Bounding box adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.
arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox
Semantic segmentation adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as \"votes\" for the correct label.
arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation
For more information, see Annotation Consolidation.
" + "documentation":"The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation.
For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions:
Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.
arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox
arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox
arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox
arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox
arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox
arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox
arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox
Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass
arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass
arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass
arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass
arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass
arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass
arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass
arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass
Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel
arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel
arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel
arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel
arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel
arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel
arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel
arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel
Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as \"votes\" for the correct label.
arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation
Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass
arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass
arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass
arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass
arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass
arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass
arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass
arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass
Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel
arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel
arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel
arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel
arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel
arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel
arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel
arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel
Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.
arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition
arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition
arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition
arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition
arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition
arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition
arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition
arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition
Bounding box verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox
arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox
arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox
arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox
arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox
arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox
arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox
Semantic segmentation verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation
Bounding box adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.
arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox
Semantic segmentation adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as \"votes\" for the correct label.
arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation
For more information, see Annotation Consolidation.
" } }, "documentation":"Configures how labels are consolidated across human workers.
" @@ -2125,7 +2125,7 @@ "members":{ "S3DataSource":{ "shape":"AutoMLS3DataSource", - "documentation":"The Amazon S3 location of the data.
" + "documentation":"The Amazon S3 location of the input data.
The input data must be in CSV format and contain at least 1000 rows.
The data source for the AutoPilot job.
" @@ -3146,7 +3146,7 @@ }, "InputDataConfig":{ "shape":"AutoMLInputDataConfig", - "documentation":"Similar to InputDataConfig supported by Tuning. Format(s) supported: CSV.
" + "documentation":"Similar to InputDataConfig supported by Tuning. Format(s) supported: CSV. Minimum of 1000 rows.
" }, "OutputDataConfig":{ "shape":"AutoMLOutputDataConfig", @@ -3319,7 +3319,7 @@ "members":{ "EndpointConfigName":{ "shape":"EndpointConfigName", - "documentation":"The name of the endpoint configuration. You specify this name in a CreateEndpoint request.
" + "documentation":"The name of the endpoint configuration. You specify this name in a CreateEndpoint request.
" }, "ProductionVariants":{ "shape":"ProductionVariantList", @@ -3359,7 +3359,7 @@ }, "EndpointConfigName":{ "shape":"EndpointConfigName", - "documentation":"The name of an endpoint configuration. For more information, see CreateEndpointConfig.
" + "documentation":"The name of an endpoint configuration. For more information, see CreateEndpointConfig.
" }, "Tags":{ "shape":"TagList", @@ -3421,6 +3421,10 @@ "shape":"FlowDefinitionName", "documentation":"The name of your flow definition.
" }, + "HumanLoopRequestSource":{ + "shape":"HumanLoopRequestSource", + "documentation":"Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source.
" + }, "HumanLoopActivationConfig":{ "shape":"HumanLoopActivationConfig", "documentation":"An object containing information about the events that trigger a human workflow.
" @@ -3494,7 +3498,7 @@ }, "HyperParameterTuningJobConfig":{ "shape":"HyperParameterTuningJobConfig", - "documentation":"The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job. For more information, see automatic-model-tuning
" + "documentation":"The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job. For more information, see How Hyperparameter Tuning Works.
" }, "TrainingJobDefinition":{ "shape":"HyperParameterTrainingJobDefinition", @@ -3616,7 +3620,7 @@ }, "VpcConfig":{ "shape":"VpcConfig", - "documentation":"A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud.
A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud.
(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
" + "documentation":"(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
" } } }, @@ -3907,7 +3911,7 @@ }, "Tags":{ "shape":"TagList", - "documentation":"(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
" + "documentation":"(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
" }, "ExperimentConfig":{"shape":"ExperimentConfig"} } @@ -4036,7 +4040,7 @@ }, "BatchStrategy":{ "shape":"BatchStrategy", - "documentation":"Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.
To enable the batch strategy, you must set the SplitType property of the DataProcessing object to Line, RecordIO, or TFRecord.
To use only one record when making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and SplitType to Line.
To fit as many records in a mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line.
Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.
To enable the batch strategy, you must set the SplitType property to Line, RecordIO, or TFRecord.
To use only one record when making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and SplitType to Line.
To fit as many records in a mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line.
The timestamp when the flow definition was created.
" }, + "HumanLoopRequestSource":{ + "shape":"HumanLoopRequestSource", + "documentation":"Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source.
" + }, "HumanLoopActivationConfig":{ "shape":"HumanLoopActivationConfig", "documentation":"An object containing information about what triggers a human review workflow.
" @@ -6851,7 +6860,7 @@ "EnvironmentArn":{ "type":"string", "max":256, - "pattern":"^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:environment/[a-z0-9](-*[a-z0-9]){0,62}$" + "pattern":"^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:environment/[a-z0-9]([-.]?[a-z0-9])*$" }, "EnvironmentKey":{ "type":"string", @@ -6921,7 +6930,7 @@ "documentation":"The list of tags that are associated with the experiment. You can use Search API to search on the tags.
" } }, - "documentation":"A summary of the properties of an experiment as returned by the Search API.
" + "documentation":"The properties of an experiment as returned by the Search API.
" }, "ExperimentArn":{ "type":"string", @@ -7065,18 +7074,18 @@ "members":{ "Name":{ "shape":"ResourcePropertyName", - "documentation":"A property name. For example, TrainingJobName. For the list of valid property names returned in a search result for each supported resource, see TrainingJob properties. You must specify a valid property name for the resource.
A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.
A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
The specified resource in Name equals the specified Value.
The specified resource in Name does not equal the specified Value.
The specified resource in Name is greater than the specified Value. Not supported for text-based properties.
The specified resource in Name is greater than or equal to the specified Value. Not supported for text-based properties.
The specified resource in Name is less than the specified Value. Not supported for text-based properties.
The specified resource in Name is less than or equal to the specified Value. Not supported for text-based properties.
Only supported for text-based properties. The word-list of the property contains the specified Value. A SearchExpression can include only one Contains operator.
If you have specified a filter Value, the default is Equals.
A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
The value of Name equals Value.
The value of Name doesn't equal Value.
The value of Name is greater than Value. Not supported for text properties.
The value of Name is greater than or equal to Value. Not supported for text properties.
The value of Name is less than Value. Not supported for text properties.
The value of Name is less than or equal to Value. Not supported for text properties.
The value of Name contains the string Value. A SearchExpression can include only one Contains operator. Only supported for text properties.
The Name property exists.
The Name property does not exist.
The value of Name is one of the comma delimited strings in Value. Only supported for text properties.
A value used with Resource and Operator to determine if objects satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.
A value used with Name and Operator to determine which resources satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.
A conditional statement for a search expression that includes a resource property, a Boolean operator, and a value.
If you don't specify an Operator and a Value, the filter searches for only the specified property. For example, defining a Filter for the FailureReason for the TrainingJob Resource searches for training job objects that have a value in the FailureReason field.
If you specify a Value, but not an Operator, Amazon SageMaker uses the equals operator as the default.
In search, there are several property types:
To define a metric filter, enter a value using the form \"Metrics.<name>\", where <name> is a metric name. For example, the following filter searches for training jobs with an \"accuracy\" metric greater than \"0.9\":
{
\"Name\": \"Metrics.accuracy\",
\"Operator\": \"GREATER_THAN\",
\"Value\": \"0.9\"
}
To define a hyperparameter filter, enter a value with the form \"HyperParameters.<name>\". Decimal hyperparameter values are treated as a decimal in a comparison if the specified Value is also a decimal value. If the specified Value is an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a \"learning_rate\" hyperparameter that is less than \"0.5\":
{
\"Name\": \"HyperParameters.learning_rate\",
\"Operator\": \"LESS_THAN\",
\"Value\": \"0.5\"
}
To define a tag filter, enter a value with the form \"Tags.<key>\".
A conditional statement for a search expression that includes a resource property, a Boolean operator, and a value. Resources that match the statement are returned in the results from the Search API.
If you specify a Value, but not an Operator, Amazon SageMaker uses the equals operator.
In search, there are several property types:
To define a metric filter, enter a value using the form \"Metrics.<name>\", where <name> is a metric name. For example, the following filter searches for training jobs with an \"accuracy\" metric greater than \"0.9\":
{
\"Name\": \"Metrics.accuracy\",
\"Operator\": \"GreaterThan\",
\"Value\": \"0.9\"
}
To define a hyperparameter filter, enter a value with the form \"HyperParameters.<name>\". Decimal hyperparameter values are treated as a decimal in a comparison if the specified Value is also a decimal value. If the specified Value is an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a \"learning_rate\" hyperparameter that is less than \"0.5\":
{
\"Name\": \"HyperParameters.learning_rate\",
\"Operator\": \"LessThan\",
\"Value\": \"0.5\"
}
To define a tag filter, enter a value with the form Tags.<key>.
The name of the Amazon SageMaker resource to Search for.
" + "documentation":"The name of the Amazon SageMaker resource to search for.
" }, "SuggestionQuery":{ "shape":"SuggestionQuery", @@ -7337,23 +7346,16 @@ "members":{ "HumanLoopActivationConditions":{ "shape":"HumanLoopActivationConditions", - "documentation":"JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. The set of conditions is different for Rekognition and Textract.
", + "documentation":"JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. The set of conditions is different for Rekognition and Textract. For more information about how to structure the JSON, see JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI in the Amazon SageMaker Developer Guide.
", "jsonvalue":true } }, - "documentation":"Defines under what conditions SageMaker creates a human loop. Used within .
" + "documentation":"Defines under what conditions SageMaker creates a human loop. Used within . See for the required format of activation conditions.
" }, "HumanLoopActivationConfig":{ "type":"structure", - "required":[ - "HumanLoopRequestSource", - "HumanLoopActivationConditionsConfig" - ], + "required":["HumanLoopActivationConditionsConfig"], "members":{ - "HumanLoopRequestSource":{ - "shape":"HumanLoopRequestSource", - "documentation":"Container for configuring the source of human task requests.
" - }, "HumanLoopActivationConditionsConfig":{ "shape":"HumanLoopActivationConditionsConfig", "documentation":"Container structure for defining under what conditions SageMaker creates a human loop.
" @@ -7441,7 +7443,7 @@ }, "PreHumanTaskLambdaArn":{ "shape":"LambdaFunctionArn", - "documentation":"The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.
For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions:
US East (Northern Virginia) (us-east-1):
arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox
arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass
arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation
arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass
arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition
arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox
arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation
US East (Ohio) (us-east-2):
arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox
arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass
arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass
arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition
arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox
arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation
US West (Oregon) (us-west-2):
arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox
arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass
arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass
arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition
arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox
arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation
Canada (Central) (ca-central-1):
arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox
arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass
arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass
arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition
arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox
arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation
EU (Ireland) (eu-west-1):
arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass
arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass
arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition
arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation
EU (London) (eu-west-2):
arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox
arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass
arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass
arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition
arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox
arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation
EU Frankfurt (eu-central-1):
arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox
arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass
arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass
arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition
arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox
arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation
Asia Pacific (Tokyo) (ap-northeast-1):
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation
Asia Pacific (Seoul) (ap-northeast-2):
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation
Asia Pacific (Mumbai) (ap-south-1):
arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox
arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass
arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass
arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation
Asia Pacific (Singapore) (ap-southeast-1):
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation
Asia Pacific (Sydney) (ap-southeast-2):
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation
The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.
For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions:
US East (Northern Virginia) (us-east-1):
arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox
arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass
arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation
arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass
arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition
arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox
arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation
US East (Ohio) (us-east-2):
arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox
arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass
arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass
arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition
arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox
arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation
US West (Oregon) (us-west-2):
arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox
arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass
arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass
arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition
arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox
arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation
Canada (Central) (ca-central-1):
arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox
arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass
arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass
arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition
arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox
arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation
EU (Ireland) (eu-west-1):
arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass
arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass
arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition
arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation
EU (London) (eu-west-2):
arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox
arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass
arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass
arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition
arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox
arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation
EU Frankfurt (eu-central-1):
arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox
arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass
arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass
arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition
arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox
arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation
Asia Pacific (Tokyo) (ap-northeast-1):
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation
Asia Pacific (Seoul) (ap-northeast-2):
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation
Asia Pacific (Mumbai) (ap-south-1):
arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox
arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass
arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass
arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation
Asia Pacific (Singapore) (ap-southeast-1):
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation
Asia Pacific (Sydney) (ap-southeast-2):
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation
The length of time that a task remains available for labeling by human workers. If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43200). The default value is 864000 seconds (1 day). For private and vendor workforces, the maximum is as listed.
" + "documentation":"The length of time that a task remains available for labeling by human workers. If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43200). The default value is 864000 seconds (10 days). For private and vendor workforces, the maximum is as listed.
" }, "MaxConcurrentTaskCount":{ "shape":"MaxConcurrentTaskCount", @@ -8124,6 +8126,7 @@ }, "JsonContentType":{ "type":"string", + "max":256, "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*" }, @@ -10837,7 +10840,7 @@ "documentation":"A list of filters. Each filter acts on a property. Filters must contain at least one Filters value. For example, a NestedFilters call might include a filter on the PropertyName parameter of the InputDataConfig property: InputDataConfig.DataSource.S3DataSource.S3Uri.
Defines a list of NestedFilters objects. To satisfy the conditions specified in the NestedFilters call, a resource must satisfy the conditions of all of the filters.
For example, you could define a NestedFilters using the training job's InputDataConfig property to filter on Channel objects.
A NestedFilters object contains multiple filters. For example, to find all training jobs whose name contains train and that have cat/data in their S3Uri (specified in InputDataConfig), you need to create a NestedFilters object that specifies the InputDataConfig property with the following Filter objects:
'{Name:\"InputDataConfig.ChannelName\", \"Operator\":\"EQUALS\", \"Value\":\"train\"}',
'{Name:\"InputDataConfig.DataSource.S3DataSource.S3Uri\", \"Operator\":\"CONTAINS\", \"Value\":\"cat/data\"}'
A list of nested Filter objects. A resource must satisfy the conditions of all filters to be included in the results returned from the Search API.
For example, to filter on a training job's InputDataConfig property with a specific channel name and S3Uri prefix, define the following filters:
'{Name:\"InputDataConfig.ChannelName\", \"Operator\":\"Equals\", \"Value\":\"train\"}',
'{Name:\"InputDataConfig.DataSource.S3DataSource.S3Uri\", \"Operator\":\"Contains\", \"Value\":\"mybucket/catdata\"}'
For each input, data is downloaded from S3 into the processing container before the processing job begins running if \"S3InputMode\" is set to File.
The name of the processing job.
" + }, + "ProcessingResources":{"shape":"ProcessingResources"}, + "StoppingCondition":{"shape":"ProcessingStoppingCondition"}, + "AppSpecification":{"shape":"AppSpecification"}, + "Environment":{ + "shape":"ProcessingEnvironmentMap", + "documentation":"Sets the environment variables in the Docker container.
" + }, + "NetworkConfig":{"shape":"NetworkConfig"}, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"The ARN of the role used to create the processing job.
" + }, + "ExperimentConfig":{"shape":"ExperimentConfig"}, + "ProcessingJobArn":{ + "shape":"ProcessingJobArn", + "documentation":"The ARN of the processing job.
" + }, + "ProcessingJobStatus":{ + "shape":"ProcessingJobStatus", + "documentation":"The status of the processing job.
" + }, + "ExitMessage":{ + "shape":"ExitMessage", + "documentation":"A string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
" + }, + "FailureReason":{ + "shape":"FailureReason", + "documentation":"A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
" + }, + "ProcessingEndTime":{ + "shape":"Timestamp", + "documentation":"The time that the processing job ended.
" + }, + "ProcessingStartTime":{ + "shape":"Timestamp", + "documentation":"The time that the processing job started.
" + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"The time the processing job was last modified.
" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"The time the processing job was created.
" + }, + "MonitoringScheduleArn":{ + "shape":"MonitoringScheduleArn", + "documentation":"The ARN of a monitoring schedule for an endpoint associated with this processing job.
" + }, + "AutoMLJobArn":{ + "shape":"AutoMLJobArn", + "documentation":"The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.
" + }, + "TrainingJobArn":{ + "shape":"TrainingJobArn", + "documentation":"The ARN of the training job associated with this processing job.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
" + } + }, + "documentation":"An Amazon SageMaker processing job that is used to analyze data and evaluate models. For more information, see Process Data and Evaluate Models.
" + }, "ProcessingJobArn":{ "type":"string", "max":256, @@ -11576,7 +11656,7 @@ }, "S3InputMode":{ "shape":"ProcessingS3InputMode", - "documentation":"Wether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.
Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.
Whether to use Gzip compresion for Amazon S3 storage.
Whether to use Gzip compression for Amazon S3 storage.
Information about where and how you want to obtain the inputs for an processing job.
" @@ -12226,22 +12306,22 @@ "members":{ "TrainingJob":{ "shape":"TrainingJob", - "documentation":"A TrainingJob object that is returned as part of a Search request.
The properties of a training job.
" }, "Experiment":{ "shape":"Experiment", - "documentation":"A summary of the properties of an experiment.
" + "documentation":"The properties of an experiment.
" }, "Trial":{ "shape":"Trial", - "documentation":"A summary of the properties of a trial.
" + "documentation":"The properties of a trial.
" }, "TrialComponent":{ "shape":"TrialComponent", - "documentation":"A summary of the properties of a trial component.
" + "documentation":"The properties of a trial component.
" } }, - "documentation":"An individual search result record that contains a single resource object.
" + "documentation":"A single resource returned as part of the Search API response.
" }, "SearchRequest":{ "type":"structure", @@ -12253,7 +12333,7 @@ }, "SearchExpression":{ "shape":"SearchExpression", - "documentation":"A Boolean conditional statement. Resource objects must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.
A Boolean conditional statement. Resources must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.
If more than MaxResults resource objects match the specified SearchExpression, the SearchResponse includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results for the specified SearchExpression and Sort parameters.
If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.
The maximum number of results to return in a SearchResponse.
The maximum number of results to return.
", "box":true } } @@ -12279,7 +12359,7 @@ "members":{ "Results":{ "shape":"SearchResultsList", - "documentation":"A list of SearchResult objects.
A list of SearchRecord objects.
When true, enables managed spot training using Amazon EC2 Spot instances to run training jobs instead of on-demand instances. For more information, see model-managed-spot-training.
" + "documentation":"When true, enables managed spot training using Amazon EC2 Spot instances to run training jobs instead of on-demand instances. For more information, see Managed Spot Training.
" }, "CheckpointConfig":{"shape":"CheckpointConfig"}, "TrainingTimeInSeconds":{ @@ -13536,7 +13622,7 @@ "documentation":"A list of the components associated with the trial. For each component, a summary of the component's properties is included.
" } }, - "documentation":"A summary of the properties of a trial as returned by the Search API.
" + "documentation":"The properties of a trial as returned by the Search API.
" }, "TrialArn":{ "type":"string", @@ -13558,7 +13644,10 @@ "shape":"TrialComponentArn", "documentation":"The Amazon Resource Name (ARN) of the trial component.
" }, - "Source":{"shape":"TrialComponentSource"}, + "Source":{ + "shape":"TrialComponentSource", + "documentation":"The Amazon Resource Name (ARN) and job type of the source of the component.
" + }, "Status":{"shape":"TrialComponentStatus"}, "StartTime":{ "shape":"Timestamp", @@ -13596,7 +13685,7 @@ }, "SourceDetail":{ "shape":"TrialComponentSourceDetail", - "documentation":"The source of the trial component.>
" + "documentation":"Details of the source of the component.
" }, "Tags":{ "shape":"TagList", @@ -13607,7 +13696,7 @@ "documentation":"An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.
" } }, - "documentation":"A summary of the properties of a trial component as returned by the Search API.
" + "documentation":"The properties of a trial component as returned by the Search API.
" }, "TrialComponentArn":{ "type":"string", @@ -13721,7 +13810,9 @@ "enum":[ "InProgress", "Completed", - "Failed" + "Failed", + "Stopping", + "Stopped" ] }, "TrialComponentSimpleSummaries":{ @@ -13754,14 +13845,14 @@ "members":{ "SourceArn":{ "shape":"TrialComponentSourceArn", - "documentation":"The Amazon Resource Name (ARN) of the source.
" + "documentation":"The source ARN.
" }, "SourceType":{ "shape":"SourceType", "documentation":"The source job type.
" } }, - "documentation":"The source of the trial component.
" + "documentation":"The Amazon Resource Name (ARN) and job type of the source of a trial component.
" }, "TrialComponentSourceArn":{ "type":"string", @@ -13775,9 +13866,16 @@ "shape":"TrialComponentSourceArn", "documentation":"The Amazon Resource Name (ARN) of the source.
" }, - "TrainingJob":{"shape":"TrainingJob"} + "TrainingJob":{ + "shape":"TrainingJob", + "documentation":"Information about a training job that's the source of a trial component.
" + }, + "ProcessingJob":{ + "shape":"ProcessingJob", + "documentation":"Information about a processing job that's the source of a trial component.
" + } }, - "documentation":"Detailed information about the source of a trial component.
" + "documentation":"Detailed information about the source of a trial component. Either ProcessingJob or TrainingJob is returned.
The SHA 256 hash that you used to create the request signature.
" + "documentation":"The SHA-256 digest of the contents of the template.
" } }, "documentation":"Container for user interface template information.
" @@ -14033,7 +14131,7 @@ }, "ExcludeRetainedVariantProperties":{ "shape":"VariantPropertyList", - "documentation":"When you are updating endpoint resources with RetainAllVariantProperties, whose value is set to true, ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig. If you don't specify a value for ExcludeAllVariantProperties, no variant properties are overridden.
When you are updating endpoint resources with UpdateEndpointInput$RetainAllVariantProperties, whose value is set to true, ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig. If you don't specify a value for ExcludeAllVariantProperties, no variant properties are overridden.
The type of variant property. The supported values are:
DesiredInstanceCount: Overrides the existing variant instance counts using the InitialInstanceCount values in the ProductionVariants.
DesiredWeight: Overrides the existing variant weights using the InitialVariantWeight values in the ProductionVariants.
DataCaptureConfig: (Not currently supported.)
The type of variant property. The supported values are:
DesiredInstanceCount: Overrides the existing variant instance counts using the ProductionVariant$InitialInstanceCount values in the CreateEndpointConfigInput$ProductionVariants.
DesiredWeight: Overrides the existing variant weights using the ProductionVariant$InitialVariantWeight values in the CreateEndpointConfigInput$ProductionVariants.
DataCaptureConfig: (Not currently supported.)
Specifies a production variant property type for an Endpoint.
If you are updating an endpoint with the RetainAllVariantProperties option set to true, the VariantProperty objects listed in ExcludeRetainedVariantProperties override the existing variant properties of the endpoint.
Specifies a production variant property type for an Endpoint.
If you are updating an endpoint with the UpdateEndpointInput$RetainAllVariantProperties option set to true, the VariantProperty objects listed in UpdateEndpointInput$ExcludeRetainedVariantProperties override the existing variant properties of the endpoint.
Provides APIs for creating and managing Amazon SageMaker resources.
" + "documentation":"Provides APIs for creating and managing Amazon SageMaker resources.
Other Resources:
" } diff --git a/botocore/data/secretsmanager/2017-10-17/examples-1.json b/botocore/data/secretsmanager/2017-10-17/examples-1.json new file mode 100644 index 00000000..fb14a047 --- /dev/null +++ b/botocore/data/secretsmanager/2017-10-17/examples-1.json @@ -0,0 +1,552 @@ +{ + "version": "1.0", + "examples": { + "CancelRotateSecret": [ + { + "input": { + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "Name" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to cancel rotation for a secret. The operation sets the RotationEnabled field to false and cancels all scheduled rotations. To resume scheduled rotations, you must re-enable rotation by calling the rotate-secret operation.", + "id": "to-cancel-scheduled-rotation-for-a-secret-1523996016032", + "title": "To cancel scheduled rotation for a secret" + } + ], + "CreateSecret": [ + { + "input": { + "ClientRequestToken": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", + "Description": "My test database secret created with the CLI", + "Name": "MyTestDatabaseSecret", + "SecretString": "{\"username\":\"david\",\"password\":\"BnQw!XDWgaEeT9XGTT29\"}" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to create a secret. The credentials stored in the encrypted secret value are retrieved from a file on disk named mycreds.json.", + "id": "to-create-a-basic-secret-1523996473658", + "title": "To create a basic secret" + } + ], + "DeleteResourcePolicy": [ + { + "input": { + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseMasterSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to delete the resource-based policy that is attached to a secret.", + "id": "to-delete-the-resource-based-policy-attached-to-a-secret-1530209419204", + "title": "To delete the resource-based policy attached to a secret" + } + ], + "DeleteSecret": [ + { + "input": { + "RecoveryWindowInDays": 7, + "SecretId": "MyTestDatabaseSecret1" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "DeletionDate": "1524085349.095", + "Name": "MyTestDatabaseSecret" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to delete a secret. The secret stays in your account in a deprecated and inaccessible state until the recovery window ends. After the date and time in the DeletionDate response field has passed, you can no longer recover this secret with restore-secret.", + "id": "to-delete-a-secret-1523996905092", + "title": "To delete a secret" + } + ], + "DescribeSecret": [ + { + "input": { + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Description": "My test database secret", + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/EXAMPLE1-90ab-cdef-fedc-ba987KMSKEY1", + "LastAccessedDate": "1523923200", + "LastChangedDate": 1523477145.729, + "LastRotatedDate": 1525747253.72, + "Name": "MyTestDatabaseSecret", + "RotationEnabled": true, + "RotationLambdaARN": "arn:aws:lambda:us-west-2:123456789012:function:MyTestRotationLambda", + "RotationRules": { + "AutomaticallyAfterDays": 30 + }, + "Tags": [ + { + "Key": "SecondTag", + "Value": "AnotherValue" + }, + { + "Key": "FirstTag", + "Value": "SomeValue" + } + ], + "VersionIdsToStages": { + "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE": [ + "AWSPREVIOUS" + ], + "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE": [ + "AWSCURRENT" + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to get the details about a secret.", + "id": "to-retrieve-the-details-of-a-secret-1524000138629", + "title": "To retrieve the details of a secret" + } + ], + "GetRandomPassword": [ + { + "input": { + "IncludeSpace": true, + "PasswordLength": 20, + "RequireEachIncludedType": true + }, + "output": { + "RandomPassword": "N+Z43a,>vx7j O8^*<8i3" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to request a randomly generated password. This example includes the optional flags to require spaces and at least one character of each included type. It specifies a length of 20 characters.", + "id": "to-generate-a-random-password-1524000546092", + "title": "To generate a random password" + } + ], + "GetResourcePolicy": [ + { + "input": { + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "ResourcePolicy": "{\n\"Version\":\"2012-10-17\",\n\"Statement\":[{\n\"Effect\":\"Allow\",\n\"Principal\":{\n\"AWS\":\"arn:aws:iam::123456789012:root\"\n},\n\"Action\":\"secretsmanager:GetSecretValue\",\n\"Resource\":\"*\"\n}]\n}" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to retrieve the resource-based policy that is attached to a secret.", + "id": "to-retrieve-the-resource-based-policy-attached-to-a-secret-1530209677536", + "title": "To retrieve the resource-based policy attached to a secret" + } + ], + "GetSecretValue": [ + { + "input": { + "SecretId": "MyTestDatabaseSecret", + "VersionStage": "AWSPREVIOUS" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "CreatedDate": 1523477145.713, + "Name": "MyTestDatabaseSecret", + "SecretString": "{\n \"username\":\"david\",\n \"password\":\"BnQw&XDWgaEeT9XGTT29\"\n}\n", + "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", + "VersionStages": [ + "AWSPREVIOUS" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to retrieve the secret string value from the version of the secret that has the AWSPREVIOUS staging label attached. If you want to retrieve the AWSCURRENT version of the secret, then you can omit the VersionStage parameter because it defaults to AWSCURRENT.", + "id": "to-retrieve-the-encrypted-secret-value-of-a-secret-1524000702484", + "title": "To retrieve the encrypted secret value of a secret" + } + ], + "ListSecretVersionIds": [ + { + "input": { + "IncludeDeprecated": true, + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "Versions": [ + { + "CreatedDate": 1523477145.713, + "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE", + "VersionStages": [ + "AWSPREVIOUS" + ] + }, + { + "CreatedDate": 1523486221.391, + "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", + "VersionStages": [ + "AWSCURRENT" + ] + }, + { + "CreatedDate": 1511974462.36, + "VersionId": "EXAMPLE3-90ab-cdef-fedc-ba987EXAMPLE;" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to retrieve a list of all of the versions of a secret, including those without any staging labels.", + "id": "to-list-all-of-the-secret-versions-associated-with-a-secret-1524000999164", + "title": "To list all of the secret versions associated with a secret" + } + ], + "ListSecrets": [ + { + "input": { + }, + "output": { + "SecretList": [ + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Description": "My test database secret", + "LastChangedDate": 1523477145.729, + "Name": "MyTestDatabaseSecret", + "SecretVersionsToStages": { + "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE": [ + "AWSCURRENT" + ] + } + }, + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret1-d4e5f6", + "Description": "Another secret created for a different database", + "LastChangedDate": 1523482025.685, + "Name": "MyTestDatabaseSecret1", + "SecretVersionsToStages": { + "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE": [ + "AWSCURRENT" + ] + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to list all of the secrets in your account.", + "id": "to-list-the-secrets-in-your-account-1524001246087", + "title": "To list the secrets in your account" + } + ], + "PutResourcePolicy": [ + { + "input": { + "ResourcePolicy": "{\n\"Version\":\"2012-10-17\",\n\"Statement\":[{\n\"Effect\":\"Allow\",\n\"Principal\":{\n\"AWS\":\"arn:aws:iam::123456789012:root\"\n},\n\"Action\":\"secretsmanager:GetSecretValue\",\n\"Resource\":\"*\"\n}]\n}", + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to add a resource-based policy to a secret.", + "id": "to-add-a-resource-based-policy-to-a-secret-1530209881839", + "title": "To add a resource-based policy to a secret" + } + ], + "PutSecretValue": [ + { + "input": { + "ClientRequestToken": "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", + "SecretId": "MyTestDatabaseSecret", + "SecretString": "{\"username\":\"david\",\"password\":\"BnQw!XDWgaEeT9XGTT29\"}" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", + "VersionStages": [ + "AWSCURRENT" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to create a new version of the secret. Alternatively, you can use the update-secret command.", + "id": "to-store-a-secret-value-in-a-new-version-of-a-secret-1524001393971", + "title": "To store a secret value in a new version of a secret" + } + ], + "RestoreSecret": [ + { + "input": { + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to restore a secret that you previously scheduled for deletion.", + "id": "to-restore-a-previously-deleted-secret-1524001513930", + "title": "To restore a previously deleted secret" + } + ], + "RotateSecret": [ + { + "input": { + "RotationLambdaARN": "arn:aws:lambda:us-west-2:123456789012:function:MyTestDatabaseRotationLambda", + "RotationRules": { + "AutomaticallyAfterDays": 30 + }, + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example configures rotation for a secret by providing the ARN of a Lambda rotation function (which must already exist) and the number of days between rotation. The first rotation happens immediately upon completion of this command. The rotation function runs asynchronously in the background.", + "id": "to-configure-rotation-for-a-secret-1524001629475", + "title": "To configure rotation for a secret" + } + ], + "TagResource": [ + { + "input": { + "SecretId": "MyExampleSecret", + "Tags": [ + { + "Key": "FirstTag", + "Value": "SomeValue" + }, + { + "Key": "SecondTag", + "Value": "AnotherValue" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to attach two tags each with a Key and Value to a secret. There is no output from this API. To see the result, use the DescribeSecret operation.", + "id": "to-add-tags-to-a-secret-1524002106718", + "title": "To add tags to a secret" + } + ], + "UntagResource": [ + { + "input": { + "SecretId": "MyTestDatabaseSecret", + "TagKeys": [ + "FirstTag", + "SecondTag" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to remove two tags from a secret's metadata. For each, both the tag and the associated value are removed. There is no output from this API. To see the result, use the DescribeSecret operation.", + "id": "to-remove-tags-from-a-secret-1524002239065", + "title": "To remove tags from a secret" + } + ], + "UpdateSecret": [ + { + "input": { + "ClientRequestToken": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE", + "Description": "This is a new description for the secret.", + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to modify the description of a secret.", + "id": "to-update-the-description-of-a-secret-1524002349094", + "title": "To update the description of a secret" + }, + { + "input": { + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows how to update the KMS customer managed key (CMK) used to encrypt the secret value. The KMS CMK must be in the same region as the secret.", + "id": "to-update-the-kms-key-associated-with-a-secret-1524002421563", + "title": "To update the KMS key associated with a secret" + }, + { + "input": { + "SecretId": "MyTestDatabaseSecret", + "SecretString": "{JSON STRING WITH CREDENTIALS}" + }, + "output": { + "ARN": "aws:arn:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to create a new version of the secret by updating the SecretString field. Alternatively, you can use the put-secret-value operation.", + "id": "to-create-a-new-version-of-the-encrypted-secret-value-1524004651836", + "title": "To create a new version of the encrypted secret value" + } + ], + "UpdateSecretVersionStage": [ + { + "input": { + "MoveToVersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", + "SecretId": "MyTestDatabaseSecret", + "VersionStage": "STAGINGLABEL1" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows you how to add a staging label to a version of a secret. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version.", + "id": "to-add-a-staging-label-attached-to-a-version-of-a-secret-1524004783841", + "title": "To add a staging label attached to a version of a secret" + }, + { + "input": { + "RemoveFromVersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", + "SecretId": "MyTestDatabaseSecret", + "VersionStage": "STAGINGLABEL1" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows you how to delete a staging label that is attached to a version of a secret. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version.", + "id": "to-delete-a-staging-label-attached-to-a-version-of-a-secret-1524004862181", + "title": "To delete a staging label attached to a version of a secret" + }, + { + "input": { + "MoveToVersionId": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2", + "RemoveFromVersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", + "SecretId": "MyTestDatabaseSecret", + "VersionStage": "AWSCURRENT" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows you how to move a staging label that is attached to one version of a secret to a different version. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version.", + "id": "to-move-a-staging-label-from-one-version-of-a-secret-to-another-1524004963841", + "title": "To move a staging label from one version of a secret to another" + } + ] + } +} diff --git a/botocore/data/securityhub/2018-10-26/service-2.json b/botocore/data/securityhub/2018-10-26/service-2.json index 351ca586..f311baaa 100644 --- a/botocore/data/securityhub/2018-10-26/service-2.json +++ b/botocore/data/securityhub/2018-10-26/service-2.json @@ -75,7 +75,23 @@ {"shape":"LimitExceededException"}, {"shape":"InvalidAccessException"} ], - "documentation":"Imports security findings generated from an integrated third-party product into Security Hub. This action is requested by the integrated product to import its findings into Security Hub.
The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.
" + "documentation":"Imports security findings generated from an integrated third-party product into Security Hub. This action is requested by the integrated product to import its findings into Security Hub.
The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.
After a finding is created, BatchImportFindings cannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow.
Confidence
Criticality
Note
RelatedFindings
Severity
Types
UserDefinedFields
VerificationState
Workflow
Used by Security Hub customers to update information about their investigation into a finding. Requested by master accounts or member accounts. Master accounts can update findings for their account and their member accounts. Member accounts can update findings for their account.
Updates from BatchUpdateFindings do not affect the value of UpdatedAt for a finding.
Master accounts can use BatchUpdateFindings to update the following finding fields and objects.
Confidence
Criticality
Note
RelatedFindings
Severity
Types
UserDefinedFields
VerificationState
Workflow
Member accounts can only use BatchUpdateFindings to update the Note object.
Enables Security Hub for your account in the current Region or the Region you specify in the request.
When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from AWS Config, Amazon GuardDuty, Amazon Inspector, and Amazon Macie.
When you use the EnableSecurityHub operation to enable Security Hub, you also automatically enable the CIS AWS Foundations standard. You do not enable the Payment Card Industry Data Security Standard (PCI DSS) standard. To enable a standard, use the BatchEnableStandards operation. To disable a standard, use the BatchDisableStandards operation.
To learn more, see Setting Up AWS Security Hub in the AWS Security Hub User Guide.
" + "documentation":"Enables Security Hub for your account in the current Region or the Region you specify in the request.
When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from other services that are integrated with Security Hub.
When you use the EnableSecurityHub operation to enable Security Hub, you also automatically enable the CIS AWS Foundations standard. You do not enable the Payment Card Industry Data Security Standard (PCI DSS) standard. To not enable the CIS AWS Foundations standard, set EnableDefaultStandards to false.
After you enable Security Hub, to enable a standard, use the BatchEnableStandards operation. To disable a standard, use the BatchDisableStandards operation.
To learn more, see Setting Up AWS Security Hub in the AWS Security Hub User Guide.
" }, "GetEnabledStandards":{ "name":"GetEnabledStandards", @@ -649,7 +665,7 @@ {"shape":"InvalidAccessException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Updates the Note and RecordState of the Security Hub-aggregated findings that the filter attributes specify. Any member account that can view the finding also sees the update to the finding.
UpdateFindings is deprecated. Instead of UpdateFindings, use BatchUpdateFindings.
Updates the Note and RecordState of the Security Hub-aggregated findings that the filter attributes specify. Any member account that can view the finding also sees the update to the finding.
A collection of attributes that are applied to all active Security Hub-aggregated findings and that result in a subset of findings that are included in this insight.
" }, + "AwsSecurityFindingIdentifier":{ + "type":"structure", + "required":[ + "Id", + "ProductArn" + ], + "members":{ + "Id":{ + "shape":"NonEmptyString", + "documentation":"The identifier of the finding that was specified by the finding provider.
" + }, + "ProductArn":{ + "shape":"NonEmptyString", + "documentation":"The ARN generated by Security Hub that uniquely identifies a product that generates findings. This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for a custom integration.
" + } + }, + "documentation":"Identifies a finding to update using BatchUpdateFindings.
The list of findings to update. BatchUpdateFindings can be used to update up to 100 findings at a time.
For each finding, the list provides the finding identifier and the ARN of the finding provider.
" + }, + "Note":{"shape":"NoteUpdate"}, + "Severity":{ + "shape":"SeverityUpdate", + "documentation":"Used to update the finding severity.
" + }, + "VerificationState":{ + "shape":"VerificationState", + "documentation":"Indicates the veracity of a finding.
The available values for VerificationState are as follows.
UNKNOWN – The default disposition of a security finding
TRUE_POSITIVE – The security finding is confirmed
FALSE_POSITIVE – The security finding was determined to be a false alarm
BENIGN_POSITIVE – A special case of TRUE_POSITIVE where the finding doesn't pose any threat, is expected, or both
The updated value for the finding confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.
Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.
" + }, + "Criticality":{ + "shape":"RatioScale", + "documentation":"The updated value for the level of importance assigned to the resources associated with the findings.
A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.
" + }, + "Types":{ + "shape":"TypeList", + "documentation":"One or more finding types in the format of namespace/category/classifier that classify a finding.
Valid namespace values are as follows.
Software and Configuration Checks
TTPs
Effects
Unusual Behaviors
Sensitive Data Identifications
A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.
" + }, + "Workflow":{ + "shape":"WorkflowUpdate", + "documentation":"Used to update the workflow status of a finding.
The workflow status indicates the progress of the investigation into the finding.
" + }, + "RelatedFindings":{ + "shape":"RelatedFindingList", + "documentation":"A list of findings that are related to the updated findings.
" + } + } + }, + "BatchUpdateFindingsResponse":{ + "type":"structure", + "required":[ + "ProcessedFindings", + "UnprocessedFindings" + ], + "members":{ + "ProcessedFindings":{ + "shape":"AwsSecurityFindingIdentifierList", + "documentation":"The list of findings that were updated successfully.
" + }, + "UnprocessedFindings":{ + "shape":"BatchUpdateFindingsUnprocessedFindingsList", + "documentation":"The list of findings that were not updated.
" + } + } + }, + "BatchUpdateFindingsUnprocessedFinding":{ + "type":"structure", + "required":[ + "FindingIdentifier", + "ErrorCode", + "ErrorMessage" + ], + "members":{ + "FindingIdentifier":{ + "shape":"AwsSecurityFindingIdentifier", + "documentation":"The identifier of the finding that was not updated.
" + }, + "ErrorCode":{ + "shape":"NonEmptyString", + "documentation":"The code associated with the error.
" + }, + "ErrorMessage":{ + "shape":"NonEmptyString", + "documentation":"The message associated with the error.
" + } + }, + "documentation":"A finding from a BatchUpdateFindings request that Security Hub was unable to update.
The attribute used as the aggregator to group related findings for the insight.
" + "documentation":"The attribute used to group the findings for the insight. The grouping attribute identifies the type of item that the insight applies to. For example, if an insight is grouped by resource identifier, then the insight produces a list of resource identifiers.
" } } }, @@ -3120,6 +3245,10 @@ "Tags":{ "shape":"TagMap", "documentation":"The tags to add to the Hub resource when you enable Security Hub.
" + }, + "EnableDefaultStandards":{ + "shape":"Boolean", + "documentation":"Whether to enable the security standards that Security Hub has designated as automatically enabled. If you do not provide a value for EnableDefaultStandards, it is set to true. To not enable the automatically enabled standards, set EnableDefaultStandards to false.
The ID of the error made during the BatchImportFindings operation.
The identifier of the finding that could not be updated.
" }, "ErrorCode":{ "shape":"NonEmptyString", - "documentation":"The code of the error made during the BatchImportFindings operation.
The code of the error returned by the BatchImportFindings operation.
The message of the error made during the BatchImportFindings operation.
The message of the error returned by the BatchImportFindings operation.
Includes details of the list of the findings that cannot be imported.
" + "documentation":"The list of the findings that cannot be imported. For each finding, the list provides the error.
" }, "ImportFindingsErrorList":{ "type":"list", @@ -3352,7 +3481,7 @@ }, "GroupByAttribute":{ "shape":"NonEmptyString", - "documentation":"The attribute that the insight's findings are grouped by. This attribute is used as a findings aggregator for the purposes of viewing and managing multiple related findings under a single operand.
" + "documentation":"The grouping attribute for the insight's findings. Indicates how to group the matching findings, and identifies the type of item that the insight applies to. For example, if an insight is grouped by resource identifier, then the insight produces a list of resource identifiers.
" } }, "documentation":"Contains information about a Security Hub insight.
" @@ -3999,6 +4128,11 @@ "type":"list", "member":{"shape":"Product"} }, + "RatioScale":{ + "type":"integer", + "max":100, + "min":0 + }, "Recommendation":{ "type":"structure", "members":{ @@ -4263,6 +4397,24 @@ "CRITICAL" ] }, + "SeverityUpdate":{ + "type":"structure", + "members":{ + "Normalized":{ + "shape":"RatioScale", + "documentation":"The normalized severity for the finding. This attribute is to be deprecated in favor of Label.
If you provide Normalized and do not provide Label, Label is set automatically as follows.
0 - INFORMATIONAL
1–39 - LOW
40–69 - MEDIUM
70–89 - HIGH
90–100 - CRITICAL
The native severity as defined by the AWS service or integrated partner product that generated the finding.
" + }, + "Label":{ + "shape":"SeverityLabel", + "documentation":"The severity value of the finding. The allowed values are the following.
INFORMATIONAL - No issue was found.
LOW - The issue does not require action on its own.
MEDIUM - The issue must be addressed but not urgently.
HIGH - The issue must be addressed as a priority.
CRITICAL - The issue must be remediated immediately to avoid it escalating.
Updates to the severity information for a finding.
" + }, "SortCriteria":{ "type":"list", "member":{"shape":"SortCriterion"} @@ -4302,6 +4454,10 @@ "Description":{ "shape":"NonEmptyString", "documentation":"A description of the standard.
" + }, + "EnabledByDefault":{ + "shape":"Boolean", + "documentation":"Whether the standard is enabled by default. When Security Hub is enabled from the console, if a standard is enabled by default, the check box for that standard is selected by default.
When Security Hub is enabled using the EnableSecurityHub API operation, the standard is enabled by default unless EnableDefaultStandards is set to false.
Provides information about a specific standard.
" @@ -4780,6 +4936,16 @@ "RESOLVED", "SUPPRESSED" ] + }, + "WorkflowUpdate":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"WorkflowStatus", + "documentation":"The status of the investigation into the finding. The allowed values are the following.
NEW - The initial state of a finding, before it is reviewed.
NOTIFIED - Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.
RESOLVED - The finding was reviewed and remediated and is now considered resolved.
SUPPRESSED - The finding will not be reviewed again and will not be acted upon.
Used to update information about the investigation into the finding.
" } }, "documentation":"Security Hub provides you with a comprehensive view of the security state of your AWS environment and resources. It also provides you with the readiness status of your environment based on controls from supported security standards. Security Hub collects security data from AWS accounts, services, and integrated third-party products and helps you analyze security trends in your environment to identify the highest priority security issues. For more information about Security Hub, see the AWS Security Hub User Guide .
When you use operations in the Security Hub API, the requests are executed only in the AWS Region that is currently active or in the specific AWS Region that you specify in your request. Any configuration or settings change that results from the operation is applied only to that Region. To make the same change in other Regions, execute the same command for each Region to apply the change to.
For example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of the member account with the master account is created only in the us-west-2 Region. Security Hub must be enabled for the member account in the same Region that the invitation was sent from.
The following throttling limits apply to using Security Hub API operations.
GetFindings - RateLimit of 3 requests per second. BurstLimit of 6 requests per second.
UpdateFindings - RateLimit of 1 request per second. BurstLimit of 5 requests per second.
All other operations - RateLimit of 10 requests per second. BurstLimit of 30 requests per second.
The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:
Specify the RoleArn property as follows:
{\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}
You cannot have both a LAUNCH and a STACKSET constraint.
You also cannot have more than one LAUNCH constraint on a product and portfolio.
Specify the NotificationArns property as follows:
{\"NotificationArns\" : [\"arn:aws:sns:us-east-1:123456789012:Topic\"]}
Specify the TagUpdatesOnProvisionedProduct property as follows:
{\"Version\":\"2.0\",\"Properties\":{\"TagUpdateOnProvisionedProduct\":\"String\"}}
The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.
Specify the Parameters property as follows:
{\"Version\": \"String\", \"Properties\": {\"AccountList\": [ \"String\" ], \"RegionList\": [ \"String\" ], \"AdminRole\": \"String\", \"ExecutionRole\": \"String\"}}
You cannot have both a LAUNCH and a STACKSET constraint.
You also cannot have more than one STACKSET constraint on a product and portfolio.
Products with a STACKSET constraint will launch an AWS CloudFormation stack set.
Specify the Rules property. For more information, see Template Constraint Rules.
The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:
You are required to specify either the RoleArn or the LocalRoleName but can't use both.
Specify the RoleArn property as follows:
{\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}
Specify the LocalRoleName property as follows:
{\"LocalRoleName\": \"SCBasicLaunchRole\"}
If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.
The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.
You cannot have both a LAUNCH and a STACKSET constraint.
You also cannot have more than one LAUNCH constraint on a product and portfolio.
Specify the NotificationArns property as follows:
{\"NotificationArns\" : [\"arn:aws:sns:us-east-1:123456789012:Topic\"]}
Specify the TagUpdatesOnProvisionedProduct property as follows:
{\"Version\":\"2.0\",\"Properties\":{\"TagUpdateOnProvisionedProduct\":\"String\"}}
The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.
Specify the Parameters property as follows:
{\"Version\": \"String\", \"Properties\": {\"AccountList\": [ \"String\" ], \"RegionList\": [ \"String\" ], \"AdminRole\": \"String\", \"ExecutionRole\": \"String\"}}
You cannot have both a LAUNCH and a STACKSET constraint.
You also cannot have more than one STACKSET constraint on a product and portfolio.
Products with a STACKSET constraint will launch an AWS CloudFormation stack set.
Specify the Rules property. For more information, see Template Constraint Rules.
The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:
Specify the RoleArn property as follows:
{\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}
You cannot have both a LAUNCH and a STACKSET constraint.
You also cannot have more than one LAUNCH constraint on a product and portfolio.
Specify the NotificationArns property as follows:
{\"NotificationArns\" : [\"arn:aws:sns:us-east-1:123456789012:Topic\"]}
Specify the TagUpdatesOnProvisionedProduct property as follows:
{\"Version\":\"2.0\",\"Properties\":{\"TagUpdateOnProvisionedProduct\":\"String\"}}
The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.
Specify the Parameters property as follows:
{\"Version\": \"String\", \"Properties\": {\"AccountList\": [ \"String\" ], \"RegionList\": [ \"String\" ], \"AdminRole\": \"String\", \"ExecutionRole\": \"String\"}}
You cannot have both a LAUNCH and a STACKSET constraint.
You also cannot have more than one STACKSET constraint on a product and portfolio.
Products with a STACKSET constraint will launch an AWS CloudFormation stack set.
Specify the Rules property. For more information, see Template Constraint Rules.
The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:
You are required to specify either the RoleArn or the LocalRoleName but can't use both.
Specify the RoleArn property as follows:
{\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}
Specify the LocalRoleName property as follows:
{\"LocalRoleName\": \"SCBasicLaunchRole\"}
If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.
The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.
You cannot have both a LAUNCH and a STACKSET constraint.
You also cannot have more than one LAUNCH constraint on a product and portfolio.
Specify the NotificationArns property as follows:
{\"NotificationArns\" : [\"arn:aws:sns:us-east-1:123456789012:Topic\"]}
Specify the TagUpdatesOnProvisionedProduct property as follows:
{\"Version\":\"2.0\",\"Properties\":{\"TagUpdateOnProvisionedProduct\":\"String\"}}
The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.
Specify the Parameters property as follows:
{\"Version\": \"String\", \"Properties\": {\"AccountList\": [ \"String\" ], \"RegionList\": [ \"String\" ], \"AdminRole\": \"String\", \"ExecutionRole\": \"String\"}}
You cannot have both a LAUNCH and a STACKSET constraint.
You also cannot have more than one STACKSET constraint on a product and portfolio.
Products with a STACKSET constraint will launch an AWS CloudFormation stack set.
Specify the Rules property. For more information, see Template Constraint Rules.
Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (Glacier or Deep Archive) that corresponds to the pool.
Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"
" + "documentation":"Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"
" }, "AttachVolume":{ "name":"AttachVolume", @@ -164,7 +164,7 @@ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], - "documentation":"Creates a Network File System (NFS) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using a NFS interface. This operation is only supported for file gateways.
File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you create a file share. Make sure AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in the AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.
File gateway does not support creating hard or symbolic links on a file share.
Creates a Network File System (NFS) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using an NFS interface. This operation is only supported for file gateways.
File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in the AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.
File gateway does not support creating hard or symbolic links on a file share.
Creates a Server Message Block (SMB) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway expose file shares using a SMB interface. This operation is only supported for file gateways.
File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.
File gateways don't support creating hard or symbolic links on a file share.
Creates a Server Message Block (SMB) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway expose file shares using an SMB interface. This operation is only supported for file gateways.
File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.
File gateways don't support creating hard or symbolic links on a file share.
Initiates a snapshot of a volume.
AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API enables you to take ad-hoc snapshot. For more information, see Editing a Snapshot Schedule.
In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type.
To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the EC2 API reference.
Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page.
Initiates a snapshot of a volume.
AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage Service (Amazon S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API enables you to take an ad hoc snapshot. For more information, see Editing a Snapshot Schedule.
In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type.
To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the EC2 API reference.
Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page.
Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and can not be reused if it has already been used on a tape . This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type.
Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.
Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and cannot be reused if it has already been used on a tape. This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type.
Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.
Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type.
Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway.
Deletes the automatic tape creation policy of a gateway. If you delete this policy, new virtual tapes must be created manually. Use the Amazon Resource Name (ARN) of the gateway in your request to remove the policy.
" + }, "DeleteBandwidthRateLimit":{ "name":"DeleteBandwidthRateLimit", "http":{ @@ -320,7 +334,7 @@ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], - "documentation":"Deletes a snapshot of a volume.
You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Working with Snapshots. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported in stored and cached volume gateway types.
To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference.
Deletes a snapshot of a volume.
You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Working with Snapshots. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported in stored and cached volume gateway types.
To list or delete a snapshot, you must use the Amazon EC2 API. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape and file gateway types.
The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.
" + "documentation":"Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape, and file gateway types.
The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.
" }, "DescribeCachediSCSIVolumes":{ "name":"DescribeCachediSCSIVolumes", @@ -418,7 +432,7 @@ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], - "documentation":"Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types.
The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).
" + "documentation":"Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types.
The list of gateway volumes in the request must be from one gateway. In the response, AWS Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).
" }, "DescribeChapCredentials":{ "name":"DescribeChapCredentials", @@ -530,7 +544,7 @@ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], - "documentation":"Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.
" + "documentation":"Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response AWS Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.
" }, "DescribeTapeArchives":{ "name":"DescribeTapeArchives", @@ -642,7 +656,7 @@ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], - "documentation":"Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.
Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type.
Once a gateway is disabled it cannot be enabled.
Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.
Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type.
After a gateway is disabled, it cannot be enabled.
Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.
" }, + "ListAutomaticTapeCreationPolicies":{ + "name":"ListAutomaticTapeCreationPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAutomaticTapeCreationPoliciesInput"}, + "output":{"shape":"ListAutomaticTapeCreationPoliciesOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"Lists the automatic tape creation policies for a gateway. If there are no automatic tape creation policies for the gateway, it returns an empty list.
This operation is only supported for tape gateways.
" + }, "ListFileShares":{ "name":"ListFileShares", "http":{ @@ -824,7 +852,7 @@ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], - "documentation":"Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types.
If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.
Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters an error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point, you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types.
If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.
Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.
The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM.
If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.
After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.
When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway.
If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.
" + "documentation":"Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.
The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM.
If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.
After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.
When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway.
If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.
" }, "StartAvailabilityMonitorTest":{ "name":"StartAvailabilityMonitorTest", @@ -924,6 +952,20 @@ ], "documentation":"Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups.
When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway.
To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.
" }, + "UpdateAutomaticTapeCreationPolicy":{ + "name":"UpdateAutomaticTapeCreationPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAutomaticTapeCreationPolicyInput"}, + "output":{"shape":"UpdateAutomaticTapeCreationPolicyOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new set of automatic tape creation rules. This is only supported for tape gateways.
By default, there is no automatic tape creation policy.
A gateway can have only one automatic tape creation policy.
An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
" + "documentation":"An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
" } } }, @@ -1192,7 +1234,7 @@ "GatewayARN":{"shape":"GatewayARN"}, "DiskIds":{ "shape":"DiskIds", - "documentation":"An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
" + "documentation":"An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
" } } }, @@ -1212,7 +1254,7 @@ "GatewayARN":{"shape":"GatewayARN"}, "DiskIds":{ "shape":"DiskIds", - "documentation":"An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
" + "documentation":"An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
" } }, "documentation":"A JSON object containing one or more of the following fields:
" @@ -1222,7 +1264,7 @@ "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"A JSON object containing the of the gateway for which working storage was configured.
" + "documentation":"A JSON object containing the Amazon Resource Name (ARN) of the gateway for which working storage was configured.
" }, "AssignTapePoolInput":{ "type":"structure", @@ -1237,7 +1279,7 @@ }, "PoolId":{ "shape":"PoolId", - "documentation":"The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.
Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"
" + "documentation":"The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"
" } } }, @@ -1295,12 +1337,65 @@ }, "documentation":"AttachVolumeOutput
" }, + "AuditDestinationARN":{ + "type":"string", + "max":1024 + }, "Authentication":{ "type":"string", "documentation":"The authentication method of the file share.
Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory.
An automatic tape creation policy consists of a list of automatic tape creation rules. This returns the rules that determine when and how to automatically create new tapes.
" + }, + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"Information about the gateway's automatic tape creation policies, including the automatic tape creation rules and the gateway that is using the policies.
" + }, + "AutomaticTapeCreationPolicyInfos":{ + "type":"list", + "member":{"shape":"AutomaticTapeCreationPolicyInfo"} + }, + "AutomaticTapeCreationRule":{ + "type":"structure", + "required":[ + "TapeBarcodePrefix", + "PoolId", + "TapeSizeInBytes", + "MinimumNumTapes" + ], + "members":{ + "TapeBarcodePrefix":{ + "shape":"TapeBarcodePrefix", + "documentation":"A prefix that you append to the barcode of the virtual tape that you are creating. This prefix makes the barcode unique.
The prefix must be 1-4 characters in length and must be one of the uppercase letters from A to Z.
The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the Amazon S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"
" + }, + "TapeSizeInBytes":{ + "shape":"TapeSize", + "documentation":"The size, in bytes, of the virtual tape capacity.
" + }, + "MinimumNumTapes":{ + "shape":"MinimumNumTapes", + "documentation":"The minimum number of available virtual tapes that the gateway maintains at all times. If the number of tapes on the gateway goes below this value, the gateway creates as many new tapes as are needed to have MinimumNumTapes on the gateway.
An automatic tape creation policy consists of automatic tape creation rules where each rule defines when and how to create new tapes.
" + }, + "AutomaticTapeCreationRules":{ + "type":"list", + "member":{"shape":"AutomaticTapeCreationRule"}, + "max":10, + "min":1 + }, "AvailabilityMonitorTestStatus":{ "type":"string", "enum":[ @@ -1510,11 +1605,11 @@ }, "KMSEncrypted":{ "shape":"Boolean", - "documentation":"True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
" + "documentation":"True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
" }, "KMSKey":{ "shape":"KMSKey", - "documentation":"The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
" + "documentation":"The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.
" }, "Tags":{ "shape":"Tags", @@ -1558,11 +1653,11 @@ }, "KMSEncrypted":{ "shape":"Boolean", - "documentation":"True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
" + "documentation":"True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
" }, "KMSKey":{ "shape":"KMSKey", - "documentation":"The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
" + "documentation":"The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.
" }, "Role":{ "shape":"Role", @@ -1632,15 +1727,15 @@ }, "GatewayARN":{ "shape":"GatewayARN", - "documentation":"The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
" + "documentation":"The ARN of the file gateway on which you want to create a file share.
" }, "KMSEncrypted":{ "shape":"Boolean", - "documentation":"True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
" + "documentation":"True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
" }, "KMSKey":{ "shape":"KMSKey", - "documentation":"The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
" + "documentation":"The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.
" }, "Role":{ "shape":"Role", @@ -1684,7 +1779,11 @@ }, "InvalidUserList":{ "shape":"FileShareUserList", - "documentation":"A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example, @group1. Can only be set if Authentication is set to ActiveDirectory.
The Amazon Resource Name (ARN) of the storage used for the audit logs.
" }, "Authentication":{ "shape":"Authentication", @@ -1814,11 +1913,11 @@ }, "KMSEncrypted":{ "shape":"Boolean", - "documentation":"True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
" + "documentation":"True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
" }, "KMSKey":{ "shape":"KMSKey", - "documentation":"The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
" + "documentation":"The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.
" }, "Tags":{ "shape":"Tags", @@ -1859,7 +1958,7 @@ }, "TapeSizeInBytes":{ "shape":"TapeSize", - "documentation":"The size, in bytes, of the virtual tape that you want to create.
The size must be aligned by gigabyte (1024*1024*1024 byte).
The size, in bytes, of the virtual tape that you want to create.
The size must be aligned by gigabyte (1024*1024*1024 bytes).
True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
" + "documentation":"True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
" }, "KMSKey":{ "shape":"KMSKey", - "documentation":"The Amazon Resource Name (ARN) of the AWS KMS Key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
" + "documentation":"The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.
" }, "PoolId":{ "shape":"PoolId", - "documentation":"The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.
Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"
" + "documentation":"The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"
" }, "Tags":{ "shape":"Tags", @@ -1910,7 +2009,7 @@ }, "TapeSizeInBytes":{ "shape":"TapeSize", - "documentation":"The size, in bytes, of the virtual tapes that you want to create.
The size must be aligned by gigabyte (1024*1024*1024 byte).
The size, in bytes, of the virtual tapes that you want to create.
The size must be aligned by gigabyte (1024*1024*1024 bytes).
True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
" + "documentation":"True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
" }, "KMSKey":{ "shape":"KMSKey", - "documentation":"The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
" + "documentation":"The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.
" }, "PoolId":{ "shape":"PoolId", - "documentation":"The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.
Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"
" + "documentation":"The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"
" }, "Tags":{ "shape":"Tags", @@ -1964,6 +2063,19 @@ "max":6, "min":0 }, + "DeleteAutomaticTapeCreationPolicyInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "DeleteAutomaticTapeCreationPolicyOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, "DeleteBandwidthRateLimitInput":{ "type":"structure", "required":[ @@ -1984,7 +2096,7 @@ "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"A JSON object containing the of the gateway whose bandwidth rate information was deleted.
" + "documentation":"A JSON object containing the Amazon Resource Name (ARN) of the gateway whose bandwidth rate information was deleted.
" }, "DeleteChapCredentialsInput":{ "type":"structure", @@ -2145,7 +2257,7 @@ "documentation":"The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request.
" } }, - "documentation":"A JSON object containing the of the storage volume that was deleted
" + "documentation":"A JSON object containing the Amazon Resource Name (ARN) of the storage volume that was deleted
" }, "DescribeAvailabilityMonitorTestInput":{ "type":"structure", @@ -2174,7 +2286,7 @@ "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"A JSON object containing the of the gateway.
" + "documentation":"A JSON object containing the Amazon Resource Name (ARN) of the gateway.
" }, "DescribeBandwidthRateLimitOutput":{ "type":"structure", @@ -2204,11 +2316,11 @@ "GatewayARN":{"shape":"GatewayARN"}, "DiskIds":{ "shape":"DiskIds", - "documentation":"An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
" + "documentation":"An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
" }, "CacheAllocatedInBytes":{ "shape":"long", - "documentation":"The amount of cache in bytes allocated to the a gateway.
" + "documentation":"The amount of cache in bytes allocated to a gateway.
" }, "CacheUsedPercentage":{ "shape":"double", @@ -2234,7 +2346,7 @@ "members":{ "VolumeARNs":{ "shape":"VolumeARNs", - "documentation":"An array of strings where each string represents the Amazon Resource Name (ARN) of a cached volume. All of the specified cached volumes must from the same gateway. Use ListVolumes to get volume ARNs for a gateway.
" + "documentation":"An array of strings where each string represents the Amazon Resource Name (ARN) of a cached volume. All of the specified cached volumes must be from the same gateway. Use ListVolumes to get volume ARNs for a gateway.
" } } }, @@ -2346,7 +2458,7 @@ "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"A JSON object containing the of the gateway.
" + "documentation":"A JSON object containing the Amazon Resource Name (ARN) of the gateway.
" }, "DescribeMaintenanceStartTimeOutput":{ "type":"structure", @@ -2492,7 +2604,7 @@ "members":{ "VolumeARNs":{ "shape":"VolumeARNs", - "documentation":"An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must from the same gateway. Use ListVolumes to get volume ARNs for a gateway.
" + "documentation":"An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must be from the same gateway. Use ListVolumes to get volume ARNs for a gateway.
" } }, "documentation":"A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.
" @@ -2519,7 +2631,7 @@ }, "Limit":{ "shape":"PositiveIntObject", - "documentation":"Specifies that the number of virtual tapes descried be limited to the specified number.
" + "documentation":"Specifies that the number of virtual tapes described be limited to the specified number.
" } }, "documentation":"DescribeTapeArchivesInput
" @@ -2654,7 +2766,7 @@ "GatewayARN":{"shape":"GatewayARN"}, "VTLDevices":{ "shape":"VTLDevices", - "documentation":"An array of VTL device objects composed of the Amazon Resource Name(ARN) of the VTL devices.
" + "documentation":"An array of VTL device objects composed of the Amazon Resource Name (ARN) of the VTL devices.
" }, "Marker":{ "shape":"Marker", @@ -2669,7 +2781,7 @@ "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"A JSON object containing the of the gateway.
" + "documentation":"A JSON object containing the Amazon Resource Name (ARN) of the gateway.
" }, "DescribeWorkingStorageOutput":{ "type":"structure", @@ -3201,7 +3313,7 @@ }, "KMSKey":{ "type":"string", - "documentation":"The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
", + "documentation":"The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.
", "max":2048, "min":7 }, @@ -3210,12 +3322,27 @@ "max":25, "min":1 }, + "ListAutomaticTapeCreationPoliciesInput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "ListAutomaticTapeCreationPoliciesOutput":{ + "type":"structure", + "members":{ + "AutomaticTapeCreationPolicyInfos":{ + "shape":"AutomaticTapeCreationPolicyInfos", + "documentation":"Gets a listing of information about the gateway's automatic tape creation policies, including the automatic tape creation rules and the gateway that is using the policies.
" + } + } + }, "ListFileSharesInput":{ "type":"structure", "members":{ "GatewayARN":{ "shape":"GatewayARN", - "documentation":"The Amazon resource Name (ARN) of the gateway whose file shares you want to list. If this field is not present, all file shares under your account are listed.
" + "documentation":"The Amazon Resource Name (ARN) of the gateway whose file shares you want to list. If this field is not present, all file shares under your account are listed.
" }, "Limit":{ "shape":"PositiveIntObject", @@ -3279,7 +3406,7 @@ "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"A JSON object containing the of the gateway.
" + "documentation":"A JSON object containing the Amazon Resource Name (ARN) of the gateway.
" }, "ListLocalDisksOutput":{ "type":"structure", @@ -3445,6 +3572,11 @@ "max":50, "min":2 }, + "MinimumNumTapes":{ + "type":"integer", + "max":10, + "min":1 + }, "MinuteOfHour":{ "type":"integer", "max":59, @@ -3482,7 +3614,7 @@ "GatewayARN":{"shape":"GatewayARN"}, "KMSEncrypted":{ "shape":"boolean", - "documentation":"True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
" + "documentation":"True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
" }, "KMSKey":{"shape":"KMSKey"}, "Path":{"shape":"Path"}, @@ -3662,7 +3794,7 @@ }, "TagKeys":{ "shape":"TagKeys", - "documentation":"The keys of the tags you want to remove from the specified resource. A tag is composed of a key/value pair.
" + "documentation":"The keys of the tags you want to remove from the specified resource. A tag is composed of a key-value pair.
" } }, "documentation":"RemoveTagsFromResourceInput
" @@ -3805,6 +3937,10 @@ "shape":"FileShareUserList", "documentation":"A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
The Amazon Resource Name (ARN) of the storage used for the audit logs.
" + }, "Authentication":{"shape":"Authentication"}, "Tags":{ "shape":"Tags", @@ -3898,14 +4034,14 @@ "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"A JSON object containing the of the gateway to shut down.
" + "documentation":"A JSON object containing the Amazon Resource Name (ARN) of the gateway to shut down.
" }, "ShutdownGatewayOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"A JSON object containing the of the gateway that was shut down.
" + "documentation":"A JSON object containing the Amazon Resource Name (ARN) of the gateway that was shut down.
" }, "SnapshotDescription":{ "type":"string", @@ -3941,14 +4077,14 @@ "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"A JSON object containing the of the gateway to start.
" + "documentation":"A JSON object containing the Amazon Resource Name (ARN) of the gateway to start.
" }, "StartGatewayOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"A JSON object containing the of the gateway that was restarted.
" + "documentation":"A JSON object containing the Amazon Resource Name (ARN) of the gateway that was restarted.
" }, "StorageClass":{ "type":"string", @@ -3968,7 +4104,7 @@ "documentation":"Human-readable text that provides detail about the error that occurred.
" } }, - "documentation":"Provides additional information about an error that was returned by the service as an or. See the errorCode and errorDetails members for more information about the error.
Provides additional information about an error that was returned by the service. See the errorCode and errorDetails members for more information about the error.
The ID of the pool that contains tapes that will be archived. The tapes in this pool are archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.
Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"
" + "documentation":"The ID of the pool that contains tapes that will be archived. The tapes in this pool are archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S# Glacier Deep Archive) that corresponds to the pool.
Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"
" } }, "documentation":"Describes a virtual tape object.
" @@ -4217,7 +4353,7 @@ }, "PoolId":{ "shape":"PoolId", - "documentation":"The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.
Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"
" + "documentation":"The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"
" } }, "documentation":"Describes a virtual tape.
" @@ -4225,7 +4361,7 @@ "TapeInfos":{ "type":"list", "member":{"shape":"TapeInfo"}, - "documentation":"An array of TapeInfo objects, where each object describes an a single tape. If there not tapes in the tape library or VTS, then the TapeInfos is an empty array.
An array of TapeInfo objects, where each object describes a single tape. If there are no tapes in the tape library or VTS, then the TapeInfos is an empty array.
An automatic tape creation policy consists of a list of automatic tape creation rules. The rules determine when and how to automatically create new tapes.
" + }, + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "UpdateAutomaticTapeCreationPolicyOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, "UpdateBandwidthRateLimitInput":{ "type":"structure", "required":["GatewayARN"], @@ -4299,7 +4455,7 @@ "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"A JSON object containing the of the gateway whose throttle information was updated.
" + "documentation":"A JSON object containing the Amazon Resource Name (ARN) of the gateway whose throttle information was updated.
" }, "UpdateChapCredentialsInput":{ "type":"structure", @@ -4375,14 +4531,14 @@ "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"A JSON object containing the of the gateway to update.
" + "documentation":"A JSON object containing the Amazon Resource Name (ARN) of the gateway to update.
" }, "UpdateGatewaySoftwareNowOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"A JSON object containing the of the gateway that was updated.
" + "documentation":"A JSON object containing the Amazon Resource Name (ARN) of the gateway that was updated.
" }, "UpdateMaintenanceStartTimeInput":{ "type":"structure", @@ -4417,7 +4573,7 @@ "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"A JSON object containing the of the gateway whose maintenance start time is updated.
" + "documentation":"A JSON object containing the Amazon Resource Name (ARN) of the gateway whose maintenance start time is updated.
" }, "UpdateNFSFileShareInput":{ "type":"structure", @@ -4429,11 +4585,11 @@ }, "KMSEncrypted":{ "shape":"Boolean", - "documentation":"True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
" + "documentation":"True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
" }, "KMSKey":{ "shape":"KMSKey", - "documentation":"The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
" + "documentation":"The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.
" }, "NFSFileShareDefaults":{ "shape":"NFSFileShareDefaults", @@ -4490,11 +4646,11 @@ }, "KMSEncrypted":{ "shape":"Boolean", - "documentation":"True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
" + "documentation":"True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
" }, "KMSKey":{ "shape":"KMSKey", - "documentation":"The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
" + "documentation":"The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.
" }, "DefaultStorageClass":{ "shape":"StorageClass", @@ -4531,6 +4687,10 @@ "InvalidUserList":{ "shape":"FileShareUserList", "documentation":"A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
The Amazon Resource Name (ARN) of the storage used for the audit logs.
" } }, "documentation":"UpdateSMBFileShareInput
" @@ -4604,7 +4764,7 @@ "documentation":"The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
" } }, - "documentation":"A JSON object containing the of the updated storage volume.
" + "documentation":"A JSON object containing the Amazon Resource Name (ARN) of the updated storage volume.
" }, "UpdateVTLDeviceTypeInput":{ "type":"structure", @@ -4803,5 +4963,5 @@ "long":{"type":"long"}, "string":{"type":"string"} }, - "documentation":"AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and the AWS storage infrastructure. The service enables you to securely upload data to the AWS cloud for cost effective backup and rapid disaster recovery.
Use the following links to get started using the AWS Storage Gateway Service API Reference:
AWS Storage Gateway Required Request Headers: Describes the required headers that you must send with every POST request to AWS Storage Gateway.
Signing Requests: AWS Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request.
Error Responses: Provides reference information about AWS Storage Gateway errors.
Operations in AWS Storage Gateway: Contains detailed descriptions of all AWS Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses.
AWS Storage Gateway Regions and Endpoints: Provides a list of each AWS Region and the endpoints available for use with AWS Storage Gateway.
AWS Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use this ID with the EC2 API, you must change it to vol-aa22bb012345daf670. Otherwise, the EC2 API might not behave as expected.
IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer format. Starting in December 2016, all new volumes and snapshots will be created with a 17-character string. Starting in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more information, see Longer EC2 and EBS Resource IDs.
For example, a volume Amazon Resource Name (ARN) with the longer volume ID format looks like the following:
arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.
A snapshot ID with the longer ID format looks like the following: snap-78e226633445566ee.
For more information, see Announcement: Heads-up – Longer AWS Storage Gateway volume and snapshot IDs coming in 2016.
AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and the AWS storage infrastructure. The service enables you to securely upload data to the AWS Cloud for cost effective backup and rapid disaster recovery.
Use the following links to get started using the AWS Storage Gateway Service API Reference:
AWS Storage Gateway Required Request Headers: Describes the required headers that you must send with every POST request to AWS Storage Gateway.
Signing Requests: AWS Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request.
Error Responses: Provides reference information about AWS Storage Gateway errors.
Operations in AWS Storage Gateway: Contains detailed descriptions of all AWS Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses.
AWS Storage Gateway Regions and Endpoints: Provides a list of each AWS Region and the endpoints available for use with AWS Storage Gateway.
AWS Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use this ID with the EC2 API, you must change it to vol-aa22bb012345daf670. Otherwise, the EC2 API might not behave as expected.
IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer format. Starting in December 2016, all new volumes and snapshots will be created with a 17-character string. Starting in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more information, see Longer EC2 and EBS Resource IDs.
For example, a volume Amazon Resource Name (ARN) with the longer volume ID format looks like the following:
arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.
A snapshot ID with the longer ID format looks like the following: snap-78e226633445566ee.
For more information, see Announcement: Heads-up – Longer AWS Storage Gateway volume and snapshot IDs coming in 2016.
Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. Canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. You can set up a canary to run continuously or just once.
Do not use CreateCanary to modify an existing canary. Use UpdateCanary instead.
To create canaries, you must have the CloudWatchSyntheticsFullAccess policy. If you are creating a new IAM role for the canary, you also need the the iam:CreateRole, iam:CreatePolicy and iam:AttachRolePolicy permissions. For more information, see Necessary Roles and Permissions.
Do not include secrets or proprietary information in your canary names. The canary name makes up part of the Amazon Resource Name (ARN) for the canary, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.
" + }, + "DeleteCanary":{ + "name":"DeleteCanary", + "http":{ + "method":"DELETE", + "requestUri":"/canary/{name}" + }, + "input":{"shape":"DeleteCanaryRequest"}, + "output":{"shape":"DeleteCanaryResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"Permanently deletes the specified canary.
When you delete a canary, resources used and created by the canary are not automatically deleted. After you delete a canary that you do not intend to use again, you should also delete the following:
The Lambda functions and layers used by this canary. These have the prefix cwsyn-MyCanaryName .
The CloudWatch alarms created for this canary. These alarms have a name of Synthetics-SharpDrop-Alarm-MyCanaryName .
Amazon S3 objects and buckets, such as the canary's artifact location.
IAM roles created for the canary. If they were created in the console, these roles have the name role/service-role/CloudWatchSyntheticsRole-MyCanaryName .
CloudWatch Logs log groups created for the canary. These logs groups have the name /aws/lambda/cwsyn-MyCanaryName .
Before you delete a canary, you might want to use GetCanary to display the information about this canary. Make note of the information returned by this operation so that you can delete these resources after you delete the canary.
This operation returns a list of the canaries in your account, along with full details about each canary.
This operation does not have resource-level authorization, so if a user is able to use DescribeCanaries, the user can see all of the canaries in the account. A deny policy can only be used to restrict access to all canaries. It cannot be used on specific resources.
Use this operation to see information from the most recent run of each canary that you have created.
" + }, + "DescribeRuntimeVersions":{ + "name":"DescribeRuntimeVersions", + "http":{ + "method":"POST", + "requestUri":"/runtime-versions" + }, + "input":{"shape":"DescribeRuntimeVersionsRequest"}, + "output":{"shape":"DescribeRuntimeVersionsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions.
" + }, + "GetCanary":{ + "name":"GetCanary", + "http":{ + "method":"GET", + "requestUri":"/canary/{name}" + }, + "input":{"shape":"GetCanaryRequest"}, + "output":{"shape":"GetCanaryResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"Retrieves complete information about one canary. You must specify the name of the canary that you want. To get a list of canaries and their names, use DescribeCanaries.
" + }, + "GetCanaryRuns":{ + "name":"GetCanaryRuns", + "http":{ + "method":"POST", + "requestUri":"/canary/{name}/runs" + }, + "input":{"shape":"GetCanaryRunsRequest"}, + "output":{"shape":"GetCanaryRunsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Retrieves a list of runs for a specified canary.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Displays the tags associated with a canary.
" + }, + "StartCanary":{ + "name":"StartCanary", + "http":{ + "method":"POST", + "requestUri":"/canary/{name}/start" + }, + "input":{"shape":"StartCanaryRequest"}, + "output":{"shape":"StartCanaryResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"Use this operation to run a canary that has already been created. The frequency of the canary runs is determined by the value of the canary's Schedule. To see a canary's schedule, use GetCanary.
Stops the canary to prevent all future runs. If the canary is currently running, Synthetics stops waiting for the current run of the specified canary to complete. The run that is in progress completes on its own, publishes metrics, and uploads artifacts, but it is not recorded in Synthetics as a completed run.
You can use StartCanary to start it running again with the canary’s current schedule at any point in the future.
Assigns one or more tags (key-value pairs) to the specified canary.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
You can use the TagResource action with a canary that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a canary.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Removes one or more tags from the specified canary.
" + }, + "UpdateCanary":{ + "name":"UpdateCanary", + "http":{ + "method":"PATCH", + "requestUri":"/canary/{name}" + }, + "input":{"shape":"UpdateCanaryRequest"}, + "output":{"shape":"UpdateCanaryResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"Use this operation to change the settings of a canary that has already been created.
You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use TagResource.
" + } + }, + "shapes":{ + "Arn":{ + "type":"string", + "pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$" + }, + "Blob":{ + "type":"blob", + "max":10000000, + "min":1 + }, + "Canaries":{ + "type":"list", + "member":{"shape":"Canary"} + }, + "CanariesLastRun":{ + "type":"list", + "member":{"shape":"CanaryLastRun"} + }, + "Canary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"UUID", + "documentation":"The unique ID of this canary.
" + }, + "Name":{ + "shape":"CanaryName", + "documentation":"The name of the canary.
" + }, + "Code":{"shape":"CanaryCodeOutput"}, + "ExecutionRoleArn":{ + "shape":"Arn", + "documentation":"The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust policy.
A structure that contains information about how often the canary is to run, and when these runs are to stop.
" + }, + "RunConfig":{"shape":"CanaryRunConfigOutput"}, + "SuccessRetentionPeriodInDays":{ + "shape":"MaxSize1024", + "documentation":"The number of days to retain data about successful runs of this canary.
" + }, + "FailureRetentionPeriodInDays":{ + "shape":"MaxSize1024", + "documentation":"The number of days to retain data about failed runs of this canary.
" + }, + "Status":{ + "shape":"CanaryStatus", + "documentation":"A structure that contains information about the canary's status.
" + }, + "Timeline":{ + "shape":"CanaryTimeline", + "documentation":"A structure that contains information about when the canary was created, modified, and most recently run.
" + }, + "ArtifactS3Location":{ + "shape":"String", + "documentation":"The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.
" + }, + "EngineArn":{ + "shape":"Arn", + "documentation":"The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions.
" + }, + "RuntimeVersion":{ + "shape":"String", + "documentation":"Specifies the runtime version to use for the canary. Currently, the only valid value is syn-1.0. For more information about runtime versions, see Canary Runtime Versions.
The list of key-value pairs that are associated with the canary.
" + } + }, + "documentation":"This structure contains all information about one canary in your account.
" + }, + "CanaryCodeInput":{ + "type":"structure", + "required":["Handler"], + "members":{ + "S3Bucket":{ + "shape":"String", + "documentation":"If your canary script is located in S3, specify the full bucket name here. The bucket must already exist. Specify the full bucket name, including s3:// as the start of the bucket name.
The S3 key of your script. For more information, see Working with Amazon S3 Objects.
" + }, + "S3Version":{ + "shape":"String", + "documentation":"The S3 version ID of your script.
" + }, + "ZipFile":{ + "shape":"Blob", + "documentation":"If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the .zip file that contains the script. It can be up to 5 MB.
" + }, + "Handler":{ + "shape":"String", + "documentation":"The entry point to use for the source code when running the canary. This value must end with the string .handler.
Use this structure to input your script code for the canary. This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. If the script was passed into the canary directly, the script code is contained in the value of Zipfile.
The ARN of the Lambda layer where Synthetics stores the canary script code.
" + }, + "Handler":{ + "shape":"String", + "documentation":"The entry point to use for the source code when running the canary.
" + } + }, + "documentation":"This structure contains information about the canary's Lambda handler and where its code is stored by CloudWatch Synthetics.
" + }, + "CanaryLastRun":{ + "type":"structure", + "members":{ + "CanaryName":{ + "shape":"CanaryName", + "documentation":"The name of the canary.
" + }, + "LastRun":{ + "shape":"CanaryRun", + "documentation":"The results from this canary's most recent run.
" + } + }, + "documentation":"This structure contains information about the most recent run of a single canary.
" + }, + "CanaryName":{ + "type":"string", + "max":21, + "min":1, + "pattern":"^[0-9a-z_\\-]+$" + }, + "CanaryRun":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"CanaryName", + "documentation":"The name of the canary.
" + }, + "Status":{ + "shape":"CanaryRunStatus", + "documentation":"The status of this run.
" + }, + "Timeline":{ + "shape":"CanaryRunTimeline", + "documentation":"A structure that contains the start and end times of this run.
" + }, + "ArtifactS3Location":{ + "shape":"String", + "documentation":"The location where the canary stored artifacts from the run. Artifacts include the log file, screenshots, and HAR files.
" + } + }, + "documentation":"This structure contains the details about one run of one canary.
" + }, + "CanaryRunConfigInput":{ + "type":"structure", + "required":["TimeoutInSeconds"], + "members":{ + "TimeoutInSeconds":{ + "shape":"MaxFifteenMinutesInSeconds", + "documentation":"How long the canary is allowed to run before it must stop. If you omit this field, the frequency of the canary is used as this value, up to a maximum of 14 minutes.
" + } + }, + "documentation":"A structure that contains input information for a canary run.
" + }, + "CanaryRunConfigOutput":{ + "type":"structure", + "members":{ + "TimeoutInSeconds":{ + "shape":"MaxFifteenMinutesInSeconds", + "documentation":"How long the canary is allowed to run before it must stop.
" + } + }, + "documentation":"A structure that contains information for a canary run.
" + }, + "CanaryRunState":{ + "type":"string", + "enum":[ + "RUNNING", + "PASSED", + "FAILED" + ] + }, + "CanaryRunStateReasonCode":{ + "type":"string", + "enum":[ + "CANARY_FAILURE", + "EXECUTION_FAILURE" + ] + }, + "CanaryRunStatus":{ + "type":"structure", + "members":{ + "State":{ + "shape":"CanaryRunState", + "documentation":"The current state of the run.
" + }, + "StateReason":{ + "shape":"String", + "documentation":"If run of the canary failed, this field contains the reason for the error.
" + }, + "StateReasonCode":{ + "shape":"CanaryRunStateReasonCode", + "documentation":"If this value is CANARY_FAILURE, an exception occurred in the canary code. If this value is EXECUTION_FAILURE, an exception occurred in CloudWatch Synthetics.
This structure contains the status information about a canary run.
" + }, + "CanaryRunTimeline":{ + "type":"structure", + "members":{ + "Started":{ + "shape":"Timestamp", + "documentation":"The start time of the run.
" + }, + "Completed":{ + "shape":"Timestamp", + "documentation":"The end time of the run.
" + } + }, + "documentation":"This structure contains the start and end times of a single canary run.
" + }, + "CanaryRuns":{ + "type":"list", + "member":{"shape":"CanaryRun"} + }, + "CanaryScheduleInput":{ + "type":"structure", + "required":["Expression"], + "members":{ + "Expression":{ + "shape":"String", + "documentation":"A rate expression that defines how often the canary is to run. The syntax is rate(number unit). unit can be minute, minutes, or hour.
For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour).
Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.
How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value. If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.
This structure specifies how often a canary is to make runs and the date and time when it should stop making runs.
" + }, + "CanaryScheduleOutput":{ + "type":"structure", + "members":{ + "Expression":{ + "shape":"String", + "documentation":"A rate expression that defines how often the canary is to run. The syntax is rate(number unit). unit can be minute, minutes, or hour.
For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour.
Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.
How long, in seconds, for the canary to continue making regular runs after it was created. The runs are performed according to the schedule in the Expression value.
How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.
The current state of the canary.
" + }, + "StateReason":{ + "shape":"String", + "documentation":"If the canary has insufficient permissions to run, this field provides more details.
" + }, + "StateReasonCode":{ + "shape":"CanaryStateReasonCode", + "documentation":"If the canary cannot run or has failed, this field displays the reason.
" + } + }, + "documentation":"A structure that contains the current state of the canary.
" + }, + "CanaryTimeline":{ + "type":"structure", + "members":{ + "Created":{ + "shape":"Timestamp", + "documentation":"The date and time the canary was created.
" + }, + "LastModified":{ + "shape":"Timestamp", + "documentation":"The date and time the canary was most recently modified.
" + }, + "LastStarted":{ + "shape":"Timestamp", + "documentation":"The date and time that the canary's most recent run started.
" + }, + "LastStopped":{ + "shape":"Timestamp", + "documentation":"The date and time that the canary's most recent run ended.
" + } + }, + "documentation":"This structure contains information about when the canary was created and modified.
" + }, + "ConflictException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"A conflicting operation is already in progress.
", + "error":{"httpStatusCode":409}, + "exception":true + }, + "CreateCanaryRequest":{ + "type":"structure", + "required":[ + "Name", + "Code", + "ArtifactS3Location", + "ExecutionRoleArn", + "Schedule", + "RuntimeVersion" + ], + "members":{ + "Name":{ + "shape":"CanaryName", + "documentation":"The name for this canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account.
Do not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.
" + }, + "Code":{ + "shape":"CanaryCodeInput", + "documentation":"A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included.
" + }, + "ArtifactS3Location":{ + "shape":"String", + "documentation":"The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files.
" + }, + "ExecutionRoleArn":{ + "shape":"Arn", + "documentation":"The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:
s3:PutObject
s3:GetBucketLocation
s3:ListAllMyBuckets
cloudwatch:PutMetricData
logs:CreateLogGroup
logs:CreateLogStream
logs:CreateLogStream
A structure that contains information about how often the canary is to run and when these test runs are to stop.
" + }, + "RunConfig":{ + "shape":"CanaryRunConfigInput", + "documentation":"A structure that contains the configuration for individual canary runs, such as timeout value.
" + }, + "SuccessRetentionPeriodInDays":{ + "shape":"MaxSize1024", + "documentation":"The number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
" + }, + "FailureRetentionPeriodInDays":{ + "shape":"MaxSize1024", + "documentation":"The number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
" + }, + "RuntimeVersion":{ + "shape":"String", + "documentation":"Specifies the runtime version to use for the canary. Currently, the only valid value is syn-1.0. For more information about runtime versions, see Canary Runtime Versions.
If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.
" + } + } + }, + "CreateCanaryResponse":{ + "type":"structure", + "members":{ + "Canary":{ + "shape":"Canary", + "documentation":"The full details about the canary you have created.
" + } + } + }, + "DeleteCanaryRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"CanaryName", + "documentation":"The name of the canary that you want to delete. To find the names of your canaries, use DescribeCanaries.
", + "location":"uri", + "locationName":"name" + } + } + }, + "DeleteCanaryResponse":{ + "type":"structure", + "members":{ + } + }, + "DescribeCanariesLastRunRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"Token", + "documentation":"A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanaries operation to retrieve the next set of results.
Specify this parameter to limit how many runs are returned each time you use the DescribeLastRun operation. If you omit this parameter, the default of 100 is used.
An array that contains the information from the most recent run of each canary.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanariesLastRun operation to retrieve the next set of results.
A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.
" + }, + "MaxResults":{ + "shape":"MaxCanaryResults", + "documentation":"Specify this parameter to limit how many canaries are returned each time you use the DescribeCanaries operation. If you omit this parameter, the default of 100 is used.
Returns an array. Each item in the array contains the full information about one canary.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanaries operation to retrieve the next set of results.
A token that indicates that there is more data available. You can use this token in a subsequent DescribeRuntimeVersions operation to retrieve the next set of results.
Specify this parameter to limit how many runs are returned each time you use the DescribeRuntimeVersions operation. If you omit this parameter, the default of 100 is used.
An array of objects that display the details about each Synthetics canary runtime version.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"A token that indicates that there is more data available. You can use this token in a subsequent DescribeRuntimeVersions operation to retrieve the next set of results.
The name of the canary that you want details for.
", + "location":"uri", + "locationName":"name" + } + } + }, + "GetCanaryResponse":{ + "type":"structure", + "members":{ + "Canary":{ + "shape":"Canary", + "documentation":"A strucure that contains the full information about the canary.
" + } + } + }, + "GetCanaryRunsRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"CanaryName", + "documentation":"The name of the canary that you want to see runs for.
", + "location":"uri", + "locationName":"name" + }, + "NextToken":{ + "shape":"Token", + "documentation":"A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results.
Specify this parameter to limit how many runs are returned each time you use the GetCanaryRuns operation. If you omit this parameter, the default of 100 is used.
An array of structures. Each structure contains the details of one of the retrieved canary runs.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results.
An unknown internal error occurred.
", + "error":{"httpStatusCode":500}, + "exception":true + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"The ARN of the canary that you want to view tags for.
The ARN format of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name .
The list of tag keys and values associated with the canary that you specified.
" + } + } + }, + "MaxCanaryResults":{ + "type":"integer", + "max":20, + "min":1 + }, + "MaxFifteenMinutesInSeconds":{ + "type":"integer", + "max":900, + "min":60 + }, + "MaxOneYearInSeconds":{ + "type":"long", + "max":31622400, + "min":0 + }, + "MaxSize100":{ + "type":"integer", + "max":100, + "min":1 + }, + "MaxSize1024":{ + "type":"integer", + "max":1024, + "min":1 + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"One of the specified resources was not found.
", + "error":{"httpStatusCode":404}, + "exception":true + }, + "RuntimeVersion":{ + "type":"structure", + "members":{ + "VersionName":{ + "shape":"String", + "documentation":"The name of the runtime version. Currently, the only valid value is syn-1.0.
Specifies the runtime version to use for the canary. Currently, the only valid value is syn-1.0.
A description of the runtime version, created by Amazon.
" + }, + "ReleaseDate":{ + "shape":"Timestamp", + "documentation":"The date that the runtime version was released.
" + }, + "DeprecationDate":{ + "shape":"Timestamp", + "documentation":"If this runtime version is deprecated, this value is the date of deprecation.
" + } + }, + "documentation":"This structure contains information about one canary runtime version. For more information about runtime versions, see Canary Runtime Versions.
" + }, + "RuntimeVersionList":{ + "type":"list", + "member":{"shape":"RuntimeVersion"} + }, + "SecurityGroupId":{"type":"string"}, + "SecurityGroupIds":{ + "type":"list", + "member":{"shape":"SecurityGroupId"}, + "max":5, + "min":0 + }, + "StartCanaryRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"CanaryName", + "documentation":"The name of the canary that you want to run. To find canary names, use DescribeCanaries.
", + "location":"uri", + "locationName":"name" + } + } + }, + "StartCanaryResponse":{ + "type":"structure", + "members":{ + } + }, + "StopCanaryRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"CanaryName", + "documentation":"The name of the canary that you want to stop. To find the names of your canaries, use DescribeCanaries.
", + "location":"uri", + "locationName":"name" + } + } + }, + "StopCanaryResponse":{ + "type":"structure", + "members":{ + } + }, + "String":{ + "type":"string", + "max":1024, + "min":1 + }, + "SubnetId":{"type":"string"}, + "SubnetIds":{ + "type":"list", + "member":{"shape":"SubnetId"}, + "max":16, + "min":0 + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":50, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"The ARN of the canary that you're adding tags to.
The ARN format of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name .
The list of key-value pairs to associate with the canary.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256 + }, + "Timestamp":{"type":"timestamp"}, + "Token":{ + "type":"string", + "pattern":"^[a-zA-Z0-9=/+_.-]{4,252}$" + }, + "UUID":{ + "type":"string", + "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"The ARN of the canary that you're removing tags from.
The ARN format of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name .
The list of tag keys to remove from the resource.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateCanaryRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"CanaryName", + "documentation":"The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.
You cannot change the name of a canary that has already been created.
", + "location":"uri", + "locationName":"name" + }, + "Code":{ + "shape":"CanaryCodeInput", + "documentation":"A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included.
" + }, + "ExecutionRoleArn":{ + "shape":"Arn", + "documentation":"The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:
s3:PutObject
s3:GetBucketLocation
s3:ListAllMyBuckets
cloudwatch:PutMetricData
logs:CreateLogGroup
logs:CreateLogStream
logs:CreateLogStream
Specifies the runtime version to use for the canary. Currently, the only valid value is syn-1.0. For more information about runtime versions, see Canary Runtime Versions.
A structure that contains information about how often the canary is to run, and when these runs are to stop.
" + }, + "RunConfig":{ + "shape":"CanaryRunConfigInput", + "documentation":"A structure that contains the timeout value that is used for each individual run of the canary.
" + }, + "SuccessRetentionPeriodInDays":{ + "shape":"MaxSize1024", + "documentation":"The number of days to retain data about successful runs of this canary.
" + }, + "FailureRetentionPeriodInDays":{ + "shape":"MaxSize1024", + "documentation":"The number of days to retain data about failed runs of this canary.
" + }, + "VpcConfig":{ + "shape":"VpcConfigInput", + "documentation":"If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC.
" + } + } + }, + "UpdateCanaryResponse":{ + "type":"structure", + "members":{ + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"A parameter could not be validated.
", + "error":{"httpStatusCode":400}, + "exception":true + }, + "VpcConfigInput":{ + "type":"structure", + "members":{ + "SubnetIds":{ + "shape":"SubnetIds", + "documentation":"The IDs of the subnets where this canary is to run.
" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"The IDs of the security groups for this canary.
" + } + }, + "documentation":"If this canary is to test an endpoint in a VPC, this structure contains information about the subnets and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC.
" + }, + "VpcConfigOutput":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"VpcId", + "documentation":"The IDs of the VPC where this canary is to run.
" + }, + "SubnetIds":{ + "shape":"SubnetIds", + "documentation":"The IDs of the subnets where this canary is to run.
" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"The IDs of the security groups for this canary.
" + } + }, + "documentation":"If this canary is to test an endpoint in a VPC, this structure contains information about the subnets and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC.
" + }, + "VpcId":{"type":"string"} + }, + "documentation":"You can use Amazon CloudWatch Synthetics to continually monitor your services. You can create and manage canaries, which are modular, lightweight scripts that monitor your endpoints and APIs from the outside-in. You can set up your canaries to run 24 hours a day, once per minute. The canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. The canaries seamlessly integrate with CloudWatch ServiceLens to help you trace the causes of impacted nodes in your applications. For more information, see Using ServiceLens to Monitor the Health of Your Applications in the Amazon CloudWatch User Guide.
Before you create and manage canaries, be aware of the security considerations. For more information, see Security Considerations for Synthetics Canaries.
" +} diff --git a/botocore/data/transcribe/2017-10-26/examples-1.json b/botocore/data/transcribe/2017-10-26/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/transcribe/2017-10-26/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/transcribe/2017-10-26/service-2.json b/botocore/data/transcribe/2017-10-26/service-2.json index fc8743b7..b7412a64 100644 --- a/botocore/data/transcribe/2017-10-26/service-2.json +++ b/botocore/data/transcribe/2017-10-26/service-2.json @@ -45,6 +45,20 @@ ], "documentation":"Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job.
" }, + "DeleteMedicalTranscriptionJob":{ + "name":"DeleteMedicalTranscriptionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteMedicalTranscriptionJobRequest"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"BadRequestException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"Deletes a transcription job generated by Amazon Transcribe Medical and any related information.
" + }, "DeleteTranscriptionJob":{ "name":"DeleteTranscriptionJob", "http":{ @@ -89,6 +103,22 @@ ], "documentation":"Removes a vocabulary filter.
" }, + "GetMedicalTranscriptionJob":{ + "name":"GetMedicalTranscriptionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMedicalTranscriptionJobRequest"}, + "output":{"shape":"GetMedicalTranscriptionJobResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"NotFoundException"} + ], + "documentation":"Returns information about a transcription job from Amazon Transcribe Medical. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You find the results of the completed job in the TranscriptFileUri field.
Returns information about a vocabulary filter.
" }, + "ListMedicalTranscriptionJobs":{ + "name":"ListMedicalTranscriptionJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListMedicalTranscriptionJobsRequest"}, + "output":{"shape":"ListMedicalTranscriptionJobsResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"Lists medical transcription jobs with a specified status or substring that matches their names.
" + }, "ListTranscriptionJobs":{ "name":"ListTranscriptionJobs", "http":{ @@ -182,6 +227,22 @@ ], "documentation":"Gets information about vocabulary filters.
" }, + "StartMedicalTranscriptionJob":{ + "name":"StartMedicalTranscriptionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartMedicalTranscriptionJobRequest"}, + "output":{"shape":"StartMedicalTranscriptionJobResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"ConflictException"} + ], + "documentation":"Start a batch job to transcribe medical speech to text.
" + }, "StartTranscriptionJob":{ "name":"StartTranscriptionJob", "http":{ @@ -263,10 +324,10 @@ }, "RedactionOutput":{ "shape":"RedactionOutput", - "documentation":"Request parameter where you choose whether to output only the redacted transcript or generate an additional unredacted transcript.
When you choose redacted Amazon Transcribe outputs a JSON file with only the redacted transcript and related information.
When you choose redacted_and_unredacted Amazon Transcribe outputs a JSON file with the unredacted transcript and related information in addition to the JSON file with the redacted transcript.
The output transcript file stored in either the default S3 bucket or in a bucket you specify.
When you choose redacted Amazon Transcribe outputs only the redacted transcript.
When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted and unredacted transcripts.
Settings for content redaction within a transcription job.
You can redact transcripts in US English (en-us). For more information see: Automatic Content Redaction
" + "documentation":"Settings for content redaction within a transcription job.
" }, "CreateVocabularyFilterRequest":{ "type":"structure", @@ -365,6 +426,16 @@ "pattern":"^arn:aws:iam::[0-9]{0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1023}$" }, "DateTime":{"type":"timestamp"}, + "DeleteMedicalTranscriptionJobRequest":{ + "type":"structure", + "required":["MedicalTranscriptionJobName"], + "members":{ + "MedicalTranscriptionJobName":{ + "shape":"TranscriptionJobName", + "documentation":"The name you provide to the DeleteMedicalTranscriptionJob object to delete a transcription job.
The name of the medical transcription job.
" + } + } + }, + "GetMedicalTranscriptionJobResponse":{ + "type":"structure", + "members":{ + "MedicalTranscriptionJob":{ + "shape":"MedicalTranscriptionJob", + "documentation":"An object that contains the results of the medical transcription job.
" + } + } + }, "GetTranscriptionJobRequest":{ "type":"structure", "required":["TranscriptionJobName"], @@ -499,11 +589,11 @@ "members":{ "AllowDeferredExecution":{ "shape":"Boolean", - "documentation":"Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the AllowDeferredExecution field is true, jobs are queued and will be executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a LimitExceededException exception.
If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the AllowDeferredExecution field is true, jobs are queued and executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a LimitExceededException exception.
If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe will assume this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.
If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.
If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
Provides information about when a transcription job should be executed.
" @@ -558,6 +648,44 @@ "documentation":"Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
", "exception":true }, + "ListMedicalTranscriptionJobsRequest":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"TranscriptionJobStatus", + "documentation":"When specified, returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don't specify a status, Amazon Transcribe Medical returns all transcription jobs ordered by creation date.
" + }, + "JobNameContains":{ + "shape":"TranscriptionJobName", + "documentation":"When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If you a receive a truncated result in the previous request of ListMedicalTranscriptionJobs, include NextToken to fetch the next set of jobs.
The maximum number of medical transcription jobs to return in the response. IF there are fewer results in the list, this response contains only the actual results.
" + } + } + }, + "ListMedicalTranscriptionJobsResponse":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"TranscriptionJobStatus", + "documentation":"The requested status of the medical transcription jobs returned.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The ListMedicalTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If the number of jobs exceeds what can fit on a page, Amazon Transcribe Medical returns the NextPage token. Include the token in the next request to the ListMedicalTranscriptionJobs operation to return in the next page of jobs.
A list of objects containing summary information for a transcription job.
" + } + } + }, "ListTranscriptionJobsRequest":{ "type":"structure", "members":{ @@ -613,7 +741,7 @@ }, "NameContains":{ "shape":"VocabularyName", - "documentation":"When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is case-insensitive, ListVocabularies will return both \"vocabularyname\" and \"VocabularyName\" in the response list.
When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is case-insensitive, ListVocabularies returns both \"vocabularyname\" and \"VocabularyName\" in the response list.
The list of vocabulary filters. It will contain at most MaxResults number of filters. If there are more filters, call the ListVocabularyFilters operation again with the NextToken parameter in the request set to the value of the NextToken field in the response.
The list of vocabulary filters. It contains at most MaxResults number of filters. If there are more filters, call the ListVocabularyFilters operation again with the NextToken parameter in the request set to the value of the NextToken field in the response.
The S3 object location of the medical transcript.
Use this URI to access the medical transcript. This URI points to the S3 bucket you created to store the medical transcript.
" + } + }, + "documentation":"Identifies the location of a medical transcript.
" + }, + "MedicalTranscriptionJob":{ + "type":"structure", + "members":{ + "MedicalTranscriptionJobName":{ + "shape":"TranscriptionJobName", + "documentation":"The name for a given medical transcription job.
" + }, + "TranscriptionJobStatus":{ + "shape":"TranscriptionJobStatus", + "documentation":"The completion status of a medical transcription job.
" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"The language code for the language spoken in the source audio file. US English (en-US) is the only supported language for medical transcriptions. Any other value you enter for language code results in a BadRequestException error.
The sample rate, in Hertz, of the source audio containing medical information.
If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleHertz blank and let Amazon Transcribe Medical determine the sample rate.
The format of the input media file.
" + }, + "Media":{"shape":"Media"}, + "Transcript":{ + "shape":"MedicalTranscript", + "documentation":"An object that contains the MedicalTranscript. The MedicalTranscript contains the TranscriptFileUri.
A timestamp that shows when the job started processing.
" + }, + "CreationTime":{ + "shape":"DateTime", + "documentation":"A timestamp that shows when the job was created.
" + }, + "CompletionTime":{ + "shape":"DateTime", + "documentation":"A timestamp that shows when the job was completed.
" + }, + "FailureReason":{ + "shape":"FailureReason", + "documentation":"If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.
The FailureReason field contains one of the following values:
Unsupported media format- The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values.
The media format provided does not match the detected media format- The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure the two values match.
Invalid sample rate for audio file- The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8000 and 48000 Hertz.
The sample rate provided does not match the detected sample rate- The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.
Invalid file size: file size too large- The size of your audio file is larger than what Amazon Transcribe Medical can process. For more information, see Guidlines and Quotas in the Amazon Transcribe Medical Guide
Invalid number of channels: number of channels too large- Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web Services General Reference
Object that contains object.
" + }, + "Specialty":{ + "shape":"Specialty", + "documentation":"The medical specialty of any clinicians providing a dictation or having a conversation. PRIMARYCARE is the only available setting for this object. This specialty enables you to generate transcriptions for the following medical fields:
Family Medicine
The type of speech in the transcription job. CONVERSATION is generally used for patient-physician dialogues. DICTATION is the setting for physicians speaking their notes after seeing a patient. For more information, see how-it-works-med
The data structure that containts the information for a medical transcription job.
" + }, + "MedicalTranscriptionJobSummaries":{ + "type":"list", + "member":{"shape":"MedicalTranscriptionJobSummary"} + }, + "MedicalTranscriptionJobSummary":{ + "type":"structure", + "members":{ + "MedicalTranscriptionJobName":{ + "shape":"TranscriptionJobName", + "documentation":"The name of a medical transcription job.
" + }, + "CreationTime":{ + "shape":"DateTime", + "documentation":"A timestamp that shows when the medical transcription job was created.
" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"A timestamp that shows when the job began processing.
" + }, + "CompletionTime":{ + "shape":"DateTime", + "documentation":"A timestamp that shows when the job was completed.
" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"The language of the transcript in the source audio file.
" + }, + "TranscriptionJobStatus":{ + "shape":"TranscriptionJobStatus", + "documentation":"The status of the medical transcription job.
" + }, + "FailureReason":{ + "shape":"FailureReason", + "documentation":"If the TranscriptionJobStatus field is FAILED, a description of the error.
Indicates the location of the transcription job's output.
The CUSTOMER_BUCKET is the S3 location provided in the OutputBucketName field when the
The medical specialty of the transcription job. Primary care is the only valid value.
The speech of the clinician in the input audio.
" + } + }, + "documentation":"Provides summary information about a transcription job.
" + }, + "MedicalTranscriptionSetting":{ + "type":"structure", + "members":{ + "ShowSpeakerLabels":{ + "shape":"Boolean", + "documentation":"Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recongition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels in the MaxSpeakerLabels field.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Amazon Transcribe Medical also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of item. The alternative transcriptions also come with confidence scores provided by Amazon Transcribe Medical.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException
Determines whether alternative transcripts are generated along with the transcript that has the highest confidence. If you set ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
The maximum number of alternatives that you tell the service to return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
Optional settings for the StartMedicalTranscriptionJob operation.
" + }, "NextToken":{ "type":"string", "max":8192, @@ -762,7 +1035,7 @@ }, "MaxSpeakerLabels":{ "shape":"MaxSpeakers", - "documentation":"The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers will be identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
Provides optional settings for the StartTranscriptionJob operation.
The name of the medical transcription job. You can't use the strings \".\" or \"..\" by themselves as the job name. The name must also be unique within an AWS account.
" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.
The sample rate, in Hertz, of the audio track in the input media file.
If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine the sample rate.
The audio format of the input media file.
" + }, + "Media":{"shape":"Media"}, + "OutputBucketName":{ + "shape":"OutputBucketName", + "documentation":"The Amazon S3 location where the transcription is stored.
You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles.
You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.
You use either of the following to identify a KMS key in the current account:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
KMS Key Alias: \"alias/ExampleAlias\"
You can use either of the following to identify a KMS key in the current account or another account:
Amazon Resource Name (ARN) of a KMS key in the current account or another account: \"arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
ARN of a KMS Key Alias: \"arn:aws:kms:region:account ID:alias/ExampleAlias\"
If you don't specify an encryption key, the output of the medical transcription job is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.
Optional settings for the medical transcription job.
" + }, + "Specialty":{ + "shape":"Specialty", + "documentation":"The medical specialty of any clinician speaking in the input media.
" + }, + "Type":{ + "shape":"Type", + "documentation":"The speech of clinician in the input audio. CONVERSATION refers to conversations clinicians have with patients. DICTATION refers to medical professionals dictating their notes about a patient encounter.
A batch job submitted to transcribe medical speech to text.
" + } + } + }, "StartTranscriptionJobRequest":{ "type":"structure", "required":[ @@ -984,6 +1320,13 @@ }, "documentation":"Provides a summary of information about a transcription job.
" }, + "Type":{ + "type":"string", + "enum":[ + "CONVERSATION", + "DICTATION" + ] + }, "UpdateVocabularyFilterRequest":{ "type":"structure", "required":["VocabularyFilterName"], diff --git a/botocore/data/transfer/2018-11-05/service-2.json b/botocore/data/transfer/2018-11-05/service-2.json index 63b3b0b2..42cf1211 100644 --- a/botocore/data/transfer/2018-11-05/service-2.json +++ b/botocore/data/transfer/2018-11-05/service-2.json @@ -6,7 +6,7 @@ "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"AWS Transfer", - "serviceFullName":"AWS Transfer for SFTP", + "serviceFullName":"AWS Transfer Family", "serviceId":"Transfer", "signatureVersion":"v4", "signingName":"transfer", @@ -23,12 +23,14 @@ "input":{"shape":"CreateServerRequest"}, "output":{"shape":"CreateServerResponse"}, "errors":[ + {"shape":"AccessDeniedException"}, {"shape":"ServiceUnavailableException"}, {"shape":"InternalServiceError"}, {"shape":"InvalidRequestException"}, - {"shape":"ResourceExistsException"} + {"shape":"ResourceExistsException"}, + {"shape":"ThrottlingException"} ], - "documentation":"Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS. When you make updates to your server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.
Instantiates an autoscaling virtual server based on the selected file transfer protocol in AWS. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.
Creates a user and associates them with an existing Secure File Transfer Protocol (SFTP) server. You can only create and associate users with SFTP servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.
Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.
Deletes the Secure File Transfer Protocol (SFTP) server that you specify.
No response returns from this operation.
" + "documentation":"Deletes the file transfer protocol-enabled server that you specify.
No response returns from this operation.
" }, "DeleteSshPublicKey":{ "name":"DeleteSshPublicKey", @@ -91,7 +94,7 @@ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Deletes the user belonging to the server you specify.
No response returns from this operation.
When you delete a user from a server, the user's information is lost.
Deletes the user belonging to a file transfer protocol-enabled server you specify.
No response returns from this operation.
When you delete a user from a server, the user's information is lost.
Describes the server that you specify by passing the ServerId parameter.
The response contains a description of the server's properties. When you set EndpointType to VPC, the response will contain the EndpointDetails.
Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
The response contains a description of a server's properties. When you set EndpointType to VPC, the response will contain the EndpointDetails.
Describes the user assigned to a specific server, as identified by its ServerId property.
The response from this call returns the properties of the user associated with the ServerId value that was specified.
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property.
The response from this call returns the properties of the user associated with the ServerId value that was specified.
Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to a specific server, identified by ServerId.
The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.
Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to the specific file transfer protocol-enabled server, identified by ServerId.
The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.
Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.
" + "documentation":"Lists the file transfer protocol-enabled servers that are associated with your AWS account.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", @@ -190,7 +193,7 @@ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Lists the users for the server that you specify by passing the ServerId parameter.
Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
Changes the state of a Secure File Transfer Protocol (SFTP) server from OFFLINE to ONLINE. It has no impact on an SFTP server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.
The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.
No response is returned from this call.
" + "documentation":"Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.
The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.
No response is returned from this call.
" }, "StopServer":{ "name":"StopServer", @@ -222,7 +225,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], - "documentation":"Changes the state of an SFTP server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server such as server and user properties are not affected by stopping your server. Stopping a server will not reduce or impact your Secure File Transfer Protocol (SFTP) endpoint billing.
The state of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.
No response is returned from this call.
" + "documentation":"Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server. Stopping the server will not reduce or impact your file transfer protocol endpoint billing.
The state of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.
No response is returned from this call.
" }, "TagResource":{ "name":"TagResource", @@ -253,7 +256,7 @@ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"If the IdentityProviderType of the server is API_Gateway, tests whether your API Gateway is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the API Gateway integration to ensure that your users can successfully use the service.
If the IdentityProviderType of a file transfer protocol-enabled server is API_Gateway, tests whether your API Gateway is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the API Gateway integration to ensure that your users can successfully use the service.
Updates the server properties after that server has been created.
The UpdateServer call returns the ServerId of the Secure File Transfer Protocol (SFTP) server you updated.
Updates the file transfer protocol-enabled server's properties after that server has been created.
The UpdateServer call returns the ServerId of the server you updated.
You do not have sufficient access to perform this action.
", + "exception":true, + "synthetic":true + }, "AddressAllocationId":{"type":"string"}, "AddressAllocationIds":{ "type":"list", @@ -319,45 +332,57 @@ "min":20, "pattern":"arn:.*" }, + "Certificate":{ + "type":"string", + "max":1600 + }, "ConflictException":{ "type":"structure", "required":["Message"], "members":{ "Message":{"shape":"Message"} }, - "documentation":"This exception is thrown when the UpdatServer is called for a server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state.
This exception is thrown when the UpdatServer is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state.
The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.
The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IPs and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
" }, "EndpointType":{ "shape":"EndpointType", - "documentation":"The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
" + "documentation":"The type of VPC endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.
" }, "HostKey":{ "shape":"HostKey", - "documentation":"The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
" + "documentation":"The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see Changing the Host Key for Your AWS Transfer Family Server in the AWS Transfer Family User Guide.
" }, "IdentityProviderDetails":{ "shape":"IdentityProviderDetails", - "documentation":"This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
Required when IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED.
Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
Specifies the mode of authentication for a file transfer protocol-enabled server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the AWS Transfer Family service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
" + "documentation":"Allows the service to write your users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
" + }, + "Protocols":{ + "shape":"Protocols", + "documentation":"Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
File Transfer Protocol (FTP): Unencrypted file transfer
Key-value pairs that can be used to group and search for servers.
" + "documentation":"Key-value pairs that can be used to group and search for file transfer protocol-enabled servers.
" } } }, @@ -367,7 +392,7 @@ "members":{ "ServerId":{ "shape":"ServerId", - "documentation":"The service-assigned ID of the SFTP server that is created.
" + "documentation":"The service-assigned ID of the file transfer protocol-enabled server that is created.
" } } }, @@ -381,31 +406,31 @@ "members":{ "HomeDirectory":{ "shape":"HomeDirectory", - "documentation":"The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
The landing directory (folder) for a user when they log in to the file transfer protocol-enabled server using the client.
An example is your-Amazon-S3-bucket-name>/home/username.
The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
The type of landing directory (folder) you want your users' home directory to be when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.
Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in Amazon S3, the entry will be ignored. As a workaround, you can use the Amazon S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a '/' for it to be considered a folder.
A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see Creating a Scope-Down Policy.
For more information, see AssumeRole in the AWS Security Token Service API Reference.
The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
" + "documentation":"The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.
" }, "ServerId":{ "shape":"ServerId", - "documentation":"A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
" + "documentation":"A system-assigned unique identifier for a file transfer protocol-enabled server instance. This is the specific server that you added your user to.
" }, "SshPublicKeyBody":{ "shape":"SshPublicKeyBody", - "documentation":"The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
" + "documentation":"The public portion of the Secure Shell (SSH) key used to authenticate the user to the file transfer protocol-enabled server.
" }, "Tags":{ "shape":"Tags", @@ -413,7 +438,7 @@ }, "UserName":{ "shape":"UserName", - "documentation":"A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
A unique string that identifies a user and is associated with a file transfer protocol-enabled server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
The ID of the SFTP server that the user is attached to.
" + "documentation":"The ID of the file transfer protocol-enabled server that the user is attached to.
" }, "UserName":{ "shape":"UserName", - "documentation":"A unique string that identifies a user account associated with an SFTP server.
" + "documentation":"A unique string that identifies a user account associated with a file transfer protocol-enabled server.
" } } }, @@ -441,7 +466,7 @@ "members":{ "ServerId":{ "shape":"ServerId", - "documentation":"A unique system-assigned identifier for an SFTP server instance.
" + "documentation":"A unique system-assigned identifier for a file transfer protocol-enabled server instance.
" } } }, @@ -455,7 +480,7 @@ "members":{ "ServerId":{ "shape":"ServerId", - "documentation":"A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
" + "documentation":"A system-assigned unique identifier for a file transfer protocol-enabled server instance that has the user assigned to it.
" }, "SshPublicKeyId":{ "shape":"SshPublicKeyId", @@ -476,11 +501,11 @@ "members":{ "ServerId":{ "shape":"ServerId", - "documentation":"A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
" + "documentation":"A system-assigned unique identifier for a file transfer protocol-enabled server instance that has the user assigned to it.
" }, "UserName":{ "shape":"UserName", - "documentation":"A unique string that identifies a user that is being deleted from the server.
" + "documentation":"A unique string that identifies a user that is being deleted from a file transfer protocol-enabled server.
" } } }, @@ -490,7 +515,7 @@ "members":{ "ServerId":{ "shape":"ServerId", - "documentation":"A system-assigned unique identifier for an SFTP server.
" + "documentation":"A system-assigned unique identifier for a file transfer protocol-enabled server.
" } } }, @@ -500,7 +525,7 @@ "members":{ "Server":{ "shape":"DescribedServer", - "documentation":"An array containing the properties of the server with the ServerID you specified.
An array containing the properties of a file transfer protocol-enabled server with the ServerID you specified.
A system-assigned unique identifier for an SFTP server that has this user assigned.
" + "documentation":"A system-assigned unique identifier for a file transfer protocol-enabled server that has this user assigned.
" }, "UserName":{ "shape":"UserName", - "documentation":"The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
" + "documentation":"The name of the user assigned to one or more file transfer protocol-enabled servers. User names are part of the sign-in credentials to use the AWS Transfer Family service and perform file transfer tasks.
" } } }, @@ -530,7 +555,7 @@ "members":{ "ServerId":{ "shape":"ServerId", - "documentation":"A system-assigned unique identifier for an SFTP server that has this user assigned.
" + "documentation":"A system-assigned unique identifier for a file transfer protocol-enabled server that has this user assigned.
" }, "User":{ "shape":"DescribedUser", @@ -544,50 +569,58 @@ "members":{ "Arn":{ "shape":"Arn", - "documentation":"Specifies the unique Amazon Resource Name (ARN) for the server to be described.
" + "documentation":"Specifies the unique Amazon Resource Name (ARN) for a file transfer protocol-enabled server to be described.
" + }, + "Certificate":{ + "shape":"Certificate", + "documentation":"The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.
The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
" + "documentation":"The virtual private cloud (VPC) endpoint settings that you configured for your file transfer protocol-enabled server.
" }, "EndpointType":{ "shape":"EndpointType", - "documentation":"The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
" + "documentation":"The type of endpoint that your file transfer protocol-enabled server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
" }, "HostKeyFingerprint":{ "shape":"HostKeyFingerprint", - "documentation":"This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
Contains the message-digest algorithm (MD5) hash of a file transfer protocol-enabled server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a file transfer protocol-enabled server is SERVICE_MANAGED.
This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
Defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this file transfer protocol-enabled server to store and access user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
" + "documentation":"An AWS Identity and Access Management (IAM) entity that allows a file transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
" + }, + "Protocols":{ + "shape":"Protocols", + "documentation":"Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
File Transfer Protocol (FTP): Unencrypted file transfer
This property is a unique system-assigned identifier for the SFTP server that you instantiate.
" + "documentation":"Unique system-assigned identifier for a file transfer protocol-enabled server that you instantiate.
" }, "State":{ "shape":"State", - "documentation":"The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
The condition of a file transfer protocol-enabled server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
" + "documentation":"Contains the key-value pairs that you can use to search for and group file transfer protocol-enabled servers that were assigned to the server that was described.
" }, "UserCount":{ "shape":"UserCount", - "documentation":"The number of users that are assigned to the SFTP server you specified with the ServerId.
The number of users that are assigned to a file transfer protocol-enabled server you specified with the ServerId.
Describes the properties of the server that was specified. Information returned includes the following: the server Amazon Resource Name (ARN), the authentication configuration and type, the logging role, the server ID and state, and assigned tags or metadata.
" + "documentation":"Describes the properties of a file transfer protocol-enabled server that was specified. Information returned includes the following: the server Amazon Resource Name (ARN), the authentication configuration and type, the logging role, the server ID and state, and assigned tags or metadata.
" }, "DescribedUser":{ "type":"structure", @@ -595,19 +628,19 @@ "members":{ "Arn":{ "shape":"Arn", - "documentation":"This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
" + "documentation":"Contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
" }, "HomeDirectory":{ "shape":"HomeDirectory", - "documentation":"This property specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .
Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .
Logical directory mappings that you specified for what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target.
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
Logical directory mappings that you specified for what Amazon S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target.
In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
The type of landing directory (folder) you mapped for your users' to see when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
The type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.
This property specifies the IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
" + "documentation":"Specifies the IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.
" }, "SshPublicKeys":{ "shape":"SshPublicKeys", - "documentation":"This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
" + "documentation":"Contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
" }, "Tags":{ "shape":"Tags", - "documentation":"This property contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
" + "documentation":"Contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
" }, "UserName":{ "shape":"UserName", - "documentation":"This property is the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your SFTP server.
" + "documentation":"The name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your file transfer protocol-enabled server.
" } }, "documentation":"Returns properties of the user that you want to describe.
" @@ -637,11 +670,11 @@ "members":{ "AddressAllocationIds":{ "shape":"AddressAllocationIds", - "documentation":"A list of address allocation IDs that are required to attach an Elastic IP address to your SFTP server's endpoint. This is only valid in the UpdateServer API.
This property can only be use when EndpointType is set to VPC.
A list of address allocation IDs that are required to attach an Elastic IP address to your file transfer protocol-enabled server's endpoint. This is only valid in the UpdateServer API.
This property can only be use when EndpointType is set to VPC.
A list of subnet IDs that are required to host your SFTP server endpoint in your VPC.
" + "documentation":"A list of subnet IDs that are required to host your file transfer protocol-enabled server endpoint in your VPC.
" }, "VpcEndpointId":{ "shape":"VpcEndpointId", @@ -649,10 +682,10 @@ }, "VpcId":{ "shape":"VpcId", - "documentation":"The VPC ID of the virtual private cloud in which the SFTP server's endpoint will be hosted.
" + "documentation":"The VPC ID of the VPC in which a file transfer protocol-enabled server's endpoint will be hosted.
" } }, - "documentation":"The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC. To control incoming internet traffic, invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server and resources only within your VPC. To control incoming internet traffic, invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
The Url parameter provides contains the location of the service endpoint used to authenticate users.
Contains the location of the service endpoint used to authenticate users.
" }, "InvocationRole":{ "shape":"Role", - "documentation":"The InvocationRole parameter provides the type of InvocationRole used to authenticate the user account.
Provides the type of InvocationRole used to authenticate the user account.
Returns information related to the type of user authentication that is in use for a server's users. A server can have only one method of authentication.
" + "documentation":"Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled server's users. A server can have only one method of authentication.
" }, "IdentityProviderType":{ "type":"string", - "documentation":"Returns information related to the type of user authentication that is in use for a server's users. For SERVICE_MANAGED authentication, the Secure Shell (SSH) public keys are stored with a user on an SFTP server instance. For API_GATEWAY authentication, your custom authentication method is implemented by using an API call. A server can have only one method of authentication.
Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled server's users. For SERVICE_MANAGED authentication, the Secure Shell (SSH) public keys are stored with a user on the server instance. For API_GATEWAY authentication, your custom authentication method is implemented by using an API call. The server can have only one method of authentication.
A system-assigned unique identifier for an SFTP server.
" + "documentation":"A system-assigned unique identifier for a file transfer protocol-enabled server.
" }, "SshPublicKeyBody":{ "shape":"SshPublicKeyBody", @@ -744,7 +777,7 @@ }, "UserName":{ "shape":"UserName", - "documentation":"The name of the user account that is assigned to one or more servers.
" + "documentation":"The name of the user account that is assigned to one or more file transfer protocol-enabled servers.
" } } }, @@ -758,18 +791,18 @@ "members":{ "ServerId":{ "shape":"ServerId", - "documentation":"A system-assigned unique identifier for an SFTP server.
" + "documentation":"A system-assigned unique identifier for a file transfer protocol-enabled server.
" }, "SshPublicKeyId":{ "shape":"SshPublicKeyId", - "documentation":"This identifier is the name given to a public key by the system that was imported.
" + "documentation":"The name given to a public key by the system that was imported.
" }, "UserName":{ "shape":"UserName", "documentation":"A user name assigned to the ServerID value that you specified.
This response identifies the user, the server they belong to, and the identifier of the SSH public key associated with that user. A user can have more than one key on each server that they are associated with.
" + "documentation":"Identifies the user, the file transfer protocol-enabled server they belong to, and the identifier of the SSH public key associated with that user. A user can have more than one key on each server that they are associated with.
" }, "InternalServiceError":{ "type":"structure", @@ -777,7 +810,7 @@ "members":{ "Message":{"shape":"Message"} }, - "documentation":"This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
", + "documentation":"This exception is thrown when an error occurs in the AWS Transfer Family service.
", "exception":true, "fault":true }, @@ -804,11 +837,11 @@ "members":{ "MaxResults":{ "shape":"MaxResults", - "documentation":"Specifies the number of servers to return as a response to the ListServers query.
Specifies the number of file transfer protocol-enabled servers to return as a response to the ListServers query.
When additional results are obtained from the ListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional servers.
When additional results are obtained from theListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional file transfer protocol-enabled servers.
When you can get additional results from the ListServers operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing additional servers.
When you can get additional results from the ListServers operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing additional file transfer protocol-enabled servers.
An array of servers that were listed.
" + "documentation":"An array of file transfer protocol-enabled servers that were listed.
" } } }, @@ -849,7 +882,7 @@ "members":{ "Arn":{ "shape":"Arn", - "documentation":"This value is the ARN you specified to list the tags of.
" + "documentation":"The ARN you specified to list the tags of.
" }, "NextToken":{ "shape":"NextToken", @@ -875,7 +908,7 @@ }, "ServerId":{ "shape":"ServerId", - "documentation":"A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server that has users assigned to it.
" + "documentation":"A system-assigned unique identifier for a file transfer protocol-enabled server that has users assigned to it.
" } } }, @@ -892,7 +925,7 @@ }, "ServerId":{ "shape":"ServerId", - "documentation":"A system-assigned unique identifier for an SFTP server that the users are assigned to.
" + "documentation":"A system-assigned unique identifier for a file transfer protocol-enabled server that the users are assigned to.
" }, "Users":{ "shape":"ListedUsers", @@ -906,34 +939,34 @@ "members":{ "Arn":{ "shape":"Arn", - "documentation":"The unique Amazon Resource Name (ARN) for the server to be listed.
" + "documentation":"The unique Amazon Resource Name (ARN) for a file transfer protocol-enabled server to be listed.
" }, "IdentityProviderType":{ "shape":"IdentityProviderType", - "documentation":"The authentication method used to validate a user for the server that was specified. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY.
The authentication method used to validate a user for a file transfer protocol-enabled server that was specified. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY.
The type of VPC endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
" + "documentation":"The type of VPC endpoint that your file transfer protocol-enabled server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
" }, "LoggingRole":{ "shape":"Role", - "documentation":"The AWS Identity and Access Management entity that allows the server to turn on Amazon CloudWatch logging.
" + "documentation":"The AWS Identity and Access Management (IAM) entity that allows a file transfer protocol-enabled server to turn on Amazon CloudWatch logging.
" }, "ServerId":{ "shape":"ServerId", - "documentation":"This value is the unique system assigned identifier for the SFTP servers that were listed.
" + "documentation":"The unique system assigned identifier for a file transfer protocol-enabled servers that were listed.
" }, "State":{ "shape":"State", - "documentation":"This property describes the condition of the SFTP server for the server that was described. A value of ONLINE> indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
Describes the condition of a file transfer protocol-enabled server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
This property is a numeric value that indicates the number of users that are assigned to the SFTP server you specified with the ServerId.
A numeric value that indicates the number of users that are assigned to a file transfer protocol-enabled server you specified with the ServerId.
Returns properties of the server that was specified.
" + "documentation":"Returns properties of a file transfer protocol-enabled server that was specified.
" }, "ListedServers":{ "type":"list", @@ -945,23 +978,23 @@ "members":{ "Arn":{ "shape":"Arn", - "documentation":"This property is the unique Amazon Resource Name (ARN) for the user that you want to learn about.
" + "documentation":"The unique Amazon Resource Name (ARN) for the user that you want to learn about.
" }, "HomeDirectory":{ "shape":"HomeDirectory", - "documentation":"This value specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.
" + "documentation":"Specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.
" }, "HomeDirectoryType":{ "shape":"HomeDirectoryType", - "documentation":"The type of landing directory (folder) you mapped for your users' home directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
The type of landing directory (folder) you mapped for your users' home directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.
The role in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows the SFTP server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.
" + "documentation":"The role in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows a file transfer protocol-enabled server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.
" }, "SshPublicKeyCount":{ "shape":"SshPublicKeyCount", - "documentation":"This value is the number of SSH public keys stored for the user you specified.
" + "documentation":"The number of SSH public keys stored for the user you specified.
" }, "UserName":{ "shape":"UserName", @@ -1004,6 +1037,20 @@ "type":"string", "max":2048 }, + "Protocol":{ + "type":"string", + "enum":[ + "SFTP", + "FTP", + "FTPS" + ] + }, + "Protocols":{ + "type":"list", + "member":{"shape":"Protocol"}, + "max":3, + "min":1 + }, "Resource":{"type":"string"}, "ResourceExistsException":{ "type":"structure", @@ -1032,7 +1079,7 @@ "Resource":{"shape":"Resource"}, "ResourceType":{"shape":"ResourceType"} }, - "documentation":"This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
", + "documentation":"This exception is thrown when a resource is not found by the AWS Transfer Family service.
", "exception":true }, "ResourceType":{"type":"string"}, @@ -1056,7 +1103,7 @@ "members":{ "Message":{"shape":"ServiceErrorMessage"} }, - "documentation":"The request has failed because the AWS Transfer for SFTP service is not available.
", + "documentation":"The request has failed because the AWS Transfer Family service is not available.
", "exception":true, "fault":true, "synthetic":true @@ -1082,7 +1129,7 @@ "documentation":"The SshPublicKeyId parameter contains the identifier of the public key.
Provides information about the public Secure Shell (SSH) key that is associated with a user account for a specific server (as identified by ServerId). The information returned includes the date the key was imported, the public key contents, and the public key ID. A user can store more than one SSH public key associated with their user name on a specific SFTP server.
Provides information about the public Secure Shell (SSH) key that is associated with a user account for the specific file transfer protocol-enabled server (as identified by ServerId). The information returned includes the date the key was imported, the public key contents, and the public key ID. A user can store more than one SSH public key associated with their user name on a specific server.
A system-assigned unique identifier for an SFTP server that you start.
" + "documentation":"A system-assigned unique identifier for a file transfer protocol-enabled server that you start.
" } } }, "State":{ "type":"string", - "documentation":"Describes the condition of the SFTP server with respect to its ability to perform file operations. There are six possible states: OFFLINE, ONLINE, STARTING, STOPPING, START_FAILED, and STOP_FAILED.
OFFLINE indicates that the SFTP server exists, but that it is not available for file operations. ONLINE indicates that the SFTP server is available to perform file operations. STARTING indicates that the SFTP server's was instantiated, but the server is not yet available to perform file operations. Under normal conditions, it can take a couple of minutes for an SFTP server to be completely operational. Both START_FAILED and STOP_FAILED are error conditions.
Describes the condition of a file transfer protocol-enabled server with respect to its ability to perform file operations. There are six possible states: OFFLINE, ONLINE, STARTING, STOPPING, START_FAILED, and STOP_FAILED.
OFFLINE indicates that the server exists, but that it is not available for file operations. ONLINE indicates that the server is available to perform file operations. STARTING indicates that the server's was instantiated, but the server is not yet available to perform file operations. Under normal conditions, it can take a couple of minutes for the server to be completely operational. Both START_FAILED and STOP_FAILED are error conditions.
A system-assigned unique identifier for an SFTP server that you stopped.
" + "documentation":"A system-assigned unique identifier for a file transfer protocol-enabled server that you stopped.
" } } }, @@ -1152,7 +1199,7 @@ }, "Value":{ "shape":"TagValue", - "documentation":"This property contains one or more values that you assigned to the key name you create.
" + "documentation":"Contains one or more values that you assigned to the key name you create.
" } }, "documentation":"Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.
A system-assigned identifier for a specific server. That server's user authentication method is tested with a user name and password.
" + "documentation":"A system-assigned identifier for a specific file transfer protocol-enabled server. That server's user authentication method is tested with a user name and password.
" }, "UserName":{ "shape":"UserName", - "documentation":"This request parameter is the name of the user account to be tested.
" + "documentation":"The name of the user account to be tested.
" }, "UserPassword":{ "shape":"UserPassword", "documentation":"The password of the user account to be tested.
" + }, + "ServerProtocol":{ + "shape":"Protocol", + "documentation":"The type of file transfer protocol to be tested.
The available protocols are:
Secure Shell (SSH) File Transfer Protocol (SFTP)
File Transfer Protocol Secure (FTPS)
File Transfer Protocol (FTP)
A message that indicates whether the test was successful or not.
" + "documentation":"A message that indicates whether the test was successful or not.
" }, "Url":{ "shape":"Url", @@ -1257,7 +1308,7 @@ "members":{ "Arn":{ "shape":"Arn", - "documentation":"This is the value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific AWS resource, such as a server, user, or role.
" + "documentation":"The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific AWS resource, such as a server, user, or role.
" }, "TagKeys":{ "shape":"TagKeys", @@ -1269,29 +1320,37 @@ "type":"structure", "required":["ServerId"], "members":{ + "Certificate":{ + "shape":"Certificate", + "documentation":"The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.
The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.
" + "documentation":"The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.
" }, "EndpointType":{ "shape":"EndpointType", - "documentation":"The type of endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, your SFTP server isn't accessible over the public internet.
" + "documentation":"The type of endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, your server isn't accessible over the public internet.
" }, "HostKey":{ "shape":"HostKey", - "documentation":"The RSA private key as generated by ssh-keygen -N \"\" -f my-new-server-key.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
" + "documentation":"The RSA private key as generated by ssh-keygen -N \"\" -f my-new-server-key.
If you aren't planning to migrate existing users from an existing file transfer protocol-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see Changing the Host Key for Your AWS Transfer Family Server in the AWS Transfer Family User Guide.
" }, "IdentityProviderDetails":{ "shape":"IdentityProviderDetails", - "documentation":"This response parameter is an array containing all of the information required to call a customer's authentication API method.
" + "documentation":"An array containing all of the information required to call a customer's authentication API method.
" }, "LoggingRole":{ "shape":"NullableRole", - "documentation":"A value that changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.
" + "documentation":"Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.
" + }, + "Protocols":{ + "shape":"Protocols", + "documentation":"Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
File Transfer Protocol (FTP): Unencrypted file transfer
A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.
" + "documentation":"A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.
" } } }, @@ -1301,7 +1360,7 @@ "members":{ "ServerId":{ "shape":"ServerId", - "documentation":"A system-assigned unique identifier for an SFTP server that the user account is assigned to.
" + "documentation":"A system-assigned unique identifier for a file transfer protocol-enabled server that the user account is assigned to.
" } } }, @@ -1314,31 +1373,31 @@ "members":{ "HomeDirectory":{ "shape":"HomeDirectory", - "documentation":"A parameter that specifies the landing directory (folder) for a user when they log in to the server using their client.
An example is <your-Amazon-S3-bucket-name>/home/username.
Specifies the landing directory (folder) for a user when they log in to the file transfer protocol-enabled server using their file transfer protocol client.
An example is your-Amazon-S3-bucket-name>/home/username.
The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP serve. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
The type of landing directory (folder) you want your users' home directory to be when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.
Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in Amazon S3, the entry will be ignored. As a workaround, you can use the Amazon S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
Allows you to supply a scope-down policy for your user so you can use the same AWS Identity and Access Management (IAM) role across multiple users. The policy scopes down user access to portions of your Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
Allows you to supply a scope-down policy for your user so you can use the same AWS Identity and Access Management (IAM) role across multiple users. The policy scopes down user access to portions of your Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see Creating a Scope-Down Policy.
For more information, see AssumeRole in the AWS Security Token Service API Reference.
The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the Secure File Transfer Protocol (SFTP) server to access your resources when servicing your SFTP user's transfer requests.
" + "documentation":"The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.
" }, "ServerId":{ "shape":"ServerId", - "documentation":"A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.
" + "documentation":"A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.
" }, "UserName":{ "shape":"UserName", - "documentation":"A unique string that identifies a user and is associated with a server as specified by the ServerId. This is the string that will be used by your user when they log in to your SFTP server. This user name is a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
A unique string that identifies a user and is associated with a file transfer protocol-enabled server as specified by the ServerId. This is the string that will be used by your user when they log in to your server. This user name is a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.
" + "documentation":"A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.
" }, "UserName":{ "shape":"UserName", - "documentation":"The unique identifier for a user that is assigned to the SFTP server instance that was specified in the request.
" + "documentation":"The unique identifier for a user that is assigned to a file transfer protocol-enabled server instance that was specified in the request.
" } }, - "documentation":" UpdateUserResponse returns the user name and server identifier for the request to update a user's properties.
UpdateUserResponse returns the user name and file transfer protocol-enabled server identifier for the request to update a user's properties.
AWS Transfer for SFTP is a fully managed service that enables the transfer of files directly into and out of Amazon S3 using the Secure File Transfer Protocol (SFTP)—also known as Secure Shell (SSH) File Transfer Protocol. AWS helps you seamlessly migrate your file transfer workflows to AWS Transfer for SFTP—by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53—so nothing changes for your customers and partners, or their applications. With your data in S3, you can use it with AWS services for processing, analytics, machine learning, and archiving. Getting started with AWS Transfer for SFTP (AWS SFTP) is easy; there is no infrastructure to buy and set up.
" + "documentation":"AWS Transfer Family is a fully managed service that enables the transfer of files over the the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3). AWS helps you seamlessly migrate your file transfer workflows to AWS Transfer Family by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53 so nothing changes for your customers and partners, or their applications. With your data in Amazon S3, you can use it with AWS services for processing, analytics, machine learning, and archiving. Getting started with AWS Transfer Family is easy since there is no infrastructure to buy and set up.
" } diff --git a/botocore/data/translate/2017-07-01/examples-1.json b/botocore/data/translate/2017-07-01/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/botocore/data/translate/2017-07-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/wafv2/2019-07-29/service-2.json b/botocore/data/wafv2/2019-07-29/service-2.json index e97298b3..6b2dbf9d 100644 --- a/botocore/data/wafv2/2019-07-29/service-2.json +++ b/botocore/data/wafv2/2019-07-29/service-2.json @@ -25,9 +25,10 @@ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentItemException"}, - {"shape":"WAFUnavailableEntityException"} + {"shape":"WAFUnavailableEntityException"}, + {"shape":"WAFInvalidOperationException"} ], - "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Associates a Web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
For AWS CloudFront, you can associate the Web ACL by providing the ARN of the WebACL to the CloudFront API call UpdateDistribution. For information, see UpdateDistribution.
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Associates a Web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
For AWS CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a Web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN) of the Web ACL. For information, see UpdateDistribution.
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure AWS WAF to block them using an IPSet that lists those IP addresses.
" }, @@ -82,7 +84,8 @@ {"shape":"WAFOptimisticLockException"}, {"shape":"WAFLimitsExceededException"}, {"shape":"WAFTagOperationException"}, - {"shape":"WAFTagOperationInternalErrorException"} + {"shape":"WAFTagOperationInternalErrorException"}, + {"shape":"WAFInvalidOperationException"} ], "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have AWS WAF inspect a web request component for the specified patterns.
" }, @@ -103,7 +106,9 @@ {"shape":"WAFUnavailableEntityException"}, {"shape":"WAFTagOperationException"}, {"shape":"WAFTagOperationInternalErrorException"}, - {"shape":"WAFSubscriptionNotFoundException"} + {"shape":"WAFSubscriptionNotFoundException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidOperationException"} ], "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Creates a RuleGroup per the specifications provided.
A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
" }, @@ -126,10 +131,28 @@ {"shape":"WAFNonexistentItemException"}, {"shape":"WAFTagOperationException"}, {"shape":"WAFTagOperationInternalErrorException"}, - {"shape":"WAFSubscriptionNotFoundException"} + {"shape":"WAFSubscriptionNotFoundException"}, + {"shape":"WAFInvalidOperationException"} ], "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Creates a WebACL per the specifications provided.
A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the Web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a Web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a Web ACL with one or more AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway API, or an Application Load Balancer.
" }, + "DeleteFirewallManagerRuleGroups":{ + "name":"DeleteFirewallManagerRuleGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteFirewallManagerRuleGroupsRequest"}, + "output":{"shape":"DeleteFirewallManagerRuleGroupsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFOptimisticLockException"}, + {"shape":"WAFInvalidOperationException"} + ], + "documentation":"Deletes all rule groups that are managed by AWS Firewall Manager for the specified web ACL.
You can only use this if ManagedByFirewallManager is false in the specified WebACL.
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Deletes the specified IPSet.
" }, @@ -160,10 +184,27 @@ "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFNonexistentItemException"}, - {"shape":"WAFOptimisticLockException"} + {"shape":"WAFOptimisticLockException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"} ], "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Deletes the LoggingConfiguration from the specified web ACL.
" }, + "DeletePermissionPolicy":{ + "name":"DeletePermissionPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePermissionPolicyRequest"}, + "output":{"shape":"DeletePermissionPolicyResponse"}, + "errors":[ + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"} + ], + "documentation":"Permanently deletes an IAM policy from the specified rule group.
You must be the owner of the rule group to perform this operation.
" + }, "DeleteRegexPatternSet":{ "name":"DeleteRegexPatternSet", "http":{ @@ -179,7 +220,8 @@ {"shape":"WAFOptimisticLockException"}, {"shape":"WAFAssociatedItemException"}, {"shape":"WAFTagOperationException"}, - {"shape":"WAFTagOperationInternalErrorException"} + {"shape":"WAFTagOperationInternalErrorException"}, + {"shape":"WAFInvalidOperationException"} ], "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Deletes the specified RegexPatternSet.
" }, @@ -198,7 +240,8 @@ {"shape":"WAFOptimisticLockException"}, {"shape":"WAFAssociatedItemException"}, {"shape":"WAFTagOperationException"}, - {"shape":"WAFTagOperationInternalErrorException"} + {"shape":"WAFTagOperationInternalErrorException"}, + {"shape":"WAFInvalidOperationException"} ], "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Deletes the specified RuleGroup.
" }, @@ -217,9 +260,10 @@ {"shape":"WAFOptimisticLockException"}, {"shape":"WAFAssociatedItemException"}, {"shape":"WAFTagOperationException"}, - {"shape":"WAFTagOperationInternalErrorException"} + {"shape":"WAFTagOperationInternalErrorException"}, + {"shape":"WAFInvalidOperationException"} ], - "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Deletes the specified WebACL.
" + "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Deletes the specified WebACL.
You can only use this if ManagedByFirewallManager is false in the specified WebACL.
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Provides high-level information for a managed rule group, including descriptions of the rules.
" }, @@ -248,9 +293,10 @@ "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFNonexistentItemException"} + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidOperationException"} ], - "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Disassociates a Web ACL from a regional application resource. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
For AWS CloudFront, you can disassociate the Web ACL by providing an empty web ACL ARN in the CloudFront API call UpdateDistribution. For information, see UpdateDistribution.
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Disassociates a Web ACL from a regional application resource. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
For AWS CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To disassociate a Web ACL, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution.
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves the specified IPSet.
" }, @@ -277,10 +324,27 @@ "output":{"shape":"GetLoggingConfigurationResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, - {"shape":"WAFNonexistentItemException"} + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"} ], "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Returns the LoggingConfiguration for the specified web ACL.
" }, + "GetPermissionPolicy":{ + "name":"GetPermissionPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPermissionPolicyRequest"}, + "output":{"shape":"GetPermissionPolicyResponse"}, + "errors":[ + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"} + ], + "documentation":"Returns the IAM policy that is attached to the specified rule group.
You must be the owner of the rule group to perform this operation.
" + }, "GetRateBasedStatementManagedKeys":{ "name":"GetRateBasedStatementManagedKeys", "http":{ @@ -292,7 +356,8 @@ "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFNonexistentItemException"} + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidOperationException"} ], "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves the keys that are currently blocked by a rate-based rule. The maximum number of managed keys that can be blocked for a single rate-based rule is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.
" }, @@ -307,7 +372,8 @@ "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFNonexistentItemException"} + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidOperationException"} ], "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves the specified RegexPatternSet.
" }, @@ -322,7 +388,8 @@ "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFNonexistentItemException"} + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidOperationException"} ], "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves the specified RuleGroup.
" }, @@ -352,7 +419,8 @@ "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFNonexistentItemException"} + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidOperationException"} ], "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves the specified WebACL.
" }, @@ -368,7 +436,8 @@ {"shape":"WAFInternalErrorException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFUnavailableEntityException"} + {"shape":"WAFUnavailableEntityException"}, + {"shape":"WAFInvalidOperationException"} ], "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves the WebACL for the specified resource.
" }, @@ -382,7 +451,8 @@ "output":{"shape":"ListAvailableManagedRuleGroupsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidParameterException"} + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"} ], "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves an array of managed rule groups that are available for you to use. This list includes all AWS Managed Rules rule groups and the AWS Marketplace managed rule groups that you're subscribed to.
" }, @@ -396,7 +466,8 @@ "output":{"shape":"ListIPSetsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidParameterException"} + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"} ], "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves an array of IPSetSummary objects for the IP sets that you manage.
" }, @@ -410,7 +481,8 @@ "output":{"shape":"ListLoggingConfigurationsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidParameterException"} + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"} ], "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves an array of your LoggingConfiguration objects.
" }, @@ -424,7 +496,8 @@ "output":{"shape":"ListRegexPatternSetsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidParameterException"} + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"} ], "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.
" }, @@ -439,7 +512,8 @@ "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFNonexistentItemException"}, - {"shape":"WAFInvalidParameterException"} + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"} ], "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL. If you want the list of AWS CloudFront resources, use the AWS CloudFront call ListDistributionsByWebACLId.
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.
" }, @@ -470,7 +545,8 @@ {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFTagOperationException"}, - {"shape":"WAFTagOperationInternalErrorException"} + {"shape":"WAFTagOperationInternalErrorException"}, + {"shape":"WAFInvalidOperationException"} ], "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves the TagInfoForResource for the specified resource.
" }, @@ -484,7 +560,8 @@ "output":{"shape":"ListWebACLsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidParameterException"} + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"} ], "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves an array of WebACLSummary objects for the web ACLs that you manage.
" }, @@ -501,9 +578,26 @@ {"shape":"WAFNonexistentItemException"}, {"shape":"WAFOptimisticLockException"}, {"shape":"WAFServiceLinkedRoleErrorException"}, - {"shape":"WAFInvalidParameterException"} + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFInvalidOperationException"} ], - "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.
You can access information about all traffic that AWS WAF inspects using the following steps:
Create an Amazon Kinesis Data Firehose.
Create the data firehose with a PUT source and in the region that you are operating. If you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).
Do not create the data firehose using a Kinesis stream as your source.
Associate that firehose to your web ACL using a PutLoggingConfiguration request.
When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.
You can access information about all traffic that AWS WAF inspects using the following steps:
Create an Amazon Kinesis Data Firehose.
Create the data firehose with a PUT source and in the Region that you are operating. If you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).
Do not create the data firehose using a Kinesis stream as your source.
Associate that firehose to your web ACL using a PutLoggingConfiguration request.
When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.
Attaches an IAM policy to the specified resource. Use this to share a rule group across accounts.
You must be the owner of the rule group to perform this operation.
This action is subject to the following restrictions:
You can attach only one policy with each PutPermissionPolicy request.
The ARN in the request must be a valid WAF RuleGroup ARN and the rule group must exist in the same region.
The user making the request must be the owner of the rule group.
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Associates tags with the specified AWS resource. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be \"customer\" and the tag value might be \"companyA.\" You can specify one or more tags to add to each container. You can add up to 50 tags to each AWS resource.
" }, @@ -536,7 +631,8 @@ {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFTagOperationException"}, - {"shape":"WAFTagOperationInternalErrorException"} + {"shape":"WAFTagOperationInternalErrorException"}, + {"shape":"WAFInvalidOperationException"} ], "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Disassociates tags from an AWS resource. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be \"customer\" and the tag value might be \"companyA.\" You can specify one or more tags to add to each container. You can add up to 50 tags to each AWS resource.
" }, @@ -554,7 +650,8 @@ {"shape":"WAFNonexistentItemException"}, {"shape":"WAFDuplicateItemException"}, {"shape":"WAFOptimisticLockException"}, - {"shape":"WAFLimitsExceededException"} + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFInvalidOperationException"} ], "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Updates the specified IPSet.
" }, @@ -572,7 +669,8 @@ {"shape":"WAFNonexistentItemException"}, {"shape":"WAFDuplicateItemException"}, {"shape":"WAFOptimisticLockException"}, - {"shape":"WAFLimitsExceededException"} + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFInvalidOperationException"} ], "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Updates the specified RegexPatternSet.
" }, @@ -592,7 +690,8 @@ {"shape":"WAFOptimisticLockException"}, {"shape":"WAFLimitsExceededException"}, {"shape":"WAFUnavailableEntityException"}, - {"shape":"WAFSubscriptionNotFoundException"} + {"shape":"WAFSubscriptionNotFoundException"}, + {"shape":"WAFInvalidOperationException"} ], "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Updates the specified RuleGroup.
A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
" }, @@ -613,7 +712,8 @@ {"shape":"WAFLimitsExceededException"}, {"shape":"WAFInvalidResourceException"}, {"shape":"WAFUnavailableEntityException"}, - {"shape":"WAFSubscriptionNotFoundException"} + {"shape":"WAFSubscriptionNotFoundException"}, + {"shape":"WAFInvalidOperationException"} ], "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Updates the specified WebACL.
A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the Web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a Web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a Web ACL with one or more AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway API, or an Application Load Balancer.
" } @@ -689,7 +789,7 @@ "members":{ "SearchString":{ "shape":"SearchString", - "documentation":"A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in FieldToMatch. The maximum length of the value is 50 bytes.
Valid values depend on the areas that you specify for inspection in FieldToMatch:
Method: The HTTP method that you want AWS WAF to search for. This indicates the type of operation specified in the request.
UriPath: The value that you want AWS WAF to search for in the URI path, for example, /images/daily-ad.jpg.
If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the AWS WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.
For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90, in the value of SearchString.
If you're using the AWS CLI or one of the AWS SDKs
The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
" + "documentation":"A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in FieldToMatch. The maximum length of the value is 50 bytes.
Valid values depend on the component that you specify for inspection in FieldToMatch:
Method: The HTTP method that you want AWS WAF to search for. This indicates the type of operation specified in the request.
UriPath: The value that you want AWS WAF to search for in the URI path, for example, /images/daily-ad.jpg.
If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the AWS WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.
For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90, in the value of SearchString.
If you're using the AWS CLI or one of the AWS SDKs
The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
" }, "FieldToMatch":{ "shape":"FieldToMatch", @@ -697,7 +797,7 @@ }, "TextTransformations":{ "shape":"TextTransformations", - "documentation":"Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A friendly name of the IP set. You cannot change the name of an IPSet after you create it.
The name of the IP set. You cannot change the name of an IPSet after you create it.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A friendly description of the IP set. You cannot change the description of an IP set after you create it.
" + "documentation":"A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.
" }, "IPAddressVersion":{ "shape":"IPAddressVersion", @@ -1071,15 +1171,15 @@ "members":{ "Name":{ "shape":"EntityName", - "documentation":"A friendly name of the set. You cannot change the name after you create the set.
" + "documentation":"The name of the set. You cannot change the name after you create the set.
" }, "Scope":{ "shape":"Scope", - "documentation":"Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A friendly description of the set. You cannot change the description of a set after you create it.
" + "documentation":"A description of the set that helps with identification. You cannot change the description of a set after you create it.
" }, "RegularExpressionList":{ "shape":"RegularExpressionList", @@ -1111,11 +1211,11 @@ "members":{ "Name":{ "shape":"EntityName", - "documentation":"A friendly name of the rule group. You cannot change the name of a rule group after you create it.
" + "documentation":"The name of the rule group. You cannot change the name of a rule group after you create it.
" }, "Scope":{ "shape":"Scope", - "documentation":"Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A friendly description of the rule group. You cannot change the description of a rule group after you create it.
" + "documentation":"A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.
" }, "Rules":{ "shape":"Rules", @@ -1159,11 +1259,11 @@ "members":{ "Name":{ "shape":"EntityName", - "documentation":"A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it.
" + "documentation":"The name of the Web ACL. You cannot change the name of a Web ACL after you create it.
" }, "Scope":{ "shape":"Scope", - "documentation":"Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A friendly description of the Web ACL. You cannot change the description of a Web ACL after you create it.
" + "documentation":"A description of the Web ACL that helps with identification. You cannot change the description of a Web ACL after you create it.
" }, "Rules":{ "shape":"Rules", @@ -1210,6 +1310,32 @@ }, "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
In a WebACL, this is the action that you want AWS WAF to perform when a web request doesn't match any of the rules in the WebACL. The default action must be a terminating action, so count is not allowed.
The Amazon Resource Name (ARN) of the web ACL.
" + }, + "WebACLLockToken":{ + "shape":"LockToken", + "documentation":"A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
A friendly name of the IP set. You cannot change the name of an IPSet after you create it.
The name of the IP set. You cannot change the name of an IPSet after you create it.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
The Amazon Resource Name (ARN) of the rule group from which you want to delete the policy.
You must be the owner of the rule group to perform this operation.
" + } + } + }, + "DeletePermissionPolicyResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteRegexPatternSetRequest":{ "type":"structure", "required":[ @@ -1268,11 +1409,11 @@ "members":{ "Name":{ "shape":"EntityName", - "documentation":"A friendly name of the set. You cannot change the name after you create the set.
" + "documentation":"The name of the set. You cannot change the name after you create the set.
" }, "Scope":{ "shape":"Scope", - "documentation":"Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A friendly name of the rule group. You cannot change the name of a rule group after you create it.
" + "documentation":"The name of the rule group. You cannot change the name of a rule group after you create it.
" }, "Scope":{ "shape":"Scope", - "documentation":"Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it.
" + "documentation":"The name of the Web ACL. You cannot change the name of a Web ACL after you create it.
" }, "Scope":{ "shape":"Scope", - "documentation":"Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
" } }, - "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
The part of a web request that you want AWS WAF to inspect. Include the FieldToMatch types that you want to inspect, with additional specifications as needed, according to the type.
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
The part of a web request that you want AWS WAF to inspect. Include the single FieldToMatch type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in FieldToMatch for each rule statement that requires it. To inspect more than one component of a web request, create a separate rule statement for each component.
The name of the rule group. You cannot change the name of a rule group after you create it.
" + }, + "Priority":{ + "shape":"RulePriority", + "documentation":"If you define more than one rule group in the first or last Firewall Manager rule groups, AWS WAF evaluates each request against the rule groups in order, starting from the lowest priority setting. The priorities don't need to be consecutive, but they must all be different.
" + }, + "FirewallManagerStatement":{ + "shape":"FirewallManagerStatement", + "documentation":"The processing guidance for an AWS Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.
" + }, + "OverrideAction":{"shape":"OverrideAction"}, + "VisibilityConfig":{"shape":"VisibilityConfig"} + }, + "documentation":"A rule group that's defined for an AWS Firewall Manager WAF policy.
" + }, + "FirewallManagerRuleGroups":{ + "type":"list", + "member":{"shape":"FirewallManagerRuleGroup"} + }, + "FirewallManagerStatement":{ + "type":"structure", + "members":{ + "ManagedRuleGroupStatement":{"shape":"ManagedRuleGroupStatement"}, + "RuleGroupReferenceStatement":{"shape":"RuleGroupReferenceStatement"} + }, + "documentation":"The processing guidance for an AWS Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.
" + }, "GeoMatchStatement":{ "type":"structure", "members":{ @@ -1498,11 +1678,11 @@ "members":{ "Name":{ "shape":"EntityName", - "documentation":"A friendly name of the IP set. You cannot change the name of an IPSet after you create it.
The name of the IP set. You cannot change the name of an IPSet after you create it.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
The Amazon Resource Name (ARN) of the rule group for which you want to get the policy.
" + } + } + }, + "GetPermissionPolicyResponse":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"PolicyString", + "documentation":"The IAM policy that is attached to the specified rule group.
" + } + } + }, "GetRateBasedStatementManagedKeysRequest":{ "type":"structure", "required":[ @@ -1553,11 +1752,11 @@ "members":{ "Scope":{ "shape":"Scope", - "documentation":"Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it.
" + "documentation":"The name of the Web ACL. You cannot change the name of a Web ACL after you create it.
" }, "WebACLId":{ "shape":"EntityId", @@ -1592,11 +1791,11 @@ "members":{ "Name":{ "shape":"EntityName", - "documentation":"A friendly name of the set. You cannot change the name after you create the set.
" + "documentation":"The name of the set. You cannot change the name after you create the set.
" }, "Scope":{ "shape":"Scope", - "documentation":"Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A friendly name of the rule group. You cannot change the name of a rule group after you create it.
" + "documentation":"The name of the rule group. You cannot change the name of a rule group after you create it.
" }, "Scope":{ "shape":"Scope", - "documentation":"Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it.
" + "documentation":"The name of the Web ACL. You cannot change the name of a Web ACL after you create it.
" }, "Scope":{ "shape":"Scope", - "documentation":"Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A friendly name of the IP set. You cannot change the name of an IPSet after you create it.
The name of the IP set. You cannot change the name of an IPSet after you create it.
A friendly description of the IP set. You cannot change the description of an IP set after you create it.
" + "documentation":"A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.
" }, "IPAddressVersion":{ "shape":"IPAddressVersion", @@ -1881,7 +2080,7 @@ "members":{ "Name":{ "shape":"EntityName", - "documentation":"A friendly name of the IP set. You cannot change the name of an IPSet after you create it.
The name of the IP set. You cannot change the name of an IPSet after you create it.
A friendly description of the IP set. You cannot change the description of an IP set after you create it.
" + "documentation":"A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.
" }, "LockToken":{ "shape":"LockToken", @@ -1909,7 +2108,7 @@ "members":{ "Scope":{ "shape":"Scope", - "documentation":"Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Don't override the rule action setting.
" } }, - "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
The action to use to override the rule's Action setting. You can use no override action, in which case the rule action is in effect, or count, in which case, if the rule matches a web request, it only counts the match.
The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.
In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both:
If the rule statement references a rule group, use this override action setting and not the action setting.
If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting.
The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.
" + }, + "Policy":{ + "shape":"PolicyString", + "documentation":"The policy to attach to the specified rule group.
The policy specifications must conform to the following:
The policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.
The policy must include specifications for Effect, Action, and Principal.
Effect must specify Allow.
Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and wafv2:PutFirewallManagerRuleGroups. AWS WAF rejects any extra actions or wildcard actions in the policy.
The policy must not include a Resource parameter.
For more information, see IAM Policies.
" + } + } + }, + "PutPermissionPolicyResponse":{ + "type":"structure", + "members":{ + } + }, "QueryString":{ "type":"structure", "members":{ @@ -2438,7 +2664,7 @@ "members":{ "Name":{ "shape":"EntityName", - "documentation":"A friendly name of the set. You cannot change the name after you create the set.
" + "documentation":"The name of the set. You cannot change the name after you create the set.
" }, "Id":{ "shape":"EntityId", @@ -2450,7 +2676,7 @@ }, "Description":{ "shape":"EntityDescription", - "documentation":"A friendly description of the set. You cannot change the description of a set after you create it.
" + "documentation":"A description of the set that helps with identification. You cannot change the description of a set after you create it.
" }, "RegularExpressionList":{ "shape":"RegularExpressionList", @@ -2477,7 +2703,7 @@ }, "TextTransformations":{ "shape":"TextTransformations", - "documentation":"Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.
Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
" @@ -2491,7 +2717,7 @@ "members":{ "Name":{ "shape":"EntityName", - "documentation":"A friendly name of the data type instance. You cannot change the name after you create the instance.
" + "documentation":"The name of the data type instance. You cannot change the name after you create the instance.
" }, "Id":{ "shape":"EntityId", @@ -2499,7 +2725,7 @@ }, "Description":{ "shape":"EntityDescription", - "documentation":"A friendly description of the set. You cannot change the description of a set after you create it.
" + "documentation":"A description of the set that helps with identification. You cannot change the description of a set after you create it.
" }, "LockToken":{ "shape":"LockToken", @@ -2520,8 +2746,7 @@ }, "RegularExpressionList":{ "type":"list", - "member":{"shape":"Regex"}, - "min":1 + "member":{"shape":"Regex"} }, "ResourceArn":{ "type":"string", @@ -2551,7 +2776,7 @@ "members":{ "Name":{ "shape":"EntityName", - "documentation":"A friendly name of the rule. You can't change the name of a Rule after you create it.
The name of the rule. You can't change the name of a Rule after you create it.
The action that AWS WAF should take on a web request when it matches the rule's statement. Settings at the web ACL level can override the rule action setting.
" + "documentation":"The action that AWS WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.
This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.
You must specify either this Action setting or the rule OverrideAction setting, but not both:
If the rule statement does not reference a rule group, use this rule action setting and not the rule override action setting.
If the rule statement references a rule group, use the override action setting and not this action setting.
The action to use to override the rule's Action setting. You can use no override action, in which case the rule action is in effect, or count action, in which case, if the rule matches a web request, it only counts the match.
The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.
In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both:
If the rule statement references a rule group, use this override action setting and not the action setting.
If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting.
A friendly name of the rule group. You cannot change the name of a rule group after you create it.
" + "documentation":"The name of the rule group. You cannot change the name of a rule group after you create it.
" }, "Id":{ "shape":"EntityId", @@ -2622,7 +2847,7 @@ }, "Description":{ "shape":"EntityDescription", - "documentation":"A friendly description of the rule group. You cannot change the description of a rule group after you create it.
" + "documentation":"A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.
" }, "Rules":{ "shape":"Rules", @@ -2659,7 +2884,7 @@ "members":{ "Name":{ "shape":"EntityName", - "documentation":"A friendly name of the data type instance. You cannot change the name after you create the instance.
" + "documentation":"The name of the data type instance. You cannot change the name after you create the instance.
" }, "Id":{ "shape":"EntityId", @@ -2667,7 +2892,7 @@ }, "Description":{ "shape":"EntityDescription", - "documentation":"A friendly description of the rule group. You cannot change the description of a rule group after you create it.
" + "documentation":"A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.
" }, "LockToken":{ "shape":"LockToken", @@ -2799,7 +3024,7 @@ }, "TextTransformations":{ "shape":"TextTransformations", - "documentation":"Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.
If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.
" @@ -3052,11 +3277,11 @@ "members":{ "Name":{ "shape":"EntityName", - "documentation":"A friendly name of the IP set. You cannot change the name of an IPSet after you create it.
The name of the IP set. You cannot change the name of an IPSet after you create it.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A friendly description of the IP set. You cannot change the description of an IP set after you create it.
" + "documentation":"A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.
" }, "Addresses":{ "shape":"IPAddresses", @@ -3097,11 +3322,11 @@ "members":{ "Name":{ "shape":"EntityName", - "documentation":"A friendly name of the set. You cannot change the name after you create the set.
" + "documentation":"The name of the set. You cannot change the name after you create the set.
" }, "Scope":{ "shape":"Scope", - "documentation":"Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A friendly description of the set. You cannot change the description of a set after you create it.
" + "documentation":"A description of the set that helps with identification. You cannot change the description of a set after you create it.
" }, "RegularExpressionList":{ "shape":"RegularExpressionList", @@ -3142,11 +3367,11 @@ "members":{ "Name":{ "shape":"EntityName", - "documentation":"A friendly name of the rule group. You cannot change the name of a rule group after you create it.
" + "documentation":"The name of the rule group. You cannot change the name of a rule group after you create it.
" }, "Scope":{ "shape":"Scope", - "documentation":"Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A friendly description of the rule group. You cannot change the description of a rule group after you create it.
" + "documentation":"A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.
" }, "Rules":{ "shape":"Rules", @@ -3192,11 +3417,11 @@ "members":{ "Name":{ "shape":"EntityName", - "documentation":"A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it.
" + "documentation":"The name of the Web ACL. You cannot change the name of a Web ACL after you create it.
" }, "Scope":{ "shape":"Scope", - "documentation":"Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A friendly description of the Web ACL. You cannot change the description of a Web ACL after you create it.
" + "documentation":"A description of the Web ACL that helps with identification. You cannot change the description of a Web ACL after you create it.
" }, "Rules":{ "shape":"Rules", @@ -3263,7 +3488,7 @@ }, "MetricName":{ "shape":"MetricName", - "documentation":"A friendly name of the CloudWatch metric. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example \"All\" and \"Default_Action.\" You can't change a MetricName after you create a VisibilityConfig.
A name of the CloudWatch metric. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example \"All\" and \"Default_Action.\" You can't change a MetricName after you create a VisibilityConfig.
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Defines and enables Amazon CloudWatch metrics and web request sample collection.
" @@ -3293,6 +3518,14 @@ "exception":true, "fault":true }, + "WAFInvalidOperationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"The operation isn't valid.
", + "exception":true + }, "WAFInvalidParameterException":{ "type":"structure", "members":{ @@ -3304,6 +3537,14 @@ "documentation":"The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
The operation failed because the specified policy isn't in the proper format.
The policy specifications must conform to the following:
The policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.
The policy must include specifications for Effect, Action, and Principal.
Effect must specify Allow.
Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and wafv2:PutFirewallManagerRuleGroups. AWS WAF rejects any extra actions or wildcard actions in the policy.
The policy must not include a Resource parameter.
For more information, see IAM Policies.
", + "exception":true + }, "WAFInvalidResourceException":{ "type":"structure", "members":{ @@ -3389,7 +3630,7 @@ "members":{ "Name":{ "shape":"EntityName", - "documentation":"A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it.
" + "documentation":"The name of the Web ACL. You cannot change the name of a Web ACL after you create it.
" }, "Id":{ "shape":"EntityId", @@ -3405,7 +3646,7 @@ }, "Description":{ "shape":"EntityDescription", - "documentation":"A friendly description of the Web ACL. You cannot change the description of a Web ACL after you create it.
" + "documentation":"A description of the Web ACL that helps with identification. You cannot change the description of a Web ACL after you create it.
" }, "Rules":{ "shape":"Rules", @@ -3418,6 +3659,18 @@ "Capacity":{ "shape":"ConsumedCapacity", "documentation":"The web ACL capacity units (WCUs) currently being used by this web ACL.
AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
" + }, + "PreProcessFirewallManagerRuleGroups":{ + "shape":"FirewallManagerRuleGroups", + "documentation":"The first set of rules for AWS WAF to process in the web ACL. This is defined in an AWS Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized after these.
In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.
" + }, + "PostProcessFirewallManagerRuleGroups":{ + "shape":"FirewallManagerRuleGroups", + "documentation":"The last set of rules for AWS WAF to process in the web ACL. This is defined in an AWS Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized before these.
In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.
" + }, + "ManagedByFirewallManager":{ + "shape":"Boolean", + "documentation":"Indicates whether this web ACL is managed by AWS Firewall Manager. If true, then only AWS Firewall Manager can delete the web ACL or any Firewall Manager rule groups in the web ACL.
" } }, "documentation":"This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the Web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a Web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a Web ACL with one or more AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway API, or an Application Load Balancer.
" @@ -3431,7 +3684,7 @@ "members":{ "Name":{ "shape":"EntityName", - "documentation":"A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it.
" + "documentation":"The name of the Web ACL. You cannot change the name of a Web ACL after you create it.
" }, "Id":{ "shape":"EntityId", @@ -3439,7 +3692,7 @@ }, "Description":{ "shape":"EntityDescription", - "documentation":"A friendly description of the Web ACL. You cannot change the description of a Web ACL after you create it.
" + "documentation":"A description of the Web ACL that helps with identification. You cannot change the description of a Web ACL after you create it.
" }, "LockToken":{ "shape":"LockToken", @@ -3465,11 +3718,11 @@ }, "TextTransformations":{ "shape":"TextTransformations", - "documentation":"Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.
" } }, - "documentation":"This is the latest version of the AWS WAF API, released in November, 2019. The names of the entities that you use to access this API, like endpoints and namespaces, all have the versioning information added, like \"V2\" or \"v2\", to distinguish from the prior version. We recommend migrating your resources to this version, because it has a number of significant improvements.
If you used AWS WAF prior to this release, you can't use this AWS WAFV2 API to access any AWS WAF resources that you created before. You can access your old rules, web ACLs, and other AWS WAF resources only through the AWS WAF Classic APIs. The AWS WAF Classic APIs have retained the prior names, endpoints, and namespaces.
For information, including how to migrate your AWS WAF resources to this version, see the AWS WAF Developer Guide.
AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to Amazon CloudFront, an Amazon API Gateway API, or an Application Load Balancer. AWS WAF also lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, API Gateway, CloudFront, or the Application Load Balancer responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You also can configure CloudFront to return a custom error page when a request is blocked.
This API guide is for developers who need detailed information about AWS WAF API actions, data types, and errors. For detailed information about AWS WAF features and an overview of how to use AWS WAF, see the AWS WAF Developer Guide.
You can make API calls using the endpoints listed in AWS Service Endpoints for AWS WAF.
For regional applications, you can use any of the endpoints in the list. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
For AWS CloudFront applications, you must use the API endpoint listed for US East (N. Virginia): us-east-1.
Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs.
We currently provide two versions of the AWS WAF API: this API and the prior versions, the classic AWS WAF APIs. This new API provides the same functionality as the older versions, with the following major improvements:
You use one API for both global and regional applications. Where you need to distinguish the scope, you specify a Scope parameter and set it to CLOUDFRONT or REGIONAL.
You can define a Web ACL or rule group with a single API call, and update it with a single call. You define all rule specifications in JSON format, and pass them to your rule group or Web ACL API calls.
The limits AWS WAF places on the use of rules more closely reflects the cost of running each type of rule. Rule groups include capacity settings, so you know the maximum cost of a rule group when you use it.
This is the latest version of the AWS WAF API, released in November, 2019. The names of the entities that you use to access this API, like endpoints and namespaces, all have the versioning information added, like \"V2\" or \"v2\", to distinguish from the prior version. We recommend migrating your resources to this version, because it has a number of significant improvements.
If you used AWS WAF prior to this release, you can't use this AWS WAFV2 API to access any AWS WAF resources that you created before. You can access your old rules, web ACLs, and other AWS WAF resources only through the AWS WAF Classic APIs. The AWS WAF Classic APIs have retained the prior names, endpoints, and namespaces.
For information, including how to migrate your AWS WAF resources to this version, see the AWS WAF Developer Guide.
AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to Amazon CloudFront, an Amazon API Gateway API, or an Application Load Balancer. AWS WAF also lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, API Gateway, CloudFront, or the Application Load Balancer responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You also can configure CloudFront to return a custom error page when a request is blocked.
This API guide is for developers who need detailed information about AWS WAF API actions, data types, and errors. For detailed information about AWS WAF features and an overview of how to use AWS WAF, see the AWS WAF Developer Guide.
You can make calls using the endpoints listed in AWS Service Endpoints for AWS WAF.
For regional applications, you can use any of the endpoints in the list. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
For AWS CloudFront applications, you must use the API endpoint listed for US East (N. Virginia): us-east-1.
Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs.
We currently provide two versions of the AWS WAF API: this API and the prior versions, the classic AWS WAF APIs. This new API provides the same functionality as the older versions, with the following major improvements:
You use one API for both global and regional applications. Where you need to distinguish the scope, you specify a Scope parameter and set it to CLOUDFRONT or REGIONAL.
You can define a Web ACL or rule group with a single call, and update it with a single call. You define all rule specifications in JSON format, and pass them to your rule group or Web ACL calls.
The limits AWS WAF places on the use of rules more closely reflects the cost of running each type of rule. Rule groups include capacity settings, so you know the maximum cost of a rule group when you use it.
A list of services corresponding to an error. A service identifies a segment and it contains a name, account ID, type, and inferred flag.
" + }, + "ClientImpacting":{ + "shape":"NullableBoolean", + "documentation":"A flag that denotes that the root cause impacts the trace client.
" } }, "documentation":"The root cause of a trace summary error.
" @@ -724,6 +728,10 @@ "Services":{ "shape":"FaultRootCauseServices", "documentation":"A list of corresponding services. A service identifies a segment and it contains a name, account ID, type, and inferred flag.
" + }, + "ClientImpacting":{ + "shape":"NullableBoolean", + "documentation":"A flag that denotes that the root cause impacts the trace client.
" } }, "documentation":"The root cause information for a trace summary fault.
" @@ -1366,6 +1374,10 @@ "Services":{ "shape":"ResponseTimeRootCauseServices", "documentation":"A list of corresponding services. A service identifies a segment and contains a name, account ID, type, and inferred flag.
" + }, + "ClientImpacting":{ + "shape":"NullableBoolean", + "documentation":"A flag that denotes that the root cause impacts the trace client.
" } }, "documentation":"The root cause information for a response time warning.
" diff --git a/docs/source/conf.py b/docs/source/conf.py index 4eb7d03b..eceeae2e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -54,7 +54,7 @@ copyright = u'2013, Mitch Garnaat' # The short X.Y version. version = '1.15.' # The full version, including alpha/beta/rc tags. -release = '1.15.26' +release = '1.15.46' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/tests/functional/test_kinesis.py b/tests/functional/test_kinesis.py new file mode 100644 index 00000000..26317956 --- /dev/null +++ b/tests/functional/test_kinesis.py @@ -0,0 +1,89 @@ +# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"). You +# may not use this file except in compliance with the License. A copy of +# the License is located at +# +# http://aws.amazon.com/apache2.0/ +# +# or in the "license" file accompanying this file. This file is +# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF +# ANY KIND, either express or implied. See the License for the specific +# language governing permissions and limitations under the License. +import json +import time +from base64 import b64decode +from uuid import uuid4 +from tests import unittest, BaseSessionTest, ClientHTTPStubber + + +class TestKinesisListStreams(BaseSessionTest): + def setUp(self): + super(TestKinesisListStreams, self).setUp() + self.stream_name = "kinesis-test-stream" + self.region = "us-east-1" + self.client = self.session.create_client("kinesis", self.region) + self.http_stubber = ClientHTTPStubber(self.client) + self.http_stubber.add_response() + + def assert_base64encoded_str_equals(self, encoded_str, expected_value): + """Validate a value can be base64 decoded and equals expected value""" + try: + decoded_str = b64decode(encoded_str).decode("utf-8") + except UnicodeDecodeError: + self.fail("Base64 encoded record is not a valid utf-8 string") + self.assertEqual(decoded_str, expected_value) + + def test_can_put_stream_blob(self): + unique_data = str(uuid4()) + with self.http_stubber as stub: + self.client.put_record( + StreamName=self.stream_name, PartitionKey="foo", Data=unique_data + ) + self.assertEqual(len(stub.requests), 1) + request = json.loads(stub.requests[0].body.decode("utf-8")) + self.assertEqual(request["StreamName"], self.stream_name) + self.assertEqual(request["PartitionKey"], "foo") + self.assert_base64encoded_str_equals( + request["Data"], unique_data + ) + + def test_can_put_records_single_blob(self): + unique_data = str(uuid4()) + with self.http_stubber as stub: + self.client.put_records( + StreamName=self.stream_name, + Records=[{"Data": unique_data, "PartitionKey": "foo"}], + ) + self.assertEqual(len(stub.requests), 1) + request = json.loads(stub.requests[0].body.decode("utf-8")) + self.assertEqual(len(request["Records"]), 1) + self.assertEqual(request["StreamName"], self.stream_name) + + record = request["Records"][0] + self.assertEqual(record["PartitionKey"], "foo") + self.assert_base64encoded_str_equals( + record["Data"], unique_data + ) + + def test_can_put_records_multiple_blob(self): + with self.http_stubber as stub: + self.client.put_records( + StreamName=self.stream_name, + Records=[ + {"Data": "foobar", "PartitionKey": "foo"}, + {"Data": "barfoo", "PartitionKey": "foo"}, + ], + ) + self.assertEqual(len(stub.requests), 1) + request = json.loads(stub.requests[0].body.decode("utf-8")) + self.assertEqual(len(request["Records"]), 2) + + record_foobar = request["Records"][0] + record_barfoo = request["Records"][1] + self.assert_base64encoded_str_equals( + record_foobar["Data"], "foobar" + ) + self.assert_base64encoded_str_equals( + record_barfoo["Data"], "barfoo" + ) diff --git a/tests/integration/test_kinesis.py b/tests/integration/test_kinesis.py deleted file mode 100644 index e1798923..00000000 --- a/tests/integration/test_kinesis.py +++ /dev/null @@ -1,111 +0,0 @@ -# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"). You -# may not use this file except in compliance with the License. A copy of -# the License is located at -# -# http://aws.amazon.com/apache2.0/ -# -# or in the "license" file accompanying this file. This file is -# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF -# ANY KIND, either express or implied. See the License for the specific -# language governing permissions and limitations under the License. -import time -from uuid import uuid4 -from tests import unittest, random_chars - -from nose.plugins.attrib import attr - -import botocore.session - - -class TestKinesisListStreams(unittest.TestCase): - - REGION = 'us-east-1' - - def setUp(self): - self.client = self.session.create_client('kinesis', self.REGION) - - @classmethod - def setUpClass(cls): - cls.session = botocore.session.get_session() - cls.stream_name = 'botocore-test-%s' % random_chars(10) - client = cls.session.create_client('kinesis', cls.REGION) - client.create_stream(StreamName=cls.stream_name, - ShardCount=1) - waiter = client.get_waiter('stream_exists') - waiter.wait(StreamName=cls.stream_name) - - @classmethod - def tearDownClass(cls): - client = cls.session.create_client('kinesis', cls.REGION) - client.delete_stream(StreamName=cls.stream_name) - - def test_list_streams(self): - parsed = self.client.list_streams() - self.assertIn('StreamNames', parsed) - - @attr('slow') - def test_can_put_stream_blob(self): - unique_data = str(uuid4()) - self.client.put_record( - StreamName=self.stream_name, PartitionKey='foo', Data=unique_data) - # Give it a few seconds for the record to get into the stream. - records = self.wait_for_stream_data() - self.assert_record_data_contains(records, unique_data.encode('ascii')) - self.assertTrue(len(records['Records']) > 0) - self.assertEqual(records['Records'][0]['Data'], b'foobar') - - @attr('slow') - def test_can_put_records_single_blob(self): - unique_data = str(uuid4()) - self.client.put_records( - StreamName=self.stream_name, - Records=[{ - 'Data': unique_data, - 'PartitionKey': 'foo' - }] - ) - records = self.wait_for_stream_data() - self.assert_record_data_contains(records, unique_data.encode('ascii')) - - @attr('slow') - def test_can_put_records_multiple_blob(self): - self.client.put_records( - StreamName=self.stream_name, - Records=[{ - 'Data': 'foobar', - 'PartitionKey': 'foo' - }, { - 'Data': 'barfoo', - 'PartitionKey': 'foo' - }] - ) - records = self.wait_for_stream_data() - self.assert_record_data_contains(records, b'foobar', b'barfoo') - - def wait_for_stream_data(self, num_attempts=6, poll_time=10): - # Poll until we get records returned from get_records(). - for i in range(num_attempts): - time.sleep(poll_time) - stream = self.client.describe_stream(StreamName=self.stream_name) - shard = stream['StreamDescription']['Shards'][0] - shard_iterator = self.client.get_shard_iterator( - StreamName=self.stream_name, ShardId=shard['ShardId'], - ShardIteratorType='TRIM_HORIZON') - records = self.client.get_records( - ShardIterator=shard_iterator['ShardIterator']) - if records['Records']: - return records - raise RuntimeError("Unable to retrieve data from kinesis stream after " - "%s attempts with delay of %s seconds." - % (num_attempts, poll_time)) - - def assert_record_data_contains(self, records, *expected): - record_data = [r['Data'] for r in records['Records']] - for item in expected: - self.assertIn(item, record_data) - - -if __name__ == '__main__': - unittest.main()